SearchHint

表示对搜索索引引擎的提示。

JSON 表示法
{

  // Union field index_type can be only one of the following:
  "useIndex": {
    object (IndexHint)
  },
  "useKnn": boolean,
  "knnHint": {
    object (KnnHint)
  },
  "indexHint": {
    object (IndexHint)
  }
  // End of list of possible types for union field index_type.
}
字段
联合字段 index_type。要使用的索引类型。index_type 只能是下列其中一项:
useIndex
(deprecated)

object (IndexHint)

可选。已弃用:请改用 indexHint。指定搜索应使用特定索引。

useKnn
(deprecated)

boolean

可选。已弃用:请改用 knnHint。如果设置为 true,搜索将使用系统的默认 K-最近邻 (KNN) 索引引擎。

knnHint

object (KnnHint)

可选。如果设置,搜索将使用系统的默认 K-最近邻 (KNN) 索引引擎。

indexHint

object (IndexHint)

可选。指定搜索应使用特定索引。

IndexHint

用于指定要用于搜索的索引的消息。

JSON 表示法
{
  "name": string,

  // Union field params can be only one of the following:
  "denseScannParams": {
    object (DenseScannParams)
  }
  // End of list of possible types for union field params.
}
字段
name

string

必需。用于搜索的索引的资源名称。索引必须位于同一项目、位置和集合中。格式:projects/{project}/locations/{location}/collections/{collection}/indexes/{index}

联合字段 params。索引的参数。params 只能是下列其中一项:
denseScannParams

object (DenseScannParams)

可选。密集 ScaNN 参数。

DenseScannParams

密集 ScaNN 的参数。

JSON 表示法
{
  "searchLeavesPct": integer,
  "initialCandidateCount": integer
}
字段
searchLeavesPct

integer

可选。用于控制召回率和延迟时间的密集 ANN 参数替换。要搜索的叶所占的百分比,范围为 [0, 100]。

initialCandidateCount

integer

可选。初始候选对象数量。必须是正整数(大于 0)。

KnnHint

此类型没有字段。

如果应在系统的默认 K-最近邻 (KNN) 索引引擎上显式执行搜索,则使用 KnnHint。