华为云用户手册

优化顾问服务权限 默认情况下，新建的 IAM 用户没有任何权限，需要将其加入用户组，并给用户组授予策略，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。例如：针对E CS 服务，管理员能够控制IAM用户仅能对某一类云服务器资源进行指定的管理操作。 多数细粒度策略以API接口为粒度进行权限拆分，OA服务支持的API授权项请参见策略及授权项说明。 如表1所示，包括了优化顾问服务的所有系统策略。 表1 优化顾问服务系统策略 策略名称 描述 依赖关系 策略类别 OA FullAccessPolicy 优化顾问服务所有权限。 无 系统策略 OA AdvancedOperationsPolicy 优化顾问服务的高级操作权限, 如执行可用性检查等，可以使用跨账号可用性检查功能 无 系统策略 OA CommonOperationsPolicy 优化顾问服务的常规操作权限, 如执行可用性检查等，但不能使用跨账号可用性检查功能。 无 系统策略 OA ReadOnlyAccessPolicy 优化顾问服务只读权限，只能查看检查结果、查看资源分组等，不能创建或执行。 无 系统策略 表2列出了优化顾问服务常用操作与系统策略的授权关系，您可以参照该表选择合适的系统策略。 表2 授权关系 功能 操作 OA FullAccessPolicy OA AdvancedOperationsPolicy OA CommonOperationsPolicy OA ReadOnlyAccessPolicy 风险检查总览 查看风险检查结果总览 √ √ √ √ 打开/关闭自动检查 √ √ √ × 查看通知主题 √ √ √ √ 选择账号 √ √ × × 执行检查 √ √ √ × 下载风险检查结果报告 √ √ √ √ 风险检查维度 查看风险检查维度 √ √ √ √ 查看单个检查项结果详情 √ √ √ √ 执行单个检查项检查 √ √ √ × 下载单个检查项结果报告 √ √ √ √ 架构设计 查看架构图列表 √ √ √ √ 查看回收站架构图列表 √ √ √ √ 查看回收站架构图详情 √ √ √ √ 恢复回收站架构图 √ √ √ × 删除回收站架构图 √ √ √ × 新建架构图 √ √ √ × 重命名架构图 √ √ √ × 导出架构图 √ √ √ √ 复制架构图 √ √ √ × 删除架构图 √ √ √ × 开启容量风险监控 √ √ √ × 查看架构图详情 √ √ √ √ 编辑架构图 √ √ √ × 查看架构图编辑历史列表 √ √ √ √ 查看架构图编辑历史详情 √ √ √ √ 恢复历史架构图 √ √ √ × 删除架构图编辑历史记录 √ √ √ × 查看图元全链路 √ √ √ √ 查看已选资源清单 √ √ √ √ 导出已选资源清单 √ √ √ √ 图元绑定资源 √ √ √ × 容量优化 查看容量优化分析结果概要信息 √ √ √ √ 查看容量优化分析结果详情列表 √ √ √ √ 删除容量优化分析结果列表数据 √ √ √ × 查看容量优化分析结果详情监控 √ √ √ √ 执行重新识别 √ √ √ × 执行停止分析 √ √ √ × 导出容量优化分析报告 √ √ √ √ 查询容量优化分析配置 √ √ √ √ 修改容量优化分析配置 √ √ √ × 查询容量优化分析报告列表 √ √ √ √ 删除容量优化分析报告 √ √ √ × 资源分组 查看资源分组列表 √ √ √ √ 查看资源分组详情 √ √ √ √ 修改资源分组 √ √ √ × 删除资源分组 √ √ √ × 新增资源分组 √ √ √ × 查看资源列表 √ √ √ √ 月度服务报告 查看月度报告列表 √ √ √ √ 查看月度报告详情 √ √ √ √ 导出月度报告 √ √ √ √ 风险检查历史 查看风险检查报告列表 √ √ √ √ 查看风险检查结果详情 √ √ √ √ 导出风险检查报告 √ √ √ √ 自定义规则 查看检查项列表 √ √ √ √ 启动检查项 √ √ √ × 停用检查项 √ √ √ × 恢复初始配置 √ √ √ × 自定义配置 √ √ √ × 授权 查看用户授权列表 √ √ √ √ 关闭/开启授权 √ × × × 关闭服务 √ × × ×

示例流程 图1 给用户授权OA权限流程 在IAM控制台创建用户组，并授予优化顾问服务权限“OA FullAccessPolicy”、“OA AdvancedOperationsPolicy”、“OA CommonOperationsPolicy”、“OA ReadOnlyAccessPolicy”，推荐授予OA FullAccessPolicy权限。 以上权限为优化顾问服务的全部权限，如您期望更精细化的优化顾问服务功能的权限，请参见：权限管理，对用户组授予对应权限。 创建用户 在IAM控制台创建用户，并将其加1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台，验证优化顾问服务的“OA FullAccessPolicy”权限。

示例流程 图1 给用户授权OA权限流程 在IAM控制台创建用户组，并授予优化顾问服务权限“OA FullAccessPolicy”、“OA AdvancedOperationsPolicy”、“OA CommonOperationsPolicy”、“OA ReadOnlyAccessPolicy”，推荐授予OA FullAccessPolicy权限。 以上权限为优化顾问服务的全部权限，如您期望更精细化的优化顾问服务功能的权限，请参见：权限管理，对用户组授予对应权限。 创建用户 在IAM控制台创建用户，并将其加1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台，验证优化顾问服务的“OA FullAccessPolicy”权限。

状态码 状态码如表1所示。 表1 状态码说明 状态码 编码 状态码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高版本的协议。 例如，切换到HTTPS的高版本协议。 200 OK 请求已成功。 201 Created 创建类的请求已成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求已成功，同时HTTPS响应不包含响应体。 在响应OPTIONS方法的HTTPS请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTPS状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTPS协议的版本，无法完成处理。 父主题： 公共参数

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "xxx", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

认证鉴权 KooSearch 服务支持通过Token认证进行认证鉴权。 Token的有效期为24小时，需要使用同一个Token鉴权时，可以缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中“auth.scope”的取值需要选择“project”，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //用户名 "password": "********", //登录密码 "domain": { "name": "domainname" //用户所属的账号名称 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 POST https://{endpoint}/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。 父主题： 如何调用API

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（即消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于“获取用户Token”接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，********为用户的登录密码，domainname为用户所属的账号名称，如果是账号本身获取token，username和domainname填为一致，xxxxxxxxxxxxxxxxxx为project的ID。 scope参数定义了Token的作用范围，表示获取的Token仅能访问指定project下的资源，scope参数的详细说明请参见：获取用户Token。 POST https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //用户名 "password": "********", //登录密码 "domain": { "name": "domainname " //用户所属的账号名称 } } } }, "scope": { "project": { "id": "xxxxxxxxxxxxxxxxxx" //项目ID } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于“获取用户Token”接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表 公共请求消息头。 表2 公共请求消息头 参数 是否必选 描述 Content-Type 是 消息体的类型（格式）。推荐用户使用默认值application/json。 X-Auth-Token 否（使用Token认证时必选） 用户Token。 调用“获取用户Token”接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头（Header）中包含的“X-Subject-Token”的值即为Token值。 对于“获取用户Token”接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.xxx.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求URI 请求URI由如下部分组成。 {URI-scheme}://{Endpoint}/{resource-path} 表1 请求URL 参数 说明 URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器 域名 或IP，不同服务在不同区域，Endpoint不同，可以参考终端节点获取。例如IAM服务在“西南-贵阳一”区域的Endpoint为“iam.cn-southwest-2.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 例如您需要获取“西南-贵阳一”区域的token，则需使用“西南-贵阳一”区域的Endpoint（iam.cn-southwest-2.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（v3/auth/toknes），拼接起来如下所示。 https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，每个具体API的URI，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-southwest-2.myhuaweicloud.com/v3/auth/tokens

API概览 Koosearch提供的接口为符合RESTful API设计规范的自研接口。通过Koosearch的自研接口，您可以使用Koosearch的表1 接口说明所示的功能。 表1 接口说明 类型 说明 知识库管理接口 知识库管理等相关接口。 结构化数据接口 将结构化数据文件纳入系统进行管理接口。 文件管理接口 用户纳入系统的文档管理接口。 FAQ管理接口 用户自定义的FAQ相关管理接口。 FAQ批量管理接口 用户自定义的批量FAQ相关管理接口。 搜索与问答接口 Koosearch的搜索与模型问答接口。 对话历史接口 用户对话历史接口。 图片管理接口 图片管理相关接口。 模型管理接口 模型管理的相关接口。 用户的文档解析规则定义接口 用户文档解析自定义规则配置接口。 表2 知识库管理接口 API 说明 创建知识库 创建名称为xxx的知识库。 修改知识库配置 修改知识库配置。包括： 解析设置：是否使用OCR增强、是否需要解析图片、是否需要解析页眉页脚、是否需要解析目录页。 文档拆分设置： 自动分段 长度分段（按文本长度分段） 层级分段（按小标题分段，可自定义小标题解析规则 搜索模型设置：rerank模型配置。 NLP模型设置。 其他设置：召回数量、参考文档数量、精排开关、Query改写开关、意图分类。 设置知识库搜索问答prompt 设置知识库搜索问答prompt，该prompt包括参考文档占位符{0}和搜索query占位符{1}。可以根据不同的使用场景，配置不同的prompt，例如增加人设、限定条件、答案格式要求等，帮助模型生成更优的结果。 设置通用问答prompt 设置通用问答prompt。该prompt包含问题占位符{0}，和对回答的要求。 开启知识库 根据ID开启知识库，知识库开启后为可检索状态。 关闭知识库 根据ID关闭知识库，知识库关闭后为不可检索状态。 获取知识库列表 获取当前账号下所有知识库列表。包括知识库ID、知识库名称、知识库状态、创建人、创建时间、更新时间等。 查询知识库详情 根据知识库ID获取当前知识库下的所有文件list，包括文档名称、文档类型、文档大小、文档状态、创建人、创建时间等。 删除知识库 根据ID删除知识库。 表3 结构化数据接口 API 说明 结构化数据上传 将结构化数据文件上传到 对象存储服务 OBS中进行结构化数据批处理功能。 下载失败的条目 下载一个JSON文件，该文件包含给定上传Field的失败条目。 结构化数据文件搜索 根据文件名搜索目标文件。 表4 文件管理接口 API 说明 上传文件 上传文件至某个知识库。 查询文件 在当前知识库查询名称为xx的文件。 下载文件 下载指定ID的文件。 删除文件 删除指定ID的文件。 表5 FAQ管理接口 API 说明 创建FAQ 输入问题、相似问题、答案，创建单条FAQ。 更新FAQ 更新指定ID的FAQ的问题、答案、相似问题。 获取FAQ 根据ID获取FAQ详情，包括问题、答案。 查询FAQ列表 获取FAQ列表，包括ID、问题、答案、创建人、创建时间等。可以根据问题关键字过滤出需要查看的FAQ。 删除FAQ 根据知识库ID和FAQ的ID，删除FAQ。 批量删除FAQ 选择多个需要删除的FAQ，根据ID批量删除。 表6 FAQ批量管理接口 API 说明 批量FAQ上传 上传xlsx/xls文件，用于FAQ的批量导入。 下载上传失败的FAQ 下载给定上传的批量FAQ文件中，上传失败的条目。 列举批量上传faq文件 列举批量上传faq文件。 下载批量导入FAQ原文件 下载批量导入FAQ的原始文件。 删除批量导入FAQ文件 删除指定的FAQ文件。 表7 搜索与问答接口 API 说明 搜索知识库 根据query，在指定知识库中搜索得到topN相关的结果。 生成答案 将content输入给模型，使用模型能力生成答案。 表8 对话历史接口 API 说明 查询对话历史列表 查询历史问题列表。包含对话ID、对话问题、用户名、对话开始时间。 获取对话历史 根据chat_id获取对话历史，返回历史的question和answer数据。 删除对话历史 根据指定ID，删除对应的对话历史。 批量删除对话历史 根据多个ID，批量删除对话历史信息。 表9 图片管理接口 API 说明 上传图片 上传图片入库。 获取图片内容 根据ID获取图片内容。 表10 模型管理接口 API 说明 新增模型 新增配置模型，包括模型名称、模型描述、模型endpoint、模型配置。 修改模型配置 修改模型。 列举模型 列举模型。 删除模型 删除模型。 表11 用户的文档解析规则定义接口 API 说明 创建用户解析规则 列用于创建用户自定义的解析规则，解析规则用于解析需要作为subtitle的文本，规则由上而下依次校验。 修改用户解析规则 用于修改已配置的解析规则。 列举用户规则列表 列举用户配置的所有解析规则列表。 删除用户定义规则解析接口 用于删除用户定义的某种规则。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在API凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 Checkpoint：消费检查点。应用程序消费数据时，记录已消费数据的最新序列号作为检查点。当重新消费数据时，可根据此检查点继续消费。 APP：应用程序标识符。当多个应用程序分别消费同一通道的数据时，为区分不同应用程序的消费检查点，使用APP作为标识。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 父主题： 使用前必读

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 file_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

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

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 file_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

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

请求示例 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/upload file

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 接口鉴权使用的Token，Token获取方式参考：获取IAM用户Token 最小长度：1 最大长度：1000000 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 仅支持JSON文件上传 rule 否 String 问题匹配规则 最小长度：0 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 file_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

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

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

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

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

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

响应示例 状态码： 200 知识库详情响应体 { "id" : "1234545", "name" : "知识库123", "detail" : "金融知识库", "status" : "OPEN", "create_user" : "", "create_time" : "", "update_time" : "1693921595857", "fields" : [ { "name" : "id", "field_type" : "keyword", "name_zh" : "id" } ] }

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

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of ErrorRsp objects 请求错误 表4 ErrorRsp 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表5 响应Body参数 参数 参数类型 描述 [数组元素] Array of ErrorRsp objects 图片不存在 表6 ErrorRsp 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 [数组元素] Array of ErrorRsp objects 内部异常 表8 ErrorRsp 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512