检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
索引擎。 访问方式 公有云提供了Web化的服务管理平台,即管理控制台和基于HTTPS请求的API(Application programming interface)管理方式。 API方式 如果用户需要将公有云平台上的集成到第三方系统,用于二次开发,请使用API方式访问,具体操作
选择“华为IAM认证”时,任何API网关租户均可以访问此API,可能存在恶意刷流量,导致过量计费的风险。 单击“确定”完成修改。 下线API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。
repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性 最小长度:1 最大长度:64
请求限定响应结果的分页大小,例如5条/页,10条/页 最小值:1 最大值:65535 缺省值:10 tag 否 String tag信息,由英文冒号连接key和value构成,如:key1:value1 最小长度:0 最大长度:65535 lod 否 String level of detail
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 表2 请求Body参数 参数 是否必选 参数类型 描述 repo_ids 是 Array
列举用户规则列表 功能介绍 列举用户配置的所有解析规则列表。 URI GET /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token
本案例以“kos_ocr”为例。 OCR增强 - OCR增强功能是引用OCR服务能力,来增强实例的搜索和问答能力。 开通OCR增强插件会创建委托访问文字识别服务,需额外计费。 网络配置 虚拟私有云 指定集群节点使用的虚拟专用网络,实现不同业务的网络隔离。 单击“查看虚拟私有云”跳转到虚
用户的文档解析规则定义 创建用户解析规则 修改用户解析规则 列举用户规则列表 删除用户定义规则解析接口
接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。 结构化数据接口 将结构化数据文件纳入系统进行管理接口。 文件管理接口 用户纳入系统的文档管理接口。 FAQ管理接口 用户自定义的FAQ相关管理接口。 FAQ批量管理接口 用户自定义的批量FAQ相关管理接口。 搜索与问答接口
接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 表2 请求Body参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知
搜索与问答 搜索知识库 生成答案
对话历史 查询对话历史列表 获取对话历史 删除对话历史 批量删除对话历史
修改模型配置 功能介绍 修改模型配置 URI PUT /v1/koosearch/models/{model_name} 表1 路径参数 参数 是否必选 参数类型 描述 model_name 是 String 模型名称 最小长度:1 最大长度:64 请求参数 表2 请求Header参数
新增模型 功能介绍 新增配置模型,包括模型名称、模型描述、模型endpoint、模型配置。 URI POST /v1/koosearch/models 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的
列举模型 功能介绍 列举模型 URI GET /v1/koosearch/models/search 表1 Query参数 参数 是否必选 参数类型 描述 model_name 否 String 模型名称 最小长度:1 最大长度:64 model_type 否 String 模型类型,枚举值:embedding
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KOS.00010001 JSON格式异常 JSON格式异常。 根据具体提示信息修改参数。 400 KOS.00010002 请求参数不合法
将本地文件上传至KooSearch知识库 创建完知识库,需要在知识库中上传知识数据。 场景描述 KooSearch知识库支持上传以下几种类型的知识。 表1 上传数据 上传方式 描述 上传文档 支持上传文档类型的知识,支持格式为 .doc, .docx, .pdf, .pptx,