# Web检索 - ListSearchWeb #### 功能介绍 Web检索 #### URI POST /v1/{project_id}/applications/{application_id}/uni-search/web/search 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-koosearch/koosearch_06_0022.html)。 **约束限制：** 不涉及 **取值范围：** 1～64个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。 **默认取值：** 不涉及 | | application_id | 是 | String | **参数解释：** 应用ID，获取方法请参见[获取应用ID](https://support.huaweicloud.com/api-koosearch/koosearch_06_0021.html)。 **约束限制：** 字符串 **取值范围：** 1～64个字符，只能包含数字、字母、中划线和下划线，且必须以字母开头。 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Token | 否 | String | **参数解释：** 用户登录后，会根据用户登录信息创建token鉴权。 通过鉴权校验用户的合法性。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 接口鉴权使用的Token，Token获取方式参考：[获取IAM用户Token](https://support.huaweicloud.com/api-koosearch/koosearch_06_0009.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | repo_id | 否 | String | **参数解释：** 知识库ID。 **约束限制：** 不涉及 **取值范围：** 长度在1到64之间，只能包含字母、数字、下划线和短横线。 **默认取值：** 不涉及 | | chat_id | 否 | String | **参数解释：** 对话ID。 **约束限制：** 不涉及 **取值范围：** 长度在1到64之间，只能包含字母、数字、下划线和短横线。 **默认取值：** 不涉及 | | query | 是 | String | **参数解释：** 用户问题。 **约束限制：** 不涉及 **取值范围：** 非空，最大长度为20480 **默认取值：** 不涉及 | | history | 否 | Array of strings | **参数解释：** 对话历史。 实现逻辑： 1.参考最近10轮对话 2.单轮对话参考300\~500字。 **约束限制：** 1. 元素必须为偶数个，如 \[Question1, Answer1, Question2, Answer2\] 2. 按照对话顺序从旧到新 3. 问题 Question 必填 4. 答案 Answer 可以为空字符串，但必须占位 **取值范围：** 列表长度限制40。 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | query | String | **参数解释：** 用户问题。 不涉及 **取值范围：** 不涉及 | | document | Array of [Document] objects | **参数解释：** Web检索网页结果。 不涉及 **取值范围：** 不涉及 | 表5Document | 参数 | 参数类型 | 描述 | |:---|:---|:---| | title | String | **参数解释：** 标题，使用此名称和 url 来创建一个超链接，单击该超链接会将用户带到该网页。 **取值范围：** 不涉及 | | content | String | **参数解释：** 内容。 **取值范围：** 不涉及 | | url | String | **参数解释：** 超链接。 **取值范围：** 不涉及 | | timestamp | String | **参数解释：** 更新时间（上次抓取网页的时间），日期的格式为 YYYY-MM-DDTHH:MM:SS。 **取值范围：** 不涉及 | | site_name | String | **参数解释：** 站点名称 **取值范围：** 不涉及 | | site_icon | String | **参数解释：** 站点icon地址 **取值范围：** 不涉及 | | type | String | **参数解释：** 搜索类型。 **取值范围：** 不涉及 | | id | String | **参数解释：** 标识。 **取值范围：** 不涉及 | | size | Long | **参数解释：** 大小。 **取值范围：** 不涉及 | | has_html | Boolean | **参数解释：** 标记是否为html。 **取值范围：** - true: 是html结果 - false: 不是html结果 | | source | String | **参数解释：** 来源。 **取值范围：** 不涉及 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** [错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。 **取值范围：** 不涉及 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及 | **状态码：500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** [错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。 **取值范围：** 不涉及 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及 | #### 请求示例 无 #### 响应示例 无 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 搜索响应。 | | 400 | 客户端错误。 | | 500 | 服务端异常。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-koosearch/ErrorCode.html)。