向量相似度匹配

将关键词转为向量，并对应文档ID，执行向量检索，返回关键词匹配度最高的K个结果。

请求方式

POST

调用地址

https://api.gptbots.ai/v1/vector/match

调用验证

详情参见API概述的鉴权方式说明。

请求

请求示例

curl -X POST https://api.gptbots.ai/v1/vector/match \
  -H 'Authorization: Bearer app-qp97HeWyyBqFs7VUKDoi2ti3' \
  -H 'Content-Type: application/json' \
  -d '{
        "prompt": "请介绍一下极光。",
        "data_ids": [
                "1234567890",
                "1230987654"
        ],
        "top_k": "5"
}'

请求头

字段	类型	描述
Authorization	Bearer ${token}	使用Authorization: Bearer ${token}进行调用验证，请在API密钥页面获取密钥作为token。
Content-Type	application/json	数据类型，取值为application/json。

请求体

字段	类型	必填	描述
prompt	string	是	关键词，用于与Bot内文档进行向量相似度匹配的内容。
data_ids	array	否	文档ID，关键词的向量匹配对象。可填入多个Bot的知识文档ID。若为空，则默认匹配Bot内全部知识文档。
top_k	int	是	将关键词与文档ID进行向量相似度匹配后，返回相似度最高的K个值。只能填写1-10。

响应

响应示例

{
  "total": 2,
  "list": [
    {
      "content": "测试数据",
      "data_id": "aS1CNvPK4XCckDKQNj7azC9a",
      "score": 0.75
    },
    {
      "content": "测试数据",
      "data_id": "aS1CNvPK4XCckDKQNj7azC9a",
      "score": 0.75
    }
  ]
}

成功响应

字段	类型	描述
content	string	分片内容。
data_id	string	来源文档。
score	float	相似度值。

失败响应

字段	类型	描述
code	int	错误码。
message	string	错误详情。

错误码

Code	Message
40000	参数错误
40127	开发者鉴权失败
40332	查询文档数量不能超过10条