检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。 结构化数据接口 将结构化数据文件纳入系统进行管理接口。 文件管理接口 用户纳入系统的文档管理接口。 FAQ管理接口 用户自定义的FAQ相关管理接口。 FAQ批量管理接口 用户自定义的批量FAQ相关管理接口。 搜索与问答接口
知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
答" 根据"名称/ID",选择购买的服务,单击"问答",进入KooSearch文档问答管理页面 左侧导航栏选择:"知识库管理" ,在知识库列表中,选择目标知识库,单击其ID进入 单击"FAQ管理",即可查看FAQ列表,获取某条FAQ的ID 最小长度:1 最大长度:64 repo_id
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
0 } 状态码 状态码 描述 200 删除信息响应体 400 请求体参数错误 500 内部异常 错误码 请参见错误码。 父主题: 知识库管理
知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
下载上传失败的FAQ 功能介绍 下载给定上传的批量FAQ文件中,上传失败的条目。 URI GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
创建和管理KooSearch模型服务(可选) 场景描述 用户可以在模型管理页面配置不同的模型,建好的模型服务可以在体验问答和搜索的时候用来配置,也可以在配置知识库时,选择您建好的模型。 创建模型服务 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSearch>Flexus企
删除包年/包月的服务 包年包月计费方式的服务支持退订/释放,退订/释放服务后,服务将会释放资源并清空数据,且无法恢复,即删除了该服务。 登录云搜索服务管理控制台。 选择需要退订的服务,在操作列单击“更多”>“退订/释放”。 输入需要退订/释放的服务名称,单击“确定”。 进入退订资源页面,可以在该页面核对资源信息以及退费金额。
知识库创建好后,可以在知识库管理页面查看到新创建的知识库基本信息,包括知识库ID、知识库名称、知识库状态等信息。 修改知识库设置 针对已创建的知识库,支持修改知识库设置。 在KooSearch控制台,左侧导航栏选择“知识库管理”。 进入知识库管理页面。 在知识库管理页面,选择已创建的知识库,单击操作列的“文档管理”。
上传结构化数据 功能介绍 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。 URI POST /v1/koosearch/repos/{repo_id}/structured-data 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
修改用户解析规则 功能介绍 用于修改已配置的解析规则。 URI PUT /v1/koosearch/rule-regex/{id} 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String 用户解析规则ID 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
库管理页面。 在知识库管理页面,选择5创建的知识库,单击操作列的“文档管理”。进入知识库详情页面。 选择“文档管理”页签,单击“上传”。 在上传对话框中单击“选择文档”,本地选择已提前准备好的文档。重复的文档不允许上传。 图2 上传文档 单击“确认”。文档上传后,可在文档管理页签
列举用户规则列表 功能介绍 列举用户配置的所有解析规则列表。 URI GET /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token
设置知识库通用无搜索的prompt 功能介绍 设置通用问答prompt。该prompt包含问题占位符{0},和对回答的要求。 URI POST /v1/koosearch/repos/{repo_id}/common-prompt 表1 路径参数 参数 是否必选 参数类型 描述 repo_id
设置知识库搜索问答prompt 功能介绍 设置知识库搜索问答prompt,该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景,配置不同的prompt,例如增加人设、限定条件、答案格式要求等,帮助模型生成更优的结果。 URI POST /v1
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KOS.00010001 JSON格式异常 JSON格式异常。 根据具体提示信息修改参数。 400 KOS.00010002 请求参数不合法
查看Flexus企业搜索服务详情 在服务的基本信息页面,可以获取服务的内网访问文档解析地址、内网访问知识管理地址、计费模式等信息。除此之外,还能进行管理服务、API管理和日志管理。 管理服务:KooSearch文档问答服务针对已创建的服务所配置的集群,可前往云搜索服务控制台对集群进行管理。
Flexus企业搜索服务使用流程 华为云企业搜索KooSearch是基于华为云的云搜索服务搭建的一站式智能搜索解决方案,帮助企业聚焦业务场景和应用开发,场景服务化、技术简单化、低门槛化,满足开发者基于业务场景的二次开发。在RAG(Retrieval-Augmented Gener