SearchHint

Represents a hint to the search index engine.

JSON representation
{

  // Union field index_type can be only one of the following:
  "knnHint": {
    object (KnnHint)
  },
  "indexHint": {
    object (IndexHint)
  }
  // End of list of possible types for union field index_type.
}
Fields
Union field index_type. The type of index to use. index_type can be only one of the following:
knnHint

object (KnnHint)

Optional. If set, the search will use the system's default K-Nearest Neighbor (KNN) index engine.

indexHint

object (IndexHint)

Optional. Specifies that the search should use a particular index.

KnnHint

This type has no fields.

KnnHint will be used if search should be explicitly done on system's default K-Nearest Neighbor (KNN) index engine.

IndexHint

Message to specify the index to use for the search.

JSON representation
{
  "name": string
}
Fields
name

string

Required. The resource name of the index to use for the search. The index must be in the same project, location, and collection. Format: projects/{project}/locations/{location}/collections/{collection}/indexes/{index}