检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
上传结构化数据 功能介绍 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。 URI POST /v1/koosearch/repos/{repo_id}/structured-data 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String
本节介绍REST API请求的组成，以调用获取用户Token接口说明如何调用API，该API获取用户的Token，Token是用户的访问令牌，承载身份与权限信息，Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud
是否开启图文并茂 session_config 否 SessionConfig object 缓存策略 extend_config 否 KnowledgeRepoExtendConfig object 知识库扩展配置 tags 否 Array of TagInfo objects
ModelExtendConfig object 模型的自定义配置，json格式 alias 否 String 昇腾模型场景请求模型需要的name 最小长度：1 最大长度：32 表3 ModelExtendConfig 参数 是否必选 参数类型 描述 iam_info 是 IamInfo object iam鉴权委托信息
”加到请求消息头即可，如下所示。 POST https://{endpoint}/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs
创建FAQ 功能介绍 输入问题、相似问题、答案，创建单条FAQ。 URI POST /v1/koosearch/repos/{repo_id}/faqs 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 String 知识库ID，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个
上传图片 功能介绍 上传图片入库。 URI POST /v1/koosearch/image/{img_id} 表1 路径参数 参数 是否必选 参数类型 描述 img_id 是 String 图片ID，格式为img-[0-9a-z]{32} 最小长度：1 最大长度：64 请求参数
搜索知识库 功能介绍 根据query，在指定知识库中搜索得到topN相关的分片文档。 URI POST /v1/koosearch/experience/search 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
设置知识库通用无搜索的prompt 功能介绍 设置通用问答prompt。该prompt包含问题占位符{0}，和对回答的要求。 URI POST /v1/koosearch/repos/{repo_id}/common-prompt 表1 路径参数 参数 是否必选 参数类型 描述 repo_id
占位符{1}。可以根据不同的使用场景，配置不同的prompt，例如增加人设、限定条件、答案格式要求等，帮助模型生成更优的结果。 URI POST /v1/koosearch/repos/{repo_id}/search-prompt 表1 路径参数 参数 是否必选 参数类型 描述
创建用户解析规则 功能介绍 用于创建用户自定义的解析规则，解析规则用于解析需要作为subtitle的文本，规则由上而下依次校验。 URI POST /v1/koosearch/rule-regex 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
话时为3、5、7、...，如 [question1, answer1, question2] 多轮对话中：对话排列顺序从旧到新 URI POST /v1/koosearch/experience/chat 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
如何调用API 构造请求 认证鉴权 接口获取 返回结果
"error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。 父主题： 如何调用API
“名称”、“描述”、“请求方法”、“apig公网地址”、“apig请求地址”等信息。 图1 KooSearch-API管理界面 父主题： 如何调用API
永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。
描述 parse_conf 否 ParseConf object 文档解析配置，包含是否使用OCR增强、是否解析图片、解析图片是否需要提取文字、是否解析页眉页脚、是否解析目录页 split_conf 否 SplitConf object 拆分配置，包括分段方式设置、层级解析模式设置、
档状态、创建人、创建时间等。 删除知识库 根据ID删除知识库。 表3 结构化数据接口 API 说明 结构化数据上传 将结构化数据文件上传到对象存储服务OBS中进行结构化数据批处理功能。 结构化数据文件搜索 根据文件名搜索目标文件。 表4 文件管理接口 API 说明 上传文件 上传文件至某个知识库。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
