GitHub – langgenius/dify: Dify
项目简介
项目背景
随着人工智能技术的飞速发展，大语言模型（LLM）在众多领域展现出了巨大的应用潜力。然而，将大语言模型高效地应用于实际应用开发，对于很多开发者来说存在诸多挑战，比如如何便捷地整合不同的模型、构建复杂的AI工作流程、实现有效的数据检索增强生成（RAG）以及管理模型的性能和可观测性等。在这样的背景下，Dify应运而生，它旨在为开发者提供一个一站式的开源大语言模型应用开发平台，降低开发门槛，加速从原型到生产的过程，助力更多创新的AI应用落地。
项目目标
Dify的主要目标是打造一个功能全面且易用的LLM应用开发平台。一方面，它希望通过直观的界面让开发者能够轻松构建和测试强大的AI工作流程，无论是经验丰富的专业开发者还是刚踏入AI开发领域的新手，都能快速上手。另一方面，它致力于整合各类LLM资源，包括众多专有和开源的大语言模型，提供无缝的集成体验，并且支持丰富的功能扩展，如RAG管道、智能代理能力、模型管理以及可观测性等功能，以满足不同场景下AI应用开发的多样化需求，最终帮助开发者高效地创建出高质量、可落地的AI应用。
项目特点
创新的可视化工作流程构建
Dify提供了可视化的画布，开发者可以在上面构建和测试强大的AI工作流程。这一创新点改变了传统通过代码编写复杂逻辑来构建AI应用流程的方式，让开发者能够直观地拖拽、连接各个组件，快速搭建起所需的工作流程，极大地提高了开发效率，同时也便于对流程进行调试和优化，降低了开发过程中的理解成本和出错概率。
全面的模型支持
它能够无缝集成来自数十个推理提供商的数百种专有和开源的大语言模型，涵盖了GPT、Mistral、Llama3以及任何与OpenAI API兼容的模型等。开发者无需为接入不同模型而耗费大量精力去适配不同的接口和处理复杂的兼容性问题，在Dify平台上可以便捷地选择和切换使用各种模型，根据具体应用场景找到最适合的模型来驱动AI应用，这为开发多样化、高性能的AI应用提供了坚实的模型基础。
强大的提示词集成开发环境（Prompt IDE）
具备直观的界面用于精心设计提示词，开发者可以方便地比较不同模型在相同提示词下的性能表现，并且还能为基于聊天的应用添加如文本转语音等额外功能。这使得开发者能够更精细地打磨提示词，提升AI应用的交互效果和响应质量，从用户输入的源头就进行优化，进而增强整个应用的智能程度和用户体验。
完善的RAG管道功能
拥有广泛的RAG能力，覆盖了从文档摄取到检索的全流程，并且对PDF、PPT等常见文档格式提供开箱即用的文本提取支持。这意味着在开发涉及知识问答、文档分析等应用场景时，开发者可以轻松利用这些功能，让AI应用能够快速准确地从大量文档中获取相关知识并用于生成回答，有效拓展了AI应用的知识储备和应用范围。
智能代理能力
允许开发者基于LLM Function Calling或ReAct来定义智能代理，并添加预构建或自定义的工具。Dify提供了50多种内置工具供AI代理使用，例如Google Search、DALL·E、Stable Diffusion和WolframAlpha等。通过智能代理，AI应用能够更加主动地去获取外部信息、执行特定任务，实现更复杂、智能的交互逻辑，仿佛拥有了一个可以自主行动的“智能助手”，极大地丰富了AI应用的功能和应用场景。
有效的LLMOps支持
能够长期监测和分析应用的日志以及性能表现。开发者可以依据生产数据和标注信息持续改进提示词、数据集以及所选用的模型，保证AI应用在长期运行过程中不断优化，性能始终处于良好状态，更好地适应业务变化和用户需求的演变，提高应用的稳定性和可靠性。
便捷的后端即服务（Backend-as-a-Service）
Dify所有的功能都配备了相应的API，开发者可以毫不费力地将其融入到自己的业务逻辑中。无论是构建移动端应用、网页应用还是其他类型的软件项目，都可以方便地调用Dify的功能，实现AI能力的嵌入，使得AI应用的开发和集成变得更加灵活、高效，有助于拓展应用的部署场景和与其他系统的协同工作能力。
技术原理
技术细节剖析
- 架构层面：Dify整体采用了分层架构设计，底层对接各类大语言模型的接口，进行模型的调用和数据交互；中间层构建了工作流程引擎、RAG模块、智能代理模块等核心功能组件，实现对AI应用逻辑的处理和协调；上层则通过直观的用户界面，将这些复杂的功能以可视化、易于操作的方式呈现给开发者。例如在工作流程引擎中，通过定义好的节点类型和流程规则，将开发者在可视化画布上搭建的流程转化为可执行的代码逻辑，然后在运行时按照顺序调用相应的模型和工具来完成任务流程。
- 数据处理方面：对于RAG功能，在文档摄取阶段，会运用合适的文档解析技术将不同格式（如PDF、PPT等）的文档内容提取出来，转化为文本数据，并进行预处理，如分词、向量化等操作，以便后续能高效地与大语言模型的输入要求相匹配。在检索阶段，利用向量数据库等技术对预处理后的文本数据建立索引，根据用户输入的查询请求，快速检索出相关的文本片段，再将其与用户的原始问题一起作为大语言模型的输入，从而生成更贴合上下文、更准确的回答。
对比不同技术路径
- 与传统AI开发平台对比：传统的AI开发往往需要开发者自行搭建模型训练环境、处理数据预处理、模型选择和集成等一系列繁琐的工作，而且对于复杂的工作流程构建和调试也比较困难。而Dify将这些常见的功能进行了整合和封装，提供可视化的操作界面，大大简化了开发流程，降低了开发门槛，开发者可以更聚焦于应用的业务逻辑设计。
- 与其他LLM应用开发工具对比：部分工具可能只侧重于某一方面的功能，比如有的仅专注于模型调用，有的只提供简单的提示词管理。但Dify涵盖了从模型管理、工作流程构建、RAG到智能代理等多维度的功能，是一个更加全面的开发平台，能满足AI应用从简单到复杂的多种开发需求，并且在不同功能模块之间实现了较好的协同和交互，使得整个应用开发更加流畅和高效。
技术创新点
- 可视化与代码逻辑的深度融合：将复杂的AI工作流程通过可视化的方式呈现给开发者，同时又能在后台精准地将其转化为可执行的代码逻辑，这种创新的设计在提高开发效率的同时，也保证了应用的灵活性和可扩展性，使得开发者既可以通过直观的操作快速搭建原型，又能在需要深入定制时方便地对代码进行修改和扩展。
- 智能代理的多功能工具集成：在智能代理方面，不仅提供了多种定义代理的方式，还集成了大量实用的内置工具，这使得智能代理能够在不同的应用场景下发挥作用，拓展了AI应用的功能边界，让AI能够更加主动地与外部环境进行交互，实现更复杂的任务，这在当前的LLM应用开发领域是一个较为突出的创新点，能够助力开发者打造出更具智能和交互性的应用。
类似项目
LangChain
项目简介：LangChain是一个用于开发由语言模型驱动的应用程序的开源框架。它提供了一系列工具和接口，帮助开发者将语言模型与其他数据源、计算资源等进行连接和整合，比如可以方便地实现文档的加载、链的构建（用于组合多个语言模型调用等操作）以及与外部工具的交互等功能，旨在简化语言模型应用开发过程，让开发者能够更高效地构建出如智能问答系统、文本生成应用等各类AI应用。其官网为https://python.langchain.com/ 。
LlamaIndex
项目简介：LlamaIndex是一个专注于帮助开发者利用大语言模型更好地处理和查询数据的项目。它提供了数据索引、查询增强等功能，特别是针对外部文档数据，能够让大语言模型更高效地与之交互，提取有用信息并生成高质量的回答。开发者可以通过它来构建具有知识增强能力的AI应用，比如基于文档知识库的智能客服系统等。其官网为https://www.llamaindex.ai/ 。
Haystack
项目简介：Haystack是一个用于构建端到端的自然语言处理管道的开源框架，可用于开发如问答系统、语义搜索等应用。它集成了多种自然语言处理组件，包括文档检索、文本预处理、语言模型调用等功能模块，开发者可以灵活配置这些模块来搭建适合自己需求的NLP应用，并且支持与不同的大语言模型进行集成，方便打造出功能强大、性能优良的AI应用。其官网为https://www.deepset.ai/haystack 。
环境配置
在使用https://github.com/langgenius/dify这个开源项目之前，我们需要先进行相应的环境配置，以确保项目能够顺利运行。
系统要求
首先，要保证你的机器满足最低系统要求，具体来说，CPU需要至少2核心，内存（RAM）要达到4 GiB及以上。低于这个配置的话，在运行项目时可能会出现卡顿甚至无法正常启动等情况，所以务必提前确认好硬件条件是否符合。
软件依赖
项目推荐使用Docker和Docker Compose来进行部署，所以需要提前在你的机器上安装好这两个软件。对于Docker，它是一种容器化平台，能够帮助我们轻松打包、分发以及运行应用程序，而Docker Compose则是用于定义和运行多容器Docker应用程序的工具，通过编写一个简单的配置文件（docker-compose.yaml），就可以方便地管理多个相关联的容器，这对于Dify这种复杂的应用平台来说非常实用。
不同操作系统安装Docker和Docker Compose的方式略有不同。例如在常见的Ubuntu系统中，可以通过以下命令来安装Docker：
sudo apt-get update
sudo apt-get install docker.io
安装完成后，设置Docker服务开机自启：
sudo systemctl enable docker
sudo systemctl start docker
而安装Docker Compose可以使用以下命令（以安装较新版本为例）：
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
在Windows系统上，可以从Docker官方网站下载对应的安装包进行安装，安装过程中按照提示逐步操作即可完成Docker以及Docker Desktop（包含了Docker Compose功能）的安装。
配置文件调整
项目提供了一个 .env.example 文件作为环境变量配置的示例模板，我们通常需要基于这个文件来创建实际使用的 .env 文件，并根据自己的需求调整其中的配置参数。比如可能需要配置数据库连接相关的参数，像数据库的地址、端口、用户名和密码等信息（如果使用外部数据库的话）；还有可能需要配置一些与项目功能相关的自定义参数，例如是否开启某些特定的功能模块等。
此外，有时候根据具体的部署环境和要求，还可能需要对 docker-compose.yaml 文件本身进行调整，比如更改镜像版本（如果有新版本发布想要尝鲜或者修复特定版本的问题时）、端口映射（当默认端口与本地其他应用冲突或者想要使用特定端口对外提供服务时）以及卷挂载（用于持久化数据存储等情况）等操作。
安装
完成环境配置后，就可以开始进行项目的安装了，以下是详细的安装步骤：
克隆项目代码（可选）
虽然可以直接使用项目提供的预构建镜像等方式来运行，但如果后续你有想要深入研究代码或者进行自定义开发等需求的话，可以先将项目代码克隆到本地。使用Git命令来克隆项目仓库：
git clone https://github.com/langgenius/dify.git
克隆完成后，进入到项目的根目录，后续的操作基本都在这个目录下进行。
通过Docker Compose启动
在已经安装好Docker和Docker Compose并且配置好相关环境变量和配置文件后，进入到项目的 dify/docker 目录下，将 .env.example 文件复制一份并重命名为 .env，命令如下：
cd dify/docker
cp.env.example.env
然后使用 docker compose up -d 命令来启动项目，-d 参数表示在后台运行容器，这样就不会占用当前终端的输入输出，启动后可以通过浏览器访问 http://localhost/install 进入到Dify的仪表盘界面，开始进行初始化等后续操作。
其他部署方式（可选）
对于想要更高级的部署配置，比如配置高可用的设置，社区有贡献的Helm Charts和YAML文件，可以将Dify部署在Kubernetes上，像由 @LeoQuote、@BorisPolonsky 等开发者提供的Helm Chart资源，或者 @Winson-030 提供的YAML文件等都可以参考使用。
另外，如果想使用Terraform进行部署，项目也支持将Dify一键部署到云平台上，例如Azure平台有对应的Azure Terraform（由 @nikawang 提供），Google Cloud平台有相应的Google Cloud Terraform（由 @sotazum 提供）等方式；对于AWS平台，还可以使用AWS CDK（由 @KevinZhao 提供）来将Dify部署到AWS上，开发者可以根据自己熟悉的平台以及具体的使用场景来选择合适的部署方式。
使用
当成功安装并启动Dify后，就可以开始使用这个强大的开源LLM应用开发平台了，下面介绍一些主要的使用方面。
构建AI工作流
在Dify直观的界面上，可以通过可视化的画布来构建和测试强大的AI工作流。就好比搭建一个流程图一样，将各个AI相关的操作节点按照逻辑顺序连接起来，比如可以先接入不同的大语言模型（LLM），然后设置数据的输入、处理步骤，再定义输出的格式等，充分利用其提供的各种功能特性，像是可以结合RAG（检索增强生成）管道，让AI在回答问题时能够从相关文档中检索到更准确的信息来辅助生成更合理的回复内容。
例如，我们要构建一个智能文档问答的工作流，首先接入合适的LLM（如GPT、Llama等支持的模型），然后配置好文档摄入的模块，将本地的PDF文档、PPT等资料导入到系统中，通过RAG功能让AI在面对用户关于文档内容的提问时，能够先从这些文档里检索出相关内容，再基于大语言模型进行回答的生成，整个过程都可以在可视化的界面上方便地进行拖拽、配置等操作来完成工作流的搭建。
模型管理与集成
Dify支持无缝集成上百种来自数十个推理提供商的专有或开源大语言模型，以及自托管的解决方案，涵盖了诸如GPT、Mistral、Llama3等常见且热门的模型，甚至还包括任何与OpenAI API兼容的模型。在平台中，可以方便地对这些模型进行管理，比如切换使用不同的模型来对比它们在不同任务场景下的性能表现，还能针对不同的应用需求选择最合适的模型进行部署。
比如，在开发一个智能客服应用时，可能刚开始使用GPT模型进行测试，发现其回答的准确性较高但成本也相对较高，后续可以切换到Llama3等开源模型进行测试，看看在保证一定准确性的基础上能否降低成本，通过在Dify平台上简单的配置操作就能实现模型的切换和对比评估。
Prompt IDE使用
其提供了一个直观的Prompt（提示词）集成开发环境（IDE），在这里可以精心编写提示词，这对于提升AI应用的效果至关重要。可以通过这个界面来比较不同模型在相同提示词下的性能表现，还能为基于聊天的应用添加额外的功能，比如文本转语音功能等。
例如，开发一个聊天机器人应用，在Prompt IDE中编写不同风格的提示词，像正式商务风格、亲切友好风格等，然后观察不同模型基于这些提示词生成的回复内容，选择最符合应用定位的提示词风格和模型组合，并且还可以添加文本转语音功能，让聊天机器人回复的内容能够直接转化成语音播放给用户听。
利用Agent能力
可以基于LLM Function Calling（函数调用）或者ReAct等方式来定义智能体（Agent），并且还能为智能体添加预构建或者自定义的工具。Dify提供了50多种内置的工具供AI智能体使用，例如Google Search（可以让智能体具备联网搜索信息的能力）、DALL·E（能生成图片）、Stable Diffusion（用于生成图像）以及WolframAlpha（用于科学计算等）等。
假设我们要开发一个智能助手应用，定义一个智能体，让它能够根据用户的需求，比如用户询问今天的天气情况，智能体可以调用Google Search工具去查询实时天气信息并回复给用户；如果用户说想要一张美丽的风景画，智能体则可以调用DALL·E或者Stable Diffusion工具来生成符合要求的图片并展示给用户。
LLMOps相关操作
在应用上线运行后，通过Dify的LLMOps功能可以长期监控和分析应用的日志以及性能情况。基于生产环境中收集到的数据以及用户的标注反馈等信息，可以持续不断地对提示词、数据集以及所使用的模型进行优化改进，从而提升整个AI应用的效果和用户体验。
比如，一个内容生成的AI应用，通过分析用户对生成内容的满意度评分、阅读时长等日志数据，发现某些类型的提示词生成的内容点击率较低，就可以针对性地调整提示词，或者更换不同的模型，再重新观察应用的性能指标变化，进行持续的优化迭代。
注意事项
在使用Dify项目的过程中，有以下一些需要注意的地方。
遇到问题的解决途径
如果在安装设置Dify时遇到问题，首先参考项目的FAQ（常见问题解答）文档，很多常见的安装配置、使用初期的问题在这里都能找到答案。要是查阅FAQ后仍然无法解决问题，可以向社区寻求帮助，在GitHub的Discussion板块分享你的问题、反馈或者向其他开发者提问，这里比较适合交流使用过程中的各种疑问以及分享使用心得等；而如果是遇到了使用Dify过程中出现的Bug或者有功能方面的建议，则可以通过GitHub Issues板块来提交，方便项目维护者和其他开发者一起查看并协助解决。另外，还可以通过Discord等社区平台，和其他使用者一起交流分享自己开发的应用等情况，共同探讨使用中遇到的问题和解决方案。
安全相关问题
出于保护隐私的考虑，千万不要在GitHub上发布安全相关的问题，一旦发现有安全方面的疑问，应该将问题发送到 security@dify.ai 这个邮箱，项目团队会提供更详细准确的解答，这样能确保安全问题得到妥善的处理，避免可能出现的安全风险隐患影响到项目的正常使用以及数据安全等。
版本更新
项目在不断发展，会不定期发布新的版本，建议及时关注项目的更新情况，比如通过在GitHub上给项目加星（Star）的方式，能即时收到项目发布新的版本的通知。在更新版本时，如果是通过Docker方式部署的，可能需要关注镜像版本的变化，按照前面提到的对 docker-compose.yaml 文件中镜像相关配置进行调整，并且重新运行 docker-compose up -d 命令来使更新生效，同时还要留意更新日志中提到的功能变更、兼容性等相关说明，避免更新后出现一些功能异常或者与现有业务逻辑不兼容的情况。
贡献代码相关
如果有开发者想要为项目贡献代码，那么需要仔细阅读项目的 Contribution Guide（贡献指南），里面详细说明了代码的提交规范、分支管理要求、如何发起Pull Request等内容，遵循这些规范能让代码贡献的流程更加顺畅，也便于项目维护者进行代码的审核和合并等操作。并且在进行自定义开发或者修改代码时，要注意做好代码的备份以及测试工作，确保自己的修改不会对原有的功能造成破坏。
