REST Resource: projects.locations.collections.indexes

資源：Index

描述 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

ID。資源名稱
displayName

string

選用。使用者指定的索引顯示名稱
description

string

選用。使用者指定的索引說明
labels

map (key: string, value: string)

選用。以鍵/值組合形式呈現的標籤。

包含 "key": value 組合清單的物件，例如 { "name": "wrench", "mass": "1.3kg", "count": "3" }。
createTime

string (Timestamp format)

僅供輸出。[Output only] 建立時間戳記

使用 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)

僅供輸出。[Output only] 更新時間戳記

使用 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

 刪除單一索引。

get

 取得單一索引的詳細資料。

list

 列出指定專案和位置中的索引。