咱们话不多说,直接说正事。
教学目标:
新手用户用dify构建一个基于阿里云工商信息查询api的工作流应用。
要达成的预期:
-
阿里云工商查询api做成dify的工具
-
将做好的工具接入到工作流中跑起来。
准备工作:
-
拥有一个阿里云账户,并在云市场选择一个工商信息查询api的服务商,出于练手目的,推荐找那种可以免费体验的服务商,先看看他们家的服务行不行,再根据实际业务需要择量采购。
-
你需要在自己的服务器上部署dify。本期教程不教你如何部署,dify是一个开源的项目,可自行学习,如果实在不懂,给我留言吧。
手把手教学步骤:
-
我们先选择一个阿里云工商信息查询api的服务商。
(1)登录阿里云账号后,去云市场搜索“企业工商信息查询”。如果你实在懒得搜,我直接给你推荐一家服务商:
https://market.aliyun.com/apimarket/detail/cmapi029030#sku=yuncode23030000014
(这家技术服务还不错的,我们公司在阿里云上使用工商信息查询服务,一直都用他们家的。并且我们对他们家的接口调用次数有几万次了,因为我们用过,所以我推荐。)
(2)选择免费试用。
(3)返回阿里云控制中心,点击“云市场”。复制appcode记下来,待会要用。

2.登录你在服务器部署的dify后台,点击顶部导航的工具,点击“自定义”,点击“创建自定义工具”,如下图所示:

(1)输入工具名称,如:阿里云工商信息查询…..(随你自己取名,但一定要取一个名字)
(2)在鉴权方法那里填入appcode。点击鉴权方法的下拉框,鉴权类型选择“api key”.
健,填写:
Authorization
值,填写:你复制的那个appcode。
整体如下图所示:

点击保存。
(3)编写工具swagger格式的openapi代码。

我给大家提供我自己写的swagger-openapi代码示例:
{"openapi": "3.1.0","info": {"title": "天眼查-精准查询工商信息","description": "天眼查-精准查询工商信息","version": "1.0.0"},"tags": [],"paths": {"/getCompanyBaseInfo/{CompanyNameOrCreditNo}/": {"get": {"operationId": "CompanyNameOrCreditNo","summary": "天眼查-精准查询工商信息","deprecated": true,"description": "企业全称或者全国统一信用代码","tags": [],"parameters": [{"name": "CompanyNameOrCreditNo","in": "path","description": "企业全称或者全国统一信用代码","required": true,"example": "安徽建工集团股份有限公司","schema": {"type": "string"}}],"responses": {"200": {"description": "成功","content": {"application/json": {"schema": {"type": "object","properties": {}}}}},"1101": {"description": "输入的名称不合法","content": {"application/json": {"schema": {"type": "object","properties": {}}}}},"1102": {"description": "请求超时","content": {"application/json": {"schema": {"type": "object","properties": {}}}}},"1103": {"description": "服务器异常","content": {"application/json": {"schema": {"type": "object","properties": {}}}}},"1104": {"description": "无法匹配到传入的企业全称","content": {"application/json": {"schema": {"type": "object","properties": {}}}}},"1105": {"description": "系统繁忙","content": {"application/json": {"schema": {"type": "object","properties": {}}}}}},"security": []}}},"components": {"schemas": {},"securitySchemes": {}},"servers": [{"url": "https://api.81api.com"}]}
复制这段代码到指定位置即可。如果你有一定的编码能力,可自行优化。
(小声BB:其实我写的示例代码已经够用了)
代码写好后,点击“保存”。
到这里,恭喜你,dify中构建一个基于阿里云的工商信息查询工具,就已经实现了。
实现归实现,是骡子是马,得拉出来溜溜,看看到底对不对,能不能跑起来最重要。那么你就需要继续往下看。
我们实操一次,用dify的workflow快速构建一个基于工商信息查询工具的工作流出来,并运行这个工作流,实现:输入一个企业名称,查询该企业的工商信息结果。
3.构建工作流测试我们刚创建的工具。
假设:
我们输入一个企业名称,要求工作流输出这个企业的统一社会信用代码和企业名称。
业务分析:
首先我们要分析一下我们的工作流实现逻辑。这个工具需要传入一个具体的企业名称,那么就意味着我们需要设定一个输入字段,接收这个字段,并传给工商信息数据去查询,然后将查询出来的结果做一个简单的json字段解析,最后展示出企业名称和该企业的统一社会信用代码。
(1)OK。说干就干,在“开始”组件中,建立一个字段“name”,如下图所示:

(2)“开始”组件之后要拉出一个新的节点,这个节点,我们就选择刚创建好的工具节点。
工具节点,我们要设置一个输入变量,选择“开始”组件中的“name”即可。如上图所示。
(3)工具节点之后再拉出一个“代码执行”节点,该节点用于解析阿里云接口返回的json数据内容,因为我们要提取统一社会信用代码,所以我们需要通过代码脚本提取出统一社会信用代码这个参数。
(3.1)将工具节点的输出变量,设置为代码执行局节点的输入变量。
是的,你没看错,因为工具节点的输出,其实就是代码节点的输入,你得设置一下,不然人家不知道输入是什么,懂了么?

我知道你是懒人,懒得手动拼写这个参数名,所以,你还是直接复制吧。
http_response
(3.2)写入Python代码,用于解析工具传回的json代码。代码示例如下:
def main(http_response: str) -> dict:import jsontry:# 尝试解析JSONdata = json.loads(http_response)# 尝试提取统一社会信用代码register_no = data['data']['registerData'].get('creditNo', 'creditNo not found')# 尝试提取公司名称company_name = data['data'].get('name', 'Company Name not found')# 构建结果字典并返回return {'register_no': register_no,'company_name': company_name}except json.JSONDecodeError:# 如果JSON解析失败,返回错误信息字典return {'error': "Failed to decode JSON"}except KeyError as e:# 如果缺少某个键,返回错误信息字典return {'error': f"Missing key in JSON data: {e}"}

如图所示,你参考下,别弄错了哦。
(3.3)设置代码节点的输出变量,用于最终结果展示。

直接参考吧,懒人请直接复制下面的吧:
这个参数指社会统一信用代码的字段名。
register_no
这个参数指企业全称的字段名。
company_name
(4)代码执行节点之后再拉出一个模型转换节点。如下图所示:

解释一下这个节点为什么是这样:
两个输入字段名是不是很熟悉,就是你刚填写的,这两个字段作为模版节点的输入变量,模板节点接收到这两个变量之后,才能在模板代码中引用展示。
在模板的代码节点中,你是不是一下子就感觉自己懂了,错,你没懂,jinjia2格式的代码看起来就像是正常的文档一样,其实它属于模板语法,变量需要通过两个花括号标记。
你之所以觉得它简单,是因为我们本次示例没有那么多额外的要求,所以不需要复杂的构造。
公司名称:{{ company_name }}统一社会信用代码:{{ register_no }}
(5)最后拉出一个“结束”节点。将模板节点的输出,作为“结束”节点的输入。展示最终效果。到这里,这个简单但完整的工作量就算构建成功了,如下图所示:

到这里,恭喜你,你可以去调试,自己跑一遍整体工作流了。以下是我又跑了一遍的结果:


