检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
概述 欢迎使用Koosearch服务。Koosearch服务为您提供托管的分布式搜索引擎服务+大模型生成能力。本文档提供了Koosearch服务API的描述、语法、参数说明及样例等内容。 父主题： 使用前必读
知识库管理 创建知识库 修改知识库配置 设置知识库搜索问答prompt 设置知识库通用无搜索的prompt 开启知识库 关闭知识库 获取知识库列表 查看知识库列表 删除知识库
批量删除FAQ 功能介绍 选择多个需要删除的FAQ，根据ID批量删除。 URI DELETE /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。
查询对话历史列表 功能介绍 查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。 URI GET /v1/koosearch/chat-history 表1 Query参数 参数 是否必选 参数类型 描述 user_name 否 String 用户名 最小长度：1 最大长度：64
用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
获取对话历史 功能介绍 根据chat_id获取对话历史，返回历史的question和answer数据。 URI GET /v1/koosearch/chat-history/{chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id
终端节点 终端节点（Endpoint）即调用API的请求地址，KooSearch局点在贵阳一，终端节点见表1。 表1 KooSearch终端节点 区域名称 区域 终端节点（Endpoint） 协议类型 西南-贵阳一 cn-southwest-2 css.cn-southwest-2
创建模型服务，对接MaaS的模型服务。 在KooSearch左侧导航栏选择“模型管理”，进入“模型管理”页面。 单击页面的“新建模型服务”，弹出新建模型服务页面。 图1 新建模型服务 在新建模型服务页面。根据下表填写对应参数后，单击“确定”按钮。 表4 新建模型服务 参数 说明
查询FAQ列表 功能介绍 获取FAQ列表，包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。 URI GET /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是
步”。 搜索模型设置 选择Embedding模型服务、精排模型服务、搜索规划模型服务。 Embedding模型服务：基于盘古大模型技术的文本表示模型，将文本转化为用数值表示的向量形式，用于文本检索、聚类、推荐等场景。 精排模型服务：基于盘古大模型技术的文本表示模型，将文本转化为用
创建的知识库默认是开启知识库的，如果问答和搜索时不需要使用该知识库时，可关闭知识库状态。 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSearch>Flexus企业搜索服务”，进入Flexus企业搜索服务页面。 选择文档问答服务，单击操作列的“问答”，前往KooSearch控制台。 左侧导航栏选择“知识库管理”，进入“知识库管理”页面。
上传图片 功能介绍 上传图片入库。 URI POST /v1/koosearch/image/{img_id} 表1 路径参数 参数 是否必选 参数类型 描述 img_id 是 String 图片ID，格式为img-[0-9a-z]{32} 最小长度：1 最大长度：64 请求参数
设置知识库搜索问答prompt 功能介绍 设置知识库搜索问答prompt，该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景，配置不同的prompt，例如增加人设、限定条件、答案格式要求等，帮助模型生成更优的结果。 URI POST /v1
下载上传失败的FAQ 功能介绍 下载给定上传的批量FAQ文件中，上传失败的条目。 URI GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
删除对话历史 功能介绍 根据指定ID，删除对应的对话历史。 URI DELETE /v1/koosearch/chat-history/{chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id 是 String 对话历史ID
删除模型 功能介绍 删除模型 URI DELETE /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度：1 最大长度：64 请求参数 表2 请求Header参数
公共参数 状态码 错误码
修改知识库配置 功能介绍 修改知识库配置。 包括： 解析设置：是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页 文档拆分设置：自动分段、长度分段（按文本长度分段）、层级分段（按小标题分段，可自定义小标题解析规则） 搜索模型设置：rerank模型配置 NLP模型设置：生成模型选择
生成答案 功能介绍 将content输入给模型，使用模型能力生成答案。 注意： 当"chat_id"为空时，"chat_create_flag"应为"1"，表示需要开启新的对话；当"chat_id"有值时，"chat_create_flag"可以为"0"，表示不需要开启新的对话。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
