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_id.md 14KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371
  1. <div align="center">
  2. <a href="https://demo.ragflow.io/">
  3. <img src="web/src/assets/logo-with-text.png" width="520" alt="Logo ragflow">
  4. </a>
  5. </div>
  6. <p align="center">
  7. <a href="./README.md"><img alt="README in English" src="https://img.shields.io/badge/English-DFE0E5"></a>
  8. <a href="./README_zh.md"><img alt="简体中文版自述文件" src="https://img.shields.io/badge/简体中文-DFE0E5"></a>
  9. <a href="./README_tzh.md"><img alt="繁體中文版自述文件" src="https://img.shields.io/badge/繁體中文-DFE0E5"></a>
  10. <a href="./README_ja.md"><img alt="日本語のREADME" src="https://img.shields.io/badge/日本語-DFE0E5"></a>
  11. <a href="./README_ko.md"><img alt="한국어" src="https://img.shields.io/badge/한국어-DFE0E5"></a>
  12. <a href="./README_id.md"><img alt="Bahasa Indonesia" src="https://img.shields.io/badge/Bahasa Indonesia-DBEDFA"></a>
  13. <a href="./README_pt_br.md"><img alt="Português(Brasil)" src="https://img.shields.io/badge/Português(Brasil)-DFE0E5"></a>
  14. </p>
  15. <p align="center">
  16. <a href="https://x.com/intent/follow?screen_name=infiniflowai" target="_blank">
  17. <img src="https://img.shields.io/twitter/follow/infiniflow?logo=X&color=%20%23f5f5f5" alt="Ikuti di X (Twitter)">
  18. </a>
  19. <a href="https://demo.ragflow.io" target="_blank">
  20. <img alt="Lencana Daring" src="https://img.shields.io/badge/Online-Demo-4e6b99">
  21. </a>
  22. <a href="https://hub.docker.com/r/infiniflow/ragflow" target="_blank">
  23. <img src="https://img.shields.io/docker/pulls/infiniflow/ragflow?label=Docker%20Pulls&color=0db7ed&logo=docker&logoColor=white&style=flat-square" alt="docker pull infiniflow/ragflow:v0.20.0">
  24. </a>
  25. <a href="https://github.com/infiniflow/ragflow/releases/latest">
  26. <img src="https://img.shields.io/github/v/release/infiniflow/ragflow?color=blue&label=Rilis%20Terbaru" alt="Rilis Terbaru">
  27. </a>
  28. <a href="https://github.com/infiniflow/ragflow/blob/main/LICENSE">
  29. <img height="21" src="https://img.shields.io/badge/Lisensi-Apache--2.0-ffffff?labelColor=d4eaf7&color=2e6cc4" alt="Lisensi">
  30. </a>
  31. <a href="https://deepwiki.com/infiniflow/ragflow">
  32. <img alt="Ask DeepWiki" src="https://deepwiki.com/badge.svg">
  33. </a>
  34. </p>
  35. <h4 align="center">
  36. <a href="https://ragflow.io/docs/dev/">Dokumentasi</a> |
  37. <a href="https://github.com/infiniflow/ragflow/issues/4214">Peta Jalan</a> |
  38. <a href="https://twitter.com/infiniflowai">Twitter</a> |
  39. <a href="https://discord.gg/NjYzJD3GM3">Discord</a> |
  40. <a href="https://demo.ragflow.io">Demo</a>
  41. </h4>
  42. #
  43. <details open>
  44. <summary><b>📕 Daftar Isi </b> </summary>
  45. - 💡 [Apa Itu RAGFlow?](#-apa-itu-ragflow)
  46. - 🎮 [Demo](#-demo)
  47. - 📌 [Pembaruan Terbaru](#-pembaruan-terbaru)
  48. - 🌟 [Fitur Utama](#-fitur-utama)
  49. - 🔎 [Arsitektur Sistem](#-arsitektur-sistem)
  50. - 🎬 [Mulai](#-mulai)
  51. - 🔧 [Konfigurasi](#-konfigurasi)
  52. - 🔧 [Membangun Image Docker tanpa Model Embedding](#-membangun-image-docker-tanpa-model-embedding)
  53. - 🔧 [Membangun Image Docker dengan Model Embedding](#-membangun-image-docker-dengan-model-embedding)
  54. - 🔨 [Meluncurkan aplikasi dari Sumber untuk Pengembangan](#-meluncurkan-aplikasi-dari-sumber-untuk-pengembangan)
  55. - 📚 [Dokumentasi](#-dokumentasi)
  56. - 📜 [Peta Jalan](#-peta-jalan)
  57. - 🏄 [Komunitas](#-komunitas)
  58. - 🙌 [Kontribusi](#-kontribusi)
  59. </details>
  60. ## 💡 Apa Itu RAGFlow?
  61. [RAGFlow](https://ragflow.io/) adalah mesin RAG (Retrieval-Augmented Generation) open-source berbasis pemahaman dokumen yang mendalam. Platform ini menyediakan alur kerja RAG yang efisien untuk bisnis dengan berbagai skala, menggabungkan LLM (Large Language Models) untuk menyediakan kemampuan tanya-jawab yang benar dan didukung oleh referensi dari data terstruktur kompleks.
  62. ## 🎮 Demo
  63. Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
  64. <div align="center" style="margin-top:20px;margin-bottom:20px;">
  65. <img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/refs/heads/image/image/chunking.gif" width="1200"/>
  66. <img src="https://raw.githubusercontent.com/infiniflow/ragflow-docs/refs/heads/image/image/agentic-dark.gif" width="1200"/>
  67. </div>
  68. ## 🔥 Pembaruan Terbaru
  69. - 2025-08-01 Mendukung Alur Kerja agen.
  70. - 2025-05-23 Menambahkan komponen pelaksana kode Python/JS ke Agen.
  71. - 2025-05-05 Mendukung kueri lintas bahasa.
  72. - 2025-03-19 Mendukung penggunaan model multi-modal untuk memahami gambar di dalam file PDF atau DOCX.
  73. - 2025-02-28 dikombinasikan dengan pencarian Internet (TAVILY), mendukung penelitian mendalam untuk LLM apa pun.
  74. - 2024-12-18 Meningkatkan model Analisis Tata Letak Dokumen di DeepDoc.
  75. - 2024-08-22 Dukungan untuk teks ke pernyataan SQL melalui RAG.
  76. ## 🎉 Tetap Terkini
  77. ⭐️ Star repositori kami untuk tetap mendapat informasi tentang fitur baru dan peningkatan menarik! 🌟
  78. <div align="center" style="margin-top:20px;margin-bottom:20px;">
  79. <img src="https://github.com/user-attachments/assets/18c9707e-b8aa-4caf-a154-037089c105ba" width="1200"/>
  80. </div>
  81. ## 🌟 Fitur Utama
  82. ### 🍭 **"Kualitas Masuk, Kualitas Keluar"**
  83. - Ekstraksi pengetahuan berbasis pemahaman dokumen mendalam dari data tidak terstruktur dengan format yang rumit.
  84. - Menemukan "jarum di tumpukan data" dengan token yang hampir tidak terbatas.
  85. ### 🍱 **Pemotongan Berbasis Template**
  86. - Cerdas dan dapat dijelaskan.
  87. - Banyak pilihan template yang tersedia.
  88. ### 🌱 **Referensi yang Didasarkan pada Data untuk Mengurangi Hallusinasi**
  89. - Visualisasi pemotongan teks memungkinkan intervensi manusia.
  90. - Tampilan cepat referensi kunci dan referensi yang dapat dilacak untuk mendukung jawaban yang didasarkan pada fakta.
  91. ### 🍔 **Kompatibilitas dengan Sumber Data Heterogen**
  92. - Mendukung Word, slide, excel, txt, gambar, salinan hasil scan, data terstruktur, halaman web, dan banyak lagi.
  93. ### 🛀 **Alur Kerja RAG yang Otomatis dan Mudah**
  94. - Orkestrasi RAG yang ramping untuk bisnis kecil dan besar.
  95. - LLM yang dapat dikonfigurasi serta model embedding.
  96. - Peringkat ulang berpasangan dengan beberapa pengambilan ulang.
  97. - API intuitif untuk integrasi yang mudah dengan bisnis.
  98. ## 🔎 Arsitektur Sistem
  99. <div align="center" style="margin-top:20px;margin-bottom:20px;">
  100. <img src="https://github.com/infiniflow/ragflow/assets/12318111/d6ac5664-c237-4200-a7c2-a4a00691b485" width="1000"/>
  101. </div>
  102. ## 🎬 Mulai
  103. ### 📝 Prasyarat
  104. - CPU >= 4 inti
  105. - RAM >= 16 GB
  106. - Disk >= 50 GB
  107. - Docker >= 24.0.0 & Docker Compose >= v2.26.1
  108. - [gVisor](https://gvisor.dev/docs/user_guide/install/): Hanya diperlukan jika Anda ingin menggunakan fitur eksekutor kode (sandbox) dari RAGFlow.
  109. > [!TIP]
  110. > Jika Anda belum menginstal Docker di komputer lokal Anda (Windows, Mac, atau Linux), lihat [Install Docker Engine](https://docs.docker.com/engine/install/).
  111. ### 🚀 Menjalankan Server
  112. 1. Pastikan `vm.max_map_count` >= 262144:
  113. > Untuk memeriksa nilai `vm.max_map_count`:
  114. >
  115. > ```bash
  116. > $ sysctl vm.max_map_count
  117. > ```
  118. >
  119. > Jika nilainya kurang dari 262144, setel ulang `vm.max_map_count` ke setidaknya 262144:
  120. >
  121. > ```bash
  122. > # Dalam contoh ini, kita atur menjadi 262144:
  123. > $ sudo sysctl -w vm.max_map_count=262144
  124. > ```
  125. >
  126. > Perubahan ini akan hilang setelah sistem direboot. Untuk membuat perubahan ini permanen, tambahkan atau perbarui nilai
  127. > `vm.max_map_count` di **/etc/sysctl.conf**:
  128. >
  129. > ```bash
  130. > vm.max_map_count=262144
  131. > ```
  132. 2. Clone repositori:
  133. ```bash
  134. $ git clone https://github.com/infiniflow/ragflow.git
  135. ```
  136. 3. Bangun image Docker pre-built dan jalankan server:
  137. > [!CAUTION]
  138. > Semua gambar Docker dibangun untuk platform x86. Saat ini, kami tidak menawarkan gambar Docker untuk ARM64.
  139. > Jika Anda menggunakan platform ARM64, [silakan gunakan panduan ini untuk membangun gambar Docker yang kompatibel dengan sistem Anda](https://ragflow.io/docs/dev/build_docker_image).
  140. > Perintah di bawah ini mengunduh edisi v0.20.0-slim dari gambar Docker RAGFlow. Silakan merujuk ke tabel berikut untuk deskripsi berbagai edisi RAGFlow. Untuk mengunduh edisi RAGFlow yang berbeda dari v0.20.0-slim, perbarui variabel RAGFLOW_IMAGE di docker/.env sebelum menggunakan docker compose untuk memulai server. Misalnya, atur RAGFLOW_IMAGE=infiniflow/ragflow:v0.20.0 untuk edisi lengkap v0.20.0.
  141. ```bash
  142. $ cd ragflow/docker
  143. # Use CPU for embedding and DeepDoc tasks:
  144. $ docker compose -f docker-compose.yml up -d
  145. # To use GPU to accelerate embedding and DeepDoc tasks:
  146. # docker compose -f docker-compose-gpu.yml up -d
  147. ```
  148. | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
  149. | ----------------- | --------------- | --------------------- | ------------------------ |
  150. | v0.20.0 | &approx;9 | :heavy_check_mark: | Stable release |
  151. | v0.20.0-slim | &approx;2 | ❌ | Stable release |
  152. | nightly | &approx;9 | :heavy_check_mark: | _Unstable_ nightly build |
  153. | nightly-slim | &approx;2 | ❌ | _Unstable_ nightly build |
  154. 1. Periksa status server setelah server aktif dan berjalan:
  155. ```bash
  156. $ docker logs -f ragflow-server
  157. ```
  158. _Output berikut menandakan bahwa sistem berhasil diluncurkan:_
  159. ```bash
  160. ____ ___ ______ ______ __
  161. / __ \ / | / ____// ____// /____ _ __
  162. / /_/ // /| | / / __ / /_ / // __ \| | /| / /
  163. / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
  164. /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
  165. * Running on all addresses (0.0.0.0)
  166. ```
  167. > Jika Anda melewatkan langkah ini dan langsung login ke RAGFlow, browser Anda mungkin menampilkan error `network anormal`
  168. > karena RAGFlow mungkin belum sepenuhnya siap.
  169. 2. Buka browser web Anda, masukkan alamat IP server Anda, dan login ke RAGFlow.
  170. > Dengan pengaturan default, Anda hanya perlu memasukkan `http://IP_DEVICE_ANDA` (**tanpa** nomor port) karena
  171. > port HTTP default `80` bisa dihilangkan saat menggunakan konfigurasi default.
  172. 3. Dalam [service_conf.yaml.template](./docker/service_conf.yaml.template), pilih LLM factory yang diinginkan di `user_default_llm` dan perbarui
  173. bidang `API_KEY` dengan kunci API yang sesuai.
  174. > Lihat [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) untuk informasi lebih lanjut.
  175. _Sistem telah siap digunakan!_
  176. ## 🔧 Konfigurasi
  177. Untuk konfigurasi sistem, Anda perlu mengelola file-file berikut:
  178. - [.env](./docker/.env): Menyimpan pengaturan dasar sistem, seperti `SVR_HTTP_PORT`, `MYSQL_PASSWORD`, dan
  179. `MINIO_PASSWORD`.
  180. - [service_conf.yaml.template](./docker/service_conf.yaml.template): Mengonfigurasi aplikasi backend.
  181. - [docker-compose.yml](./docker/docker-compose.yml): Sistem ini bergantung pada [docker-compose.yml](./docker/docker-compose.yml) untuk memulai.
  182. Untuk memperbarui port HTTP default (80), buka [docker-compose.yml](./docker/docker-compose.yml) dan ubah `80:80`
  183. menjadi `<YOUR_SERVING_PORT>:80`.
  184. Pembaruan konfigurasi ini memerlukan reboot semua kontainer agar efektif:
  185. > ```bash
  186. > $ docker compose -f docker-compose.yml up -d
  187. > ```
  188. ## 🔧 Membangun Docker Image tanpa Model Embedding
  189. Image ini berukuran sekitar 2 GB dan bergantung pada aplikasi LLM eksternal dan embedding.
  190. ```bash
  191. git clone https://github.com/infiniflow/ragflow.git
  192. cd ragflow/
  193. docker build --platform linux/amd64 --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .
  194. ```
  195. ## 🔧 Membangun Docker Image Termasuk Model Embedding
  196. Image ini berukuran sekitar 9 GB. Karena sudah termasuk model embedding, ia hanya bergantung pada aplikasi LLM eksternal.
  197. ```bash
  198. git clone https://github.com/infiniflow/ragflow.git
  199. cd ragflow/
  200. docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly .
  201. ```
  202. ## 🔨 Menjalankan Aplikasi dari untuk Pengembangan
  203. 1. Instal uv, atau lewati langkah ini jika sudah terinstal:
  204. ```bash
  205. pipx install uv pre-commit
  206. ```
  207. 2. Clone kode sumber dan instal dependensi Python:
  208. ```bash
  209. git clone https://github.com/infiniflow/ragflow.git
  210. cd ragflow/
  211. uv sync --python 3.10 --all-extras # install RAGFlow dependent python modules
  212. uv run download_deps.py
  213. pre-commit install
  214. ```
  215. 3. Jalankan aplikasi yang diperlukan (MinIO, Elasticsearch, Redis, dan MySQL) menggunakan Docker Compose:
  216. ```bash
  217. docker compose -f docker/docker-compose-base.yml up -d
  218. ```
  219. Tambahkan baris berikut ke `/etc/hosts` untuk memetakan semua host yang ditentukan di **conf/service_conf.yaml** ke `127.0.0.1`:
  220. ```
  221. 127.0.0.1 es01 infinity mysql minio redis sandbox-executor-manager
  222. ```
  223. 4. Jika Anda tidak dapat mengakses HuggingFace, atur variabel lingkungan `HF_ENDPOINT` untuk menggunakan situs mirror:
  224. ```bash
  225. export HF_ENDPOINT=https://hf-mirror.com
  226. ```
  227. 5. Jika sistem operasi Anda tidak memiliki jemalloc, instal sebagai berikut:
  228. ```bash
  229. # ubuntu
  230. sudo apt-get install libjemalloc-dev
  231. # centos
  232. sudo yum install jemalloc
  233. ```
  234. 6. Jalankan aplikasi backend:
  235. ```bash
  236. source .venv/bin/activate
  237. export PYTHONPATH=$(pwd)
  238. bash docker/launch_backend_service.sh
  239. ```
  240. 7. Instal dependensi frontend:
  241. ```bash
  242. cd web
  243. npm install
  244. ```
  245. 8. Jalankan aplikasi frontend:
  246. ```bash
  247. npm run dev
  248. ```
  249. _Output berikut menandakan bahwa sistem berhasil diluncurkan:_
  250. ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187)
  251. 9. Hentikan layanan front-end dan back-end RAGFlow setelah pengembangan selesai:
  252. ```bash
  253. pkill -f "ragflow_server.py|task_executor.py"
  254. ```
  255. ## 📚 Dokumentasi
  256. - [Quickstart](https://ragflow.io/docs/dev/)
  257. - [Configuration](https://ragflow.io/docs/dev/configurations)
  258. - [Release notes](https://ragflow.io/docs/dev/release_notes)
  259. - [User guides](https://ragflow.io/docs/dev/category/guides)
  260. - [Developer guides](https://ragflow.io/docs/dev/category/developers)
  261. - [References](https://ragflow.io/docs/dev/category/references)
  262. - [FAQs](https://ragflow.io/docs/dev/faq)
  263. ## 📜 Roadmap
  264. Lihat [Roadmap RAGFlow 2025](https://github.com/infiniflow/ragflow/issues/4214)
  265. ## 🏄 Komunitas
  266. - [Discord](https://discord.gg/NjYzJD3GM3)
  267. - [Twitter](https://twitter.com/infiniflowai)
  268. - [GitHub Discussions](https://github.com/orgs/infiniflow/discussions)
  269. ## 🙌 Kontribusi
  270. RAGFlow berkembang melalui kolaborasi open-source. Dalam semangat ini, kami menerima kontribusi dari komunitas.
  271. Jika Anda ingin berpartisipasi, tinjau terlebih dahulu [Panduan Kontribusi](https://ragflow.io/docs/dev/contributing).