SemanticSearch

Defines a semantic search operation.

JSON representation
{
  "searchText": string,
  "searchField": string,
  "taskType": enum (EmbeddingTaskType),
  "outputFields": {
    object (OutputFields)
  },
  "filter": {
    object
  },
  "searchHint": {
    object (SearchHint)
  },
  "topK": integer
}
Fields
searchText

string

Required. The query text, which is used to generate an embedding according to the embedding model specified in the collection config.

searchField

string

Required. The vector field to search.

taskType

enum (EmbeddingTaskType)

Optional. The task type of the query embedding.

outputFields

object (OutputFields)

Optional. The fields to return in the search results.

filter

object (Struct format)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

searchHint

object (SearchHint)

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.

topK

integer

Optional. The number of data objects to return.