检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如何调用API 构造请求 认证鉴权 接口获取 返回结果
500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能,无法完成请求。 502 Bad Gateway 充当网关或代理的服务器,从远端服务器接收到了一个无效的请求。
在RAG(Retrieval-Augmented Generation)及搜索场景提供效果和性能突出的组件化服务,架构理想、灵活编排的机制,帮助企业客户快速构建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个字符,只能包含数字、字母、中划线和下划线
接口获取 KooSearch服务接口组成: https://{apig公网地址}/{apig请求地址} 服务接口请求地址获取方式: 账号登录CSS控制台。 左侧导航栏选择:“KooSearch >Flexus 企业搜索服务”。 根据“名称/ID”,单击进入已购买的服务。
图1 新建模型服务 在新建模型服务页面。根据下表填写对应参数后,单击“确定”按钮。 表1 新建模型服务 参数 说明 模型服务名称 输入模型服务名称,不能为空。 模型类型 NLP模型-云底座:通过华为云提供的盘古nlp大模型访问方式。
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型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 模型类型
Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中“auth.scope”的取值需要选择“project”,如下所示。
删除对话历史 功能介绍 根据指定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个字符,只能包含数字