You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README_KL.md 14KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. ![cover-v5-optimized](./images/GitHub_README_if.png)
  2. <p align="center">
  3. <a href="https://cloud.dify.ai">Dify Cloud</a> ·
  4. <a href="https://docs.dify.ai/getting-started/install-self-hosted">Self-hosting</a> ·
  5. <a href="https://docs.dify.ai">Documentation</a> ·
  6. <a href="https://dify.ai/pricing">Dify product editions</a>
  7. </p>
  8. <p align="center">
  9. <a href="https://dify.ai" target="_blank">
  10. <img alt="Static Badge" src="https://img.shields.io/badge/Product-F04438"></a>
  11. <a href="https://dify.ai/pricing" target="_blank">
  12. <img alt="Static Badge" src="https://img.shields.io/badge/free-pricing?logo=free&color=%20%23155EEF&label=pricing&labelColor=%20%23528bff"></a>
  13. <a href="https://discord.gg/FngNHpbcY7" target="_blank">
  14. <img src="https://img.shields.io/discord/1082486657678311454?logo=discord&labelColor=%20%235462eb&logoColor=%20%23f5f5f5&color=%20%235462eb"
  15. alt="chat on Discord"></a>
  16. <a href="https://reddit.com/r/difyai" target="_blank">
  17. <img src="https://img.shields.io/reddit/subreddit-subscribers/difyai?style=plastic&logo=reddit&label=r%2Fdifyai&labelColor=white"
  18. alt="Follow Reddit"></a>
  19. <a href="https://twitter.com/intent/follow?screen_name=dify_ai" target="_blank">
  20. <img src="https://img.shields.io/twitter/follow/dify_ai?logo=X&color=%20%23f5f5f5"
  21. alt="follow on X(Twitter)"></a>
  22. <a href="https://www.linkedin.com/company/langgenius/" target="_blank">
  23. <img src="https://custom-icon-badges.demolab.com/badge/LinkedIn-0A66C2?logo=linkedin-white&logoColor=fff"
  24. alt="follow on LinkedIn"></a>
  25. <a href="https://hub.docker.com/u/langgenius" target="_blank">
  26. <img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/langgenius/dify-web?labelColor=%20%23FDB062&color=%20%23f79009"></a>
  27. <a href="https://github.com/langgenius/dify/graphs/commit-activity" target="_blank">
  28. <img alt="Commits last month" src="https://img.shields.io/github/commit-activity/m/langgenius/dify?labelColor=%20%2332b583&color=%20%2312b76a"></a>
  29. <a href="https://github.com/langgenius/dify/" target="_blank">
  30. <img alt="Issues closed" src="https://img.shields.io/github/issues-search?query=repo%3Alanggenius%2Fdify%20is%3Aclosed&label=issues%20closed&labelColor=%20%237d89b0&color=%20%235d6b98"></a>
  31. <a href="https://github.com/langgenius/dify/discussions/" target="_blank">
  32. <img alt="Discussion posts" src="https://img.shields.io/github/discussions/langgenius/dify?labelColor=%20%239b8afb&color=%20%237a5af8"></a>
  33. </p>
  34. <p align="center">
  35. <a href="./README.md"><img alt="README in English" src="https://img.shields.io/badge/English-d9d9d9"></a>
  36. <a href="./README_CN.md"><img alt="简体中文版自述文件" src="https://img.shields.io/badge/简体中文-d9d9d9"></a>
  37. <a href="./README_JA.md"><img alt="日本語のREADME" src="https://img.shields.io/badge/日本語-d9d9d9"></a>
  38. <a href="./README_ES.md"><img alt="README en Español" src="https://img.shields.io/badge/Español-d9d9d9"></a>
  39. <a href="./README_FR.md"><img alt="README en Français" src="https://img.shields.io/badge/Français-d9d9d9"></a>
  40. <a href="./README_KL.md"><img alt="README tlhIngan Hol" src="https://img.shields.io/badge/Klingon-d9d9d9"></a>
  41. <a href="./README_KR.md"><img alt="README in Korean" src="https://img.shields.io/badge/한국어-d9d9d9"></a>
  42. <a href="./README_AR.md"><img alt="README بالعربية" src="https://img.shields.io/badge/العربية-d9d9d9"></a>
  43. <a href="./README_TR.md"><img alt="Türkçe README" src="https://img.shields.io/badge/Türkçe-d9d9d9"></a>
  44. <a href="./README_VI.md"><img alt="README Tiếng Việt" src="https://img.shields.io/badge/Ti%E1%BA%BFng%20Vi%E1%BB%87t-d9d9d9"></a>
  45. <a href="./README_BN.md"><img alt="README in বাংলা" src="https://img.shields.io/badge/বাংলা-d9d9d9"></a>
  46. </p>
  47. #
  48. <p align="center">
  49. <a href="https://trendshift.io/repositories/2152" target="_blank"><img src="https://trendshift.io/api/badge/repositories/2152" alt="langgenius%2Fdify | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
  50. </p>
  51. Dify is an open-source LLM app development platform. Its intuitive interface combines AI workflow, RAG pipeline, agent capabilities, model management, observability features and more, letting you quickly go from prototype to production. Here's a list of the core features:
  52. </br> </br>
  53. **1. Workflow**:
  54. Build and test powerful AI workflows on a visual canvas, leveraging all the following features and beyond.
  55. **2. Comprehensive model support**:
  56. Seamless integration with hundreds of proprietary / open-source LLMs from dozens of inference providers and self-hosted solutions, covering GPT, Mistral, Llama3, and any OpenAI API-compatible models. A full list of supported model providers can be found [here](https://docs.dify.ai/getting-started/readme/model-providers).
  57. ![providers-v5](https://github.com/langgenius/dify/assets/13230914/5a17bdbe-097a-4100-8363-40255b70f6e3)
  58. **3. Prompt IDE**:
  59. Intuitive interface for crafting prompts, comparing model performance, and adding additional features such as text-to-speech to a chat-based app.
  60. **4. RAG Pipeline**:
  61. Extensive RAG capabilities that cover everything from document ingestion to retrieval, with out-of-box support for text extraction from PDFs, PPTs, and other common document formats.
  62. **5. Agent capabilities**:
  63. You can define agents based on LLM Function Calling or ReAct, and add pre-built or custom tools for the agent. Dify provides 50+ built-in tools for AI agents, such as Google Search, DALL·E, Stable Diffusion and WolframAlpha.
  64. **6. LLMOps**:
  65. Monitor and analyze application logs and performance over time. You could continuously improve prompts, datasets, and models based on production data and annotations.
  66. **7. Backend-as-a-Service**:
  67. All of Dify's offerings come with corresponding APIs, so you could effortlessly integrate Dify into your own business logic.
  68. ## Feature Comparison
  69. <table style="width: 100%;">
  70. <tr>
  71. <th align="center">Feature</th>
  72. <th align="center">Dify.AI</th>
  73. <th align="center">LangChain</th>
  74. <th align="center">Flowise</th>
  75. <th align="center">OpenAI Assistants API</th>
  76. </tr>
  77. <tr>
  78. <td align="center">Programming Approach</td>
  79. <td align="center">API + App-oriented</td>
  80. <td align="center">Python Code</td>
  81. <td align="center">App-oriented</td>
  82. <td align="center">API-oriented</td>
  83. </tr>
  84. <tr>
  85. <td align="center">Supported LLMs</td>
  86. <td align="center">Rich Variety</td>
  87. <td align="center">Rich Variety</td>
  88. <td align="center">Rich Variety</td>
  89. <td align="center">OpenAI-only</td>
  90. </tr>
  91. <tr>
  92. <td align="center">RAG Engine</td>
  93. <td align="center">✅</td>
  94. <td align="center">✅</td>
  95. <td align="center">✅</td>
  96. <td align="center">✅</td>
  97. </tr>
  98. <tr>
  99. <td align="center">Agent</td>
  100. <td align="center">✅</td>
  101. <td align="center">✅</td>
  102. <td align="center">❌</td>
  103. <td align="center">✅</td>
  104. </tr>
  105. <tr>
  106. <td align="center">Workflow</td>
  107. <td align="center">✅</td>
  108. <td align="center">❌</td>
  109. <td align="center">✅</td>
  110. <td align="center">❌</td>
  111. </tr>
  112. <tr>
  113. <td align="center">Observability</td>
  114. <td align="center">✅</td>
  115. <td align="center">✅</td>
  116. <td align="center">❌</td>
  117. <td align="center">❌</td>
  118. </tr>
  119. <tr>
  120. <td align="center">Enterprise Feature (SSO/Access control)</td>
  121. <td align="center">✅</td>
  122. <td align="center">❌</td>
  123. <td align="center">❌</td>
  124. <td align="center">❌</td>
  125. </tr>
  126. <tr>
  127. <td align="center">Local Deployment</td>
  128. <td align="center">✅</td>
  129. <td align="center">✅</td>
  130. <td align="center">✅</td>
  131. <td align="center">❌</td>
  132. </tr>
  133. </table>
  134. ## Using Dify
  135. - **Cloud </br>**
  136. We host a [Dify Cloud](https://dify.ai) service for anyone to try with zero setup. It provides all the capabilities of the self-deployed version, and includes 200 free GPT-4 calls in the sandbox plan.
  137. - **Self-hosting Dify Community Edition</br>**
  138. Quickly get Dify running in your environment with this [starter guide](#quick-start).
  139. Use our [documentation](https://docs.dify.ai) for further references and more in-depth instructions.
  140. - **Dify for Enterprise / Organizations</br>**
  141. We provide additional enterprise-centric features. [Send us an email](mailto:business@dify.ai?subject=[GitHub]Business%20License%20Inquiry) to discuss enterprise needs. </br>
  142. > For startups and small businesses using AWS, check out [Dify Premium on AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-t22mebxzwjhu6) and deploy it to your own AWS VPC with one-click. It's an affordable AMI offering with the option to create apps with custom logo and branding.
  143. ## Staying ahead
  144. Star Dify on GitHub and be instantly notified of new releases.
  145. ![star-us](https://github.com/langgenius/dify/assets/13230914/b823edc1-6388-4e25-ad45-2f6b187adbb4)
  146. ## Quick Start
  147. > Before installing Dify, make sure your machine meets the following minimum system requirements:
  148. >
  149. >- CPU >= 2 Core
  150. >- RAM >= 4GB
  151. </br>
  152. The easiest way to start the Dify server is to run our [docker-compose.yml](docker/docker-compose.yaml) file. Before running the installation command, make sure that [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) are installed on your machine:
  153. ```bash
  154. cd docker
  155. cp .env.example .env
  156. docker compose up -d
  157. ```
  158. After running, you can access the Dify dashboard in your browser at [http://localhost/install](http://localhost/install) and start the initialization process.
  159. > If you'd like to contribute to Dify or do additional development, refer to our [guide to deploying from source code](https://docs.dify.ai/getting-started/install-self-hosted/local-source-code)
  160. ## Next steps
  161. If you need to customize the configuration, please refer to the comments in our [.env.example](docker/.env.example) file and update the corresponding values in your `.env` file. Additionally, you might need to make adjustments to the `docker-compose.yaml` file itself, such as changing image versions, port mappings, or volume mounts, based on your specific deployment environment and requirements. After making any changes, please re-run `docker-compose up -d`. You can find the full list of available environment variables [here](https://docs.dify.ai/getting-started/install-self-hosted/environments).
  162. If you'd like to configure a highly-available setup, there are community-contributed [Helm Charts](https://helm.sh/) and YAML files which allow Dify to be deployed on Kubernetes.
  163. - [Helm Chart by @LeoQuote](https://github.com/douban/charts/tree/master/charts/dify)
  164. - [Helm Chart by @BorisPolonsky](https://github.com/BorisPolonsky/dify-helm)
  165. - [Helm Chart by @magicsong](https://github.com/magicsong/ai-charts)
  166. - [YAML file by @Winson-030](https://github.com/Winson-030/dify-kubernetes)
  167. - [YAML file by @wyy-holding](https://github.com/wyy-holding/dify-k8s)
  168. - [🚀 NEW! YAML files (Supports Dify v1.6.0) by @Zhoneym](https://github.com/Zhoneym/DifyAI-Kubernetes)
  169. #### Terraform atorlugu pilersitsineq
  170. wa'logh nIqHom neH ghun deployment toy'wI' [terraform](https://www.terraform.io/) lo'laH.
  171. ##### Azure Global
  172. - [Azure Terraform mung @nikawang](https://github.com/nikawang/dify-azure-terraform)
  173. ##### Google Cloud
  174. - [Google Cloud Terraform qachlot @sotazum](https://github.com/DeNA/dify-google-cloud-terraform)
  175. #### AWS CDK atorlugh pilersitsineq
  176. wa'logh nIqHom neH ghun deployment toy'wI' [CDK](https://aws.amazon.com/cdk/) lo'laH.
  177. ##### AWS
  178. - [AWS CDK qachlot @KevinZhao](https://github.com/aws-samples/solution-for-deploying-dify-on-aws)
  179. #### Alibaba Cloud
  180. [Alibaba Cloud Computing Nest](https://computenest.console.aliyun.com/service/instance/create/default?type=user&ServiceName=Dify%E7%A4%BE%E5%8C%BA%E7%89%88)
  181. #### Alibaba Cloud Data Management
  182. [Alibaba Cloud Data Management](https://www.alibabacloud.com/help/en/dms/dify-in-invitational-preview/)
  183. ## Contributing
  184. For those who'd like to contribute code, see our [Contribution Guide](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md).
  185. At the same time, please consider supporting Dify by sharing it on social media and at events and conferences.
  186. > We are looking for contributors to help with translating Dify to languages other than Mandarin or English. If you are interested in helping, please see the [i18n README](https://github.com/langgenius/dify/blob/main/web/i18n/README.md) for more information, and leave us a comment in the `global-users` channel of our [Discord Community Server](https://discord.gg/8Tpq4AcN9c).
  187. **Contributors**
  188. <a href="https://github.com/langgenius/dify/graphs/contributors">
  189. <img src="https://contrib.rocks/image?repo=langgenius/dify" />
  190. </a>
  191. ## Community & Contact
  192. * [GitHub Discussion](https://github.com/langgenius/dify/discussions
  193. ). Best for: sharing feedback and asking questions.
  194. * [GitHub Issues](https://github.com/langgenius/dify/issues). Best for: bugs you encounter using Dify.AI, and feature proposals. See our [Contribution Guide](https://github.com/langgenius/dify/blob/main/CONTRIBUTING.md).
  195. * [Discord](https://discord.gg/FngNHpbcY7). Best for: sharing your applications and hanging out with the community.
  196. * [X(Twitter)](https://twitter.com/dify_ai). Best for: sharing your applications and hanging out with the community.
  197. ## Star History
  198. [![Star History Chart](https://api.star-history.com/svg?repos=langgenius/dify&type=Date)](https://star-history.com/#langgenius/dify&Date)
  199. ## Security Disclosure
  200. To protect your privacy, please avoid posting security issues on GitHub. Instead, send your questions to security@dify.ai and we will provide you with a more detailed answer.
  201. ## License
  202. This repository is available under the [Dify Open Source License](LICENSE), which is essentially Apache 2.0 with a few additional restrictions.