插件和流程编排应用

功能描述

本文主要介绍如何使用API调用阿里云百炼的插件和流程编排应用，包括从应用广场中创建的插件应用（如插件调用、插件调度应用、检索&插件调度增强）、流程编排中创建的应用和自然语言转SQL应用。

API详情

请求地址： https://bailian.aliyuncs.com/v2/app/completions

请求方式：POST

请求数据格式：JSON

请求参数

响应参数

示例

请求示例

curl -X "POST" "https://bailian.aliyuncs.com/v2/app/completions" \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: Bearer <Token>' \
-H 'Accept-charset: utf-8' \
-d '{
  "RequestId": "<RequestId>",
  "AppId": "<AppId>",
  "Prompt": "今天杭州的天气怎么样",
  "HasThoughts": true,
  "BizParams": {"userId": "123"}
}' --verbose

响应示例

{
  "Success": true,
  "Data": {
    "ResponseId": "3c59d91**********37e98135f",
    "Text": "今天杭州晴转多云。",
    "Thoughts": [],
    "Usage": [
      {
        "InputTokens": 10,
        "OutputTokens": 9,
        "ModelId": "bailian-plugin"
      }
    ]
  },
  "RequestId": "f0a953cc-*************-f32e606985d7"
}

请求示例（流式SSE）

curl -X "POST" "https://bailian.aliyuncs.com/v2/app/completions" \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: Bearer <Token>' \
-H 'Accept: text/event-stream' \
-H 'Accept-charset: utf-8' \
-d '{
  "RequestId": "<RequestId>",
  "AppId": "<AppId>",
  "Prompt": "今天杭州的天气怎么样",
  "HasThoughts": true,
  "BizParams": {"userId": "123"}
}' --verbose

响应示例（流式SSE）

data: {
  "Success": true,
  "Data": {
    "ResponseId": "3c59d91**********37e98135f",
    "Text": "今天杭州晴转多云。",
    "Thoughts": [],
    "Usage": [
      {
        "InputTokens": 10,
        "OutputTokens": 9,
        "ModelId": "bailian-plugin"
      }
    ]
  },
  "RequestId": "f0a953cc-*************-f32e606985d7"
}

请求示例（自然语言转SQL）

curl -X "POST" "https://bailian.aliyuncs.com/v2/app/completions" \
-H 'Content-Type: application/json; charset=utf-8' \
-H 'Authorization: Bearer <Token>' \
-H 'Accept-charset: utf-8' \
-d '{
  "RequestId": "<RequestId>",
  "AppId": "<AppId>",
  "Prompt": "浙江近五年GNP总和是多少",
  "BizParams": {
    "sqlInput": {
      "synonym_infos": "国民生产总值: GNP|Gross National Product",
      "schema_infos": [
        {
          "columns": [
            {
              "col_caption": "地区",
              "col_name": "region"
            },
            {
              "col_caption": "年份",
              "col_name": "year"
            },
            {
              "col_caption": "国民生产总值",
              "col_name": "gross_national_product"
            }
          ],
          "table_id": "t_gross_national_product_1",
          "table_desc": "国民生产总值表"
        }
      ]
    }
  }
}' --verbose

响应示例（自然语言转SQL）

{
  "Success": true,
  "Data": {
    "ResponseId": "1b595831****************4733ef5d41",
    "Text": "SELECT SUM(gross_national_product) AS 浙江近五年国民生产总值总和 FROM t_gross_national_product_1 WHERE region = '浙江' AND year >= YEAR(CURDATE()) - 5;",
    "Usage": [
      {
        "InputTokens": 194,
        "OutputTokens": 45,
        "ModelId": "bailian_nl2sql"
      }
    ]
  },
  "RequestId": "f0a953cc-*************-f32e606985d7"
}