调用运行时 -j9九游会登录
功能介绍
该接口用于运行场景化应用,支持在指定的智能体、工作流中执行。接口支持流式响应模式,可以根据需要返回增量执行结果,适用于实时交互场景。
适用场景:
-
在项目中运行预定义的工作流/智能体。
-
支持调试模式和发布模式,适用于不同开发和生产环境。
-
支持流式响应,适用于需要实时反馈的场景(如聊天机器人、实时数据分析等)。
调用方法
请参见如何调用api。
授权信息
当前api调用无需身份策略权限。
uri
post /runtimes/{runtime_name}/invocations
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| runtime_name | 是 | string | 参数解释: 需要执行的运行时名称。 获取方法: 方式一
方式二
约束限制: 不涉及。 取值范围: 由英文,数字,“-”,“_”组成,不超过64位字符。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| authorization | 是 | string | 参数解释: 鉴权参数,根据部署时所选择的方式填写对应的鉴权,分为api key认证、oauth 2.0认证、iam认证(ak/sk认证),获取参数详情参考认证鉴权。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| x-invoke-mode | 否 | string | 参数解释: 该参数用于标识运行时运行的模式。 约束限制: 不涉及。 取值范围:
默认取值: published。 |
| x-sdk-content-sha256 | 否 | string | 参数解释: 如果智能体运行时的入站认证类型为iam认证时,需要指定该header头为unsigned-payload。 约束限制: 不涉及。 取值范围: 固定为unsigned-payload。 默认取值: 不涉及。 |
| x-hw-agentarts-session-id | 是 | string | 参数解释: 会话id,每个会话的唯一标识符。用户可将会话id设置为任意字符串,例如“123e4567e89b12d3a456426614174000”,无需在其他地方获取。 约束限制: 不涉及。 取值范围: 由英文,数字,“-”,“_”组成,不超过64位字符。 默认取值: 不涉及。 |
| x-request-id | 否 | string | 参数解释: 调用链id,每个请求的唯一标识符。用于日志中跟踪整个请求的调用链路。用户可将调用链id设置为任意字符串,例如“123e4567e89b12d3a4564266141740”,无需在其他地方获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| content-type | 是 | string | 参数解释: 发送的实体的mime类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: application/json。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| query | 否 | string | 参数解释: 用户请求的问题。 调用单智能体/多智能体选择此参数,必填。 约束限制: 不涉及 取值范围: 不涉及。 默认取值: 不涉及。 |
| inputs | 是 | map | 参数解释: 在调用工作流接口时,inputs对象中的字段(key)并非api预留的固定字段,而是取决于您在工作流“开始节点”中定义的变量名 约束限制: 为确保工作流正常运行,请遵循以下原则判断哪些变量需要传入: 配置必填项:如果在“开始节点”中将某个变量设为“必填”,则调用api时必须包含该字段,且取值不能为空(如果后续节点未引用,可填写任意占位值)。 逻辑引用项:如果某个变量在“开始节点”中设为“可选”,但其后的任何一个节点(如大模型节点、工具节点)引用了该变量,则调用api时必须传入该字段,否则会导致引用该变量的节点执行失败。 可选忽略项:只有在“开始节点”中设为“可选”,且后续所有节点均未引用的情况下,该字段才可以在调用时省略。 取值范围: 不涉及。 默认取值: 不涉及。 |
| plugin_configs | 否 | array of pluginconfig objects | 参数解释: 插件配置信息。 约束限制: 不涉及。 取值范围: 当工作流关联插件节点,并且插件是“用户级鉴权”时,需要配置对应的鉴权信息。其他情况该参数无需传值,plugin_configs传空数组。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| plugin_id | 否 | string | 参数解释: 插件id。 获取方式:
约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| config | 否 | map | 参数解释: 配置插件信息。当工作流关联插件节点,并且插件是“用户级鉴权”时,需要在此配置对应的鉴权信息。例如,针对如下插件,config可以配成:{"key2": "value"}。其他情况该参数无需传值,plugin_configs传空数组即可。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| event | map | 参数解释: 运行时最终输出内容表示运行时结果。 取值范围: 不涉及。 |
| data | data object | 参数解释: 运行时回复内容。例如,提问器节点问题消息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| text | string | 参数解释: 运行时输出内容消息块。 取值范围: 不涉及。 |
| index | integer | 参数解释: 消息块索引。 取值范围: 不涉及。 |
| node_id | string | 参数解释: 节点id。 取值范围: 不涉及。 |
| node_type | string | 参数解释: 工作流节点类型。 取值范围: 不涉及。 |
| node_name | string | 参数解释: 节点名称。 取值范围: 不涉及。 |
| workflow_id | string | 参数解释: 工作流id。 取值范围: 不涉及。 |
| workflow_name | string | 参数解释: 工作流名称。 取值范围: 不涉及。 |
| createdtime | long | 参数解释: 创建时间,格式为毫秒级时间戳(13位整数)。例如,1733817348963。 取值范围: 不涉及。 |
请求示例
调用运行时
{
"method" : "post",
"url" : "https://api.example.com/runtimes/jiuwen-ef727077-9903-4e0a-9196-e93298bfcce3/invocations",
"headers" : {
"authorization" : "bearer *******",
"x-hw-agentarts-session-id" : 123456789
},
"body" : {
"inputs" : {
"query" : "你好"
},
"plugin_configs" : [ {
"plugin_id" : "xxxxxxxxx",
"config" : {
"key" : "value"
}
} ]
}
} 响应示例
状态码:200
成功响应。
{
"event" : "message",
"data" : {
"text" : null,
"index" : 11,
"node_id" : "node_end",
"node_type" : "end",
"node_name" : "结束",
"workflow_id" : "cd7a8f33-66e3-455c-b008-a6b18dd27319",
"workflow_name" : "flowouttest",
"createdtime" : 1760169416635
},
"createdtime" : 1760169416635
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功响应。 |
错误码
请参见错误码。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨