搜索增强
功能介绍
搜索增强。
URI
POST /v1/koosearch/search
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
query |
是 |
String |
参数解释: 用户问题。 约束限制: 不涉及 取值范围: 最大长度为1024。 默认取值: 不涉及 |
knowledge_threshold |
否 |
Float |
参数解释: unidata知识库阈值。 约束限制: 不涉及 取值范围: 0-1 默认取值: 0.98 |
faq_threshold |
否 |
Float |
参数解释: unidata faq库阈值。 约束限制: 不涉及 取值范围: 0-1 默认取值: 0.9 |
repo_id |
否 |
String |
参数解释: koosearch知识库ID。 约束限制: 不涉及 取值范围: 长度在1到64之间,只能包含字母、数字、下划线和短横线。 默认取值: 不涉及 |
plan |
否 |
SearchPlanningRsp object |
参数解释: 搜索规划的响应。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
debug |
否 |
Boolean |
参数解释: 是否调试模式。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
category |
否 |
String |
参数解释: Query分类,对于行业知识类,建议使用前缀匹配,后续可能继续扩展。 约束限制: 对于未考虑到行业知识类的细分类别,一般会分为"行业知识类" 取值范围:
默认取值: 不涉及 |
sub_queries |
否 |
Array of strings |
参数解释: 多轮改写和复杂问题分解之后的子查询问题,可能包含多个值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
language |
否 |
String |
参数解释: 查询语言,编码对应 ISO 639-1 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
timeliness |
否 |
Boolean |
参数解释: 时效性查询,比如今天天气怎么样 |
date_range |
否 |
String |
参数解释: 从query中抽取时间范围,有多个子query时,使用";"连接每个子query的抽取结果 如: query:2022年全网最高用电负荷最大时,外电入鲁电力是多少? date_range : 2022-01-01~2022-12-31 query: 华为一季度收入 date_range : 2024-01-01~2024-03-31 query: 今日时间 date_range: 2024-04-01 query: 2023年11月30日配套储能放电量是多少? date_range: 2023-11-30~2023-11-30 query: 两天前北京发生了什么大事 date_range: 2024-03-30~2024-03-30 query中涉及到的日期范围,当有多个子query时,用;拼接 如: query: 2023年第一季度山东和山西的GDP date_range: 2023-01-01~2023-03-31;2023-01-01~2023-03-31 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
calculation |
否 |
Boolean |
参数解释: 计算类查询,比如经济增长率 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
output_language |
否 |
String |
参数解释: query是否涉及“请用xx语言回答”这样的表述,即会输出对应语言编码。如zh、en、ar、fr、th。无结果输出"" 查询语言,编码对应 ISO 639-1 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
cost |
否 |
Float |
参数解释: 请求处理耗时,单位ms 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
term_weight |
否 |
Map<String,Number> |
参数解释: 词权重结果 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
query |
String |
参数解释: 用户原问题。 取值范围: 不涉及 |
documents |
Array of Document objects |
参数解释: 搜索结果。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
参数解释: 来源。 取值范围: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
搜索响应。 |
400 |
客户端错误。 |
500 |
服务端异常。 |
错误码
请参见错误码。