华为云用户手册

响应参数 状态码：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 参数解释： 错误信息。 取值范围： 不涉及。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 参数解释： 工具总数。 取值范围： 不涉及。 list Array of list objects 参数解释： 工具信息列表。 取值范围： 不涉及。 pageNum Integer 参数解释： 当前页。 取值范围： 不涉及。 pageSize Integer 参数解释： 每页的数量。 取值范围： 不涉及。 size Integer 参数解释： 当前页的数量。 取值范围： 不涉及。 startRow Integer 参数解释： 当前页面第一个元素在数据库中的行号。 取值范围： 不涉及。 endRow Integer 参数解释： 当前页面最后一个元素在数据库中的行号。 取值范围： 不涉及。 pages Integer 参数解释： 总页数。 取值范围： 不涉及。 prePage Integer 参数解释： 前一页。 取值范围： 不涉及。 nextPage Integer 参数解释： 后一页。 取值范围： 不涉及。 isFirstPage Boolean 参数解释： 是否为第一页。 取值范围： 不涉及。 isLastPage Boolean 参数解释： 是否为最后一页。 取值范围： 不涉及。 hasPreviousPage Boolean 参数解释： 是否有前一页。 取值范围： 不涉及。 hasNextPage Boolean 参数解释： 是否有下一页。 取值范围： 不涉及。 navigatePages Integer 参数解释： 工具总数。 取值范围： 不涉及。 navigatepageNums Array of integers 参数解释： 所有导航页号。 取值范围： 不涉及。 navigateFirstPage Integer 参数解释： 导航页上一页。 取值范围： 不涉及。 navigateLastPage Integer 参数解释： 导航页下一页。 取值范围： 不涉及。 表4 list 参数 参数类型 描述 id String 参数解释： 工具ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 name String 参数解释： 工具名称。 取值范围： 只能由中英文、数字、下划线、中划线、英文小括号组成，只能使用中英文以及数字开头，且长度不能超过32个字符。 description String 参数解释： 工具描述。 取值范围： 只能包含中英文、数字、下划线、中划线、空格及,.?:;"'：；“”‘’，。？、（）()/@!！*%#等，且长度不能超过256个字符。 icon String 参数解释： 工具图标。 取值范围： 格式正确的base64编码。 type String 参数解释： 工具类别。 取值范围： PRIVATE表示用户自创建工具、SUBSCRIBED表示从资产中心订阅的工具、ONBOARD表示已经上架到资产中心的工具、PUBLIC表示平台预置工具。 status String 参数解释： 工具状态。 取值范围： OFFBOARD：待上架 ONBOARD：已上架 APPROVING：审批中 created_time String 参数解释： 创建时间。 取值范围： 不涉及。 approval_id String 参数解释： 审批ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 asset_id String 参数解释： 工具对应的资产中心ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 version String 参数解释： 工具版本。 取值范围： 正整数。 auth_content String 参数解释： 安全认证配置内容。 取值范围： 不涉及。 状态码：500 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。

响应示例 状态码：200 成功。 { "data" : { "total" : 100, "list" : [ { "id" : "uuid", "name" : "example name1", "description" : "example description", "icon" : "base64 string", "type" : "PRIVATE", "status" : "OFFBOARD", "created_time" : "2025-02-06T00:00:00.000+00:00", "approval_id" : null, "asset_id" : null, "version" : "3", "auth_content" : { } }, { "id" : "uuid", "name" : "example name2", "description" : "example description", "icon" : "base64 string", "type" : "PRIVATE", "status" : "OFFBOARD", "created_time" : "2025-02-06T00:00:00.000+00:00", "approval_id" : null, "asset_id" : null, "version" : "3", "auth_content" : { "auth_type" : "apiKey", "cdm_params_config" : { "cdmParams" : "String", "cdmVisibility" : false }, "auth_dynamic" : { }, "auth_info" : { }, "auth_prop" : { "key" : { "format" : "password", "type" : "string", "required" : true } }, "auth_config" : { "in" : "query", "name" : "key" }, "host_config" : { "canModifyHostAddress" : false, "host" : "https://restapi.amap.com" } } } ], "pageNum" : 1, "pageSize" : 10, "size" : 10, "startRow" : 1, "endRow" : 10, "pages" : 2, "prePage" : 0, "nextPage" : 2, "isFirstPage" : true, "isLastPage" : false, "hasPreviousPage" : false, "hasNextPage" : true, "navigatePages" : 8, "navigatepageNums" : [ 1, 2 ], "navigateFirstPage" : 1, "navigateLastPage" : 2 } } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.22009001", "error_msg" : "Internal Server Error." }

URI GET https://aiae.appstage.myhuaweicloud.com/v1/workflow-adapter-open/connectors 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 参数解释： 偏移量。 约束限制： 不涉及。 取值范围： 正整数。 默认取值： 0。 limit 否 Integer 参数解释： 分页每页的条目数量。 约束限制： 不涉及。 取值范围： 1-1000的整数。 默认取值： 10。 keyword 否 String 参数解释： 查询关键字。 约束限制： 支持中英文、数字、下划线（_），1-50个字符。 取值范围： 不涉及。 默认取值： 不涉及。 status 否 String 参数解释： 工具状态。 约束限制： 不涉及。 取值范围： OFFBOARD：待上架 ONBOARD：已上架 APPROVING：审批中 默认取值： 不涉及。

响应示例 状态码：200 成功。 { "data" : { "total" : 100, "list" : [ { "id" : "uuid", "name" : "example name1", "description" : "example description", "english_name" : "english example name1", "connector_id" : "uuid", "created_time" : "2025-02-06T00:00:00.000+00:00", "updated_time" : "2025-02-06T00:00:00.000+00:00" }, { "id" : "uuid", "name" : "example name2", "description" : "example description", "english_name" : "english example name2", "connector_id" : "uuid", "created_time" : "2025-02-06T00:00:00.000+00:00", "updated_time" : "2025-02-06T00:00:00.000+00:00" } ], "pageNum" : 1, "pageSize" : 10, "size" : 10, "startRow" : 1, "endRow" : 10, "pages" : 2, "prePage" : 0, "nextPage" : 2, "isFirstPage" : true, "isLastPage" : false, "hasPreviousPage" : false, "hasNextPage" : true, "navigatePages" : 8, "navigatepageNums" : [ 1, 2 ], "navigateFirstPage" : 1, "navigateLastPage" : 2 } } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.22009001", "error_msg" : "Internal Server Error." }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 参数解释： 执行动作总数。 取值范围： 不涉及。 list Array of list objects 参数解释： 执行动作信息列表。 取值范围： 不涉及。 pageNum Integer 参数解释： 当前页。 取值范围： 不涉及。 pageSize Integer 参数解释： 每页的数量。 取值范围： 不涉及。 size Integer 参数解释： 当前页的数量。 取值范围： 不涉及。 startRow Integer 参数解释： 当前页面第一个元素在数据库中的行号。 取值范围： 不涉及。 endRow Integer 参数解释： 当前页面最后一个元素在数据库中的行号。 取值范围： 不涉及。 pages Integer 参数解释： 总页数。 取值范围： 不涉及。 prePage Integer 参数解释： 前一页。 取值范围： 不涉及。 nextPage Integer 参数解释： 后一页。 取值范围： 不涉及。 isFirstPage Boolean 参数解释： 是否为第一页。 取值范围： 不涉及。 isLastPage Boolean 参数解释： 是否为最后一页。 取值范围： 不涉及。 hasPreviousPage Boolean 参数解释： 是否有前一页。 取值范围： 不涉及。 hasNextPage Boolean 参数解释： 是否有下一页。 取值范围： 不涉及。 navigatePages Integer 参数解释： 工具总数。 取值范围： 不涉及。 navigatepageNums Array of integers 参数解释： 所有导航页号。 取值范围： 不涉及。 navigateFirstPage Integer 参数解释： 导航页上一页。 取值范围： 不涉及。 navigateLastPage Integer 参数解释： 导航页下一页。 取值范围： 不涉及。 表5 list 参数 参数类型 描述 id String 参数解释： 执行动作ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 name String 参数解释： 执行动作名称。 取值范围： 只能由中英文、数字、下划线、中划线、英文小括号组成，只能使用中英文以及数字开头，且长度不能超过32个字符。 description String 参数解释： 执行动作描述。 取值范围： 只能包含中英文、数字、下划线、中划线、空格及,.?:;"'：；“”‘’，。？、（）()/@!！*%#等，且长度不能超过256个字符。 connector_id String 参数解释： 执行动作所属工具ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 english_name String 参数解释： 执行动作英文名称。 取值范围： 只能由英文、数字、下划线、中划线、英文小括号组成，只能使用英文以及数字开头，且长度不能超过32个字符。 created_time String 参数解释： 创建时间。 取值范围： 不涉及。 update_time String 参数解释： 更新时间。 取值范围： 不涉及。 状态码：500 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 data data object 响应的body参数。 表5 data 参数 参数类型 描述 id String 参数解释： 调用记录ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 version Number 参数解释： 工具的版本号。 取值范围： 正整数。 connector_id String 参数解释： 工具ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 action_id String 参数解释： 工具的执行动作ID。 取值范围： 只由英文字母、数字以及“-”组成，且长度为36个字符。 start_time String 参数解释： 本次调用的开始时间。 取值范围： UTC格式的日期。 end_time String 参数解释： 本次调用的结束时间。 取值范围： UTC格式的日期。 cost Number 参数解释： 本次调用的总耗时，单位为毫秒。 取值范围： 正整数。 status String 参数解释： 本次调用的结果。 取值范围： success failure status_code Number 参数解释： 本次调用的状态码。 取值范围： 不涉及。 method String 参数解释： 本次调用的方法。 取值范围： GET POST PUT DELETE path String 参数解释： 本次调用的url。 取值范围： 不涉及。 invoke_output invoke_output object 参数解释： 本次调用的输出结果，即返回体。 取值范围： 不涉及。 invoke_input invoke_input object 参数解释： 本次调用的输入内容，即请求体。 取值范围： 不涉及。 表6 invoke_output 参数 参数类型 描述 body String 参数解释： 本次调用的输出结果具体内容。 取值范围： 不涉及。 表7 invoke_input 参数 参数类型 描述 body String 参数解释： 本次调用的请求体。 取值范围： 不涉及。 header String 参数解释： 本次调用的请求头。 取值范围： 不涉及。 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。

响应示例 状态码：200 成功。 { "data" : { "id" : "6f46e379-9adf-4395-af0d-4549e09c4048", "version" : 3, "connector_id" : "d5a2b8fd-ad02-437d-9234-2225eb992fd6", "action_id" : "a224ce98-07b5-479a-b75e-560029399312", "start_time" : "2024-12-28T01:17:31.146Z", "end_time" : "2024-12-28T01:17:33.582Z", "cost" : 2436, "status" : "success", "status_code" : 200, "method" : "POST", "path" : "some path", "invoke_output" : { "body" : "something in response body" }, "invoke_input" : { "body" : "something in request body", "header" : "something in request header" } } } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.22009001", "error_msg" : "Internal Server Error." }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 参数解释： 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 body 是 Object 参数解释： 结构与工具的执行动作的配置相关，并且所有请求头中的入参与请求参数均添加至请求体中，由AI原生应用引擎自动完成分配。如果为GET请求则为非必填，如果为POST请求则为必填。 比如工作流配置了query_param作为查询参数，header_param作为请求头参数，body_param_1与body_param_2作为请求体参数，此时调用本接口只需要将这些参数依次传入，AI原生应用引擎自动按照名称进行分配，并完成工具的执行动作的调用。 具体结构请参照本接口的请求示例。 约束限制： 不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 参数解释： 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 body 是 Object 参数解释： 结构与知识检索流的起始节点配置相关，如果为GET请求则为非必填，如果为POST请求则为必填。 比如检索流配置了query_param作为查询参数，header_param作为请求头参数，body_param_1与body_param_2作为请求体参数，此时调用本接口只需要将这些参数依次传入，AI原生应用引擎自动按照名称进行分配，并完成检索流的调用。 具体结构请参照本接口的请求示例。 约束限制： 不涉及

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 responseBody String 参数解释： 流执行结果的内容。 取值范围： 不涉及。 responseHeaders Object 参数解释： 流执行结果的响应头。 取值范围： 不涉及。 状态码：500 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。

响应示例 状态码：200 成功。 { "data" : { "responseBody" : "something in response body", "responseHeaders" : { "Server" : "api-gateway", "X-Request-Id" : "787b7740f42e75b007ac3bfb599fcef4", "X-Content-Type-Options" : "nosniff", "Connection" : "keep-alive", "lubanops-nspan-id" : "1", "X-Download-Options" : "noopen", "Date" : "Tue, 23 Jul 2024 11:38:29 GMT", "lubanops-ntrace-id" : "2748112-1721734708992-1130609", "Referrer-Policy" : "no-referrer", "X-Frame-Options" : "SAMEORIGIN", "Strict-Transport-Security" : "max-age=31536000; includeSubdomains;", "lubanops-nenv-id" : "28164", "Content-Length" : "0", "X-XSS-Protection" : "1; mode=block;", "Content-Type" : "application/json" }, "statusCode" : 200 } } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.22009001", "error_msg" : "Internal Server Error." }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 responseBody String 参数解释： 流执行结果的内容。 取值范围： 不涉及。 responseHeaders Object 参数解释： 流执行结果的响应头。 取值范围： 不涉及。 状态码：500 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。

响应示例 状态码：200 成功。 { "data" : { "responseBody" : "something in response body", "responseHeaders" : { "Server" : "api-gateway", "X-Request-Id" : "787b7740f42e75b007ac3bfb599fcef4", "X-Content-Type-Options" : "nosniff", "Connection" : "keep-alive", "lubanops-nspan-id" : "1", "X-Download-Options" : "noopen", "Date" : "Tue, 23 Jul 2024 11:38:29 GMT", "lubanops-ntrace-id" : "2748112-1721734708992-1130609", "Referrer-Policy" : "no-referrer", "X-Frame-Options" : "SAMEORIGIN", "Strict-Transport-Security" : "max-age=31536000; includeSubdomains;", "lubanops-nenv-id" : "28164", "Content-Length" : "0", "X-XSS-Protection" : "1; mode=block;", "Content-Type" : "application/json" }, "statusCode" : 200 } } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.22009001", "error_msg" : "Internal Server Error." }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 参数解释： 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 body 是 Object 参数解释： 结构与流的起始节点配置相关，如果为GET请求则为非必填，如果为POST请求则为必填。 比如工作流配置了query_param作为查询参数，header_param作为请求头参数，body_param_1与body_param_2作为请求体参数，此时调用本接口只需要将这些参数依次传入，AI原生应用引擎自动按照名称进行分配，并完成工作流的调用。 具体结构请参照本接口的请求示例。 约束限制： 不涉及。

请求示例 { "swagger" : { "paths" : { "/test" : { "post" : { "operationId" : "1234567-1234-1234-123451234512", "x-hw-visibility" : "none", "description" : "example description", "summary" : "example name", "parameters" : [ { "in" : "body", "name" : "body", "description" : "", "x-hw-body-required" : true, "schema" : { "properties" : { "input" : { "description" : "input", "default" : "", "x-hw-default" : "", "type" : "string", "x-hw-label" : "input", "format" : "input", "x-hw-format" : "input", "x-hw-select-options" : [ ] } }, "required" : [ "input" ], "type" : "object", "xml" : null }, "x-hw-xml-header" : null } ], "response" : { "200" : { "description" : "请求成功", "schema" : { "properties" : { "output" : { "description" : "输出", "default" : "", "x-hw-default" : "", "type" : "string", "x-hw-label" : "output", "x-hw-visibility" : "none", "format" : "input", "x-hw-format" : "input", "x-hw-select-options" : [ ] } }, "type" : "object", "xml" : null }, "headers" : { }, "x-hw-xml-header" : null } }, "x-model" : { "input-MappingConfig" : { "rules" : [ ] }, "input-is-model-mapping" : false, "input-model" : { }, "output-MappingConfig" : { "rules" : [ ] }, "output-is-model-mapping" : false, "output-model" : { } }, "consumes" : [ "application/json" ], "produces" : [ "application/json" ] } } } }, "name" : "example name", "description" : "example description", "english_name" : "example english name" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 参数解释： 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 Content-Type 是 String 参数解释： 消息体的类型。 约束限制： 由于需要上传文件，所以必须为multipart/form-data。 取值范围： application/json application/json;charset=utf-8 multipart/form-data 默认取值： 不涉及。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 data String 参数解释： 生成的文件ID。 取值范围： 由英文字母和数字组成，长度为32个字符。 状态码：500 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。

请求示例 设置memory，向Agent发起一次对话请求。 /v1/routes/open/{id}/execute { "query" : "查询北京天气", "memory" : [ { "role" : "user", "content" : "你是谁" }, { "role" : "assistant", "content" : "我是盘古大模型" }, { "role" : "user", "content" : "南京天气" }, { "role" : "assistant", "tool_calls" : [ { "id" : "efd6ff92-422c-4ba4-b531-ac1991af7c1a", "type" : "function", "function" : { "name" : "查询当前天气 查询当前天气", "arguments" : "{\"city\":\"320100\",\"extensions\":\"all\"}" } } ] }, { "role" : "tool", "tool_call_id" : "efd6ff92-422c-4ba4-b531-ac1991af7c1a", "content" : "{\"data\":{\"status\":\"1\",\"count\":\"1\",\"info\":\"OK\",\"infocode\":\"10000\",\"forecasts\":[{\"city\":\"南京市\",\"adcode\":\"320100\",\"province\":\"江苏\",\"reporttime\":\"2024-08-20 16:32:01\",\"casts\":[{\"date\":\"2024-08-20\",\"week\":\"2\",\"dayweather\":\"中雨\",\"nightweather\":\"中雨\",\"daytemp\":\"32\",\"nighttemp\":\"26\",\"daywind\":\"西北\",\"nightwind\":\"西北\",\"daypower\":\"1-3\",\"nightpower\":\"1-3\",\"daytemp_float\":\"32.0\",\"nighttemp_float\":\"26.0\"}]}]}}" } ] } 设置引用文件、自定义的用户id和对话id、一般变量，向Agent发起一次对话请求。 /v1/routes/open/{id}/execute { "query" : "上海有哪些旅游景点", "quote" : "上海旅游攻略.docx", "user_id" : 1008600000300604420, "conversation_id" : "70dc6dfd397244edbbf4847acb78bfa9a", "variables" : { "common_variables" : { "上海古典名园" : "豫园" } } }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 request_id String 参数解释： 唯一请求id。 取值范围： 只由英文字母及数字组成，长度为32个字符。 agent_id String 参数解释： Agent的唯一id。 取值范围： 只由英文字母及数字组成，长度为32个字符。 user_id String 参数解释： 本轮对话的用户唯一身份标识。 取值范围： 在发起对话请求时自定义的user_id。 AI引擎用户的真实user_id，orgid的不可逆加密值。 conversation_id String 参数解释： 会话ID。 取值范围： 在发起对话请求时自定义的conversation_id。 随机生成的仅包含英文字母与数字的32位字符串。 type String 参数解释： 返回内容的类型。 取值范围： hint workflow tool knowledge message。 data Object 参数解释： 不同响应类型的响应体中包含不同的参数，见示例。 取值范围： 不涉及。 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。 状态码：500 表7 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误信息。 取值范围： 不涉及。

响应示例 状态码：200 表示Agent成功接收对话请求，正常响应。 响应采用Server-Sent Events（SSE）机制进行流式输出，数据内容用data字段表示，示例如下：data: message；需注意，这并不是一个JSON数据。此外，还可以有冒号开头的行，表示注释，通常可忽略。 Agent的响应类型为hint，用于提示接下来使用knowledge，tool或workflow进行响应，示例中的提示为workflow。 { "request_id" : "266e71692aba45ec8b111d847963109d", "agent_id" : "50b58e0041e843b0b7bd343dca076443", "user_id" : 1008600000300604420, "conversation_id" : "c568e962b0004650bc12b63aec96366d", "type" : "hint", "data" : { "id" : "ce7f20a1-a3dd-4249-b7ca-8c5039dd8c74", "name" : "儿科问答", "tool_type" : "workflow" } } Agent使用workflow进行响应。 { "request_id" : "266e71692aba45ec8b111d847963109d", "agent_id" : "50b58e0041e843b0b7bd343dca076443", "user_id" : 1008600000300604420, "conversation_id" : "c568e962b0004650bc12b63aec96366d", "type" : "workflow", "data" : { "id" : "ce7f20a1-a3dd-4249-b7ca-8c5039dd8c74", "name" : "儿科问答", "status" : "SUC CES S", "request" : { "query" : "婴儿肥胖怎么办" }, "response" : { "data" : { "responseBody" : "{\"result\":\"问题分析:主要控制儿童饮食，合理饮食不喝酒，不吃油炸食物意见和建议:建议孩子们多锻炼一点，每天至少锻炼一到两个小时，而且他们必须坚持锻炼。他们也应该少吃油和脂肪，多吃水果和蔬菜。我认为我们应该在一段时间后恢复正常。就食疗而言，父母必须参与其中，并被要求掌握一些相关知识，如不允许孩子吃得太多或太多，不给予高糖、高脂肪、高热量的饮食。治疗节食中的儿童并让他们挨饿也很困难。因此，在进行饮食控制之前，有必要耐心而详细地告诉儿童肥胖的危害、\"}", "responseHeaders" : { "Server" : "api-gateway", "X-Request-Id" : "6701c75b8f23102a659e63a3cc5a20d6", "X-Content-Type-Options" : "nosniff", "Connection" : "keep-alive", "X-Download-Options" : "noopen", "Date" : "Tue, 20 Aug 2024 08:37:27 GMT", "Referrer-Policy" : "no-referrer", "X-Frame-Options" : "SAMEORIGIN", "Strict-Transport-Security" : "max-age=31536000; includeSubdomains;", "lubanops-nenv-id" : "28164", "Content-Length" : "660", "X-XSS-Protection" : "1; mode=block;", "Content-Type" : "application/json" }, "statusCode" : 200 } } } } Agent使用tool进行响应。 { "request_id" : "266e71692aba45ec8b111d847963109d", "agent_id" : "50b58e0041e843b0b7bd343dca076443", "user_id" : 1008600000300604420, "conversation_id" : "c568e962b0004650bc12b63aec96366d", "type" : "tool", "data" : { "id" : "b6dbf1a6-f374-4d44-96fb-45726f7fa7f0", "name" : "航班信息 航班信息", "status" : "SUCCESS", "request" : { "city" : "南京", "endcity" : "大理", "date" : "2024-08-24" }, "response" : { "data" : { "status" : 0, "msg" : "ok", "result" : { "city" : "NKG", "endcity" : "DLU", "date" : "2024-08-24", "list" : [ { "flightno" : "ZH2010", "airline" : "深圳航空", "realflightno" : "TV6026", "departportcode" : "NKG", "departport" : "禄口国际机场", "arrivalportcode" : "DLU", "arrivalport" : "大理荒草坝机场", "departterminal" : "T1", "arrivalterminal" : "", "departdate" : "2024-08-24", "arrivaldate" : "2024-08-24", "departtime" : "16:35", "arrivaltime" : "19:40", "departdateadd" : 0, "arrivaldateadd" : 0, "craft" : "19N", "stopnum" : "0", "costtime" : "03:05", "punctualrate" : "95", "pricelist" : [ ], "minprice" : "0", "airporttax" : "50", "fueltax" : "50", "food" : "1,", "isasr" : "1,", "iseticket" : "1,", "iscodeshare" : 1 } ] } } } } } Agent使用knowledge进行响应。 { "request_id" : "266e71692aba45ec8b111d847963109d", "agent_id" : "50b58e0041e843b0b7bd343dca076443", "user_id" : 1008600000300604420, "conversation_id" : "c568e962b0004650bc12b63aec96366d", "type" : "knowledge", "data" : { "id" : "7e4cf06bd8404ec594c621c8f47c44f1", "name" : "华西医院", "status" : "SUCCESS", "request" : { "query" : "肠息肉怎么办" }, "response" : "结直肠息肉应该怎么办？\n结直肠息肉是什么\n结肠息肉需不需要切除" } } Agent使用大模型进行响应。 { "request_id" : "266e71692aba45ec8b111d847963109d", "agent_id" : "50b58e0041e843b0b7bd343dca076443", "user_id" : 1008600000300604420, "conversation_id" : "c568e962b0004650bc12b63aec96366d", "type" : "knowledge", "data" : { "id" : "202412302111448bd332d627ed4c5f", "content" : "著名的", "url" : null, "raw" : { "role" : "assistant", "content" : "著名的" } } } 状态码：400 缺少请求体。 { "error_code" : "AIAE.00001400", "error_msg" : "Request body is missing" } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error_code" : "AIAE.00001500", "error_msg" : "Internal Server Error." }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 参数解释： 鉴权信息。获取平台API Key，并为API Key添加前缀Bearer，得到标准鉴权信息，例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 query 是 String 参数解释： 发起对话的内容。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 quote 否 String 参数解释： 对话中引用文件盒子中文件的完整名称，包含后缀。 约束限制： 如果发布Agent时，用户在该Agent的文件盒子中没有文件，需要先上传文件。 取值范围： 只支持pdf、txt、docx等文本文件格式。 默认取值： 不涉及。 memory 否 Array of memory objects 参数解释： 在本次对话请求中，让大模型提前记住的部分。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 user_id 否 String 参数解释： 用户id，允许自定义，与conversation_id共同使用可以使Agent自动获取该用户相同对话id下的前几轮对话内容。 约束限制： 不与memory同时生效，memory存在时memory优先生效。 取值范围： 不涉及。 默认取值： AI引擎用户的真实user_id，orgid的不可逆加密值。 conversation_id 否 String 参数解释： 对话id，允许自定义，与user_id共同使用可以使Agent自动获取该用户相同对话id下的前几轮对话内容。 约束限制： 不与memory同时生效，memory存在时memory优先生效。 取值范围： 不涉及。 默认取值： 随机生成的仅包含英文字母与数字的32位字符串。 variables 否 Object 参数解释： 变量用于用户个人信息，例如语言偏好等，并让Agent记住这些特征，使回复更加个性化。 约束限制： 变量包括一般变量和敏感变量，一般变量可用于对话和工作流，敏感变量只用于工作流。如果Agent中设置了敏感变量，敏感变量为必传，一般变量非必需。 取值范围： 一般变量common_variables和敏感变量sensitive_variables。 默认取值： 不涉及。 表4 memory 参数 是否必选 参数类型 描述 role 是 String 参数解释： 对话角色。 约束限制： 只支持user，assistant或tool三种取值。 取值范围： user，assistant或tool。 默认取值： 不涉及。 content 是 String 参数解释： 对话内容。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 200 AIAE.22001001 API调用异常 API调用异常 调用接口url、请求方式错误或出现访问其他用户资源的越权问题，请检查后重试 200 AIAE.22001002 IAM 认证异常 IAM认证异常 后端服务错误，请联系技术支持 200 AIAE.22001003 认证失败: {reason} 认证失败: {reason} 请参考返回的error message，或联系技术支持 200 AIAE.22001004 参数{parameterName}异常 参数{parameterName}异常 输入的参数有误，请参考返回的error message进行修改后重试 200 AIAE.22001005 {type}类型远程调用失败，错误信息为{error_msg} {type}类型远程调用失败，错误信息为{error_msg} 请参考返回的error message处理后重试 200 AIAE.22001006 文件上传失败: {reason} 文件上传失败: {reason} 文件上传失败，请参考返回的error message处理后重试 200 AIAE.22001007 技能未设置鉴权信息 技能未设置鉴权信息 在wiseAgent页面为技能设置鉴权信息。 200 AIAE.22001008 用户无权限访问当前资源 用户无权限访问当前资源 请更换用户后访问 200 AIAE.22001009 开启的流无法被删除 开启的流无法被删除 关闭流后重试 200 AIAE.22009001 系统内部错误，请联系管理员 系统内部错误，请联系管理员 系统内部错误，请联系技术支持 400 AIAE.31001106 AK/SK signature verify failed, please check and try again later！ 很抱歉，AK/SK签名验证失败！ 很抱歉，AK/SK签名验证失败！ 400 AIAE.31001601 Sensitive request error, please try again later！ 很抱歉，请求内容中包含敏感信息，请重试！ 很抱歉，请求内容中包含敏感信息，请重试！ 400 AIAE.31001602 Sensitive response error, please try again later！ 很抱歉，返回内容中包含敏感信息，请重试！ 很抱歉，返回内容中包含敏感信息，请重试！ 400 AIAE.31001603 Sensitive content error, please try again later！ 很抱歉，请求或返回内容中包含敏感信息，请重试！ 很抱歉，请求或返回内容中包含敏感信息，请重试！ 400 AIAE.31001701 Bad request parameter error, please check and try again later！ 很抱歉，请求参数异常，请检查后重试！ 很抱歉，请求参数异常，请检查后重试！ 400 AIAE.40001003 Authentication failed X-Auth-Token 鉴权失败 很抱歉，X-Auth-Token 鉴权失败 400 AIAE.40002605 knowledgeBase status is not ENABLE 很抱歉，知识库未启用，没有权限查询 很抱歉，知识库未启用，没有权限查询 401 AIAE.31001101 User not login, please check and try again later！ 很抱歉，用户未登录，请登录后重试！ 很抱歉，用户未登录，请登录后重试！ 401 AIAE.31001102 AK/SK verify failed, please check and try again later！ 很抱歉，AK/SK校验失败！ 很抱歉，AK/SK校验失败！ 401 AIAE.31001103 Authentication verify failed, please check and try again later！ 很抱歉，鉴权失败！ 很抱歉，鉴权失败！ 401 AIAE.31001104 API Key verify failed, please check and try again later！ 很抱歉，API Key校验失败！ 很抱歉，API Key校验失败！ 401 AIAE.31001201 Tenant id is empty, please check and try again later！ 很抱歉，空的租户id，请检查后重试！ 很抱歉，空的租户id，请检查后重试！ 401 AIAE.31005001 The third model service authentication is abnormal, please check and try again later！ 很抱歉，三方模型服务鉴权异常，请检查您的鉴权信息！ 很抱歉，三方模型服务鉴权异常，请检查您的鉴权信息！ 401 AIAE.31005002 Invalid third api key, please check and try again later！ 很抱歉，三方模型服务鉴权API Key异常，请检查您的鉴权信息！ 很抱歉，三方模型服务鉴权API Key异常，请检查您的鉴权信息！ 401 AIAE.31005007 The third model service authentication is empty, please set and try again later！ 很抱歉，三方模型服务鉴权未设置，请设置后重试！ 很抱歉，三方模型服务鉴权未设置，请设置后重试！ 402 AIAE.31005005 The third model service exceeded current quota error, please check and try again later！ 很抱歉，账户异常，请检查您的账户余额！ 很抱歉，账户异常，请检查您的账户余额！ 403 AIAE.31001105 Role permission verify failed, please check and try again later！ 很抱歉，当前用户不允许该操作！ 很抱歉，当前用户不允许该操作！ 403 AIAE.31001501 SKU not subscribed to model service, please try again after subscribed！ 很抱歉，您未订阅当前模型服务的SKU，请联系管理员订阅！ 很抱歉，您未订阅当前模型服务的SKU，请联系管理员订阅！ 403 AIAE.31001502 SKU verify failed, please check and try again later！ 很抱歉，SKU校验异常，请检查您的SKU！ 很抱歉，SKU校验异常，请检查您的SKU！ 403 AIAE.40001004 User does not have permission 当前用户没有权限 很抱歉，当前用户没有权限 404 AIAE.31001202 Model not published, please try again after model published！ 很抱歉，模型服务未发布，请发布后重试！ 很抱歉，模型服务未发布，请发布后重试！ 404 AIAE.31001702 Model not exists, please check and try again later！ 很抱歉，模型服务不存在，请检查您输入的模型服务名称！ 很抱歉，模型服务不存在，请检查您输入的模型服务名称！ 408 AIAE.31001003 Connection timeout, please try again later！ 很抱歉，网络连接超时，请稍后重试！ 很抱歉，网络连接超时，请稍后重试！ 408 AIAE.31005006 The third model service connect timeout, please try again later！ 很抱歉，三方服务连接超时，请稍后重试！ 很抱歉，三方服务连接超时，请稍后重试！ 429 AIAE.31001002 Request too frequent error, please try again later！ 很抱歉，您的请求过于频繁，请稍后重试！ 很抱歉，您的请求过于频繁，请稍后重试！ 429 AIAE.31005003 The third model service rate limit exceeded, please try again later！ 很抱歉，您的请求当前已达最大并发数，请稍后重试！ 很抱歉，您的请求当前已达最大并发数，请稍后重试！ 429 AIAE.31005004 The third model service overload error, please try again later！ 很抱歉，服务当前超载，请稍后重试！ 很抱歉，服务当前超载，请稍后重试！ 500 AIAE.31001001 Internal server error, please try again later！ 很抱歉，服务内部出现了问题，请稍后重试！ 很抱歉，服务内部出现了问题，请稍后重试！ 500 AIAE.31001004 Ai security governance service error, please try again later or disable ai security governance service！ 很抱歉， 内容审核 服务出现了问题，请稍后重试！ 很抱歉，内容审核服务出现了问题，请稍后重试！ 500 AIAE.31005000 Invalid third response, please try again later！ 很抱歉，调用三方模型服务异常，请稍后重试！ 很抱歉，调用三方模型服务异常，请稍后重试！ 400 UniModel.Request.0001 请求参数错误 模型服务的请求参数错误 检查模型的请求参数 500 UniDataEmbed.Internal.0001 请求失败 请求向量化服务失败 检查向量知识库配置 500 UniModel.Internal.0001 模型访问失败 无法访问选择的模型 检查模型是否已经正常部署 500 UniModel.Internal.0002 模型返回超时 模型服务返回超时 检查网络情况，或者减少模型返回内容 500 WS.00100001 AUTHENTICATION_ERROR 鉴权错误 检查访问权限 500 WS.00100002 SHA_ERROR SHA算法错误 检查签名所用的算法 500 WS.00100003 SIGN_ERROR 请求签名错误 检查请求签名 500 WS.00100005 NO_ACCESS_ERROR 无访问权限错误 检查接口访问权限 父主题： 附录

响应示例 状态码：200 OK { "data": [ { "index": 0, "embedding": [ 0.02513289265334606, -0.017512470483779907, -0.029955564066767693, ... ], "object": "embedding" } ], "usage": { "prompt_tokens": 5, "total_tokens": 5 }, "model": "embedding-2", "object": "list" } 状态码：500 服务器内部错误或三方服务器内部错误。 { "error" : { "message" : "Internal server error, please try again later!", "type" : "internal_error", "param" : null, "code" : "internal_error" }, "error_code" : "AIAE.31001001", "error_msg" : "Internal server error, please try again later!" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 data Array of Embedding objects 参数解释： 向量化结果。 取值范围： 不涉及。 model String 参数解释： 实际转发后调用的模型名称，与请求体中model可能不同。 取值范围： 不涉及。 object String 参数解释： 固定值。 取值范围： ‘list’ usage usage object 参数解释： 每次请求的用量统计。 取值范围： 不涉及。 表4 Embedding 参数 参数类型 描述 index Integer 参数解释： 向量在向量列表中的排序。 取值范围： 不涉及。 embedding Array of numbers 参数解释： 向量数组（Float类型）。 取值范围： 不涉及。 object String 参数解释： 固定值。 取值范围： ‘embedding’ 表5 usage 参数 参数类型 描述 prompt_tokens Integer 参数解释： 提问包含的token数。 取值范围： 不涉及。 total_tokens Integer 参数解释： 提问包含的token数。 取值范围： 不涉及。 状态码：500 表6 响应Body参数 参数 参数类型 描述 error Error object 参数解释： 异常详情。 取值范围： 不涉及。 error_code String 参数解释： 平台异常错误码。 取值范围： 不涉及。 error_msg String 参数解释： 异常信息。 取值范围： 不涉及。 表7 Error 参数 参数类型 描述 code String 参数解释： 异常码。 取值范围： 不涉及。 message String 参数解释： 异常信息。 取值范围： 不涉及。 param String 参数解释： 异常参数，暂未使用。 取值范围： 不涉及。 type String 参数解释： 异常类型，同code。 取值范围： 不涉及。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 data DeleteResult object 参数解释： 知识数据集删除结果。 取值范围： 不涉及。 表4 DeleteResult 参数 参数类型 描述 id String 参数解释： 知识数据集id。 取值范围： 由数字、字母和中划线组成，长度36。 name String 参数解释： 知识数据集名称。 取值范围： 由中英文、数字、“_”组成，长度为[2-50]。 result Boolean 参数解释： 知识数据集删除成功或失败。 取值范围： true或false。 reason String 参数解释： 知识数据集删除失败原因。 取值范围： 不涉及。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 异常错误码。 取值范围： 不涉及。 error_msg String 参数解释： 异常错误信息。 取值范围： 不涉及。

响应示例 状态码：200 操作成功，返回删除结果。 { "data" : { "id" : "djh28e62-xxxxxxxxx-a15be0d63812", "name" : "知识数据集名称", "result" : false, "reason" : "知识数据集已被知识库引用" } } 状态码：400 请求错误。 { "error_code" : "AIAE.40001001", "error_msg" : "参数xxxx不合法。" }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 data DeleteResult object 参数解释： 知识数据集删除结果。 取值范围： 不涉及。 表4 DeleteResult 参数 参数类型 描述 id String 参数解释： 知识库id。 取值范围： 由数字、字母和中划线组成，长度36。 name String 参数解释： 知识库名称。 取值范围： 由中英文、数字、“_”组成，长度为[2-50]。 result Boolean 参数解释： 知识库删除成功或失败。 取值范围： true或false。 reason String 参数解释： 知识库删除失败原因。 取值范围： 不涉及。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 异常错误码。 取值范围： 不涉及。 error_msg String 参数解释： 异常错误信息。 取值范围： 不涉及。