知识检索与问答

知识检索

跨多个知识库执行联合语义检索

POST

/api/v1/indices/knowledge/search

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/knowledge/search" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "什么是RAG？",
    "agent_id": "aid-xxx",
    "agent_version": "beta"
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "total": 3,
    "cost_time": 710,
    "nodes": [
      {
        "score": 0.85,
        "text": "【正文】: RAG（检索增强生成）是一种...",
        "metadata": {
          "content": "RAG（检索增强生成）是一种...",
          "title": "RAG 概述",
          "doc_id": "file_xxx",
          "doc_name": "产品文档.pdf",
          "pipeline_id": "your_kb_id",
          "_citation_index": 1,
          "_knowledge_type": "document"
        }
      }
    ]
  },
  "request_id": "f91d0071-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

检索范围和策略（多库权重、路由、混排等）由 agent_id 对应的知识检索服务配置驱动，调用方仅需传入 query 和 agent_id。

Authorizations

string

header

required

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

Body

application/json

string

required

检索查询文本。

Required range:length >= 1

string

required

检索服务 ID，在控制台知识检索页面获取。

string

服务版本，如 "beta" 或 "prod"。

object[]

多轮对话历史，用于上下文理解和 query 改写。

Show child attributes

enum<string>

消息角色：user 或 assistant。

Available options:user,assistant

string

消息内容。

string[]

图片 URL 列表，用于多模态检索场景。

Response

200-application/json

string

响应码，成功时为 Success。

integer

HTTP 状态码。

string

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

object

Show child attributes

integer

命中的文档片段总数。

integer

检索耗时（毫秒）。

object[]

检索结果列表。

Show child attributes

number

相关度得分。

string

文档片段文本。

object

片段元数据。

Show child attributes

string

片段正文内容。

string

文档标题。

string

文档 ID。

string

文档文件名。

string

文档 URL。

string

知识库 ID。

string

工作空间 ID。

integer

页码（PDF 等分页文档）。

string

图片 URL（多模态场景）。

string

知识类型，如 document。

integer

引用索引号。

number

原始评分。

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/knowledge/search" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "什么是RAG？",
    "agent_id": "aid-xxx",
    "agent_version": "beta"
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "total": 3,
    "cost_time": 710,
    "nodes": [
      {
        "score": 0.85,
        "text": "【正文】: RAG（检索增强生成）是一种...",
        "metadata": {
          "content": "RAG（检索增强生成）是一种...",
          "title": "RAG 概述",
          "doc_id": "file_xxx",
          "doc_name": "产品文档.pdf",
          "pipeline_id": "your_kb_id",
          "_citation_index": 1,
          "_knowledge_type": "document"
        }
      }
    ]
  },
  "request_id": "f91d0071-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}