华为云用户手册

基本概念 大模型推理服务 直接调用预置大模型提供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 参数解释： 错误信息。 取值范围： 不涉及。

响应参数 状态码：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原生应用引擎自动按照名称进行分配，并完成工具的执行动作的调用。 具体结构请参照本接口的请求示例。 约束限制： 不涉及。

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

请求参数 表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 成功。 { "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原生应用引擎自动按照名称进行分配，并完成工作流的调用。 具体结构请参照本接口的请求示例。 约束限制： 不涉及。