检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
概述 欢迎使用Koosearch服务。Koosearch服务为您提供托管的分布式搜索引擎服务+大模型生成能力。本文档提供了Koosearch服务API的描述、语法、参数说明及样例等内容。 父主题： 使用前必读
Token的有效期为24小时，需要使用同一个Token鉴权时，可以缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 T
缓存生成模型服务：选择一个模型服务。 缓存阈值：达到缓存阈值，就会使用缓存输入值必须在0.1到1之间。 缓存策略：达到缓存阈值，如果有多个答案，可以设置最高分或者随机。 过期策略配置：缓存过期的方式，有3中选择。 Least Recently Used：根据当前时间与最后一次访问时间的差值超过存活时间时删除。
利用LLM技术的Query分类、多轮改写、复杂查询分解。 图文并茂&内容溯源 支持输出参考链接，和上下文语义相关的图片。 内容优选 通过query和片段的语义关系，精简出和query相关的web片段，达到减少下游大模型推理成本，以及提升大模型的推理效果。 缓存 利用缓存技术，预先存
下载失败的条目 功能介绍 下载一个JSON文件，该文件包含给定上传Field的失败条目。 URI GET /v1/koosearch/repos/{repo_id}/structured-data/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id
是否扩展长上下文。提供更广泛的上下文，以生成完整回答。 缺省值：false effective_input_length Integer 效果最好的上下文长度，与模型相关，确保输入令牌的有效长度以保证最佳输出 考虑到多轮对话，建议控制在模型上下文长度的60%（向上取整）。 最小值：2
是否扩展长上下文。提供更广泛的上下文，以生成完整回答。 缺省值：false effective_input_length 否 Integer 效果最好的上下文长度，与模型相关，确保输入令牌的有效长度以保证最佳输出 考虑到多轮对话，建议控制在模型上下文长度的60%（向上取整）。 最小值：2
搜索精排模型：对搜索的召回结果进行重排序，提升向量检索的效果。 搜索规划模型：提供多轮改写及意图识别功能。 缓存生成模型：提供query之间相似度的计算，用于知识库的缓存功能。 访问地址 模型的内网访问地址及端口。 模型描述 模型详细信息的描述。 昇腾云模型名称 来源于昇腾云服务开通的NLP大模型的模型名称。
是否扩展长上下文。提供更广泛的上下文，以生成完整回答。 缺省值：false effective_input_length 否 Integer 效果最好的上下文长度，与模型相关，确保输入令牌的有效长度以保证最佳输出 考虑到多轮对话，建议控制在模型上下文长度的60%（向上取整）。 最小值：2
下载上传失败的FAQ 功能介绍 下载给定上传的批量FAQ文件中，上传失败的条目。 URI GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
是否扩展长上下文。提供更广泛的上下文，以生成完整回答。 缺省值：false effective_input_length Integer 效果最好的上下文长度，与模型相关，确保输入令牌的有效长度以保证最佳输出 考虑到多轮对话，建议控制在模型上下文长度的60%（向上取整）。 最小值：2
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token
创建用户解析规则 功能介绍 用于创建用户自定义的解析规则，解析规则用于解析需要作为subtitle的文本，规则由上而下依次校验。 URI POST /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
修改用户解析规则 功能介绍 用于修改已配置的解析规则。 URI PUT /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户解析规则ID 最小长度：1 最大长度：64 请求参数 表2 请求Header参数
X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token 最小长度：1 最大长度：1000000 响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 需要删除的规则ID 最小长度：1 最大长度：64
列举用户规则列表 功能介绍 列举用户配置的所有解析规则列表。 URI GET /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token
"你是一名问题回答助手，请参考以下给出的文章回答问题。在回答问题之前，请你先仔细判给出的文章是否可以回答问题。如果给出的文章与问题不相关，则直接输出“抱歉，我无法回答此次问题“；如果给出的文章与问题相关，则参考给出的文章回答问题。\n给出的文章：\n{0}\n问题：{1}\n请你
在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token
在API凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
