检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
模型管理 新增模型 修改模型配置 列举模型 删除模型
华为云企业搜索KooSearch是基于华为云的云搜索服务搭建的一站式智能搜索解决方案,帮助企业聚焦业务场景和应用开发,场景服务化、技术简单化、低门槛化,满足开发者基于业务场景的二次开发。在RAG(Retrieval-Augmented Generation)及搜索场景提供效果和性能突出的组件化服务,架构理想、灵活编
删除模型 功能介绍 删除模型 URI DELETE /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
如何调用API 构造请求 认证鉴权 接口获取 返回结果
查询文档接口 功能介绍 在当前知识库查询名称为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”,单击进入已购买的服务。 单击“API管理”,即可看到支持的所有API列表。
创建人、创建时间等。 删除知识库 根据ID删除知识库。 表3 结构化数据接口 API 说明 结构化数据上传 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。 下载失败的条目 下载一个JSON文件,该文件包含给定上传Field的失败条目。 结构化数据文件搜索 根据文件名搜索目标文件。
对话历史 查询对话历史列表 获取对话历史 删除对话历史 批量删除对话历史
exus企业搜索服务页面。 选择文档问答服务,单击操作列的“问答”,前往KooSearch控制台。 左侧导航栏选择“模型管理”,进入“模型管理”页面。 单击页面的“新建模型服务”,弹出新建模型服务页面。 图1 新建模型服务 在新建模型服务页面。根据下表填写对应参数后,单击“确定”按钮。
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
结构化数据 上传结构化数据 下载失败的条目 搜索结构化数据文件
图片管理 上传图片 获取图片内容
批量删除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个字符,只能包含数字、字母、中划线和下划线。 最小长度:1
列举模型 功能介绍 列举模型 URI GET /v1/koosearch/models/search 表1 Query参数 参数 是否必选 参数类型 描述 model_name 否 String 模型名称 最小长度:1 最大长度:64 model_type 否 String 模型类型,枚举值:embedding
将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中“auth.scope”的取值需要选择“project”,如下所示。
使用前必读 概述 调用说明 终端节点 基本概念
搜索与问答 搜索知识库 生成答案