检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
更新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。 父主题: 使用前必读
构造请求 本节介绍REST API请求的组成,以调用获取用户Token接口说明如何调用API,该API获取用户的Token,Token是用户的访问令牌,承载身份与权限信息,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
华为IAM认证 表示借助IAM服务进行安全认证。 说明: 选择“华为IAM认证”时,任何API网关租户均可以访问此API,可能存在恶意刷流量,导致过量计费的风险。 编辑API 已发布的API,支持修改安全认证方式。 进入KooSearch服务详情页面。
获取知识库列表 功能介绍 获取当前账号下所有知识库列表。包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。 URI GET /v1/koosearch/repos 表1 Query参数 参数 是否必选 参数类型 描述 name 否 String 知识库名称 最小长度
查看知识库列表 功能介绍 查看知识库列表,包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。 URI GET /v1/koosearch/repos/{repo_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID
开通Flexus企业搜索服务 仅“西南-贵阳一”区域支持开通和使用KooSearch服务。 在使用KooSearch服务之前,需要开通KooSearch服务,具体操作如下: 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSearch>Flexus企业搜索服务”,进入Flexus
批量删除对话历史 功能介绍 根据对话ID,批量删除对话历史信息。 URI DELETE /v1/koosearch/chat-history/batch 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
删除Flexus企业搜索服务 当无需使用KooSearch文档问答服务时,可删除服务释放资源。 约束限制 删除服务时,会清理业务数据也会删除依赖集群,请谨慎操作。 删除包年/包月的服务 包年包月计费方式的服务支持退订/释放,退订/释放服务后,服务将会释放资源并清空数据,且无法恢复,
删除用户定义规则解析接口 功能介绍 用于删除用户自定义解析规则。 URI DELETE /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户规则ID 最小长度:1 最大长度:64 请求参数 表2 请求
体验KooSearch搜索 当知识库有了数据以后,就可以在KooSearch体验平台支持进行搜索体验。 前提条件 已准备好数据库,且已上传数据。 待进行问答体验的知识库状态为“开启”状态。 进入KooSearch控制台 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSearch
查询对话历史列表 功能介绍 查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。 URI GET /v1/koosearch/chat-history 表1 Query参数 参数 是否必选 参数类型 描述 user_name 否 String 用户名 最小长度:1 最大长度
开启知识库 功能介绍 根据ID开启知识库,知识库开启后为可检索状态。 URI PUT /v1/koosearch/repos/{repo_id}/enable 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字
上传图片 功能介绍 上传图片入库。 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/
列举用户规则列表 功能介绍 列举用户配置的所有解析规则列表。 URI GET /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考
获取图片内容 功能介绍 根据ID获取图片内容。 URI GET /v1/koosearch/image/{img_id} 表1 路径参数 参数 是否必选 参数类型 描述 img_id 是 String 图片ID,格式为img-[0-9a-z]{32} 最小长度:1 最大长度:64
创建用户解析规则 功能介绍 用于创建用户自定义的解析规则,解析规则用于解析需要作为subtitle的文本,规则由上而下依次校验。 URI POST /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token