检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接口获取 KooSearch服务接口组成: https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式: 账号登录CSS控制台。 左侧导航栏选择:“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”,单击进入已购买的服务。 单击“A
7317c/files 响应示例 状态码: 201 上传文档接口响应体 { "file_id" : "5c46f7e31c5c4587ac99ef0da0502470" } 状态码 状态码 描述 201 上传文档接口响应体 400 请求体参数错误 500 内部异常 错误码 请参见错误码。
查询文档接口 功能介绍 在当前知识库查询名称为xx的文件。 URI GET /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
对于获取用户Token接口,返回如图 获取用户Token响应消息头所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体通常以结构化格式
如何调用API 构造请求 认证鉴权 接口获取 返回结果
加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中“auth.scope”的取值需要选择“project”,如下所示。 { "auth":
application/json 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(即消息体为空),GET、
s企业搜索服务”,进入KooSearch服务列表。 选择目标服务,单击服务名称,进入服务详情页。 单击“API管理”,进入API管理页签。 选择已发布的API,单击操作列的“编辑”。 在“编辑”页面修改API的安全认证方式。 “APP认证”:表示由API网关服务负责接口请求的安全认证。推荐使用APP认证方式。
将结构化数据文件纳入系统进行管理接口。 文件管理接口 用户纳入系统的文档管理接口。 FAQ管理接口 用户自定义的FAQ相关管理接口。 FAQ批量管理接口 用户自定义的批量FAQ相关管理接口。 搜索与问答接口 Koosearch的搜索与模型问答接口。 对话历史接口 用户对话历史接口。 图片管理接口 图片管理相关接口。
删除文档接口 功能介绍 删除指定ID的文件。 URI DELETE /v1/koosearch/repos/{repo_id}/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
最小长度:1 最大长度:64 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 响应参数 状态码: 200
访问方式 公有云提供了Web化的服务管理平台,即管理控制台和基于HTTPS请求的API(Application programming interface)管理方式。 API方式 如果用户需要将公有云平台上的集成到第三方系统,用于二次开发,请使用API方式访问,具体操作请参见《Flexus企业搜索服务API参考》。
公共参数 状态码 错误码
搜索与问答 搜索知识库 生成答案
对话历史 查询对话历史列表 获取对话历史 删除对话历史 批量删除对话历史
模型管理 新增模型 修改模型配置 列举模型 删除模型
FAQ批量管理 批量FAQ上传 列举批量上传FAQ文件 下载上传失败的FAQ 下载批量导入FAQ原文件 删除批量导入FAQ文件
您提供托管的分布式搜索引擎服务+大模型生成能力。 本文档提供了Flexus企业搜索服务API的描述、语法、参数说明及样例等内容。 调用说明 Flexus企业搜索服务提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用。
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
FAQ管理 创建FAQ 更新FAQ 获取FAQ 查询FAQ列表 删除FAQ 批量删除FAQ