知识检索 - 阿里云百炼

前提条件

已获取与配置 API Key并配置API Key到环境变量。
已创建知识库并获取知识库 ID。可通过以下方式创建知识库：
- 控制台创建：在百炼控制台的知识库页面创建知识库。详细步骤请参考创建和使用知识库。
- API 创建：通过阿里云百炼 SDK 调用 API 创建知识库。详细步骤请参考知识库API指南。
  通过 API 创建知识库前，需要先在百炼控制台获取业务空间 ID（workspace_id）。仅支持两类知识库：文档搜索和数据查询；适用于基础文档问答，不支持图文并茂回复。
知识库 ID 可在百炼控制台的知识库详情页中查看。

使用方式

知识检索功能通过 Responses API 调用。在 tools 参数中添加 file_search 工具，并通过 vector_store_ids 参数指定要检索的知识库 ID。

使用前需先创建和使用知识库并获取知识库 ID。当前 vector_store_ids 仅支持传入一个知识库 ID。

# 此处省略依赖导入与创建客户端步骤，完整可运行代码请参见下文「快速开始」
response = client.responses.create(
    model="qwen3.8-max",
    input="介绍一下阿里云百炼X1手机",
    tools=[
        {
            "type": "file_search",
            # 替换为您的知识库 ID，当前仅支持一个
            "vector_store_ids": ["your_knowledge_base_id"]
        }
    ]
)

print(response.output_text)

支持的模型

千问Max：Qwen3.8-Max系列、Qwen3.7-Max系列
千问Plus：Qwen3.7-Plus系列、Qwen3.6-Plus系列、Qwen3.5-Plus系列
千问Flash：Qwen3.8-Flash系列、Qwen3.7-Flash系列、Qwen3.6-Flash系列、Qwen3.5-Flash系列
Qwen3.8开源系列
Qwen3.6开源系列（qwen3.6-27b除外）
Qwen3.5开源系列

仅支持通过 Responses API 调用。

快速开始

运行以下代码，通过 Responses API 调用知识检索工具，在指定的知识库中检索相关内容并生成回答。

请将示例代码中的 vector_store_ids 替换为您实际的知识库 ID。

请确保传入有效的知识库 ID。如果传入空数组或无效的知识库 ID，知识检索工具将不会生效，模型会直接使用自身知识回答，且不会返回错误提示。

import os
from openai import OpenAI

client = OpenAI(
    # 若没有配置环境变量，请用百炼API Key将下行替换为：api_key="sk-xxx"（不建议）,
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # 以下为华北2（北京）地域的URL，调用时请将 {WorkspaceId} 替换为真实的业务空间ID，各地域的URL不同。
    base_url="https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1"
)

response = client.responses.create(
    model="qwen3.8-max",
    input="介绍一下阿里云百炼X1手机",
    tools=[
        {
            "type": "file_search",
            # 替换为您的知识库 ID，当前仅支持一个
            "vector_store_ids": ["your_knowledge_base_id"]
        }
    ]
)

print("[模型回复]")
print(response.output_text)
print(f"\n[Token 用量] 输入: {response.usage.input_tokens}, 输出: {response.usage.output_tokens}, 合计: {response.usage.total_tokens}")

运行以上代码可获取如下回复：

[模型回复]
根据知识库中的内容，该产品要点包括以下几个方面：

1. **核心功能**：产品提供了...
2. **适用场景**：适用于...
3. **技术特性**：基于...

...

[Token 用量] 输入: 1568, 输出: 1724, 合计: 3292

流式输出

知识检索工具需要在知识库中进行语义搜索，可能需要一定的处理时间，建议启用流式输出，实时获取中间过程输出结果。

import os
from openai import OpenAI

client = OpenAI(
    # 若没有配置环境变量，请用百炼API Key将下行替换为：api_key="sk-xxx",
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # 以下为华北2（北京）地域的URL，调用时请将 {WorkspaceId} 替换为真实的业务空间ID，各地域的URL不同。
    base_url="https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1"
)

stream = client.responses.create(
    model="qwen3.8-max",
    input="介绍一下阿里云百炼X1手机",
    tools=[
        {
            "type": "file_search",
            # 替换为您的知识库 ID，当前仅支持一个
            "vector_store_ids": ["your_knowledge_base_id"]
        }
    ],
    stream=True
)

for event in stream:
    # 模型回复开始
    if event.type == "response.content_part.added":
        print("[模型回复]")
    # 流式打印模型回复
    elif event.type == "response.output_text.delta":
        print(event.delta, end="", flush=True)
    # 响应完成，打印 Token 用量
    elif event.type == "response.completed":
        usage = event.response.usage
        print(f"\n\n[Token 用量] 输入: {usage.input_tokens}, 输出: {usage.output_tokens}, 合计: {usage.total_tokens}")

参数说明

file_search 工具支持以下参数：

参数	必填	说明
`type`	是	固定为 `"file_search"`。
`vector_store_ids`	是	知识库 ID 列表。当前仅支持传入一个知识库 ID。知识库 ID 可在百炼控制台的知识库详情页查看，也可通过 API 创建知识库时获取。请确保传入有效的知识库 ID。如果传入空数组或无效的知识库 ID，知识检索工具将不会生效，模型会直接使用自身知识回答，且不会返回错误提示。

计费说明

计费涉及以下方面：

模型调用费用：知识库检索到的内容会拼接到提示词中，增加模型的输入 Token，按照模型的标准价格计费。价格详情请参考百炼控制台。
工具调用费用：参见知识库计费说明。

​前提条件

​使用方式

​支持的模型

​快速开始

​流式输出

​参数说明

​计费说明

前提条件

使用方式

支持的模型

快速开始

流式输出

参数说明

计费说明