更新时间:2025-01-05 GMT+08:00
分享

调用工作流

工作流试运行成功后,可以使用API调用该工作流。

获取调用路径

工作流的调用路径获取步骤如下:

  1. 登录ModelArts Studio大模型开发平台,在“我的空间”模块,单击进入所需空间。
  2. 在左侧导航栏中选择“Agent开发”,跳转至Agent开发平台。
  3. 在“工作台 > 工作流”页面,单击所需工作流的“ > 调用路径”。
    图1 获取工作流调用路径-1
  4. 在“调用路径”页面,单击“复制路径”即可获取调用路径。

    其中,conversation_id参数为会话ID,唯一标识每个会话的标识符,可将会话ID设置为任意值,使用标准UUID格式。

    图2 获取工作流调用路径-2

使用Postman调用API

  1. 获取Token。参考《API参考》文档“如何调用REST API > 认证鉴权”章节获取Token。
  2. 在Postman中新建POST请求,并填入工作流的调用路径,详见获取调用路径
  3. 填写请求Header参数。
    • 参数名为Content-Type,参数值为application/json。
    • 参数名为X-Auth-Token,参数值为步骤1中获取的Token值。
    • 参数名为stream,参数值为true。当前工作流仅支持流式调用。
  4. 在Postman中选择“Body > raw”选项,请求Body填写示例如下。
    其中,inputs参数为用户提出的问题,作为工作流的输入。plugin_id参数为插件ID,获取方式详见管理插件
    { 
      "inputs": {
        "query": "你好"
      },
      "plugin_configs": [
        {
          "plugin_id": "xxxxxxxxx",
          "config": {
            "key": "value"
          }
        }
      ]
    }
  5. 单击Postman界面“Send”,发送请求。当接口返回状态为200时,表示应用API调用成功,响应示例如下:

    提问器节点返回示例:

    {
        "conversation_id": "2c90493f-803d-431d-a197-57543d414317",
        "messages": [
            {
                "role": "assistant",
                "content": "请您提供年龄相关的信息"
            }
        ],
        "status": {
            "code": 1,
            "desc": "succeeded"
        },
        "start_time": 1734336269313,
        "end_time": 1734336270908
    }

    结束节点返回示例:

    {
        "conversation_id": "2c90493f-803d-431d-a197-57543d414317",
        "outputs": {
            "responseContent": "18"
        },
        "messages": [],
        "status": {
            "code": 1,
            "desc": "succeeded"
        },
        "start_time": 1734337068533,
        "end_time": 1734337082545
    }

相关文档