AI搜索开放平台提供联网搜索功能,支持直接调用联网搜索API或使用deepseek-r1模型时启用联网搜索。
服务列表
服务名称 | 服务ID | 服务描述 |
服务名称 | 服务ID | 服务描述 |
联网搜索服务 | ops-web-search-001 | 提供通用的联网搜索服务,可配合大模型拓展私有知识库场景的回答。 |
获取身份鉴权信息
通过API调用AI搜索开放平台服务时,需要对调用者身份进行鉴权,如何获取鉴权信息请参见获取API-KEY。
获取服务调用地址
支持通过公网和VPC两种方式调用服务,详情请参见获取服务接入地址。
请求方式
POST
URL
{host}/v3/openapi/workspaces/{workspace_name}/web-search/{service_id}
host:调用服务的地址,支持通过公网和VPC两种方式调用API服务,可参见获取服务接入地址。
workspace_name:工作空间名称,例如default。
service_id: 系统内置服务ID,例如ops-web-search-001。
请求参数
Header参数
API-KEY认证
参数 | 类型 | 必填 | 描述 | 示例值 |
参数 | 类型 | 必填 | 描述 | 示例值 |
Content-Type | String | 是 | 请求类型:application/json | application/json |
Authorization | String | 是 | API-Key | Bearer OS-d1**2a |
Body参数
参数 | 类型 | 必填 | 描述 | 示例值 |
参数 | 类型 | 必填 | 描述 | 示例值 |
query | String | 是 | 搜索词。 | 杭州今日天气 |
way | String | 否 | AI搜索开放平台使用大模型对Query进行改写后再进行联网搜索,您可以通过参数选择搜索模式:
| normal |
top_k | Integer | 否 | 搜索返回结果数。 | 5 |
Curl请求示例
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 您的API-KEY" \
"http://xxxx-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/web-search/ops-web-search-001" \
-d '{
"query":"杭州今日天气",
"way":"normal",
"top_k":5
}'
返回参数
参数 | 类型 | 描述 | 示例值 |
参数 | 类型 | 描述 | 示例值 |
result.search_result | List<search_result> | 本次联网搜索返回的结果。 | |
result.search_result[].tilte | String | 网页标题。 | 杭州天气 |
result.search_result[].link | String | 网页链接。 | https://www.xxx.com |
result.search_result[].snippet | String | 网页摘要。 | 今天夜里多云;明天晴到多云;后天多云到阴 |
result.search_result[].content | String | 网页内容。 | 杭州天气\n今天夜里多云;明天晴到多云; |
result.search_result[].position | Integer | 网页在召回结果中的位置。 | 3 |
usage.search_count | Integer | 联网搜索次数。 | 1 |
usage.rewrite_model.input_tokens | Integer | 对Query进行重写的输入tokens。 | 100 |
usage.rewrite_model.output_tokens | Integer | 对Query进行重写后的输出tokens。 | 100 |
usage.rewrite_model.total_tokens | Integer | 对Query进行重写后的总Token数。 | 200 |
usage.filter_model.input_tokens | Integer | 对搜索结果进行大模型过滤的输入tokens。 | 100 |
usage.filter_model.output_tokens | Integer | 对搜索结果进行大模型过滤后的输出tokens。 | 100 |
usage.filter_model.total_tokens | Integer | 对搜索结果进行大模型过滤的总Token数。 | 200 |
响应示例
正常响应示例
{
"result":{
"search_result": [
{
"title": "杭州天气",
"link": "https://www.hzqx.com/pc/hztq/",
"snippet": "今天夜里多云;明天晴到多云;后天多云到阴。 今天夜里偏北风2-3级,明天偏东风2级。 明天白天最高气温10度,明天早晨最低气温3度,明天平均相对湿度65%。",
"position": 3,
"content": "杭州天气\n今天夜里多云;明天晴到多云;后天多云到阴。 今天夜里偏北风2-3级,明天偏东风2级。 明天白天最高气温10度,明天早晨最低气温3度,明天平均相对湿度65%。"
},
{
"title": "杭州市天气预报_天气查询- 墨迹天气",
"link": "https://tianqi.moji.com/weather/china/zhejiang/hangzhou",
"snippet": "杭州市今天实况:3度晴,湿度:66%,西北风:3级。白天:10度,晴。 夜间:多云,3度,天凉了,墨迹天气建议您在羊毛衫外面套上厚外套,年老体弱者可以穿着呢大衣增加保暖系数。",
"position": 4,
"content": "杭州市天气预报_天气查询- 墨迹天气\n杭州市今天实况:3度晴,湿度:66%,西北风:3级。白天:10度,晴。 夜间:多云,3度,天凉了,墨迹天气建议您在羊毛衫外面套上厚外套,年老体弱者可以穿着呢大衣增加保暖系数。"
}
]
},
"usage": {
"search_count": 1,
"rewrite_model.input_tokens": 249,
"rewrite_model.output_tokens": 1,
"rewrite_model.total_tokens": 250,
"filter_model.input_tokens": 1804,
"filter_model.output_tokens": 216,
"filter_model.total_tokens": 2020
}
}
异常响应示例
在访问请求出错的情况下,输出的结果中会通过code和message指明出错原因。
{
"request_id": "6F33AFB6-A35C-****-AFD2-9EA16CCF4383",
"latency": 2.0,
"code": "InvalidParameter",
"http_code": 400,
"message": "JSON parse error: Cannot deserialize value of type `ImageStorage` from String \\"xxx\\"
}
状态码说明
HTTP 状态码 | 错误码 | 描述 |
HTTP 状态码 | 错误码 | 描述 |
200 | - | 请求成功,包括任务失败场景,实际任务状态需从result.status中判断 |
404 | BadRequest.TaskNotExist | 任务不存在 |
400 | InvalidParameter | 不合法请求 |
500 | InternalServerError | 内部错误 |
详情请参见AI搜索开放平台状态码说明。
- 本页导读
- 服务列表
- 请求方式
- URL
- 请求参数
- Header参数
- Body参数
- Curl请求示例
- 返回参数
- 响应示例
- 状态码说明