向量查询

功能说明

向量查询是指用户将生成好的向量数据导入到向量检索版实例中，进行向量检索的查询方式。

注：若您没有向量模型对您的数据生成向量，可以通过向量检索版提供的图片向量化、文本向量化的功能将您的数据通过内置的向量模型生成向量，再通过预测查询进行检索。

URL

/vector-service/query

• 以上 URL 省略了请求Header参数及编码等因素。

• 以上 URL 中省略了访问应用的 host 地址。

• 以上URL中拼接的所有查询参数，请查看下方“查询参数”的参数定义、使用方式及样例。

请求协议

HTTP

请求方式

POST

支持格式

JSON

签名机制

可用以下方法计算签名（authorization）

import com.aliyun.darabonba.encode.Encoder;
import com.aliyun.darabonbastring.Client;

public class GenerateAuthorization {

 public static void main(String[] args) throws Exception {
 String accessUserName = "username";
 String accessPassWord = "password";
 String realmStr = "" + accessUserName + ":" + accessPassWord + "";
 String authorization = Encoder.base64EncodeToString(Client.toBytes(realmStr, "UTF-8"));
 System.out.println(authorization);
		}
}

authorization正确返回格式：

cm9vdDp******mdhbA==

使用HTTP请求设置authorization参数是需加上Basic前缀

示例：（加在header中）

authorization: Basic cm9vdDp******mdhbA==

请求body语法

单向量查询

{
    "tableName": "gist",
    "vector": [
        0.1,
        0.2,
        0.3
    ],
    "topK": 3,
    "searchParams":"{\"qc.searcher.scan_ratio\":0.01}",
    "includeVector": true
}

带namespace查询

OpenSearch向量检索版支持通过namespace将索引进行分区，为向量索引配置namespace后，可在指定namespace内查询，因此不同的查询请求可以搜索不同的索引子集。

注意：设置namespace后，查询时必须指定namespace。

{
    "tableName": "gist",
    "namespace": "space_b",
    "vector": [
        0.1,
        0.2
    ],
    "topK": 3,
    "searchParams":"{\"qc.searcher.scan_ratio\":0.01}",
    "includeVector": true
}

多namespace查询

为向量索引配置namespace后，支持在多个namespace中查询。

{
    "tableName": "gist",
    "queries": [
        {
            "vector": [
                0.1,
                0.2,
                0.3
            ],
            "namespace": "space_a"
        },
        {
            "vector": [
                0.4,
                0.5,
                0.6
            ],
            "namespace": "space_b"
        }
    ],
    "topK": 3,
    "searchParams":"{\"qc.searcher.scan_ratio\":0.01}",
    "includeVector": true
}

带过滤查询

支持使用filter表达式，指定过滤条件进行查询。

{
    "tableName": "gist",
    "vector": [
        0.1,
        0.2
    ],
    "topK": 3,
    "searchParams":"{\"qc.searcher.scan_ratio\":0.01}",
    "filter": "a > 10",
    "includeVector": true,
    "outputFields": [
        "a",
        "b"
    ]
}

多向量查询

可以同时查询多个向量，这些向量的结果会合并排序，返回最终的topK个结果。例如向量维度为2，同时查询两个向量：

{
    "tableName": "gist",
    "vector": [
        0.1,
        0.2,
        0.3,
        0.4
    ],
    "vectorCount": 2,
    "topK": 3,
    "searchParams":"{\"qc.searcher.scan_ratio\":0.01}",
    "includeVector": true,
    "outputFields": [
        "a",
        "b"
    ]
}

返回参数

item定义：

示例：

{
    "result": [
        {
            "id": 1,
            "score": 1.0508723258972169,
            "vector": [
                0.1,
                0.2,
                0.3
            ]
        },
        {
            "id": 2,
            "score": 1.0329746007919312,
            "vector": [
                0.2,
                0.2,
                0.3
            ]
        },
        {
            "id": 3,
            "score": 0.980593204498291,
            "vector": [
                0.3,
                0.2,
                0.3
            ]
        }
    ],
    "totalCount": 3,
    "totalTime": 2.943
}