检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
认证类型 IAM认证:支持华为iam认证,系统将默认使用css资源租户进行认证。开启使用委托账号后可以通过配置委托名和委托账号的方式使用委托账号的权限进行认证。 自定义认证:支持在调用时添加自定义请求头。
接口获取 KooSearch服务接口组成: https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式: 账号登录CSS控制台。 左侧导航栏选择:“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”,单击进入已购买的服务。 单击“API
认证鉴权 KooSearch服务支持通过Token认证进行认证鉴权。 Token的有效期为24小时,需要使用同一个Token鉴权时,可以缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将
构造请求 本节介绍REST API请求的组成,以调用获取用户Token接口说明如何调用API,该API获取用户的Token,Token是用户的访问令牌,承载身份与权限信息,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
删除模型 功能介绍 删除模型 URI DELETE /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
状态码 状态码如表1所示。 表1 状态码说明 状态码 编码 状态码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高版本的协议。 例如,切换到
使用前必读 概述 欢迎使用Flexus企业搜索服务。Flexus企业搜索服务基于业界效果突出的搜索模型、云搜索服务的高性能GaussDB向量数据库以及LLM模型组成行业RAG解决方案,导入非结构化或者结构化业务数据,帮助企业客户快速一站式搭建企业智能问答应用。搜索增强大模型,数据来源于搜索
查询文档接口 功能介绍 在当前知识库查询名称为xx的文件。 URI GET /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线
获取对话历史 功能介绍 根据chat_id获取对话历史,返回历史的question和answer数据。 URI GET /v1/koosearch/chat-history/{chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id
上传文档接口 功能介绍 上传文件至某个知识库。 URI POST /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token
批量删除FAQ 功能介绍 选择多个需要删除的FAQ,根据ID批量删除。 URI DELETE /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字
下载文件接口 功能介绍 下载指定ID的文件。 URI GET /v1/koosearch/repos/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 file_id 是 String 文件ID,1~64个字符,只能包含数字、字母、中划线和下划线。 最小长度
列举模型 功能介绍 列举模型 URI GET /v1/koosearch/models/search 表1 Query参数 参数 是否必选 参数类型 描述 model_name 否 String 模型名称 最小长度:1 最大长度:64 model_type 否 String 模型类型
删除对话历史 功能介绍 根据指定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个字符,只能包含数字
更新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
生成答案 功能介绍 将content输入给模型,使用模型能力生成答案。 注意: 当"chat_id"为空时,"chat_create_flag"应为"1",表示需要开启新的对话;当"chat_id"有值时,"chat_create_flag"可以为"0",表示不需要开启新的对话。