华为云用户手册

操作场景 当您确认不再使用当前集群后，可以删除当前 CDM 集群。 删除CDM集群后集群以及数据都销毁且无法恢复，请您谨慎操作！ 删除集群前，请您确认如下注意事项： 待删除集群确认已不再使用。 待删除集群中所需的连接和作业数据已通过批量管理CDM作业中的导出作业功能进行备份。 对于购买 DataArts Studio 服务时系统赠送的CDM集群，非常不建议您进行删除操作。该集群删除后无法再次赠送，只能另外购买。 删除集群后，CDM集群不再按需计费或扣除套餐时长。如果您为删除的CDM集群购买了CDM折扣套餐或包年包月形式的DataArts Studio数据集成增量包，则请参考云服务退订章节进行套餐包退订。

创建CDM集群并绑定EIP 如果是独立CDM服务，参考创建集群创建CDM集群；如果是作为DataArts Studio服务CDM组件使用，参考创建集群创建CDM集群。 关键配置如下： CDM集群的规格，按待迁移的数据量选择，一般选择cdm.medium即可，满足大部分迁移场景。 CDM集群创建完成后，选择集群操作列的“绑定弹性IP”，CDM通过EIP访问MySQL。 图1 集群列表 如果用户对本地数据源的访问通道做了SSL加密，则CDM无法通过弹性IP连接数据源。

请求示例 分页查询Agent资产列表，每页10条，查询第1页。 http://xxx.x.x.x:xxxx/v1/routes/open/queryApplicationDetailList { "isPublic" : "Y", "filter" : { "type" : "agent", "tags" : [ ] }, "page" : { "currentPage" : 1, "pageSize" : 10 } }

响应示例 状态码：200 调用接口成功。 { "data" : { "total" : 1, "applicationDeployList" : [ { "id" : "6011120231120194500011", "appSettings" : "", "appUri" : null, "webUri" : null, "settings" : null, "description" : "问数是基于大模型与数据分析核心技术的AI智能应用，用户无需掌握复杂的SQL知识，通过自然语言文字或语音对话即可完成深入数据挖掘、辅助提供决策建议，轻松完成多种业务场景下的数据查询、数据分析以及结果的可视化输出；体验版提供了基于测试数据的功能体验，欢迎试用。", "isPublic" : "Y", "logoUrl" : "/v1/obs/image/application/interfaceDef/assertQuestioningTrialVersion.png", "type" : "agent", "industry" : "internet", "ownerType" : "other", "ownerId" : "", "extInfo" : "{\"mode\":\"thirdParty\",\"url\":\"https://hwcd.jointpilot.com\"}", "tenantId" : null, "tags" : [ "通用", "问数" ], "hasApikey" : false, "apiInfo" : "", "ext2Info" : "", "deleted" : false, "deptCode" : null, "documentUrl" : "", "createDate" : "2024/12/31 00:00:00", "createdDate" : "2024/12/31 00:00:00", "videoUrl" : null, "hyperlinkUrl" : null, "imageUrl" : null, "iconUrl" : "https://wise-agent-1.obs.cn-north-5.myhuaweicloud.com:443/application/interfaceDef/assertQuestioningTrialVersion.png?AccessKeyId=WBKUD4EGREIAL7UN4KV2&Expires=1739365207&x-obs-security-token=ggpjbi1ub3J0aC01TqJ7ImFjY2VzcyI6Ild CS 1VENEVHUkVJQUw3VU40S1YyIiwibWV0aG9kcyI6WyJ0b2tlbiJdLCJyb2xlIjpbXSwicm9sZXRhZ2VzIjpbXSwidGltZW91dF9hdCI6MTczOTI3OTcwNzM4MCwidXNlciI6eyJkb21haW4iOnsiaWQiOiIyMDU0YmRlMDI4MTc0MzQyODQ4YTFkMDVlOTUxMDQ4YSIsIm5hbWUiOiJISVNfV2lzZUNsb3VkX2RldiJ9LCJpZCI6ImNiNzllMGY1YThkOTQ0YTZiZDY4YWFiNmNmZGY3OWJhIiwibmFtZSI6InowMDc3MTE4NCIsInBhc3N3b3JkX2V4cGlyZXNfYXQiOiIiLCJ1c2VyX3R5cGUiOjE2fX084pGeu6B3ngytwBJX93IDWjFolzhjnbGQFxonBCjDw_sYcDUgx17RQKtHGE2JV7iXZ24JVx6j_ijPAIgjfcwQ7Jk4SopzOX-9SJ6BRfv8LxvgFtqUloa_8BH1ylyIOb9u-6HMGb8TZHqiQve2hfssIbx2jzj9i9aejXLtBIQwgQt1pNUoQ-4lNP_HZK-dkYS2eJuXWrUQIBmGIRp_cERuxi_4py7aDGk5dhD_12zXvoTA044ChCMg1Q1Yk9Io_bPi-fNVu4pxArPW_sWWSARKCBfmNVJbbNyKgOpIPGzZWKdJqfPXMwoD_DVQjixP17I1R_mSZLWQgjFywvSseIGE&Signature=ZIZfH%2F%2Fykp4%2Fm25cb9xVSxvnFQw%3D", "lastUpdateDate" : "2024/06/16 08:00:00", "lastUpdatedDate" : "2024/06/16 08:00:00", "createdByUserId" : "Admin_Admin_Admin", "createdByUserName" : null, "lastUpdatedByUserId" : "Admin_Admin_Admin", "lastUpdatedByUserName" : null, "status" : "released", "isFavourite" : "N", "notebookDto" : null, "orchestrationEntityVo" : null, "swaggerAnalysisFileDto" : null, "name" : "问数体验版" } ] } } 状态码：400 缺少请求体。 { "error_code" : "AIAE.00001400", "error_msg" : "Request body is missing" } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.00001500", "error_msg" : "Internal Server Error." }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 data data object 参数解释： 查询成功时接口返回数据。 取值范围： 不涉及。 error_msg String 参数解释： 错误描述。 取值范围： 不涉及。 error_code String 参数解释： 错误码。 取值范围： 不涉及。 表6 data 参数 参数类型 描述 applicationDeployList BatchQueryList object 参数解释： 批量查询总数和Agent列表。 取值范围： 不涉及。 表7 BatchQueryList 参数 参数类型 描述 total Integer 参数解释： 查询总数。 取值范围： 不涉及。 applicationDeployList Array of ApplicationSingleInfoDto objects 参数解释： 查询返回Agent列表。 取值范围： 不涉及。 表8 ApplicationSingleInfoDto 参数 参数类型 描述 id String 参数解释： 主键ID。 取值范围： 不涉及。 appSettings String 参数解释： Agent设置。 取值范围： 不涉及。 appUri String 参数解释： 发布的Agent OpenAPI。 取值范围： 不涉及。 webUri String 参数解释： 发布的Agent访问URL。 取值范围： 不涉及。 settings String 参数解释： 已废弃。 取值范围： 不涉及。 description String 参数解释： Agent描述。 取值范围： 不涉及。 isPublic String 参数解释： 是否公共资产。 取值范围： 不涉及。 logoUrl String 参数解释： Agent icon路径。 取值范围： 不涉及。 type String 参数解释： 资产类型。 取值范围： 不涉及。 industry String 参数解释： 所属行业，预留字段。 取值范围： 不涉及。 ownerType String 参数解释： 开发模式，预留字段。 取值范围： 不涉及。 ownerId String 参数解释： 子表ID，已废弃。 取值范围： 不涉及。 extInfo String 参数解释： 扩展字段。 取值范围： 不涉及。 tenantId String 参数解释： 租户ID。 取值范围： 不涉及。 tags Array of strings 参数解释： 标签。 取值范围： 不涉及。 hasApikey Boolean 参数解释： 已废弃。 取值范围： 不涉及。 apiInfo String 参数解释： 已废弃。 取值范围： 不涉及。 ext2Info String 参数解释： 已废弃。 取值范围： 不涉及。 deleted Boolean 参数解释： 是否删除。 取值范围： 不涉及。 deptCode String 参数解释： 部门Code。 取值范围： 不涉及。 documentUrl String 参数解释： 预置文件OBS路径。 取值范围： 不涉及。 createDate String 参数解释： 已废弃。 取值范围： 不涉及。 createdDate String 参数解释： 创建时间。 取值范围： 不涉及。 videoUrl String 参数解释： 视频路径。 取值范围： 不涉及。 hyperlinkUrl String 参数解释： 门户访问路径。 取值范围： 不涉及。 imageUrl String 参数解释： Agent描述图片。 取值范围： 不涉及。 iconUrl String 参数解释： 可下载的icon URL。 取值范围： 不涉及。 lastUpdateDate String 参数解释： 已废弃。 取值范围： 不涉及。 lastUpdatedDate String 参数解释： 最后更新时间。 取值范围： 不涉及。 createdByUserId String 参数解释： 创建用户ID。 取值范围： 不涉及。 createdByUserName String 参数解释： 创建用户名称。 取值范围： 不涉及。 lastUpdatedByUserId String 参数解释： 最后更新用户ID。 取值范围： 不涉及。 lastUpdatedByUserName String 参数解释： 最后更新用户名称。 取值范围： 不涉及。 status String 参数解释： 发布状态。 取值范围： 不涉及。 isFavourite String 参数解释： 是否收藏。 取值范围： 不涉及。 notebookDto String 参数解释： 已废弃。 取值范围： 不涉及。 orchestrationEntityVo String 参数解释： 已废弃。 取值范围： 不涉及。 swaggerAnalysisFileDto String 参数解释： 已废弃。 取值范围： 不涉及。 name String 参数解释： Agent名称。 取值范围： 不涉及。 状态码：400 表9 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 参数解释： 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 status 否 String 参数解释： 根据Agent状态筛选，预留字段，可不填。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 isPublic 是 String 参数解释： 查询对外开放资产。 约束限制： 不涉及。 取值范围： Y。 默认取值： 不涉及。 filter 是 Filter object 参数解释： 查询过滤条件。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 page 是 Page object 参数解释： 分页条件。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 Filter 参数 是否必选 参数类型 描述 type 是 String 参数解释： 应用广场类型过滤字段。 约束限制： 不涉及。 取值范围： agent。 默认取值： 不涉及。 industry 否 String 参数解释： 行业筛选字段，预留字段，可不填。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 name 否 String 参数解释： 按名称搜索，预留字段，可不填。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 tags 否 Array of strings 参数解释： 根据标签筛选，预留字段，可不填。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 status 否 String 参数解释： 根据Agent状态筛选，预留字段，可不填。 约束限制： 不涉及。 取值范围： released。 默认取值： 不涉及。 表4 Page 参数 是否必选 参数类型 描述 pageSize 是 Integer 参数解释： 分页每页大小。 约束限制： 不涉及。 取值范围： [1-1000]。 默认取值： 不涉及。 currentPage 是 Integer 参数解释： 当前页数。 约束限制： 不涉及。 取值范围： [1-10000]。 默认取值： 不涉及。

状态码 状态码如表1所示 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 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 已经被废弃的HTTP状态码。 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 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于文本对话接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "created": 1718772336, "usage": { "completion_tokens": 23, "prompt_tokens": 45, "total_tokens": 68 }, "model": "chatglm3-6b", "id": "chatcmpl-xxx", "choices": [{ "finish_reason": "stop", "index": 0, "message": { "role": "assistant", "content": "你好，有什么我可以帮助你的吗？" }, "logprobs": null }], "object": "chat.completion" } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_code": "AIAE.31001702", "error_msg": "Model not exists, please check and try again later!" } 其中，error_code表示错误码，error_msg表示错误描述信息。

AK/SK认证 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名。详细的签名认证操作流程如下。 AK/SK申请 使用具有管理员权限（admin）账号登录到AI原生应用引擎，从凭证管理进入到AK/SK访问密钥页面，新建AK/SK。 每个用户只能同时拥有两个AK/SK凭证。 AK/SK下载 成功创建AK/SK后，会立刻弹出AK/SK凭证下载弹窗，下载后得到凭证文件。 每个凭证仅能下载一次，且无法找回，请妥善保管凭证文件。 使用AK/SK鉴权 在请求头里添加如下header： ts: 毫秒时间戳 nonce: 请求唯一标识（UUID） ak: 凭证文件中的AK明文 resource-code: WiseAgent对外开放接口对应的唯一编码，每个接口唯一 sign: 按如下规则拼接字符串"ts={变量名}&nonce={nonce}&ak={ak}"，对拼接得到的字符串plain进行SHA256散列后得到散列值hash，再使用凭证中的SK明文对刚才生产的hash进行再散列，最后进行Base64转码，得到签名字符串。 签名样例代码（JAVA）： public String sha256(String plain) { try { MessageDigest messageDigest = MessageDigest.getInstance("SHA-256"); messageDigest.update(plain.getBytes(StandardCharsets.UTF_8)); byte[] bytes = messageDigest.digest(); StringBuffer hexBuffer = new StringBuffer(); for (byte aByte : bytes) { String hex = Integer.toHexString(0xff & aByte); if (hex.length() == 1) { hexBuffer.append('0'); } hexBuffer.append(hex); } return hexBuffer.toString(); } catch (NoSuchAlgorithmException ignore) { } } public String hmacSha256(String hash, String sk) { try { Mac hmacSHA256 = Mac.getInstance("HmacSHA256"); SecretKeySpec secretKeySpec = new SecretKeySpec(sk.getBytes(StandardCharsets.UTF_8), "HmacSHA256"); hmacSHA256.init(secretKeySpec); byte[] bytes = hmacSHA256.doFinal(hash.getBytes(StandardCharsets.UTF_8)); return Base64.encodeBase64String(bytes); } catch (NoSuchAlgorithmException | InvalidKeyException ignore) { } }

API Key认证 API Key全称为应用程序接口密钥，是一种用于验证和授权API请求的代码。它通常是一串字符，用于识别调用API的应用程序和开发者。 获取API Key 以管理员身份登录AI原生应用引擎工作台，参考创建API Key获取。 使用API Key鉴权 调用时，在请求头里新增字段Authorization，值填写为Bearer ${API Key}，拼接起来如下所示。 Authorization:Bearer sk-5db9*********dd58

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。如果请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于文本对话接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。 POST https://aiae.appstage.myhuaweicloud.com/v1/chat/completions { "model": "platform:chatglm3-6b", "messages": [ { "role": "user", "content": "你好!" } ], "stream": false } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，当前AppStage服务只在“华北-北京四”部署，Endpoint为“aiae.appstage.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如文本对话API的resource-path为“/v1/chat/completions”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如，您需要调用AppStage在“华北-北京四”区域的文本对话接口，则需使用“华北-北京四”区域的Endpoint（aiae.appstage.myhuaweicloud.com），并在文本对话的URI部分找到resource-path（/v1/chat/completions），拼接起来如下所示。 https://aiae.appstage.myhuaweicloud.com/v1/chat/completions 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在调用文本对话接口的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://aiae.appstage.myhuaweicloud.com/v1/chat/completions

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3和表4。 表3 AK/SK认证公共请求消息头 名称 描述 是否必选 示例 Content-Type 消息体的类型（格式），当前只支持application/json。 是 application/json ts 毫秒时间戳。 是 1707101222000 nonce 请求唯一标识（UUID）。从AK/SK认证中获取。 是 - ak 为AK/SK凭证文件中的AK明文。从AK/SK认证中获取。 是 - sign 签名字符串。从AK/SK认证中获取。 是 - resource-code WiseAgent对外开放接口对应的唯一编码，每个接口唯一。请参考表5。 是 modelmarket.chat 表4 API Key认证公共请求消息头 名称 描述 是否必选 示例 Content-Type 消息体的类型（格式），当前只支持application/json。 是 application/json Authorization 认证信息。格式为：Bearer ${API Key} 是 Bearer sk-5db9*********dd58 表5 Resource-code Resource-code 接口 modelrouter.chat 调用文本对话模型服务 modelrouter.embeddings 调用文本向量化模型服务 knowledgeBases.query.embeddata 检索知识库数据

基本概念 大模型推理服务 直接调用预置大模型提供API完成推理过程。 私有模型部署 针对已经微调训练好的模型，如需评测此模型效果，或通过应用调用此模型，则需将模型部署为线上服务。 向量知识库 通过引入多种类型和格式的企业知识，将数据转化为向量，并利用高效的存储和索引方式进行查询，实现基于检索增强的大模型能力。 工作流 任务流程的细化分解是一种有效策略，能够简化系统架构，并降低对大语言模型能力的过度依赖。通过将繁复的工作拆解为一系列独立节点，不仅增强了复杂任务处理的效率，还在很大程度上提升了整个系统的透明度、鲁棒性和错误容忍度。这种方法使得LLM的应用范围得以扩大，即便面对高度复杂的任务也能表现出色。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 参数解释： 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 - 否 String 参数解释： 知识库召回状态。 约束限制： 不涉及。 取值范围： 枚举值：ENABLE（启用召回）与DISABLE（禁用召回）。 默认取值： 不涉及。

响应示例 状态码：200 操作成功，返回执行记录信息。 { "data" : { "id" : "djh28e62-3a81-4018-a48f-a15be0d63812", "result" : "SUC CES S", "progress" : 100.0, "run_time" : 27684, "start_time" : "2024-11-22T03:15:49.000+00:00", "end_time" : "2024-11-22T03:16:17.000+00:00", "log_detail" : "开始任务......结束任务" } } 状态码：400 请求错误。 { "error_code" : "AIAE.40001001", "error_msg" : "参数xxxx不合法。" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 data ExecutionRecord object 参数解释： 执行记录与日志。 取值范围： 不涉及。 表4 ExecutionRecord 参数 参数类型 描述 id String 参数解释： 任务执行记录id。 取值范围： 由数字、字母和中划线组成，长度36。 result String 参数解释： 任务执行结果。 取值范围： 枚举值：SUCCESS（任务执行成功）、FAILURE（任务执行失败）、SKIP（跳过）、RUNNING（任务正在执行）。 progress Float 参数解释： 任务执行进度。 取值范围： 范围[0,100]。 run_time Long 参数解释： 任务执行时长，单位毫秒。 取值范围： 不涉及。 start_time String 参数解释： 任务开始时间。 取值范围： 格式为：yyyy-mm-ddThh:mm:ss.000+00:00，如2024-11-21T11:36:55.000+00:00。 end_time String 参数解释： 任务结束时间。 取值范围： 格式为：yyyy-mm-ddThh:mm:ss.000+00:00，如2024-11-21T11:36:55.000+00:00。 log_detail String 参数解释： 任务日志详细信息。 取值范围： 不涉及。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 异常错误码。 取值范围： 不涉及。 error_msg String 参数解释： 异常错误信息。 取值范围： 不涉及。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 data ExecutionRecord object 参数解释： 执行记录与日志。 取值范围： 不涉及。 表4 ExecutionRecord 参数 参数类型 描述 id String 参数解释： 任务执行记录id。 取值范围： 由数字、字母和中划线组成，长度36。 result String 参数解释： 任务执行结果。 取值范围： 枚举值：SUCCESS（任务执行成功）、FAILURE（任务执行失败）、SKIP（跳过）、RUNNING（任务正在执行）。 progress Float 参数解释： 任务执行进度。 取值范围： 范围[0,100]。 run_time Long 参数解释： 任务执行时长，单位毫秒。 取值范围： 不涉及。 start_time String 参数解释： 任务开始时间。 取值范围： 格式为：yyyy-mm-ddThh:mm:ss.000+00:00，如2024-11-21T11:36:55.000+00:00。 end_time String 参数解释： 任务结束时间。 取值范围： 格式为：yyyy-mm-ddThh:mm:ss.000+00:00，如2024-11-21T11:36:55.000+00:00。 log_detail String 参数解释： 任务日志详细信息。 取值范围： 不涉及。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 异常错误码。 取值范围： 不涉及。 error_msg String 参数解释： 异常错误信息。 取值范围： 不涉及。

响应示例 状态码：200 操作成功，返回执行记录信息。 { "data" : { "id" : "djh28e62-3a81-4018-a48f-a15be0d63812", "result" : "SUCCESS", "progress" : 100.0, "run_time" : 27684, "start_time" : "2024-11-22T03:15:49.000+00:00", "end_time" : "2024-11-22T03:16:17.000+00:00", "log_detail" : "开始任务......结束任务" } } 状态码：400 请求错误。 { "error_code" : "AIAE.40001001", "error_msg" : "参数xxxx不合法。" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 data KnowledgeDataSetDetail object 参数解释： 知识数据集详情。 取值范围： 不涉及。 表4 KnowledgeDataSetDetail 参数 参数类型 描述 data_set_versions Array of KdsVersionInfo objects 参数解释： 知识数据集版本配置信息列表。 取值范围： 列表最大长度100。 index_configs Array of KdsIndexConfigInfo objects 参数解释： 知识数据集索引配置信息列表。 取值范围： 列表最大长度100。 表5 KdsVersionInfo 参数 参数类型 描述 id String 参数解释： 数据集版本id。 取值范围： 由数字、字母和中划线组成，长度36。 version String 参数解释： 数据集版本号。 取值范围： 格式为：vyyyy-mm-ddThh:mm:ssZ，如v2024-11-21T11:36:55Z。 created_date String 参数解释： 数据集版本创建时间。 取值范围： 格式为：yyyy-mm-dd hh:mm:ss，如2024-11-21 11:36:55。 last_updated_date String 参数解释： 数据集版本最近更新时间。 取值范围： 格式为：yyyy-mm-dd hh:mm:ss，如2024-11-21 11:36:55。 表6 KdsIndexConfigInfo 参数 参数类型 描述 id String 参数解释： 索引id。 取值范围： 由数字、字母和中划线组成，长度36。 name String 参数解释： 索引名称。 取值范围： 由中英文、数字、“_”组成，长度为[2-50]。 description String 参数解释： 索引描述。 取值范围： 不涉及。 data_set_id String 参数解释： 知识数据集id。 取值范围： 由数字、字母和中划线组成，长度36。 vector_model_service_key String 参数解释： 向量化模型的service_key。 取值范围： 不涉及。 index_vector_config IndexVectorConfig object 参数解释： 索引向量化配置。 取值范围： 不涉及。 表7 IndexVectorConfig 参数 参数类型 描述 long_text_solution String 参数解释： 知识数据集切片长文本处理方式。 取值范围： 枚举值： TRUNCATE_MODE（截断模式：如果分片的token长度超过向量化模型的token数，则自动对超长部分进行截断处理）。 SMART_MODE（智能模式：如果分片的token长度超过向量化模型的token数，则知识库向量化失败）。 DEFAULT_MODE（默认模式：如果分片的token长度超过向量化模型的token数，则知识库向量化失败）。 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 异常错误码。 取值范围： 不涉及。 error_msg String 参数解释： 异常错误信息。 取值范围： 不涉及。

响应示例 状态码：200 操作成功，返回数据集详情。 { "data" : { "data_set_versions" : [ { "id" : "askdjh28e62-xxxxxxxxx-a15be0d63812", "version" : "v2024-11-21T11:36:55Z", "created_date" : "2024-11-11 19:36:57", "last_updated_date" : "2024-11-21 19:36:57" } ], "index_configs" : [ { "id" : "d3f28e62-xxxxxxx-a15be0d638a2", "name" : "索引配置名称", "description" : "索引配置", "data_set_id" : "d3f28e62-3a81-4018-a48f-a15be0d638a2", "vector_model_service_key" : "service_key", "index_vector_config" : { "long_text_solution" : "TRUNCATE_MODE" } } ] } } 状态码：400 请求错误。 { "error_code" : "AIAE.40001001", "error_msg" : "参数xxxx不合法。" }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 参数解释： 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 file 是 File 参数解释： 文件内容，目前仅支持jpg、png、jpeg格式的图片。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 type 是 String 参数解释： 文件类型，目前仅支持image图片类型。 约束限制： 不涉及。 取值范围： image 默认取值： 不涉及。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 id String 参数解释： 文件ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 temp_url String 参数解释： 文件的临时访问外链。 取值范围： 只由英文字母、数字以及“/”、“_”、“-”组成。 expire_time String 参数解释： 文件的临时访问外链的过期时间。 取值范围： 不涉及。 状态码：500 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。

响应示例 状态码：200 成功。 { "data" : { "id" : "file_id", "temp_url" : "temporary url of file which can access for some time", "expire_time" : "current temporary url will expire at this time" } } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.22009001", "error_msg" : "Internal Server Error." }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 参数解释： 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 file 是 File 参数解释： 文件内容，目前仅支持jpg、png、jpeg格式的图片。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 type 是 String 参数解释： 文件类型，目前仅支持image图片类型。 约束限制： 不涉及。 取值范围： image 默认取值： 不涉及。

响应示例 状态码：200 成功。 { "data" : { "id" : "1234567-1234-1234-1234-1234-123451234512", "type" : "swagger", "name" : "example tool", "description" : "example description", "icon" : "base64 string", "created_time" : "2025-02-06T00:00:00.000+00:00", "updated_time" : "2025-02-06T00:00:00.000+00:00", "status" : "released", "swagger" : { "security" : [ ], "basePath" : "/", "host" : "example.com", "schemas" : [ "https" ], "securityDefinitions" : { }, "swagger" : "2.0", "info" : { "x-can-modify-host-address" : "false", "description" : "example description", "x-cdm-visibility" : false, "title" : "example tool", "version" : "1.0.0", "x-hw-color" : "#14a8ff", "x-hw-icon" : "icon-huawei-default-5" } }, "auth_content" : { }, "version" : "1", "category" : null, "need_auth" : "false", "auth_id" : null, "action_count" : 2, "trigger_count" : 0, "provider_name" : null, "release_version" : null, "favorite" : null, "connector_type" : "PRIVATE", "connector_status" : "OFFBOARD" } } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.22009001", "error_msg" : "Internal Server Error." }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 id String 参数解释： 工具ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 name String 参数解释： 工具名称。 取值范围： 支持中英文、数字、下划线（_）、中划线（-）、小括号（）、空格，2-50个字符，以中英文、数字开头。 description String 参数解释： 工具描述。 取值范围： 只能包含英文、中文、数字、下划线、中划线、空格及,，。.()（） ;；:、 connector_id String 参数解释： 执行动作对应的工具ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 connector_version String 参数解释： 工具的版本号。 取值范围： 正整数。 created_time String 参数解释： 创建时间。 取值范围： 不涉及。 updated_time String 参数解释： 修改时间。 取值范围： 不涉及。 test_result String 参数解释： 最近一次测试结果。 取值范围： 不涉及。 swagger Object 参数解释： swagger文档（只包含基本信息+认证信息）。 取值范围： 不涉及。 definition Object 参数解释： 操作or触发器的详细定义。 取值范围： 不涉及。 operation_id String 参数解释： 执行动作ID。 取值范围： 正整数。 category String 参数解释： 分类。 取值范围： 不涉及。 action_type String 参数解释： 执行动作的类型。 取值范围： 不涉及。 visibility String 参数解释： 标记动作在流编排是否可见。 取值范围： 不涉及。 english_name String 参数解释： 执行动作英文名称。 取值范围： 不涉及。 状态码：500 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。

响应示例 状态码：200 成功。 { "data" : { "id" : "uuid", "name" : "action name", "description" : "example description", "connector_id" : "connector id", "connector_version" : "4", "created_time" : "2025-02-06T12:00:05.000+00:00", "updated_time" : "2025-02-06T12:00:05.000+00:00", "test_result" : null, "category" : null, "swagger" : { "/test" : { "post" : { "summary" : "action name", "description" : "action description", "operationId" : "uuid", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "", "required" : false, "schema" : { "type" : "object", "required" : [ "input" ], "properties" : { "input" : { "type" : "string", "format" : "input", "description" : "输入", "default" : "", "x-hw-visibility" : "none", "x-hw-label" : "输入", "x-hw-format" : "input", "x-hw-select-options" : [ ], "x-hw-default" : "" } } }, "x-hw-body-required" : true } ], "responses" : { "200" : { "description" : "请求成功", "headers" : { }, "schema" : { "type" : "object", "properties" : { "output" : { "type" : "string", "format" : "input", "description" : "输出", "default" : "", "x-hw-visibility" : "none", "x-hw-label" : "输出", "x-hw-format" : "input", "x-hw-select-options" : [ ], "x-hw-default" : "" } } } } }, "x-hw-visibility" : "none", "x-model" : { "input-MappingConfig" : { "rules" : [ ] }, "input-is-model-mapping" : false, "input-model" : { }, "output-MappingConfig" : { "rules" : [ ] }, "output-is-model-mapping" : false, "output-model" : { } } } } }, "definition" : { "id" : "uuid", "name" : "action name", "description" : "action description", "type" : "action", "is_include_required" : true, "props" : { "query" : { }, "path" : { }, "header" : { }, "form" : { }, "body" : { "input" : { "type" : "string", "format" : "input", "description" : "输入", "default" : "", "x-hw-visibility" : "none", "x-hw-label" : "输入", "x-hw-format" : "input", "x-hw-select-options" : [ ], "x-hw-default" : "", "required" : true } }, "trigger" : { } }, "props_present" : { "body" : { "type" : "object", "required" : [ "input" ] }, "body/input" : { "type" : "string", "format" : "input", "description" : "输入", "default" : "", "x-hw-visibility" : "none", "x-hw-label" : "输入", "x-hw-format" : "input", "x-hw-select-options" : [ ], "x-hw-default" : "", "required" : true } }, "response" : { "200" : { "props" : { "header" : { }, "body" : { "output" : { "type" : "string", "format" : "input", "description" : "输出", "default" : "", "x-hw-visibility" : "none", "x-hw-label" : "输出", "x-hw-format" : "input", "x-hw-select-options" : [ ], "x-hw-default" : "", "required" : false } }, "query" : null, "path" : null, "form" : null }, "props_present" : { "body/output" : { "type" : "string", "format" : "input", "description" : "输出", "default" : "", "x-hw-visibility" : "none", "x-hw-label" : "输出", "x-hw-format" : "input", "x-hw-select-options" : [ ], "x-hw-default" : "", "required" : false }, "header" : { "type" : "object", "description" : "响应头", "x-hw-label" : "响应头" }, "body" : { "type" : "object", "description" : "响应体", "x-hw-label" : "响应体" } } } }, "polling_config" : null }, "operation_id" : "uuid", "action_type" : "api", "visibility" : "none", "english_name" : "example english name" } } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.22009001", "error_msg" : "Internal Server Error." }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 id String 参数解释： 执行动作ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 type String 参数解释： 执行动作类型。 取值范围： swagger name String 参数解释： 执行动作名称。 取值范围： 支持中英文、数字、下划线（_）、中划线（-）、小括号（）、空格，2-50个字符，以中英文、数字开头。 description String 参数解释： 执行动作描述。 取值范围： 只能包含英文、中文、数字、下划线、中划线、空格及,，。.()（） ;；:、 icon String 参数解释： 执行动作图标。 取值范围： 合法的base64编码。 created_time String 参数解释： 执行动作创建时间。 取值范围： 不涉及。 updated_time String 参数解释： 执行动作更新时间。 取值范围： 不涉及。 status String 参数解释： 工具状态。 取值范围： dev：草稿 released：已发布 onboard：已上架 swagger Object 参数解释： 执行动作的swagger信息。 取值范围： 不涉及。 auth_content String 参数解释： 安全认证配置内容。 取值范围： 不涉及。 version String 参数解释： 工具版本。 取值范围： 不涉及。 category String 参数解释： 工具类别。 取值范围： 不涉及。 need_auth Boolean 参数解释： 是否需要验证。 取值范围： 不涉及。 auth_id String 参数解释： 认证配置ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 action_count String 参数解释： 执行动作ID。 取值范围： 不涉及。 状态码：500 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。