Represents a hint to the search index engine.
| JSON representation |
|---|
{ // Union field |
index_type
. The type of index to use. index_type
can be only one of the following:useIndex
(deprecated)
object (
IndexHint
)
Optional. Deprecated: Use indexHint
instead. Specifies that the search should use a particular index.
useKnn
(deprecated)
boolean
Optional. Deprecated: Use knnHint
instead. If set to true, the search will use the system's default K-Nearest Neighbor (KNN) index engine.
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.
IndexHint
Message to specify the index to use for the search.
| JSON representation |
|---|
{ "name" : string , // Union field |
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}
params
. The parameters for the index. params
can be only one of the following:denseScannParams
object (
DenseScannParams
)
Optional. Dense ScaNN parameters.
DenseScannParams
Parameters for dense ScaNN.
| JSON representation |
|---|
{ "searchLeavesPct" : integer , "initialCandidateCount" : integer } |
| Fields | |
|---|---|
searchLeavesPct
|
Optional. Dense ANN param overrides to control recall and latency. The percentage of leaves to search, in the range [0, 100]. |
initialCandidateCount
|
Optional. The number of initial candidates. Must be a positive integer (> 0). |
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.
