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

标识符。资源的名称
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

可选。要推送到索引中以实现内嵌数据检索的字段。

DistanceMetric

向量搜索的距离指标。

枚举
DISTANCE_METRIC_UNSPECIFIED 默认值，未指定距离指标。
DOT_PRODUCT 点积距离指标。
COSINE_DISTANCE 余弦距离指标。

方法

create

 在给定的项目和位置中创建新索引。

delete

 删除单个索引。

get

 获取单个索引的详细信息。

list

 列出给定项目和位置中的索引。