华为云用户手册

响应示例 状态码： 200 文档列表响应体 { "total" : 1, "page_num" : 1, "page_size" : 1, "files" : [ { "id" : "6e9abdb7-4626-492d-9f18-abad3b95572d", "name" : "successData.xlsx", "type" : "faq", "size" : 9834, "create_time" : "1700481265798" } ]}

请求示例 https://console.ulanqab.huawei.com/elasticsearch/unisearch-dev/v1/729cbd739854470da5426ed26bd900ca/unisearch-dev/v1/1ed40ceefc8d40f8b884edb6a84e7768/applications/fb9731ab-7085-474f-b6c7-64473586f0f3/uni-search/e8196714-3e6b-454e-8c23-61baff601ec9/faq/batch/search?page_num=1&page_size=10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 返回的文档总数 最小值：1 最大值：65535 page_num Integer 页码 最小值：1 最大值：65535 page_size Integer 每页数量 最小值：1 最大值：65535 files Array of FileInfo objects 文件列表 数组长度：0 - 65535 表5 FileInfo 参数 参数类型 描述 id String 文件ID 最小长度：1 最大长度：64 task_id String 任务id 最小长度：0 最大长度：64 name String 文件名 最小长度：1 最大长度：255 repo_id String 知识库id 最小长度：0 最大长度：64 project_id String 项目id 最小长度：1 最大长度：64 application_id String 应用id 最小长度：1 最大长度：64 status String 文件状态 SUC CES S 执行成功 ERROR 执行失败 PENDING 初始状态,未处理 RUNNING 执行中 IMPORT_EXCEPTION 导入异常 FILE_ENCODING_ERROR 编码错误 最小长度：0 最大长度：64 枚举值： SUCCESS ERROR PENDING RUNNING IMPORT_EXCEPTION FILE_ENCODING_ERROR type String 文件类型 最小长度：1 最大长度：64 size Long 文件大小（bytes） 最小值：1 最大值：99999999 category String 文档目录，单值，对应目录树中的叶子节点。 建议格式为 叶子节点目录名称(目录 ID)，如：专利（3166-1）。 最小长度：0 最大长度：255 create_user String 创建者，指上传文件的用户，可能不存在该键值 最小长度：1 最大长度：64 create_time String 创建时间，指上传文件的时间，例如：1692848139119 最小长度：1 最大长度：13 update_time String 更新时间，可能不存在该键值 最小长度：1 最大长度：13 file_path String 文件地址，可能不存在该键值 最小长度：0 最大长度：65535 upload_desc String 上传说明，可能不存在该键值 最小长度：0 最大长度：65535 file_extract_conf FileExtractConf object 文件抽取配置项 tags Array of strings 文档标签，可以使用标签对文档进行自动分组，用于筛选过滤。 注意事项： 1.建议不区分大小写，例如， Approved and approved 是同一个标签 2.文档可以有一个或多个标签 3.建议格式为：标签名称:标签值 ，如果能够保证标签值不冲突，也可以直接使用 标签值，例如 《冰箱使用说明书》对应的产品型号：ProductModel:BCD-551WLCTDAFA5U1 《一句顶一万句》的作者是：刘震云 《外观设计专利交底书模板》 的专业领域是：法务领域 最小长度：1 最大长度：255 数组长度：0 - 250 fail_count Integer 上传失败的数据条数 最小值：0 最大值：65535 fail_records_expire_time String 上传失败的时间戳 最小长度：1 最大长度：13 表6 FileExtractConf 参数 参数类型 描述 parse_conf ParseConf object 文档解析配置，包含是否使用OCR增强、是否解析图片、解析图片是否需要提取文字、是否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置，包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 id String 文档解析ID 最小长度：0 最大长度：64 表7 ParseConf 参数 参数类型 描述 ocr_enabled Boolean ocr增强 缺省值：false image_enabled Boolean 图片解析 缺省值：false header_footer_enabled Boolean 解析页眉页脚 缺省值：false catalog_enabled Boolean 解析目录页 缺省值：false image_conf String 图片解析开启后（TEXT 提取图片文本、IMAGE 保留原图） 缺省值：TEXT 枚举值： TEXT IMAGE 表8 SplitConf 参数 参数类型 描述 split_mode String 分段设置/层级解析模型 LENGTH-长度拆分，即为字数拆分 CATA LOG -层级分段下的自动解析 RULE- 层级分段下的规则解析 AUTO- 自动拆分，自动识别文档格式匹配适合的拆分解析方式 缺省值：AUTO 枚举值： LENGTH CATALOG RULE AUTO separator_ids Array of strings 分段标识符ID列表 文件解析分类 default.separator.list[0].id=space_en default.separator.list[0].separator=\u0020 default.separator.list[0].locale=en default.separator.list[1].id=period_zh default.separator.list[1].separator=。 default.separator.list[1].locale=zh default.separator.list[2].id=period_en default.separator.list[2].separator=. default.separator.list[2].locale=en default.separator.list[3].id=exclamation_mark_zh default.separator.list[3].separator=！ default.separator.list[3].locale=zh default.separator.list[4].id=exclamation_mark_en default.separator.list[4].separator=! default.separator.list[4].locale=en default.separator.list[5].id=question_mark_zh default.separator.list[5].separator=？ default.separator.list[5].locale=zh default.separator.list[6].id=question_mark_en default.separator.list[6].separator=? default.separator.list[6].locale=en default.separator.list[7].id=comma_zh default.separator.list[7].separator=， default.separator.list[7].locale=zh default.separator.list[8].id=comma_en default.separator.list[8].separator=, default.separator.list[8].locale=en 最小长度：1 最大长度：128 数组长度：1 - 100 rule_regex_id String 用户定义解析规则ID 最小长度：1 最大长度：256 chunk_size Integer 分段预计长度 最小值：0 最大值：6000 缺省值：500 title_level Integer 标题层级深度 最小值：1 最大值：10 缺省值：3 combine_title Boolean false 保留最后一级 true 保存多标题组合 缺省值：false merge_titles Boolean 是否跨标题合并，不同标题段落文字较少时，会自动合并到指定的分段长度，有助于生成更全面的结果 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI GET /v1/koosearch/repos/{repo_id}/faqs/files 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录 KooSearch 体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 file_name 否 String 文件名 最小长度：0 最大长度：255 file_status 否 String 文件状态 SUCCESS 上传成功 ERROR 上传失败 PENDING 上传等待 RUNNING 上传进行中 IMPORT_EXCEPTION 导入失败 FILE_ENCODING_ERROR 文件编码错误 最小长度：0 最大长度：128 枚举值： SUCCESS ERROR PENDING RUNNING IMPORT_EXCEPTION FILE_ENCODING_ERROR page_num 否 Integer 请求页码 最小值：1 最大值：65535 缺省值：1 page_size 否 Integer 请求限定响应结果的分页大小，例如5条/页，10条/页 最小值：1 最大值：65535 缺省值：10 ids 否 Array 精准查询id列表 最小长度：1 最大长度：64 数组长度：1 - 65535

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取 IAM 用户Token 最小长度：1 最大长度：1000000 表3 请求Body参数 参数 是否必选 参数类型 描述 regexs 是 Array of strings 规则list 最小长度：1 最大长度：200 数组长度：1 - 10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 修改的规则id 最小长度：1 最大长度：64 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应参数 状态码： 200 表11 响应Body参数 参数 参数类型 描述 repo_id String 知识库ID 最小长度：1 最大长度：64 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI PUT /v1/koosearch/repos/{repo_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64

请求示例 /v1/koosearch/repos/v22cca08-a83b-4518-8abf-0666ab5d635a{ "rerank_model" : "string", "pangu_nlp_model" : "string", "file_extract" : { "parse_conf" : { "ocr_enabled" : false, "image_enabled" : false, "header_footer_enabled" : false, "catalog_enabled" : false, "image_conf" : "TEXT" }, "split_conf" : { "split_mode" : "AUTO", "separator_ids" : [ ], "rule_regex_id" : "string", "chunk_size" : 6000, "title_level" : 3, "combine_title" : true } }, "search_plan_category_ids" : [ "string" ], "rerank_enabled" : true, "top_k" : 500, "reference_count" : 10, "query_rewrite_enabled" : true}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 rules Array of RuleRegexInfo objects 已配置的规则解析列表 数组长度：0 - 65535 表3 RuleRegexInfo 参数 参数类型 描述 id String 规则ID 最小长度：1 最大长度：65535 rule_regexs Array of strings 用户自定义规则内容 最小长度：1 最大长度：65535 数组长度：1 - 65535 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 返回的文档总数 最小值：1 最大值：65535 page_num Integer 页码 最小值：1 最大值：65535 page_size Integer 每页数量 最小值：1 最大值：65535 files Array of FileInfo objects 文件列表 数组长度：0 - 65535 表5 FileInfo 参数 参数类型 描述 id String 文件ID 最小长度：1 最大长度：64 task_id String 任务id 最小长度：0 最大长度：64 name String 文件名 最小长度：1 最大长度：255 repo_id String 知识库id 最小长度：0 最大长度：64 project_id String 项目id 最小长度：1 最大长度：64 application_id String 应用id 最小长度：1 最大长度：64 status String 文件状态 SUCCESS 执行成功 ERROR 执行失败 PENDING 初始状态,未处理 RUNNING 执行中 IMPORT_EXCEPTION 导入异常 FILE_ENCODING_ERROR 编码错误 最小长度：0 最大长度：64 枚举值： SUCCESS ERROR PENDING RUNNING IMPORT_EXCEPTION FILE_ENCODING_ERROR type String 文件类型 最小长度：1 最大长度：64 size Long 文件大小（bytes） 最小值：1 最大值：99999999 category String 文档目录，单值，对应目录树中的叶子节点。 建议格式为 叶子节点目录名称(目录 ID)，如：专利（3166-1）。 最小长度：0 最大长度：255 create_user String 创建者，指上传文件的用户，可能不存在该键值 最小长度：1 最大长度：64 create_time String 创建时间，指上传文件的时间，例如：1692848139119 最小长度：1 最大长度：13 update_time String 更新时间，可能不存在该键值 最小长度：1 最大长度：13 file_path String 文件地址，可能不存在该键值 最小长度：0 最大长度：65535 upload_desc String 上传说明，可能不存在该键值 最小长度：0 最大长度：65535 file_extract_conf FileExtractConf object 文件抽取配置项 tags Array of strings 文档标签，可以使用标签对文档进行自动分组，用于筛选过滤。 注意事项： 1.建议不区分大小写，例如， Approved and approved 是同一个标签 2.文档可以有一个或多个标签 3.建议格式为：标签名称:标签值 ，如果能够保证标签值不冲突，也可以直接使用 标签值，例如 《冰箱使用说明书》对应的产品型号：ProductModel:BCD-551WLCTDAFA5U1 《一句顶一万句》的作者是：刘震云 《外观设计专利交底书模板》 的专业领域是：法务领域 最小长度：1 最大长度：255 数组长度：0 - 250 fail_count Integer 上传失败的数据条数 最小值：0 最大值：65535 fail_records_expire_time String 上传失败的时间戳 最小长度：1 最大长度：13 表6 FileExtractConf 参数 参数类型 描述 parse_conf ParseConf object 文档解析配置，包含是否使用OCR增强、是否解析图片、解析图片是否需要提取文字、是否解析页眉页脚、是否解析目录页 split_conf SplitConf object 拆分配置，包括分段方式设置、层级解析模式设置、标题层级深度设置、标题保存方式设置、分段长度配置、标题匹配pattern配置等 id String 文档解析ID 最小长度：0 最大长度：64 表7 ParseConf 参数 参数类型 描述 ocr_enabled Boolean ocr增强 缺省值：false image_enabled Boolean 图片解析 缺省值：false header_footer_enabled Boolean 解析页眉页脚 缺省值：false catalog_enabled Boolean 解析目录页 缺省值：false image_conf String 图片解析开启后（TEXT 提取图片文本、IMAGE 保留原图） 缺省值：TEXT 枚举值： TEXT IMAGE 表8 SplitConf 参数 参数类型 描述 split_mode String 分段设置/层级解析模型 LENGTH-长度拆分，即为字数拆分 CATALOG-层级分段下的自动解析 RULE- 层级分段下的规则解析 AUTO- 自动拆分，自动识别文档格式匹配适合的拆分解析方式 缺省值：AUTO 枚举值： LENGTH CATALOG RULE AUTO separator_ids Array of strings 分段标识符ID列表 文件解析分类 default.separator.list[0].id=space_en default.separator.list[0].separator=\u0020 default.separator.list[0].locale=en default.separator.list[1].id=period_zh default.separator.list[1].separator=。 default.separator.list[1].locale=zh default.separator.list[2].id=period_en default.separator.list[2].separator=. default.separator.list[2].locale=en default.separator.list[3].id=exclamation_mark_zh default.separator.list[3].separator=！ default.separator.list[3].locale=zh default.separator.list[4].id=exclamation_mark_en default.separator.list[4].separator=! default.separator.list[4].locale=en default.separator.list[5].id=question_mark_zh default.separator.list[5].separator=？ default.separator.list[5].locale=zh default.separator.list[6].id=question_mark_en default.separator.list[6].separator=? default.separator.list[6].locale=en default.separator.list[7].id=comma_zh default.separator.list[7].separator=， default.separator.list[7].locale=zh default.separator.list[8].id=comma_en default.separator.list[8].separator=, default.separator.list[8].locale=en 最小长度：1 最大长度：128 数组长度：1 - 100 rule_regex_id String 用户定义解析规则ID 最小长度：1 最大长度：256 chunk_size Integer 分段预计长度 最小值：0 最大值：6000 缺省值：500 title_level Integer 标题层级深度 最小值：1 最大值：10 缺省值：3 combine_title Boolean false 保留最后一级 true 保存多标题组合 缺省值：false merge_titles Boolean 是否跨标题合并，不同标题段落文字较少时，会自动合并到指定的分段长度，有助于生成更全面的结果 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI GET /v1/koosearch/repos/{repo_id}/structured-data/search 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 file_name 是 String 结构化数据的文件名 最小长度：1 最大长度：1024 file_status 是 String 文件状态 SUCCESS - 上传成功 ERROR - 上传失败 PENDING - 排队解析中 RUNNING - 正在解析 IMPORT_EXCEPTION - 导入异常 FILE_ENCODING_ERROR - 文章解码异常 最小长度：0 最大长度：128 枚举值： SUCCESS ERROR PENDING RUNNING IMPORT_EXCEPTION FILE_ENCODING_ERROR page_num 否 Integer 请求页码 最小值：1 最大值：65535 缺省值：1 page_size 否 Integer 请求限定响应结果的分页大小，例如5条/页，10条/页 最小值：1 最大值：65535 缺省值：10 ids 否 Array 精准查询文件id列表 数组长度：1 - 64

URI GET /v1/koosearch/repos 表1 Query参数 参数 是否必选 参数类型 描述 name 否 String 知识库名称 最小长度：1 最大长度：64 status 否 String 状态(open-开启，close-关闭） 最小长度：1 最大长度：64 page_num 否 Integer 请求页码 最小值：1 最大值：65535 缺省值：1 page_size 是 Integer 请求限定响应结果的分页大小，例如5条/页，10条/页 最小值：1 最大值：65535 缺省值：10 tag 否 String tag信息，由英文冒号连接key和value构成，如：key1:value1 最小长度：0 最大长度：65535 lod 否 String level of detail, 返回结果详细程度：simple：简单 detail：详细 缺省值：detail 最小长度：1 最大长度：64 枚举值： simple detail

响应示例 状态码： 200 知识库列表响应体 { "data_list" : [ { "id" : "12369797", "name" : "知识库1", "detail" : "金融知识库", "status" : "OPEN", "create_user" : "", "create_time" : "1235356", "update_time" : "1235356", "fields" : [ { "name" : "", "field_type" : "", "name_zh" : "" } ] } ], "total" : 10}

响应示例 状态码： 200 成功 { "records" : [ { "id" : "991a482a-8330-4338-bdda-32852504bb38", "repo_id" : "b4254b30-f241-476c-b003-63df8f1cc221", "question" : "无法登录我的账户怎么办？", "answer" : "请确保您使用的是正确的用户名和密码。如果仍然无法登录，请尝试重置密码或联系客服。", "status" : 0, "create_time" : "1700807345932", "update_time" : "1700807345932" }, { "id" : "d3477f5c-f7d7-409c-a709-b56df8a7341c", "repo_id" : "b4254b30-f241-476c-b003-63df8f1cc221", "question" : "如何申请入学？", "answer" : "请查看我们的官方网站或联系招生办公室，了解入学要求、申请截止日期和所需材料。我们还提供入学顾问服务。", "status" : 0, "create_time" : "1700807328240", "update_time" : "1700807328240" } ], "total" : 2, "size" : 10, "current" : 1, "optimize_count_sql" : true, "search_count" : true, "pages" : 1}

URI GET /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 表2 Query参数 参数 是否必选 参数类型 描述 question 否 String 问题关键字 最小长度：0 最大长度：1000 repo_id 是 String 知识库ID 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 answer 否 String FAQ答案 最小长度：0 最大长度：10000 page_num 否 Integer 请求页码 最小值：1 最大值：65535 缺省值：1 page_size 否 Integer 限定响应体每页返回的数据条数，例如5页/条，10页/条 最小值：1 最大值：65535 缺省值：10 ids 否 Array faq id列表 最小长度：1 最大长度：64 数组长度：0 - 65535

URI GET /v1/koosearch/models/search 表1 Query参数 参数 是否必选 参数类型 描述 model_name 否 String 模型名称 最小长度：1 最大长度：64 model_type 否 String 模型类型，枚举值：embedding,rerank,nlp,search-plan,query2query 最小长度：1 最大长度：64 model_status 否 String 模型状态 最小长度：1 最大长度：64 page_num 否 Integer 请求页码 最小值：1 最大值：65535 缺省值：1 page_size 否 Integer 请求限定响应结果的分页大小，例如5条/页，10条/页 最小值：1 最大值：65535 缺省值：10

响应示例 状态码： 200 模型列表 { "page_num" : 1, "page_size" : 1, "total" : 1, "models" : [ { "name" : "pangu_38b", "detail" : "pangu_38b", "type" : "nlp", "status" : "ready", "create_time" : "1716946517167", "update_time" : "1716946517167", "endpoint" : "http://10.0.0.169:31010", "extend_config" : { "deployment_id" : "123", "iam_info" : { "iam_enabled" : false, "agency_enabled" : false, "project_id" : "456" } } } ]}

请求示例 /v1/111/applications/222/uni-search/nlp-models{ "name" : "pangu_38b", "detail" : "pangu_38b", "type" : "nlp", "endpoint" : "http://10.0.0.169:31010", "extend_config" : { "deployment_id" : "123", "iam_info" : { "iam_enabled" : false, "agency_enabled" : false } }}

响应参数 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KOS.00010001 JSON格式异常 JSON格式异常。 根据具体提示信息修改参数。 400 KOS.00010002 请求参数不合法 请求参数不合法。 根据具体提示信息修改参数。 400 KOS.00010003 请求参数为空 请求参数为空。 根据具体提示信息修改参数。 400 KOS.00010004 url参数解析异常 url参数解析异常。 根据具体提示信息修改参数。 400 KOS.00010005 url路径不合法 url路径不合法。 参考文档进行url路径修改。 400 KOS.00010006 参数类型异常 参数类型异常。 根据具体提示信息修改参数。 400 KOS.00020001 es查询异常 es查询异常。 建议检查es节点状态。 400 KOS.00020002 es索引创建异常 es索引创建异常。 建议检查es节点状态。 400 KOS.00020003 es更新异常 es更新异常。 建议检查es节点状态。 400 KOS.00020004 es删除索引异常 es删除索引异常。 建议检查es节点状态。 400 KOS.00020005 es批量删除异常 es批量删除异常。 建议检查es节点索引状态。 400 KOS.00020006 es删除索引异常 es删除索引异常。 建议检查es节点索引状态。 400 KOS.00020007 es批量创建索引异常 es批量创建索引异常。 建议检查es节点状态。 400 KOS.00020008 es删除文档异常 es删除文档异常。 建议检查es节点状态。 400 KOS.00020009 es更新文档异常 es更新文档异常。 建议检查es节点状态。 400 KOS.00020010 es批量操作异常 es批量操作异常。 建议检查es节点状态。 400 KOS.00020011 连接es失败 连接es失败。 建议检查es节点状态。 400 kos.00020013 更新es索引配置异常 更新es索引配置异常。 建议检查es节点状态。 400 KOS.00040001 调用盘古nlp模型异常 调用盘古nlp模型异常。 模型状态异常，请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 KOS.00040002 调用多轮改写服务异常 调用多轮改写服务异常。 模型状态异常，请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 KOS.00040003 调用文档解析服务异常 调用文档解析服务异常。 文档解析服务异常，请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 kos.00050003 文件信息写入数据库异常 文件信息写入数据库异常。 服务数据库异常，请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 kos.00050004 上传obs异常 上传obs异常。 obs服务异常，请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 kos.00050005 json处理异常 json处理异常。 请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 KOS.00050006 处理中的文件不支持删除 处理中的文件不支持删除。 文件正在处理中，请稍后重试。 400 kos.00060001 数据库查询结果为空 数据库查询结果为空。 数据库查询结果为空。 400 kos.00060002 数据库操作失败 数据库操作失败。 服务数据库异常，请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 kos.00060003 数据库更新异常 数据库更新异常。 服务数据库异常，请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 kos.00060004 操作资源不存在 操作资源不存在。 资源不存在。 400 kos.00060005 模型不可用 模型不可用。 模型可能存在异常，请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 KOS.00070004 下载json文件异常 下载json文件异常。 请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 KOS.00070005 写入json文件异常 写入json文件异常。 请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 KOS.00080001 同名知识库已存在 同名知识库已存在。 知识库已经存在。 400 KOS.00080002 知识库为空时不支持开启 知识库为空时不支持开启。 知识库为空。 400 KOS.00080003 知识库关闭时不允许当前操作 知识库关闭时不允许当前操作。 知识库为关闭状态。 400 KOS.00080004 对话时间超期 对话时间超期。 建议重新开启新对话。 400 KOS.00080005 知识库更新失败 知识库更新失败。 请查看服务日志，根据具体问题分析服务异常。 400 KOS.00090001 内部异常 内部异常。 请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 400 KOS.00100002 权限不足 权限不足。 请联系技术支持。您可以登录华为云官网，在华为云首页，单击右上角的“联系我们”，反馈您所遇到的问题，技术支持会快速为您定位问题，解决问题。 父主题： 公共参数

请求示例 https://console.ulanqab.huawei.com/elasticsearch/unisearch-dev/v1/729cbd739854470da5426ed26bd900ca/unisearch-dev/v1/1ed40ceefc8d40f8b884edb6a84e7768/applications/fb9731ab-7085-474f-b6c7-64473586f0f3/uni-search/e8196714-3e6b-454e-8c23-61baff601ec9/faq/batch/fail-records/f01d3089-7c36-4f03-94ac-38b8df2ff016

URI GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id}/fails 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 file_id 是 String 文件ID，1～64个字符，只能包含数字、字母、中划线和下划线。 最小长度：1 最大长度：64

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 - File 下载成功的文件 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI DELETE /v1/koosearch/repos/{repo_id}/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 file_id 是 String 文件ID，1～64个字符，只能包含数字、字母、中划线和下划线。 最小长度：1 最大长度：64

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token 最小长度：1 最大长度：1000000 表2 请求Body参数 参数 是否必选 参数类型 描述 regexs 是 Array of strings 规则list 最小长度：1 最大长度：200 数组长度：1 - 10

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 规则ID 最小长度：1 最大长度：64 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI GET /v1/koosearch/repos/{repo_id}/faqs/files/{file_id} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，1～64个字符，只能包含数字、字母、中划线和下划线。 获取方式： 账号登录KooSearch体验平台，在左侧导航栏选择："知识库管理" ，在此界面获取"知识库ID"字段的值，表示该知识库在向量数据库中存储的ID，具有唯一性 最小长度：1 最大长度：64 file_id 是 String 文件ID，1～64个字符，只能包含数字、字母、中划线和下划线。 最小长度：1 最大长度：64

请求示例 https://console.ulanqab.huawei.com/elasticsearch/unisearch-dev/v1/729cbd739854470da5426ed26bd900ca/unisearch-dev/v1/1ed40ceefc8d40f8b884edb6a84e7768/applications/fb9731ab-7085-474f-b6c7-64473586f0f3/uni-search/faq/batch/6e9abdb7-4626-492d-9f18-abad3b95572d