API重磅上新|工作流运行接口

2024-10-31 11:40   上海  

💡 关注我们,第一时间获取产品更新和相关资讯。

Link.AI 为用户提供了调用 AI 应用或 AI 工作流对话能力的开放 API,便于开发者通过接口开发来集成第三方系统和服务,以实现个性化的 AI 应用场景。

随着我们在 3.0.0 至 3.1.5 版本中不断推出新的功能,Link.AI 工作流已支持设置自定义的变量输入,并在流程节点中引用变量。这能够很好的满足需要同时输入多个、多模态内容来运行工作流的需求。

现在,这一能力正式提供开放 API 供企业客户和开发者们使用。


API 简介

该开放接口是用于 工作流运行 的高级接口,相较于通用的基础对话接口 ,该接口具备以下特性:

  • 支持传入工作流开始节点中的设置的自定义变量🔗

  • 支持图片类型和文件类型变量的输入🌄

  • 支持工作流中开启的上下文记忆功能🧠

你可以开发灵活、个性的前端界面,供用户输入文字、图片、文件、选项等内容,通过这个高级接口,调用 Link.AI 的后端服务对这些内容进行智能化的工作流加工,获取输出结果。如此可极大扩展个性化 AI 应用的能力边界。

下面我们用一个简单易懂的测算 BMI 指数的示例来介绍工作流运行接口的能力及使用方法:


搭建工作流

一个测算 BMI 的工作流,可以基于用户的身高和体重精确计算,也可以根据上传的体态照片大致计算。前者需要输入身高和体重的具体数值,后者需要输入一张侧面全身照

1. 首先,在工作流开始节点的变量设置中,新增两个文本类型的自定义变量:身高(height)体重(weight),并且可以打开系统变量中的默认图片变量(input_image)

2. 接下来,我们为两种场景分别设计一个分支:根据身高体重精确计算 BMI 、识别身材图片大致计算 BMI 。并且可以使用自定义变量「身高 」「体重」的输入情况作为分支判断条件

3. 再分别用代码块节点进行精确计算(引用输入的身高、体重变量编写代码逻辑)、用图像识别节点进行大致计算(引用输入的图片进行识别),最后用大模型节点进行内容总结生成。

一个能够测算 BMI 📊的健康小助手就搭建好了。

可通过网页端体验该工作流:👉戳我测算BMI



调用 API

使用工作流运行接口时,需传入你所设计的工作流 app_code ,并根据需求传入在工作流的开始节点中定义的系统内置变量(文本、图片、文件)或 自定义变量(文本、选项)的值。

请求示例🔗

{    "app_code": "G7z6vKwp",    "args": {        "input_text": "帮我计算BMI指数,并提供健康建议",      # 系统默认文本变量        "input_image": "",      # 系统默认图片变量        "input_file": "",       # 系统默认文件变量        "height": "1.8",        # 自定义变量,示例        "weight": "75"          # 自定义变量,示例    }}

注:

1. app_code:你构建的 Link.AI 工作流 code。

2. input_text、input_image、input_file分别为工作流的系统内置文本、图片和文件变量,可分别传入字符、图片 URL、文件 URL

响应示例💡

传入参数后,将调用 Link.AI 服务运行前面设计的 BMI 指数计算工作流,根据变量输入得到运行结果,在接口响应中返回。

{    "success": true,    "code": 200,    "message": "success",    "data": {        "output_text": "您好!您的BMI值是23.15,这个结果处于正常范围(18.5-23.9之间)。恭喜您,保持在这个范围内是健康的标志!\n\n为了进一步维护您的健康,建议您继续保持均衡的饮食和适量的运动。可以考虑增加一些富含纤维的食物,比如水果、蔬菜和全谷物,同时减少高糖和高脂肪食物的摄入。此外,每周至少进行150分钟的中等强度锻炼,比如快走、游泳或骑自行车,都是非常有益的。"    }}



其他说明

错误说明🙅‍♂️

当接口调用异常时❌,会返回以下结构(常见错误类型请参考完整接口文档),示例:

{    "success": false,    "code": 408,    "message": "当前版本无该API访问权限",    "data": null}
接口文档📚

点击查看 工作流运行接口文档,详细了解接口定义(接口地址、请求头、请求体、错误说明和示例代码等),可进行在线调试。

更多用法⭐️

除了文本、图片以外,还支持通过接口输入文件类型变量运行,目前支持 pdf、word、csv、excel、markdown 等文件格式。上传的文件可以在工作流中进行处理,目前「内容总结插件」节点、「大模型」节点、「渠道发送」节点均支持引用和处理文件类型的变量:

  • 内容总结插件对文件内容进行总结,可通过自定义节点输入来指定需要关注的关键信息、以及输出格式

  • 大模型: 更灵活的文件处理方式,可以通过自定义提示词来对文件内容进行 润色、改写、翻译、总结等

  • 渠道发送: 支持直接将文件类型发送至渠道,目前支持 企微、钉钉、飞书、微信客服。

版本说明💰

工作流运行接口需Link.AI 标准版及以上版本可使用。

咨询反馈❓

如有问题或建议,欢迎扫码添加客服微信,期待您的反馈:




LinkAI —— 更适合企业的领先AI智能体平台



点个“在看”吧!▼

LinkAI平台
LinkAI是领先的一站式AI Agent搭建平台,零代码快速构建企业级AI智能体,并一键发布至渠道。link-ai.tech