DescribeCollection - 查询向量集信息 - 云原生数据仓库AnalyticDB

查询向量集信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
gpdb:DescribeCollection	create	*Collection `acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	否	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-bp152460513z****
Namespace	string	否	命名空间。说明您可以通 ListNamespaces 接口查看列表。	mynamespace
NamespacePassword	string	是	命名空间对应的密码。	testpassword
Collection	string	是	集合名。说明您可以通过 ListCollections 接口查看列表。	document
RegionId	string	是	实例所在地域 ID。	cn-hangzhou
WorkspaceId	string	否	多数据库实例组成的 Workspace 的 Id。此参数和 DBInstanceId 参数不能同时为空，当和 DBInstanceId 同时指定时以此参数为准。	gp-ws-*****

返回参数

名称	类型	描述	示例值
	object	向量详情。
RequestId	string	请求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Dimension	integer	向量维度。	1024
FullTextRetrievalFields	string	用于全文检索的字段，多个字段用英文逗号（,）分隔。	title,content
Metadata	object	向量数据的元信息，为 MAP 格式的 JSON 字符串。其中 key 代表字段名，value 代表数据类型。警告 id、vector、to_tsvector 字段为保留字段，禁止使用。
	string	元数据。	{"title":"text","content":"text"}
Metrics	string	Distance Metrics。	cosine
Parser	string	用于全文检索的分词器。	zh_cn
DBInstanceId	string	实例 ID。	gp-bp152460513z****
RegionId	string	地域 ID。	cn-hangzhou
Namespace	string	命名空间。	mynamespace
Message	string	接口返回详细信息。	success
Status	string	API 执行状态，取值如下： success：执行成功。 fail：执行失败。	success

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Dimension": 1024,
  "FullTextRetrievalFields": "title,content",
  "Metadata": {
    "key": "{\"title\":\"text\",\"content\":\"text\"}"
  },
  "Metrics": "cosine",
  "Parser": "zh_cn",
  "DBInstanceId": "gp-bp152460513z****",
  "RegionId": "cn-hangzhou",
  "Namespace": "mynamespace",
  "Message": "success",
  "Status": "success"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-08-04	OpenAPI 入参发生变更	查看变更详情
2023-11-07	API 内部配置变更，不影响调用	查看变更详情
2023-08-01	API 内部配置变更，不影响调用	查看变更详情