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

  // 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 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
createTime

string (Timestamp format)

仅限输出。[仅限输出] 创建时间戳

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 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 规范化（即转换为 UTC 零时区格式并在末尾附加 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

 更新单个索引的参数。