检索与同步

检索

在知识库中执行语义检索

POST

/api/v1/indices/rag/index/retrieve

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/retrieve" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "index_id": "your_index_id",
    "query": "如何使用百炼平台？",
    "rerank_top_n": 5
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "total": 1,
    "nodes": [
      {
        "score": 0.48142415285110474,
        "metadata": {
          "title": "",
          "doc_id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
          "doc_name": "a",
          "doc_url": "https://oss-example.aliyuncs.com/...",
          "content": "your_kb_id",
          "page_number": [
            0
          ],
          "image_url": []
        },
        "text": "your_kb_id"
      }
    ],
    "isDowngrade": false
  },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}

Authorizations

string

header

required

DashScope API Key，在控制台 API Key 页面（https://rag.console.aliyun.com/settings/apikey）获取。

Body

application/json

string

required

知识库 ID。

string

required

检索查询文本。

Required range:length >= 1

integer

default5

重排序后返回的最大结果数。

Required range:1 <= x <= 200

number

重排序最低分数阈值，低于此分数的结果将被过滤。取值范围 0.01-1.0。

Required range:0.01 <= x <= 1

integer

default5

向量检索返回的候选结果数量。

Required range:1 <= x <= 100

Response

200-application/json

string

响应码，成功时为 Success。

integer

HTTP 状态码。

string

请求唯一标识，排查问题时请提供此 ID。

object

Show child attributes

object[]

检索结果列表，按相关性分数降序排列。

Show child attributes

number

相关性分数。

string

匹配的文档片段文本。

object

文档元数据。

Show child attributes

string

文档唯一标识。

string

文档名称。

string

知识库 ID。

string

文档片段内容。

string

文档标题。

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/index/retrieve" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "index_id": "your_index_id",
    "query": "如何使用百炼平台？",
    "rerank_top_n": 5
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "total": 1,
    "nodes": [
      {
        "score": 0.48142415285110474,
        "metadata": {
          "title": "",
          "doc_id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
          "doc_name": "a",
          "doc_url": "https://oss-example.aliyuncs.com/...",
          "content": "your_kb_id",
          "page_number": [
            0
          ],
          "image_url": []
        },
        "text": "your_kb_id"
      }
    ],
    "isDowngrade": false
  },
  "success": true,
  "message": "success",
  "request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "SUCCESS"
}