// Code generated by sidekick. DO NOT EDIT.
//
// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import Foundation
import GoogleCloudWkt

/// Defines a semantic search operation.
public struct SemanticSearch: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  Sendable
{
  /// Required. The query text, which is used to generate an embedding according
  /// to the embedding model specified in the collection config.
  public var searchText: Swift.String = Swift.String()

  /// Required. The vector field to search.
  public var searchField: Swift.String = Swift.String()

  /// Required. The task type of the query embedding.
  public var taskType: EmbeddingTaskType = EmbeddingTaskType()

  /// Optional. The fields to return in the search results.
  public var outputFields: OutputFields? = nil

  /// Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
  /// represented as a google.protobuf.Struct.
  public var filter: GoogleCloudWkt.Struct? = nil

  /// Optional. The number of data objects to return.
  public var topK: Swift.Int32? = nil

  /// Optional. Sets the search hint. If no strategy is specified, the service
  /// will use an index if one is available, and fall back to KNN search
  /// otherwise.
  public var searchHint: SearchHint? = nil

  /// Initialize a new instance of `SemanticSearch`.
  public init() {}

  /// Use `config` to return a new instance of this object, with some fields updated.
  ///
  /// Commonly used to initialize the value, for example:
  ///
  /// ```
  /// let value = SemanticSearch().with { $0.searchText = ... }
  /// ```
  public func with(_ config: (inout Self) throws -> Swift.Void) rethrows -> Self {
    var copy = self
    try config(&copy)
    return copy
  }

  public static var _anyTypeUrl: Swift.String {
    return "type.googleapis.com/google.cloud.vectorsearch.v1.SemanticSearch"
  }
  public init(fromAny any: GoogleCloudWkt.`Any`) throws {
    self = try GoogleCloudWkt._slowAnyDeserialize(Self.self, from: any)
  }
  public func _pack() throws -> GoogleCloudWkt.Struct {
    return try GoogleCloudWkt._slowAnySerialize(message: self)
  }
}
