检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
最大值:2 缺省值:0 use_system_prompt 否 Boolean 是否使用系统Prompt,与盘古RAG场景Prompt标准拼接方案保持一致 缺省值:false system_prompt 否 String 系统Prompt,注意: 1.当 use_system_prompt为true时必填
FAQ管理 创建FAQ 更新FAQ 获取FAQ 查询FAQ列表 删除FAQ 批量删除FAQ
开通Flexus企业搜索服务 仅“西南-贵阳一”区域支持开通和使用KooSearch服务。 在使用KooSearch服务之前,需要开通KooSearch服务,具体操作如下: 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSearch>Flexus企业搜索服务”,进入Flexus企业搜索服务页面。
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
结构化数据 上传结构化数据 下载失败的条目 搜索结构化数据文件
图片管理 上传图片 获取图片内容
创建FAQ 功能介绍 输入问题、相似问题、答案,创建单条FAQ。 URI POST /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
删除FAQ 功能介绍 根据知识库ID和FAQ的ID,删除FAQ。 URI DELETE /v1/koosearch/repos/{repo_id}/faqs/{faq_id} 表1 路径参数 参数 是否必选 参数类型 描述 faq_id 是 String FAQ编号 最小长度:1
获取FAQ 功能介绍 根据ID获取FAQ详情,包括问题、答案。 URI GET /v1/koosearch/repos/{repo_id}/faqs/{faq_id} 表1 路径参数 参数 是否必选 参数类型 描述 faq_id 是 String FAQ ID,1~64个字符,只
FAQ批量管理 批量FAQ上传 列举批量上传FAQ文件 下载上传失败的FAQ 下载批量导入FAQ原文件 删除批量导入FAQ文件
删除对话历史 功能介绍 根据指定ID,删除对应的对话历史。 URI DELETE /v1/koosearch/chat-history/{chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id 是 String 对话历史ID
删除文档接口 功能介绍 删除指定ID的文件。 URI DELETE /v1/koosearch/repos/{repo_id}/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KOS.00010001 JSON格式异常 JSON格式异常。 根据具体提示信息修改参数。 400 KOS.00010002 请求参数不合法
生成答案 功能介绍 将content输入给模型,使用模型能力生成答案。 注意: 当"chat_id"为空时,"chat_create_flag"应为"1",表示需要开启新的对话;当"chat_id"有值时,"chat_create_flag"可以为"0",表示不需要开启新的对话。
更新FAQ 功能介绍 更新指定ID的FAQ的问题、答案、相似问题。 URI PUT /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
修改模型配置 功能介绍 修改模型配置 URI PUT /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
调用说明 KooSearch服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 父主题: 使用前必读
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求
批量FAQ上传 功能介绍 上传xlsx/xls文件,用于FAQ的批量导入。 URI POST /v1/koosearch/repos/{repo_id}/faqs/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个
基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作 用户 由账号在IAM中创建的用户,是云服务的使