调用QueryCollectionData召回向量数据_云原生数据仓库 AnalyticDB PostgreSQL版(AnalyticDB for PostgreSQL)-阿里云帮助中心

召回向量数据。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
gpdb:QueryCollectionData	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-xxxxxxxxx
Collection	string	是	集合名。说明您可以通过 ListCollections 接口查看列表。	document
Namespace	string	否	命名空间。说明您可以通过 ListNamespaces 查看列表。	mynamespace
NamespacePassword	string	是	命名空间对应的密码。	testpassword
Content	string	否	用于全文检索的内容。即此值为空时，仅使用向量检索；不为空时，使用向量和全文双路检索。说明和 Vector 参数不能同时为空。	hello_world
Filter	string	否	过滤器。	response > 200
TopK	long	是	设置返回 top 结果数量。	10
Vector	array	否	向量数据，长度和 CreateCollection 接口的维度一致。说明当 vector 为空时，只返回全文检索结果。
	double	否	向量数据。	1.234
RegionId	string	是	实例所在地域 ID。	cn-hangzhou
Metrics	string	否	检索时的相似度算法。取值说明： l2：欧氏距离。 ip：点积（内积）距离。 cosine：余弦相似度。说明此值为空时，则使用构建索引时指定的算法。	cosine
IncludeValues	boolean	否	是否返回向量数据。取值说明： true：返回向量数据。 false：不返回向量数据，用于全文检索场景。	true
HybridSearch	string	否	双路召回算法，默认为空(即直接将向量和全文的分数比较并排序)。可选值： RRF：倒数排序融合(Reciprocal rank fusion)，有一个参数 k 控制融合效果，详见 HybridSearchArgs 配置； Weight：比重排序，采用一个参数 alpha 控制向量和全文的分数比重，然后再排序，参数详见 HybridSearchArgs 配置； Cascaded：先全文检索再在其基础上进行向量检索；	RRF
HybridSearchArgs	object	否	双路召回的算法参数。目前支持 RRF 和 Weight 两种： RRF：指定计算分数的算法的`1/(k+rank_i)`中的 k 常数，范围大于 1 的正整数，格式为： `{ "RRF": { "k": 60 } }` Weight: 计算公式`alpha * vector_score + (1-alpha) * text_score`，参数 alpha 表示向量和全文的检索分数比重，范围为 0～1，其中 0 表示只全文，1 表示只向量： `{ "Weight": { "alpha": 0.5 } }`
	object	否	双路召回的参数名。
	any	否	参数值。	{ "Weight": { "alpha": 0.5 } }

返回参数

名称	类型	描述	示例值
	object	召回结果。
Matches	object []	数据列表。
Id	string	向量数据的唯一 ID。	doca-1234
Metadata	object	元数据。
	string	元数据内容。	{"title":"test title", "content": "test content"}
Values	array	向量数据列表。
	double	向量数据。	1.234
Score	double	此条数据的相似度分数，其分数算法和创建索引时指定的算法`(l2/ip/cosine)`相关。	0.12345
RequestId	string	请求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Status	string	状态，取值说明： success：成功。 fail：失败。	success
Message	string	请求失败时的详细信息。	0.1234

示例

正常返回示例

JSON格式

{
  "Matches": {
    "match": [
      {
        "Id": "doca-1234",
        "Metadata": {
          "key": "{\"title\":\"test title\", \"content\":  \"test content\"}"
        },
        "Values": {
          "value": [
            1.234
          ]
        },
        "Score": 0.12345
      }
    ]
  },
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Status": "success",
  "Message": "0.1234"
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2024-04-22

OpenAPI 入参发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：HybridSearch
	新增入参：HybridSearchArgs

2023-11-07

API 内部配置变更，不影响调用

看变更集

变更项	变更内容
	API 内部配置变更，不影响调用。

2023-08-17

OpenAPI 入参发生变更

看变更集

变更项	变更内容
入参	OpenAPI 入参发生变更。
	新增入参：Metrics
	新增入参：IncludeValues

2023-08-08

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-08-01

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-08-01

API 内部配置变更，不影响调用

看变更集

变更项	变更内容
	API 内部配置变更，不影响调用。