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

識別子。リソースの名前
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

省略可。インライン データ取得を有効にするためにインデックスにプッシュするフィールド。
共用体フィールド 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

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

get

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

list

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

patch

 単一のインデックスのパラメータを更新します。