调用工作流应用 -j9九游会登录
功能介绍
该接口用于运行场景化应用,支持在指定的项目、工作流和对话上下文中执行工作流逻辑。接口支持流式响应模式,可以根据需要返回增量执行结果,适用于实时交互场景。
适用场景:
-
在项目中运行预定义的工作流。
-
支持调试模式和发布模式,适用于不同开发和生产环境。
-
支持流式响应,适用于需要实时反馈的场景(如聊天机器人、实时数据分析等)。
调用方法
请参见如何调用api。
uri
post /v1/{project_id}/workflows/{workflow_id}/conversations/{conversation_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
string |
参数解释: 当前租户项目id。 获取方法请参考获取项目id。 约束限制: 不涉及。 取值范围: 由英文,数字,“-”,“_”组成,不超过64位字符。 默认取值: 不涉及。 |
|
workflow_id |
是 |
string |
参数解释: 工作流应用的id。 获取方式:
约束限制: 不涉及。 取值范围: 由英文,数字,“-”,“_”组成,不超过64位字符。 默认取值: 不涉及。 |
|
conversation_id |
是 |
string |
参数解释: 会话id,每个会话的唯一标识符。用户可将会话id设置为任意字符串,例如“123e4567e89b12d3a456426614174000”,无需在其他地方获取。 约束限制: 不涉及。 取值范围: 由英文,数字,“-”,“_”组成,不超过64位字符。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
workspace_id |
否 |
string |
参数解释: 工作空间id,用于标识特定的工作空间。 获取方法请参考获取工作空间id。 约束限制: 不涉及。 取值范围: 由英文,数字,“-”,“_”组成,不超过64位字符。 默认取值: 不涉及。 |
|
version |
否 |
string |
参数解释: 发布版本。 获取方式:
约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-auth-token |
是 |
string |
参数解释: 用户token。通过调用iam服务获取用户token接口获取(响应消息头中x-subject-token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
x-invoke-mode |
否 |
string |
参数解释: 该参数用于标识工作流应用运行的模式。 约束限制: 不涉及。 取值范围:
默认取值: published。 |
|
stream |
否 |
boolean |
参数解释: 是否开启流式调用。
约束限制: 不涉及。 取值范围:
默认取值: true。 |
|
content-type |
是 |
string |
参数解释: 发送的实体的mime类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: application/json。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
inputs |
是 |
map |
参数解释: 用户提出的问题,作为运行工作流的输入,与工作流开始节点输入参数对应。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
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 |
integer |
参数解释: 创建时间。 取值范围: 不涉及。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
event |
map |
参数解释: 工作流最终输出内容表示工作流运行。 取值范围: 不涉及。 |
|
data |
data object |
参数解释: 工作流助手回复内容。例如,提问器节点问题消息。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
node_id |
string |
参数解释: 节点id。 取值范围: 不涉及。 |
|
node_type |
string |
参数解释: 节点类型。 取值范围: 不涉及。 |
|
node_name |
string |
参数解释: 节点名称。 取值范围: 不涉及。 |
|
code |
string |
参数解释: 错误码。 取值范围: 不涉及。 |
|
message |
string |
参数解释: 错误信息。 取值范围: 不涉及。 |
|
workflow_id |
string |
参数解释: 工作流id。 取值范围: 不涉及。 |
|
workflow_name |
string |
参数解释: 工作流名称。 取值范围: 不涉及。 |
请求示例
-
调用工作流
{ "method" : "post", "url" : "https://api.example.com/v1/12345/workflows/67890/conversations/67890", "headers" : { "content-type" : "application/json", "x-auth-token" : "miinrwyjkozihvcnaqccoiinodccdtqcaqexdtalbglghkgbzqmeagewgguvbgkqhkig...", "stream" : true }, "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
}
状态码:500
错误响应。
{
"event" : "error",
"data" : {
"text" : null,
"index" : 11,
"node_id" : "node_end",
"node_type" : "end",
"node_name" : "结束",
"code" : "101563",
"message" : "执行报错,错误码:101563,错误信息:get model streaming output error, msg-model request error: ",
"workflow_id" : "cd7a8f33-66e3-455c-b008-a6b18dd27319",
"workflow_name" : "flowouttest",
"createdtime" : 1760169416635
},
"createdtime" : 1760169416635
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功响应。 |
|
500 |
错误响应。 |
错误码
请参见错误码。
相关文档
意见反馈
文档内容是否对您有帮助?
如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨