REST Resource: projects.locations.collections.indexes

リソース: インデックス

Index オブジェクトについて説明するメッセージ

JSON 表現 
{
  "name": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "distanceMetric": enum (DistanceMetric),
  "indexField": string,
  "filterFields": [
    string
  ],
  "storeFields": [
    string
  ]
}
フィールド
name

string

識別子。リソースの名前
displayName

string

省略可。ユーザーが指定したインデックスの表示名
description

string

省略可。ユーザーが指定したインデックスの説明
labels

map (key: string, value: string)

省略可。Key-Value ペアとしてのラベル。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
createTime

string (Timestamp format)

出力専用。[出力専用] 作成タイムスタンプ

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。[出力専用] 更新タイムスタンプ

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
distanceMetric

enum (DistanceMetric)

省略可。インデックス作成に使用される距離指標。指定しない場合、デフォルトで DOT_PRODUCT になります。
indexField

string

必須。インデックス付けするコレクション スキーマ フィールド。
filterFields[]

string

省略可。高速 ANN インライン フィルタリングを有効にするためにインデックスにプッシュするフィールド。
storeFields[]

string

省略可。インライン データ取得を有効にするためにインデックスにプッシュするフィールド。

DistanceMetric

ベクトル検索の距離指標。

列挙型
DISTANCE_METRIC_UNSPECIFIED デフォルト値。距離指標は指定されていません。
DOT_PRODUCT ドット積距離指標。
COSINE_DISTANCE コサイン距離指標。

メソッド

create

 指定されたプロジェクトとロケーションに新しいインデックスを作成します。

delete

 1 つのインデックスを削除します。

get

 1 つのインデックスの詳細を取得します。

list

 指定されたプロジェクトとロケーションのインデックスを一覧表示します。