REST Resource: projects.locations.collections

资源：Collection

描述 Collection 对象的消息

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "schema": {
    object
  },
  "vectorSchema": {
    string: {
      object (VectorField)
    },
    ...
  },
  "dataSchema": {
    object
  }
}
字段
name

string

标识符。资源的名称
displayName

string

可选。用户指定的集合显示名
description

string

可选。用户指定的商品集说明
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"。
labels

map (key: string, value: string)

可选。标签作为键值对。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
schema
(deprecated)

object (Struct format)

可选。已弃用：数据的 JSON 架构。请改用 dataSchema。
vectorSchema

map (key: string, value: object (VectorField))

可选。向量字段的架构。只有此架构中的向量字段可供搜索。字段名称只能包含字母数字字符、下划线和连字符。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
dataSchema

object (Struct format)

可选。数据的 JSON 架构。字段名称只能包含字母数字字符、下划线和连字符。

VectorField

描述向量字段的消息。

JSON 表示法 
{

  // Union field vector_type_config can be only one of the following:
  "denseVector": {
    object (DenseVectorField)
  },
  "sparseVector": {
    object (SparseVectorField)
  }
  // End of list of possible types for union field vector_type_config.
}
字段
联合字段 vector_type_config。向量类型配置。vector_type_config 只能是下列其中一项：
denseVector

object (DenseVectorField)

密集向量字段。
sparseVector

object (SparseVectorField)

稀疏向量字段。

DenseVectorField

描述密集矢量字段的消息。

JSON 表示法 
{
  "dimensions": integer,
  "vertexEmbeddingConfig": {
    object (VertexEmbeddingConfig)
  }
}
字段
dimensions

integer

向量字段的维度。
vertexEmbeddingConfig

object (VertexEmbeddingConfig)

可选。用于为向量字段生成嵌入的配置。如果未指定，则必须在 DataObject 中填充嵌入字段。

VertexEmbeddingConfig

用于描述使用 Vertex AI 嵌入 API 为向量字段生成嵌入的配置的消息。

JSON 表示法 
{
  "modelId": string,
  "textTemplate": string,
  "taskType": enum (EmbeddingTaskType)
}
字段
modelId

string

必需。必需：要使用的嵌入模型的 ID。如需查看支持的模型的列表，请参阅 https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models。
textTemplate

string

必需。必需：模型输入的文本模板。模板必须包含对 DataObject 中一个或多个字段的引用，例如：“电影片名：{title} ---- 电影情节：{plot}”。
taskType

enum (EmbeddingTaskType)

必需。必需：嵌入的任务类型。

EmbeddingTaskType

表示嵌入将用于的任务。

枚举
EMBEDDING_TASK_TYPE_UNSPECIFIED 未指定任务类型。
RETRIEVAL_QUERY 在搜索/检索设置中指定给定文本是查询。
RETRIEVAL_DOCUMENT 指定给定文本是正在搜索的语料库中的文档。
SEMANTIC_SIMILARITY 指定给定文本用于 STS。
CLASSIFICATION 指定要对给定的文本进行分类。
CLUSTERING 指定嵌入用于聚类。
QUESTION_ANSWERING 指定嵌入用于问答。
FACT_VERIFICATION 指定嵌入用于事实验证。
CODE_RETRIEVAL_QUERY 指定嵌入用于代码检索。

SparseVectorField

此类型没有字段。

描述稀疏向量字段的消息。

方法

create

 在给定的项目和位置中创建新集合。

delete

 删除单个集合。

exportDataObjects

 启动长时间运行的操作，以从集合中导出 DataObject。

get

 获取单个集合的详细信息。

importDataObjects

 启动长时间运行的操作，以将 DataObject 导入到集合中。

list

 列出给定项目和位置中的集合。

patch

 更新单个集合的参数。