检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
上传结构化数据 功能介绍 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。 URI POST /v1/koosearch/repos/{repo_id}/structured-data 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
结构化数据 上传结构化数据 搜索结构化数据文件
,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 file_name 是 String 结构化数据的文件名 最小长度:1 最大长度:1024 file_status
创建FAQ 功能介绍 输入问题、相似问题、答案,创建单条FAQ。 URI POST /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
上传图片 功能介绍 上传图片入库。 URI POST /v1/koosearch/image/{img_id} 表1 路径参数 参数 是否必选 参数类型 描述 img_id 是 String 图片ID,格式为img-[0-9a-z]{32} 最小长度:1 最大长度:64 请求参数
上传文档接口 功能介绍 上传文件至某个知识库。 URI POST /v1/koosearch/repos/{repo_id}/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。
批量FAQ上传 功能介绍 上传xlsx/xls文件,用于FAQ的批量导入。 URI POST /v1/koosearch/repos/{repo_id}/faqs/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个
搜索知识库 功能介绍 根据query,在指定知识库中搜索得到topN相关的分片文档。 URI POST /v1/koosearch/experience/search 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
创建知识库 功能介绍 创建知识库。 URI POST /v1/koosearch/repos 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
设置知识库通用无搜索的prompt 功能介绍 设置通用问答prompt。该prompt包含问题占位符{0},和对回答的要求。 URI POST /v1/koosearch/repos/{repo_id}/common-prompt 表1 路径参数 参数 是否必选 参数类型 描述 repo_id
占位符{1}。可以根据不同的使用场景,配置不同的prompt,例如增加人设、限定条件、答案格式要求等,帮助模型生成更优的结果。 URI POST /v1/koosearch/repos/{repo_id}/search-prompt 表1 路径参数 参数 是否必选 参数类型 描述
创建用户解析规则 功能介绍 用于创建用户自定义的解析规则,解析规则用于解析需要作为subtitle的文本,规则由上而下依次校验。 URI POST /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
体验KooSearch问答 当知识库有了数据以后,就可以在KooSearch体验平台进行问答体验。 前提条件 已准备好数据库,且已上传数据。 待进行问答体验的知识库状态为“开启”状态。 进入KooSearch控制台 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSearch
体验KooSearch搜索 当知识库有了数据以后,就可以在KooSearch体验平台支持进行搜索体验。 前提条件 已准备好数据库,且已上传数据。 待进行问答体验的知识库状态为“开启”状态。 进入KooSearch控制台 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSear
图1 项目隔离模型 Checkpoint:消费检查点。应用程序消费数据时,记录已消费数据的最新序列号作为检查点。当重新消费数据时,可根据此检查点继续消费。 APP:应用程序标识符。当多个应用程序分别消费同一通道的数据时,为区分不同应用程序的消费检查点,使用APP作为标识。 企业项目
当无需使用KooSearch文档问答服务时,可删除服务释放资源。 约束限制 删除服务时,会清理业务数据也会删除依赖集群,请谨慎操作。 删除包年/包月的服务 包年包月计费方式的服务支持退订/释放,退订/释放服务后,服务将会释放资源并清空数据,且无法恢复,即删除了该服务。 登录云搜索服务管理控制台。 选择需要退
PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens 请求消息头
获取对话历史 功能介绍 根据chat_id获取对话历史,返回历史的question和answer数据。 URI GET /v1/koosearch/chat-history/{chat_history_id} 表1 路径参数 参数 是否必选 参数类型 描述 chat_history_id
看到知识管理和文档解析两类API。 知识管理:该类API主要用于知识库管理,例如上传文档、刷新文档等。 文档解析:该类API主要用于对文档数据进行处理,例如切分文档内容。 将KooSearch API发布到不同环境后,支持在环境中调用API使用KooSearch服务。操作流程如下: