检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口,您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。 结构化数据接口 将结构化数据文件纳入系统进行管理接口
接口获取 KooSearch服务接口组成: https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式: 账号登录CSS控制台。 左侧导航栏选择:“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”,单击进入已购买的服务。 单击“API
查询文档接口 功能介绍 在当前知识库查询名称为xx的文件。 URI GET /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线
上传文档接口 功能介绍 上传文件至某个知识库。 URI POST /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线
如何调用API 构造请求 认证鉴权 接口获取 返回结果
API网关(API Gateway)是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务,能快速将企业服务能力包装成标准API接口,帮助您轻松构建、管理和部署任意规模的API,并上架API云商店进行售卖。
101 Switching Protocols 切换协议。只能切换到更高版本的协议。 例如,切换到HTTPS的高版本协议。 200 OK 请求已成功。 201 Created 创建类的请求已成功。 202 Accepted 已经接受请求,但未处理完成。
{URI-scheme}://{Endpoint}/{resource-path} 表1 请求URL 参数 说明 URI-scheme 传输请求的协议,当前所有API均采用HTTPS协议。
删除文档接口 功能介绍 删除指定ID的文件。 URI DELETE /v1/koosearch/repos/{repo_id}/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字
下载文件接口 功能介绍 下载指定ID的文件。 URI GET /v1/koosearch/repos/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 file_id 是 String 文件ID,1~64个字符,只能包含数字、字母、中划线和下划线。 最小长度
删除用户定义规则解析接口 功能介绍 用于删除用户自定义解析规则。 URI DELETE /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户规则ID 最小长度:1 最大长度:64 请求参数 表2 请求
表1 Flexus企业搜索服务终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 西南-贵阳一 cn-southwest-2 css.cn-southwest-2.myhuaweicloud.com HTTPS 基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
访问地址 MaaS服务的模型服务的“API接口公网地址”。获取方式请参见步骤1:在MaaS部署模型服务。 模型描述 模型详细信息的描述。 昇腾云模型名称 来源于MaaS服务的模型服务的“调用模型名称”,获取方式请参见步骤1:在MaaS部署模型服务。
填写退订原因,勾选相关协议后,单击“退订”。 在弹出确认退订提示信息后,再次单击“退订”。 当服务处于生效中状态时,则走退订流程,此时会产生一个订单进行退费,然后删除服务。当服务处于已过期或者已冻结状态时,则走释放流程,直接删除服务。服务退订的使用说明请参考费用中心相关描述。
认证鉴权 KooSearch服务支持通过Token认证进行认证鉴权。 Token的有效期为24小时,需要使用同一个Token鉴权时,可以缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将
如果未注册,请单击右上方“注册”,根据界面提示填写用户基本信息,然后单击“同意协议并注册”完成管理控制台用户注册。
公共参数 状态码 错误码
模型管理 新增模型 修改模型配置 列举模型 删除模型
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口