检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
公共参数 状态码 错误码
文件管理 上传文档接口 查询文档接口 下载文件接口 删除文档接口
图片管理 上传图片 获取图片内容
模型管理 新增模型 修改模型配置 列举模型 删除模型
结构化数据 上传结构化数据 搜索结构化数据文件
是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性
FAQ管理 创建FAQ 更新FAQ 获取FAQ 查询FAQ列表 删除FAQ 批量删除FAQ
FAQ批量管理 批量FAQ上传 列举批量上传FAQ文件 下载上传失败的FAQ 下载批量导入FAQ原文件 删除批量导入FAQ文件
析页眉页脚、是否解析目录页 split_conf 否 SplitConf object 拆分配置,包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 id 否 String 文档解析ID 最小长度:0 最大长度:64
知识库管理 创建知识库 修改知识库配置 设置知识库搜索问答prompt 设置知识库通用无搜索的prompt 开启知识库 关闭知识库 获取知识库列表 查看知识库列表 删除知识库
修改知识库配置。包括: 解析设置:是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页。 文档拆分设置: 自动分段 长度分段(按文本长度分段) 层级分段(按小标题分段,可自定义小标题解析规则 搜索模型设置:rerank模型配置。 NLP模型设置。 其他设置:召回数量、参
是否必选 参数类型 描述 repo_id 是 String 知识库ID,1~64个字符,只能包含数字、字母、中划线和下划线。 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理" ,在此界面获取"知识库ID"字段的值,表示该知识库在向量数据库中存储的ID,具有唯一性
单击需要查看的知识库的操作列的“文档管理”,进入知识库详情页面。 图1 查看知识库详情 进入详情页面后,除了查看知识库详细信息,也可以进行开启关闭知识库、引用知识库、设置知识库、上传文件、任务管理、版本管理的操作。 引用知识库 如果您有知识共享诉求,比如同级部门间的共享A引用B的知识库,或者各部门分权独立维
否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置,包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 表7 ParseConf 参数 参数类型 描述 ocr_enabled
否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置,包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 表6 ParseConf 参数 参数类型 描述 ocr_enabled
接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 表2 请求Body参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID 获取方式: 账号登录KooSearch体验平台,在左侧导航栏选择:"知识库管理"
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 响应参数 无 请求示例 无 响应示例 无 状态码 状态码 描述 200 删除成功 400
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 响应参数 无 请求示例 无 响应示例 无 状态码 状态码 描述 200 成功 错误码 请参见错误码。
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 表3 请求Body参数 参数 是否必选 参数类型 描述 detail 否 String
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token,Token获取方式参考:获取IAM用户Token 最小长度:1 最大长度:1000000 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 模型名称