文本与向量混合查询

查询语法

URL

• curl -X POST /search 或者 curl -X POST /vector-service/search

• 以上 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==

查询参数

注意事项

• knn仅支持单个向量查询，参数与query API相同。

• 距离分转换

  为了将knn与text分数做融合，将对knn的距离分做转换。

  # 欧式距离
  score = 1.0 / (1.0 + l2_distance^2)
  
  # 内积距离
  score = (1.0 + ip_distance) / 2.0

• knn查询中的order参数不起作用，统一使用外层的order参数。

• 默认排序

  • 配置方式：不配置rank，或者rank配置为空{}

    {
      "rank": {}
    }

  • 两路结果中相同pk的doc的分数按权重相加。按加权后的分数排序。

    score(i) = knn_score(i) * knn_weight + text_score(i) * text_weight

• RRF

  • 配置方式：

    {
      "rank": {
        "rrf": {
          "rankConstant": 60
        }
      }
    }
    
    # rankConstant为可选参数，默认为60

  • 公式

    score = 0.0
    if d in result(q):
        score += 1.0 / (rankConstant + rank(result(q), d))
    return score
    
    # rankConstant是排序常数，决定了单路结果集中的文档对最终结果的影响程度。大的值表示低排名的文档具有更大的影响力。可以设置为大于等于1的整数。默认为60.
    # rank(result(q), d) 是该文档在某一路查询结果中的位置，从1开始。

查询示例

{
    "tableName": "test",
    "text": {
        "queryString": "title:'阿里巴巴'",
        "queryParams": {
            "default_op": "OR"
        },
        "filter": "count > 0",
        "terminateAfter": 100000
    },
    "knn": {
        "vector": [0.1, 0.2, 0.3, 0.4, 0.5],
        "namespace": "1",
        "topK": 100
    },
    "order": "DESC",
    "size": 10,
    "rank": {
        "rrf": {
            "rankConstant": 1
        }
    },
    "outputFields": ["title"]
}

返回结果

{
  "totalTime": 8.522,
  "coveredPercent": 1.0,
  "totalCount": 5,
  "result": [
    {
      "__source__": 2,
      "score": 0.833333,
      "namespace": 1,
      "id": 2,
      "fields": {
        "title": "a b c"
      }
    },
    {
      "__source__": 3,
      "score": 0.666666,
      "namespace": 1,
      "id": 1,
      "fields": {
        "title": "a b"
      }
    },
    {
      "__source__": 3,
      "score": 0.333333,
      "namespace": 2,
      "id": 5,
      "fields": {
        "title": "c"
      }
    },
    {
      "__source__": 2,
      "score": 0.25,
      "namespace": 2,
      "id": 4,
      "fields": {
        "title": "b c"
      }
    },
    {
      "__source__": 2,
      "score": 0.2,
      "namespace": 1,
      "id": 0,
      "fields": {
        "title": "a"
      }
    }
  ]
}

result参数：