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.
}
フィールド
使用するインデックスのタイプ。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
useIndex
(deprecated)

object (IndexHint)

省略可。非推奨: 代わりに、indexHint を使用してください。検索で特定のインデックスを使用することを指定します。
useKnn
(deprecated)

boolean

省略可。非推奨: 代わりに、knnHint を使用してください。true に設定すると、検索でシステムのデフォルトの K 近傍法（KNN）インデックス エンジンが使用されます。
knnHint

object (KnnHint)

省略可。設定されている場合、検索ではシステムのデフォルトの K-Nearest Neighbor（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}
インデックスのパラメータ。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
denseScannParams

object (DenseScannParams)

省略可。Dense 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] の範囲内の double 値にする必要があります。検索は、このレベルの再現率を達成することを目的としていますが、保証されるものではありません。

KnnHint

この型にはフィールドがありません。

検索をシステムのデフォルトの K 近傍法（KNN）インデックス エンジンで明示的に行う必要がある場合は、KnnHint が使用されます。