文档

QueryCollectionData - 召回向量数据

更新时间:

召回向量数据。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-xxxxxxxxx
Collectionstring

集合名。

说明 您可以通过 ListCollections 接口查看列表。
document
Namespacestring

命名空间。

说明 您可以通过 ListNamespaces 查看列表。
mynamespace
NamespacePasswordstring

命名空间对应的密码。

testpassword
Contentstring

用于全文检索的内容。即此值为空时,仅使用向量检索;不为空时,使用向量和全文双路检索。

说明 和 Vector 参数不能同时为空。
hello_world
Filterstring

过滤器。

response > 200
TopKlong

设置返回 top 结果数量。

10
Vectorarray

向量数据,长度和 CreateCollection 接口的维度一致。

说明 当 vector 为空时,只返回全文检索结果。
double

向量数据。

1.234
RegionIdstring

实例所在地域 ID。

cn-hangzhou
Metricsstring

检索时的相似度算法。取值说明:

  • l2:欧氏距离。
  • ip:点积(内积)距离。
  • cosine:余弦相似度。
说明 此值为空时,则使用构建索引时指定的算法。
cosine
IncludeValuesboolean

是否返回向量数据。取值说明:

  • true:返回向量数据。
  • false:不返回向量数据,用于全文检索场景。
true

返回参数

名称类型描述示例值
object

召回结果。

Matchesobject []

数据列表。

Idstring

向量数据的唯一 ID。

doca-1234
Metadataobject

元数据。

string

元数据内容。

{"title":"test title", "content": "test content"}
Valuesarray

向量数据列表。

double

向量数据。

1.234
Scoredouble

此条数据的相似度分数,其分数算法和创建索引时指定的算法(l2/ip/cosine)相关。

0.12345
RequestIdstring

请求 ID。

ABB39CC3-4488-4857-905D-2E4A051D0521
Statusstring

状态,取值说明:

  • success:成功。
  • fail:失败。
success
Messagestring

请求失败时的详细信息。

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"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-07API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-17OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Metrics
    新增入参:IncludeValues
2023-08-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-01OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈