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
  ],

  // Union field infra_type can be only one of the following:
  "dedicatedInfrastructure": {
    object (DedicatedInfrastructure)
  }
  // End of list of possible types for union field infra_type.

  // Union field index_type can be only one of the following:
  "denseScann": {
    object (DenseScannIndex)
  }
  // End of list of possible types for union field index_type.
}
欄位
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

選用。要推送到索引的欄位，以便啟用內嵌資料擷取功能。
聯集欄位 infra_type。索引的基礎架構類型。infra_type 只能是下列其中一個設定：
dedicatedInfrastructure

object (DedicatedInfrastructure)

選用。索引專屬基礎架構。
聯集欄位 index_type。索引的類型。index_type 只能是下列其中一個設定：
denseScann

object (DenseScannIndex)

選用。密集 ScaNN 索引。

DedicatedInfrastructure

代表索引的專屬基礎架構。

JSON 表示法 
{
  "autoscalingSpec": {
    object (AutoscalingSpec)
  },
  "mode": enum (Mode)
}
欄位
autoscalingSpec

object (AutoscalingSpec)

選用。自動調度資源規格。
mode

enum (Mode)

選用。專屬基礎架構模式。

模式

專屬基礎架構模式。

列舉
MODE_UNSPECIFIED 預設值為 PERFORMANCE_OPTIMIZED。
STORAGE_OPTIMIZED 這是經過最佳化處理的儲存空間變體。
PERFORMANCE_OPTIMIZED 這是在 E2 或同等機器家族上進行效能最佳化。

AutoscalingSpec

自動調度資源規格。

JSON 表示法 
{
  "minReplicaCount": integer,
  "maxReplicaCount": integer
}
欄位
minReplicaCount

integer

選用。副本數量下限。如未設定或設為 0，則預設為 2。必須 >= 1 且 <= 1000。
maxReplicaCount

integer

選用。副本數量上限。必須 >= minReplicaCount 且 <= 1000。如果是 v1beta 版，如果未設定或設為 0，則預設為 minReplicaCount 和 5 中較大的值。如果是其他版本，如果未設定或設為 0，則預設值為 minReplicaCount 和 2 中較大的值。

DenseScannIndex

密集 ScaNN 索引設定。

JSON 表示法 
{
  "featureNormType": enum (FeatureNormType)
}
欄位
featureNormType

enum (FeatureNormType)

選用。特徵正規化類型。

FeatureNormType

ScaNN 索引的特徵正規化類型。

列舉
FEATURE_NORM_TYPE_UNSPECIFIED 未指定特徵正規化類型。
NONE 未套用任何規範。
UNIT_L2_NORM 單位 L2 範數。

DistanceMetric

向量搜尋的距離指標。

列舉
DISTANCE_METRIC_UNSPECIFIED 預設值，未指定距離指標。
DOT_PRODUCT 點積距離指標。
COSINE_DISTANCE 餘弦距離指標。

方法

create

 在指定專案和位置中建立新索引。

delete

 刪除單一索引。

get

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

list

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

patch

 更新單一索引的參數。