检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
上传图片 功能介绍 上传图片入库。 URI POST /v1/koosearch/image/{img_id} 表1 路径参数 参数 是否必选 参数类型 描述 img_id 是 String 图片ID,格式为img-[0-9a-z]{32} 最小长度:1 最大长度:64 请求参数
获取图片内容 功能介绍 根据ID获取图片内容。 URI GET /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个
最小长度:0 最大长度:255 file_status 否 String 文件状态 SUCCESS 上传成功 ERROR 上传失败 PENDING 上传等待 RUNNING 上传进行中 IMPORT_EXCEPTION 导入失败 FILE_ENCODING_ERROR 文件编码错误
下载上传失败的FAQ 功能介绍 下载给定上传的批量FAQ文件中,上传失败的条目。 URI GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
上传结构化数据 功能介绍 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。 URI POST /v1/koosearch/repos/{repo_id}/structured-data 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
默认进入“文档管理”页签,单击“上传”。 在上传对话框中单击“选择文档”,本地选择已提前准备好的文档。重复的文档不允许上传。 图2 上传文档 单击“确认”。文档上传后,可在文档管理页签查看已上传的文档,当“文档状态”为“正常”,说明文档已上传成功。 文档上传成功后,可以单击文档名称,查看切片效果。
选择“文档管理”页签,单击“上传”。 在上传对话框中单击“选择文档”,本地选择已提前准备好的文档。重复的文档不允许上传。 图3 上传文档 单击“确认”。文档上传后,可在文档管理页签查看已上传的文档,当“文档状态”为“正常”,说明文档已上传成功。 文档上传成功后,可以单击文档名称,查看切片效果。
选择多个需要删除的FAQ,根据ID批量删除。 表6 FAQ批量管理接口 API 说明 批量FAQ上传 上传xlsx/xls文件,用于FAQ的批量导入。 下载上传失败的FAQ 下载给定上传的批量FAQ文件中,上传失败的条目。 列举批量上传faq文件 列举批量上传faq文件。 下载批量导入FAQ原文件 下载批量导入FAQ的原始文件。
KooSearch服务提供的API支持发布到不同的环境,发布成功后支持被调用。 场景描述 KooSearch服务开通成功后,会自动创建KooSearch API。在KooSearch服务详情页的API管理页签,可以看到知识管理和文档解析两类API。 知识管理:该类API主要用于知识库管理,例如上传文档、刷新文档等。
是否必选 参数类型 描述 parse_conf 否 ParseConf object 文档解析配置,包含是否使用OCR增强、是否解析图片、解析图片是否需要提取文字、是否解析页眉页脚、是否解析目录页 split_conf 否 SplitConf object 拆分配置,包括分段方式
勾选后,即可调用OCR服务进行智能文档识别,如表格解析或扫描文件等。 解析图片 未勾选,在文档中遇到图片默认跳过,不处理图片。 勾选后,有两种解析方式可供选择: 提取图片文本:识别图片内文字。 仅保留原图:将图片提取后上传OBS桶,便于问答图文展示。 解析页眉页脚 未勾选,解析结果中不包含页眉页脚。
结构化数据的文件名 最小长度:1 最大长度:1024 file_status 是 String 文件状态 SUCCESS - 上传成功 ERROR - 上传失败 PENDING - 排队解析中 RUNNING - 正在解析 IMPORT_EXCEPTION - 导入异常 FILE_ENCODING_ERROR
最小长度:0 最大长度:255 create_user String 创建者,指上传文件的用户,可能不存在该键值 最小长度:1 最大长度:64 create_time String 创建时间,指上传文件的时间,例如:1692848139119 最小长度:1 最大长度:13 update_time
下载失败的条目 功能介绍 下载一个JSON文件,该文件包含给定上传Field的失败条目。 URI GET /v1/koosearch/repos/{repo_id}/structured-data/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id
体验KooSearch问答 当知识库有了数据以后,就可以在KooSearch体验平台进行问答体验。 前提条件 已准备好数据库,且已上传数据。 待进行问答体验的知识库状态为“开启”状态。 进入KooSearch控制台 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSearch
体验KooSearch搜索 当知识库有了数据以后,就可以在KooSearch体验平台支持进行搜索体验。 前提条件 已准备好数据库,且已上传数据。 待进行问答体验的知识库状态为“开启”状态。 进入KooSearch控制台 登录云搜索服务管理控制台。 在左侧导航栏选择“KooSear
”,进入知识库详情页面。 图1 查看知识库详情 进入详情页面后,除了查看知识库详细信息,也可以进行开启关闭知识库、引用知识库、设置知识库、上传文件、任务管理、版本管理的操作。 引用知识库 如果您有知识共享诉求,比如同级部门间的共享A引用B的知识库,或者各部门分权独立维护知识库、但