千问联网检索Agent对外服务接口目录,所有接口使用 DashScope HTTP 协议对外提供服务。
API概览
API鉴权
调用接口需要先获取 API Key,邀测期间,仅百炼默认业务空间所属的API Key有调用权限。
API目录
API名称 | API概述 |
生成对话 | 千问联网检索Agent提供的 agent_id 与 agent_version 信息,提供联网知识检索、场景化对话等能力。 |
服务接入节点
亚太
地域名称 | 地域ID | 公网接入地址 | VPC接入地址 |
华北2(北京) | cn-beijing | https://dashscope.aliyuncs.com/api/v2/apps/ | 无 |
生成对话
基于千问联网检索Agent提供的 agent_id 与 agent_version 信息,提供联网知识检索、场景化对话等能力。
请求语法
POST /web-search-agent/chat/completions HTTP/1.1请求参数
参数名 | 类型 | 是否必须 | 说明 |
stream | bool | 是 | 必须填 true,当前版本仅支持流式响应。若提供false或不提供,请求将失败 |
input | object | 是 | 输入字段 |
input.request_id | str | 否 | 请求ID(业务自定义) |
input.messages | array[object] | 是 | 对话消息 |
input.messages.[].role | str | 是 | 角色,枚举值为:user、assistant |
input.messages.[].content | str | 是 | 消息内容 |
parameters | object | 是 | 配置参数字段 |
parameters.agent_options | object | 是 | 智能体专用参数 |
parameters.agent_options.agent_id | string | 是 | 应用ID |
parameters.agent_options.agent_version | string | 是 | 应用版本 |
parameters.agent_options.session_knowledge | string | 否 | session 会话级别知识 |
返回参数
参数名 | 类型 | 是否必须 | 说明 |
request_id | str | 是 | 请求ID(dashscope 平台) |
code | str | 是 | 状态码(成功:200) |
message | str | 是 | 状态信息 |
output | object | 是 | 输出字段 |
output.request_id | str | 否 | 请求ID(业务自定义) |
output.choices | array[object] | 是 | 模型输出信息 |
output.choices.[].finish_reason | str | 是 | 生成结束原因,仅尾包输出stop |
output.choices.[].message | object | 是 | 对话消息 |
output.choices.[].message.role | str | 是 | 角色,枚举值为:user、assistant、tool |
output.choices.[].message.content | str | array[object] | 是 | 生成内容/工具返回内容,当生成配置开启输出报告时,报告消息体类型为array[object] |
output.choices.[].message.reasoning_content | str | 否 | 思考内容,如果 content内没有内容,则尝试获取最后一轮深度思考中的reasoning_content内容 |
output.choices.[].message.tool_calls | array[object] | 否 | 工具调用信息 |
output.choices.[].message.tool_calls[0].arguments | dcit[str,object] | 否 | 工具调用参数 |
output.choices.[].message.tool_calls[0].name | str | 否 | 工具调用名称 |
output.choices.[].message.additional_kwargs.extra_json | Any | 否 | 工具调用返回时,携带结构化输出信息 |
output.choices.[].message.extra | dict | 否 | 步骤状态信息 |
output.choices.[].message.extra.group | str | 否 | 执行阶段 |
output.choices.[].message.extra.step_change | str | 否 | 步骤变化事件 |
output.choices.[].message.extra.step | str | 否 | 当前步骤 |
output.choices.[].message.response_metadata | dict | 否 | 请求模型调用详细信息 |
output.usage | object | 否 | 用量统计 |
output.usage.input_tokens | int | 否 | 输入 tokens |
output.usage.output_tokens | int | 否 | 输出 tokens |
output.usage.total_tokens | int | 否 | 总 tokens |
示例
请求示例
{
"input": {
"messages": [
{
"role": "user",
"content": "现在日期"
}
]
},
"stream": true,
"parameters": {
"agent_options": {
"agent_id": "aid-xxx",
"agent_version": "beta"
}
}
}返回示例
data: {
"status_code": 200,
"code": "",
"message": "",
"output": {
"choices": [
{
"finish_reason": "",
"message": {
"content": "xxx",
"additional_kwargs": {},
"response_metadata": {
"headers": {
"vary": "Origin",
"x-request-id": "ca7a41ad-3994-9dcf-adf6-f7aa56bec62b",
"content-type": "text/event-stream;charset=UTF-8",
"x-dashscope-call-gateway": "true",
"req-cost-time": "508",
"req-arrive-time": "1773800485527",
"resp-start-time": "1773800486035",
"x-envoy-upstream-service-time": "506",
"date": "Wed, 18 Mar 2026 02:21:25 GMT",
"server": "istio-envoy",
"transfer-encoding": "chunked"
}
},
"type": "ai",
"name": null,
"id": "run--019cfebf-7194-78b3-ad12-c3df6b6423b1",
"example": false,
"tool_calls": [],
"invalid_tool_calls": [],
"usage_metadata": null,
"tool_call_chunks": [],
"reasoning_content": "",
"role": "assistant",
"extra": {
"group": "generating",
"step_change": "generation_start",
"step": "generating"
}
}
}
]
},
"usage": null,
"request_id": "xxxx-xxxx"
}调用示例
# coding=utf-8
import os
import json
import requests
chat_completions_url = 'https://dashscope.aliyuncs.com/api/v2/apps/web-search-agent/chat/completions'
headers = {
'Authorization': f'Bearer {os.getenv("DASHSCOPE_API_KEY", "")}', # 配置 API KEY
'Content-Type': 'application/json'
}
if __name__ == "__main__":
params = {
"input": {
"messages": [{"role": "user", "content": "目前国内主流多模态模型分别有哪些,根据性能和效果做下分析"}] # 传入请求消息
},
"parameters": {
"agent_options": { # 设置 agent 选项
"agent_id": "${agent_id}", # 应用ID,可在应用管理页面获取到,例如:aid-8fd***e00
"agent_version": "${agent_version}" # 应用版本,beta 测试版本 / release 发布版本
}
},
"stream": True
}
response = requests.post(chat_completions_url, headers=headers, json=params, stream=True)
resultlist = []
stage = ''
action = ''
content = ''
reasoning_content = ''
for chunk in response.iter_lines():
if chunk:
chunk_str = chunk.decode('utf-8').strip()
if chunk_str.startswith('data:'):
json_str = chunk_str[len('data:'):].strip()
try:
obj = json.loads(json_str)
# 检查异常
if obj.get('code') != '200':
print("服务异常:", obj)
# 获取消息体
msg = obj.get('output', {}).get('choices', [{}])[0].get('message', {})
extra_flags = msg.get('extra', {}) # 获取模型状态标记字段
if stage != extra_flags.get('group', ''): # 获取 模型当前阶段
print(f"agent stage: {extra_flags.get('group', '')}")
stage = extra_flags.get('group', '')
if action != extra_flags.get('step', '') and extra_flags.get('step', ''): # 获取 模型当前阶段
print(f"agent action: {extra_flags.get('step', '')}")
action = extra_flags.get('step', '')
role = msg.get('role', '') # 获取模型角色 assistant or role
content = msg.get('content') # 获取生成内容
toolcalls = msg.get('tool_calls', []) # 获取工具调用
if toolcalls:
print(f'{toolcalls}')
if role == "tool":
print("\\n" + content + "\\n", end='') # 前后都换行
else:
print(content, end='') # 流式输出
# 可按需保存
resultlist.append(obj)
except Exception as e:
print("异常解析:", e)import java.io.*;
import java.net.*;
import java.util.*;
import com.alibaba.fastjson.*;
import java.nio.charset.StandardCharsets;
public class WebSearchStreamDemo {
// 配置 API KEY
public final static String CHAT_COMPLETIONS_URL = "https://dashscope.aliyuncs.com/api/v2/apps/web-search-agent/chat/completions";
public final static String API_KEY = System.getenv("DASHSCOPE_API_KEY");
public static void main(String[] args) throws Exception {
// 构造参数
Map<String, Object> params = new HashMap<>();
// input.messages
List<Map<String, Object>> messages = new ArrayList<>();
Map<String, Object> msgObj = new HashMap<>();
msgObj.put("role", "user");
msgObj.put("content", "${prompt}");
messages.add(msgObj);
// input
Map<String, Object> input = new HashMap<>();
input.put("messages", messages);
// parameters.agent_options
Map<String, Object> agentOptions = new HashMap<>(); //
agentOptions.put("agent_id", "${agent_id}");// 应用ID,可在应用管理页面获取到,例如:aid-8fd***e00
agentOptions.put("agent_version", "${agent_version}"); // 应用版本,beta 测试版本 / release 发布版本
// parameters
Map<String, Object> parameters = new HashMap<>();
parameters.put("agent_options", agentOptions);
params.put("input", input);
params.put("parameters", parameters);
params.put("stream", true);
String body = JSON.toJSONString(params);
// HTTP 请求
URL apiUrl = new URL(CHAT_COMPLETIONS_URL);
HttpURLConnection conn = (HttpURLConnection) apiUrl.openConnection();
conn.setRequestMethod("POST");
conn.setDoOutput(true);
conn.setRequestProperty("Authorization", "Bearer " + API_KEY);
conn.setRequestProperty("Content-Type", "application/json");
// 发送 body
try (OutputStream os = conn.getOutputStream()) {
os.write(body.getBytes(StandardCharsets.UTF_8));
}
// 处理流式响应
InputStream inputStream = conn.getInputStream();
BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8));
String line;
String stage = "";
String action = "";
List<JSONObject> resultList = new ArrayList<>();
while ((line = reader.readLine()) != null) {
if (!line.trim().isEmpty()) {
String chunkStr = line.trim();
if (chunkStr.startsWith("data:")) {
String jsonStr = chunkStr.substring(5).trim();
try {
JSONObject obj = JSON.parseObject(jsonStr);
// 检查异常
if (!"200".equals(obj.getString("code"))) {
System.out.print("服务异常: " + obj);
}
// 获取 output->choices[0]->message
JSONObject msg = null;
if (obj.containsKey("output")) {
JSONObject output = obj.getJSONObject("output");
if (output != null && output.containsKey("choices")) {
JSONArray choices = output.getJSONArray("choices");
if (choices != null && !choices.isEmpty()) {
JSONObject firstChoice = choices.getJSONObject(0);
if (firstChoice.containsKey("message")) {
msg = firstChoice.getJSONObject("message");
}
}
}
}
if (msg == null) {
continue;
}
// 获取 extra_flags 字段
JSONObject extraFlags = msg.containsKey("extra") && msg.get("extra") != null
? msg.getJSONObject("extra") : new JSONObject();
// agent stage
String stageNew = extraFlags.containsKey("group") && extraFlags.get("group") != null
? extraFlags.getString("group") : "";
if (!stage.equals(stageNew)) {
System.out.println("agent stage: " + stageNew);
}
stage = stageNew;
// agent action
String actionNew = extraFlags.containsKey("step") && extraFlags.get("step") != null
? extraFlags.getString("step") : "";
if (!action.equals(actionNew) && !actionNew.isEmpty()) {
System.out.println("agent action: " + actionNew);
}
action = actionNew;
String role = msg.containsKey("role") && msg.get("role") != null
? msg.getString("role") : "";
Object contentObj = msg.get("content");
String content = null;
boolean isContentString = false;
// content 是字符串类型
if (contentObj instanceof String) {
content = contentObj.toString();
isContentString = true;
}
// 字符串为空时补 reasoning_content
if (isContentString && content.isEmpty()) {
Object reasoningContentObj = msg.get("reasoning_content");
if (reasoningContentObj instanceof String) {
content = reasoningContentObj.toString();
}
}
// 工具调用
if (msg.containsKey("tool_calls") && msg.get("tool_calls") instanceof List) {
JSONArray toolCalls = msg.getJSONArray("tool_calls");
if (!toolCalls.isEmpty()) {
System.out.println(toolCalls);
}
}
if ("tool".equals(role)) {
System.out.print("\\n" + content + "\\n");
} else {
System.out.print(content);
}
// 可按需保存
resultList.add(obj);
} catch (Exception e) {
System.out.println("异常解析: " + e);
}
}
}
}
reader.close();
}
}