异步执行工作流组件
异步执行工作流组件，创建异步工作流任务并返回execute_id用于获取执行结果
权限说明
调用本文API，需使用API Key鉴权方式。使用API Key鉴权调用API流程，具体调用流程，请查看认证鉴权。
API-Key的任一权限均支持组件调用。
请求参数
组件ID，用于标识要执行的工作流组件。
组件ID可以在个人空间-组件下查看。
组件版本号，用于指定要执行的组件版本。
如果不指定version，默认使用组件的最新版本。如果要指定version，可以使用具体的版本号。
调用传参，包含工作流执行所需的各类参数。
显示子属性
隐藏子属性
用户query，对应画布中开始节点的系统参数rawQuery。
用户输入的原始查询内容。
文件路径，对应画布中开始节点的系统参数fileUrls。
格式为{"文件名": "文件路径"}。
例如：{"xxx.pdf": "http:///"}。
显示子属性
隐藏子属性
对话id，对应画布中开始节点的系统参数conversation_id。
可通过新建会话接口创建。当前仅透传该字段，并不获取里面的上下文信息。
终端用户id，对应画布中开始节点的系统参数end_user_id。
用于标识终端用户。
应用使用的累计对话历史，对应画布中开始节点的系统参数chatHistory。
用于传递历史对话信息。
显示子属性
隐藏子属性
显示子属性
隐藏子属性
角色，标识对话中的角色类型。
内容，对话的具体内容。
POST /v2/tools/workflow/async/run HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: Bearer <API Key>
Content-Type: application/json
{
"component": "c-wf-dce67d59-04eb-406b-8d7b-f0bdfb28a713",
"version": "1.0",
"parameters": {
"_sys_origin_query": "你好",
"_sys_file_urls": {
"xxx.pdf": "http:///"
},
"_sys_conversation_id": "32fad7d0-1f8c-4d59-9e63-61f5d602c156",
"_sys_end_user_id": "david1980",
"_sys_chat_history": [
{
"role": "user",
"content": "你好"
}
]
}
}示例代码
异步执行工作流组件的基础调用示例
curl -X POST "https://qianfan.baidubce.com/v2/tools/workflow/async/run" \
-H "Authorization: Bearer bce-v3/ALTAK-******ZftZDTn7/125eeb1c5e9ddc8cf3edf18ef6d03f1517ec9408" \
-H "Content-Type: application/json" \
-d '{
"component": "c-wf-dce67d59-04eb-406b-8d7b-f0bdfb28a713",
"parameters": {
"_sys_origin_query": "你好"
}
}'返回响应
多选一且必需“只能”符合其中一个
显示子属性
隐藏子属性
成功响应时的返回格式
显示子属性
隐藏子属性
错误调用时标识UUID，用于追踪和定位问题。
当发生异常时返回。
错误代码，用于标识错误类型。
当发生异常时返回。
错误消息，详细描述错误信息。
当发生异常时返回。
会话标识UUID，用于标识当前会话。
成功调用时返回。
一问或一答的标识UUID，用于标识单次交互。
成功调用时返回。
正确调用时标识UUID，用于追踪请求。
成功调用时返回。
开发者UUID（计费依赖），用于标识开发者身份和计费。
成功调用时返回。
终端用户ID，用于标识终端用户。
成功调用时返回。
执行任务的唯一标识，用于获取工作流的执行结果。
接口返回的 execute_id 可调用「查询工作流异步执行结果API」获取工作流的执行结果。
成功调用时返回。
权限错误时的返回格式
显示子属性
隐藏子属性
错误调用时标识UUID，用于追踪和定位问题。
错误代码，用于标识错误类型。
权限错误时返回PermissionDeniedError。
错误消息，详细描述错误信息。
权限错误时返回"没有权限"。
异步执行工作流组件成功时的响应示例
{
"conversation_id": "32fad7d0-1f8c-4d59-9e63-61f5d602c156",
"message_id": "7b6fab29-d11e-4544-9f84-a0afb9f8e4c9",
"trace_id": "c5de1b79-bd5b-49c1-9ffc-0dfebda92eda",
"user_id": "a00dd7b8-70ec-4312-9e23-29c8e1a11f4f",
"end_user_id": "david1980",
"execute_id": "a9856439-0edb-4649-b1b9-7aa83526bb51"
}权限错误时的响应示例
{
"request_id": "ae2225f7-1c2e-427a-a1ad-5413b762957d",
"code": "PermissionDeniedError",
"message": "没有权限"
}