Web检索能力
功能介绍
Web检索。
URI
POST /v1/{project_id}/applications/{application_id}/uni-search/web/search
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repo_id |
是 |
String |
参数解释: 知识库ID。 约束限制: 不涉及 取值范围: 长度在1到64之间,只能包含字母、数字、下划线和短横线。 默认取值: 不涉及 |
chat_id |
否 |
String |
参数解释: 对话ID。 约束限制: 不涉及 取值范围: 长度在1到64之间,只能包含字母、数字、下划线和短横线。 默认取值: 不涉及 |
query |
是 |
String |
参数解释: 用户问题。 约束限制: 不涉及 取值范围: 非空,最大长度为20480 默认取值: 不涉及 |
history |
否 |
Array of strings |
参数解释: 对话历史。 实现逻辑: 1.只参考最近5轮对话 2.单轮对话只参考300~500字。 约束限制:
取值范围: 列表长度限制40。 默认取值: 不涉及 |
engine |
否 |
String |
参数解释: web搜索引擎。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
mode |
否 |
String |
参数解释: AI搜索模式: simple: 简洁模式,只经过一轮搜索问答,可预期首token时延2秒。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
stream |
否 |
Boolean |
参数解释: 流式输出开关。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
model_options |
否 |
Map<String,Object> |
参数解释: 生成模型参数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
max_documents |
否 |
Integer |
参数解释: 检索的最大网页数量,便于生成模型控制上下文。 约束限制: 不涉及 取值范围: 1-20 默认取值: 5 |
max_chunk_size |
否 |
Integer |
参数解释: 网页分片大小限制。对于长篇的网页,内部完成分片优选 约束限制: 不涉及 取值范围: 200-2000 默认取值: 500 |
prompt_template |
否 |
String |
参数解释: Prompt模板,提供 query、docs 上下文。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
extra_repo_ids |
否 |
Array of strings |
参数解释: 共同搜索知识库ID。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
file_ids |
否 |
Array of strings |
参数解释: 基于文件问答。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
thinking_enabled |
否 |
Boolean |
参数解释: 深度思考。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
search_enabled |
否 |
Boolean |
参数解释: 联网搜索。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
query |
String |
参数解释: 用户问题。 不涉及 取值范围: 不涉及 |
documents |
Array of Document objects |
参数解释: Web检索网页结果。 不涉及 取值范围: 不涉及 |
time_travel |
TimeTravel object |
参数解释: 调试信息。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
title |
String |
参数解释: 标题,使用此名称和 url 来创建一个超链接,单击该超链接会将用户带到该网页。 取值范围: 不涉及 |
content |
String |
参数解释: 内容。 取值范围: 不涉及 |
url |
String |
参数解释: 超链接。 取值范围: 不涉及 |
score |
Float |
参数解释: 相关度。 取值范围: 不涉及 |
timestamp |
String |
参数解释: 更新时间(上次抓取网页的时间),日期的格式为 YYYY-MM-DDTHH:MM:SS。 取值范围: 不涉及 |
category |
String |
参数解释: 目录,单值。 取值范围: 不涉及 |
tags |
Array of strings |
参数解释: 标签列表。 取值范围: 不涉及 |
query |
String |
参数解释: 搜索query。 取值范围: 不涉及 |
type |
String |
参数解释: 搜索类型。 取值范围: 不涉及 |
id |
String |
参数解释: 标识。 取值范围: 不涉及 |
file_id |
String |
参数解释: 文件标识。 取值范围: 不涉及 |
size |
Long |
参数解释: 大小。 取值范围: 不涉及 |
has_html |
Boolean |
参数解释: 标记是否为html。 取值范围: 不涉及 |
rank |
String |
参数解释: doc在websearch召回时的排序。 取值范围: 不涉及 |
source |
String |
参数解释: 来源。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
steps |
Array of StepExecution objects |
参数解释: 每步详情。 取值范围: 不涉及 |
elapsed_ms |
Long |
参数解释: 经过时间, 默认0。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
step_name |
String |
参数解释: 步骤名称。 取值范围: 不涉及 |
summary |
String |
参数解释: 简洁明了的步骤总结,用于过程回放,支持问题分析和定位。 取值范围: 不涉及 |
self_time_ms |
Long |
参数解释: 本步骤消耗时间。 取值范围: 不涉及 |
total_time_ms |
Long |
参数解释: 截止当前步骤完成时的总耗时。 取值范围: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
搜索响应。 |
400 |
客户端错误。 |
500 |
服务端异常。 |
错误码
请参见错误码。