SearchHint

代表搜尋索引引擎的提示。

JSON 表示法 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "useIndex": {
    object (IndexHint)
  },
  "useKnn": boolean,
  "knnHint": {
    object (KnnHint)
  },
  "indexHint": {
    object (IndexHint)
  }
  // End of mutually exclusive fields.
}
欄位
要使用的索引類型。以下列出互斥的欄位。回應中最多會設定一個欄位：
useIndex
(deprecated)

object (IndexHint)

選用。已淘汰：請改用 indexHint。指定搜尋應使用特定索引。
useKnn
(deprecated)

boolean

選用。已淘汰：請改用 knnHint。如果設為 True，搜尋時會使用系統預設的 K 近鄰 (KNN) 索引引擎。
knnHint

object (KnnHint)

選用。如果設定此值，搜尋作業會使用系統的預設 K 近鄰 (KNN) 索引引擎。
indexHint

object (IndexHint)

選用。指定搜尋應使用特定索引。
互斥欄位的結尾。

IndexHint

指定用於搜尋的索引。

JSON 表示法 
{
  "name": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "denseScannParams": {
    object (DenseScannParams)
  }
  // End of mutually exclusive fields.
}
欄位
name

string

這是必要旗標，用於搜尋的索引資源名稱。索引必須位於相同專案、位置和集合。格式：projects/{project}/locations/{location}/collections/{collection}/indexes/{index}
索引的參數。以下列出互斥的欄位。回應中最多會設定一個欄位：
denseScannParams

object (DenseScannParams)

選用。密集 ScaNN 參數。
互斥欄位的結尾。

DenseScannParams

密集 ScaNN 的參數。

JSON 表示法 
{
  "searchLeavesPct": integer,
  "initialCandidateCount": integer,
  "targetRecall": number
}
欄位
searchLeavesPct

integer

選用。密集 ANN 參數覆寫，可控制召回率和延遲時間。要搜尋的分葉百分比，範圍為 [0, 100]。不支援 STORAGE_OPTIMIZED 索引。無法與「targetRecall」一併設定。
initialCandidateCount

integer

選用。初始候選人數。必須是正整數 (大於 0)。不支援 STORAGE_OPTIMIZED 索引。無法與「targetRecall」一併設定。
targetRecall

number

選用。搜尋的目標召回率。必須是介於 [0, 1] 範圍內的雙精度浮點數。搜尋作業的目標是達到這個召回率，但無法保證一定能達成。

KnnHint

這個類型沒有任何欄位。

如果應明確在系統的預設 K 近鄰 (KNN) 索引引擎上執行搜尋，系統就會使用 KnnHint。