检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
调用说明 KooSearch服务提供了REST（Representational State Transfer）风格API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。 父主题： 使用前必读
返回结果 状态码 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对应请求
下载文件接口 功能介绍 下载指定ID的文件。 URI GET /v1/koosearch/repos/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 file_id 是 String 文件ID，1～64个字符，只能包含数字、字母、中划线和下划线。 最小长度：1
列举模型 功能介绍 列举模型 URI GET /v1/koosearch/models/search 表1 Query参数 参数 是否必选 参数类型 描述 model_name 否 String 模型名称 最小长度：1 最大长度：64 model_type 否 String 模型类型，枚举值：embedding
认证鉴权 KooSearch服务支持通过Token认证进行认证鉴权。 Token的有效期为24小时，需要使用同一个Token鉴权时，可以缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候
批量删除对话历史 功能介绍 根据对话ID，批量删除对话历史信息。 URI DELETE /v1/koosearch/chat-history/batch 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用
删除Flexus企业搜索服务 当无需使用KooSearch文档问答服务时，可删除服务释放资源。 约束限制 删除服务时，会清理业务数据也会删除依赖集群，请谨慎操作。 删除包年/包月的服务 包年包月计费方式的服务支持退订/释放，退订/释放服务后，服务将会释放资源并清空数据，且无法恢复，即删除了该服务。
列举用户规则列表 功能介绍 列举用户配置的所有解析规则列表。 URI GET /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token
repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64
删除知识库 功能介绍 根据ID删除知识库。 URI DELETE /v1/koosearch/repos 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token
终端节点 终端节点（Endpoint）即调用API的请求地址，KooSearch局点在贵阳一，终端节点见表1。 表1 KooSearch终端节点 区域名称 区域 终端节点（Endpoint） 协议类型 西南-贵阳一 cn-southwest-2 css.cn-southwest-2
repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64
repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64
repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64
repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64
创建知识库 功能介绍 创建知识库。 URI POST /v1/koosearch/repos 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token
查看Flexus企业搜索服务详情 在服务的基本信息页面，可以获取服务的内网访问文档解析地址、内网访问知识管理地址、计费模式等信息。除此之外，还能进行管理服务、API管理和日志管理。 管理服务：KooSearch文档问答服务针对已创建的服务所配置的集群，可前往云搜索服务控制台对集群进行管理。
管理KooSearch知识库 创建好的知识库可以进行查看、关闭、开启、引用、删除等操作。 查看知识库详情 进入KooSearch控制台。 左侧导航栏选择“知识库管理”，进入“知识库管理”页面。 单击需要查看的知识库的操作列的“文档管理”，进入知识库详情页面。 图1 查看知识库详情
上传图片 功能介绍 上传图片入库。 URI POST /v1/koosearch/image/{img_id} 表1 路径参数 参数 是否必选 参数类型 描述 img_id 是 String 图片ID，格式为img-[0-9a-z]{32} 最小长度：1 最大长度：64 请求参数
配置Flexus企业搜索服务集群路由 当KooSearch服务需要主动访问公网，或者是需要跨网络访问KooSearch API，则需要配置KooSearch服务的集群路由，连通网络。 操作步骤 进入KooSearch服务详情页面。 登录云搜索服务管理控制台。 在左侧导航栏选择“K
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
