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 13KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  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">English</a> |
  8. <a href="./README_zh.md">简体中文</a> |
  9. <a href="./README_tzh.md">繁体中文</a> |
  10. <a href="./README_ja.md">日本語</a> |
  11. <a href="./README_ko.md">한국어</a> |
  12. <a href="./README_id.md">Bahasa Indonesia</a> |
  13. <a href="/README_pt_br.md">Português (Brasil)</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/badge/docker_pull-ragflow:v0.17.2-brightgreen" alt="docker pull infiniflow/ragflow:v0.17.2">
  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. </p>
  32. <h4 align="center">
  33. <a href="https://ragflow.io/docs/dev/">Dokumentasi</a> |
  34. <a href="https://github.com/infiniflow/ragflow/issues/4214">Peta Jalan</a> |
  35. <a href="https://twitter.com/infiniflowai">Twitter</a> |
  36. <a href="https://discord.gg/4XxujFgUN7">Discord</a> |
  37. <a href="https://demo.ragflow.io">Demo</a>
  38. </h4>
  39. <details open>
  40. <summary><b>📕 Daftar Isi </b> </summary>
  41. - 💡 [Apa Itu RAGFlow?](#-apa-itu-ragflow)
  42. - 🎮 [Demo](#-demo)
  43. - 📌 [Pembaruan Terbaru](#-pembaruan-terbaru)
  44. - 🌟 [Fitur Utama](#-fitur-utama)
  45. - 🔎 [Arsitektur Sistem](#-arsitektur-sistem)
  46. - 🎬 [Mulai](#-mulai)
  47. - 🔧 [Konfigurasi](#-konfigurasi)
  48. - 🔧 [Membangun Image Docker tanpa Model Embedding](#-membangun-image-docker-tanpa-model-embedding)
  49. - 🔧 [Membangun Image Docker dengan Model Embedding](#-membangun-image-docker-dengan-model-embedding)
  50. - 🔨 [Meluncurkan aplikasi dari Sumber untuk Pengembangan](#-meluncurkan-aplikasi-dari-sumber-untuk-pengembangan)
  51. - 📚 [Dokumentasi](#-dokumentasi)
  52. - 📜 [Peta Jalan](#-peta-jalan)
  53. - 🏄 [Komunitas](#-komunitas)
  54. - 🙌 [Kontribusi](#-kontribusi)
  55. </details>
  56. ## 💡 Apa Itu RAGFlow?
  57. [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.
  58. ## 🎮 Demo
  59. Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
  60. <div align="center" style="margin-top:20px;margin-bottom:20px;">
  61. <img src="https://github.com/infiniflow/ragflow/assets/7248/2f6baa3e-1092-4f11-866d-36f6a9d075e5" width="1200"/>
  62. <img src="https://github.com/user-attachments/assets/504bbbf1-c9f7-4d83-8cc5-e9cb63c26db6" width="1200"/>
  63. </div>
  64. ## 🔥 Pembaruan Terbaru
  65. - 2025-02-28 dikombinasikan dengan pencarian Internet (TAVILY), mendukung penelitian mendalam untuk LLM apa pun.
  66. - 2025-02-05 Memperbarui daftar model 'SILICONFLOW' dan menambahkan dukungan untuk Deepseek-R1/DeepSeek-V3.
  67. - 2025-01-26 Optimalkan ekstraksi dan penerapan grafik pengetahuan dan sediakan berbagai opsi konfigurasi.
  68. - 2024-12-18 Meningkatkan model Analisis Tata Letak Dokumen di DeepDoc.
  69. - 2024-12-04 Mendukung skor pagerank ke basis pengetahuan.
  70. - 2024-11-22 Peningkatan definisi dan penggunaan variabel di Agen.
  71. - 2024-11-01 Penambahan ekstraksi kata kunci dan pembuatan pertanyaan terkait untuk meningkatkan akurasi pengambilan.
  72. - 2024-08-22 Dukungan untuk teks ke pernyataan SQL melalui RAG.
  73. ## 🎉 Tetap Terkini
  74. ⭐️ Star repositori kami untuk tetap mendapat informasi tentang fitur baru dan peningkatan menarik! 🌟
  75. <div align="center" style="margin-top:20px;margin-bottom:20px;">
  76. <img src="https://github.com/user-attachments/assets/18c9707e-b8aa-4caf-a154-037089c105ba" width="1200"/>
  77. </div>
  78. ## 🌟 Fitur Utama
  79. ### 🍭 **"Kualitas Masuk, Kualitas Keluar"**
  80. - Ekstraksi pengetahuan berbasis pemahaman dokumen mendalam dari data tidak terstruktur dengan format yang rumit.
  81. - Menemukan "jarum di tumpukan data" dengan token yang hampir tidak terbatas.
  82. ### 🍱 **Pemotongan Berbasis Template**
  83. - Cerdas dan dapat dijelaskan.
  84. - Banyak pilihan template yang tersedia.
  85. ### 🌱 **Referensi yang Didasarkan pada Data untuk Mengurangi Hallusinasi**
  86. - Visualisasi pemotongan teks memungkinkan intervensi manusia.
  87. - Tampilan cepat referensi kunci dan referensi yang dapat dilacak untuk mendukung jawaban yang didasarkan pada fakta.
  88. ### 🍔 **Kompatibilitas dengan Sumber Data Heterogen**
  89. - Mendukung Word, slide, excel, txt, gambar, salinan hasil scan, data terstruktur, halaman web, dan banyak lagi.
  90. ### 🛀 **Alur Kerja RAG yang Otomatis dan Mudah**
  91. - Orkestrasi RAG yang ramping untuk bisnis kecil dan besar.
  92. - LLM yang dapat dikonfigurasi serta model embedding.
  93. - Peringkat ulang berpasangan dengan beberapa pengambilan ulang.
  94. - API intuitif untuk integrasi yang mudah dengan bisnis.
  95. ## 🔎 Arsitektur Sistem
  96. <div align="center" style="margin-top:20px;margin-bottom:20px;">
  97. <img src="https://github.com/infiniflow/ragflow/assets/12318111/d6ac5664-c237-4200-a7c2-a4a00691b485" width="1000"/>
  98. </div>
  99. ## 🎬 Mulai
  100. ### 📝 Prasyarat
  101. - CPU >= 4 inti
  102. - RAM >= 16 GB
  103. - Disk >= 50 GB
  104. - Docker >= 24.0.0 & Docker Compose >= v2.26.1
  105. ### 🚀 Menjalankan Server
  106. 1. Pastikan `vm.max_map_count` >= 262144:
  107. > Untuk memeriksa nilai `vm.max_map_count`:
  108. >
  109. > ```bash
  110. > $ sysctl vm.max_map_count
  111. > ```
  112. >
  113. > Jika nilainya kurang dari 262144, setel ulang `vm.max_map_count` ke setidaknya 262144:
  114. >
  115. > ```bash
  116. > # Dalam contoh ini, kita atur menjadi 262144:
  117. > $ sudo sysctl -w vm.max_map_count=262144
  118. > ```
  119. >
  120. > Perubahan ini akan hilang setelah sistem direboot. Untuk membuat perubahan ini permanen, tambahkan atau perbarui nilai
  121. > `vm.max_map_count` di **/etc/sysctl.conf**:
  122. >
  123. > ```bash
  124. > vm.max_map_count=262144
  125. > ```
  126. 2. Clone repositori:
  127. ```bash
  128. $ git clone https://github.com/infiniflow/ragflow.git
  129. ```
  130. 3. Bangun image Docker pre-built dan jalankan server:
  131. > [!CAUTION]
  132. > Semua gambar Docker dibangun untuk platform x86. Saat ini, kami tidak menawarkan gambar Docker untuk ARM64.
  133. > 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).
  134. > Perintah di bawah ini mengunduh edisi v0.17.2-slim dari gambar Docker RAGFlow. Silakan merujuk ke tabel berikut untuk deskripsi berbagai edisi RAGFlow. Untuk mengunduh edisi RAGFlow yang berbeda dari v0.17.2-slim, perbarui variabel RAGFLOW_IMAGE di docker/.env sebelum menggunakan docker compose untuk memulai server. Misalnya, atur RAGFLOW_IMAGE=infiniflow/ragflow:v0.17.2 untuk edisi lengkap v0.17.2.
  135. ```bash
  136. $ cd ragflow/docker
  137. $ docker compose -f docker-compose.yml up -d
  138. ```
  139. | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
  140. | ----------------- | --------------- | --------------------- | ------------------------ |
  141. | v0.17.2 | &approx;9 | :heavy_check_mark: | Stable release |
  142. | v0.17.2-slim | &approx;2 | ❌ | Stable release |
  143. | nightly | &approx;9 | :heavy_check_mark: | _Unstable_ nightly build |
  144. | nightly-slim | &approx;2 | ❌ | _Unstable_ nightly build |
  145. 1. Periksa status server setelah server aktif dan berjalan:
  146. ```bash
  147. $ docker logs -f ragflow-server
  148. ```
  149. _Output berikut menandakan bahwa sistem berhasil diluncurkan:_
  150. ```bash
  151. ____ ___ ______ ______ __
  152. / __ \ / | / ____// ____// /____ _ __
  153. / /_/ // /| | / / __ / /_ / // __ \| | /| / /
  154. / _, _// ___ |/ /_/ // __/ / // /_/ /| |/ |/ /
  155. /_/ |_|/_/ |_|\____//_/ /_/ \____/ |__/|__/
  156. * Running on all addresses (0.0.0.0)
  157. ```
  158. > Jika Anda melewatkan langkah ini dan langsung login ke RAGFlow, browser Anda mungkin menampilkan error `network anormal`
  159. > karena RAGFlow mungkin belum sepenuhnya siap.
  160. 2. Buka browser web Anda, masukkan alamat IP server Anda, dan login ke RAGFlow.
  161. > Dengan pengaturan default, Anda hanya perlu memasukkan `http://IP_DEVICE_ANDA` (**tanpa** nomor port) karena
  162. > port HTTP default `80` bisa dihilangkan saat menggunakan konfigurasi default.
  163. 3. Dalam [service_conf.yaml.template](./docker/service_conf.yaml.template), pilih LLM factory yang diinginkan di `user_default_llm` dan perbarui
  164. bidang `API_KEY` dengan kunci API yang sesuai.
  165. > Lihat [llm_api_key_setup](https://ragflow.io/docs/dev/llm_api_key_setup) untuk informasi lebih lanjut.
  166. _Sistem telah siap digunakan!_
  167. ## 🔧 Konfigurasi
  168. Untuk konfigurasi sistem, Anda perlu mengelola file-file berikut:
  169. - [.env](./docker/.env): Menyimpan pengaturan dasar sistem, seperti `SVR_HTTP_PORT`, `MYSQL_PASSWORD`, dan
  170. `MINIO_PASSWORD`.
  171. - [service_conf.yaml.template](./docker/service_conf.yaml.template): Mengonfigurasi aplikasi backend.
  172. - [docker-compose.yml](./docker/docker-compose.yml): Sistem ini bergantung pada [docker-compose.yml](./docker/docker-compose.yml) untuk memulai.
  173. Untuk memperbarui port HTTP default (80), buka [docker-compose.yml](./docker/docker-compose.yml) dan ubah `80:80`
  174. menjadi `<YOUR_SERVING_PORT>:80`.
  175. Pembaruan konfigurasi ini memerlukan reboot semua kontainer agar efektif:
  176. > ```bash
  177. > $ docker compose -f docker-compose.yml up -d
  178. > ```
  179. ## 🔧 Membangun Docker Image tanpa Model Embedding
  180. Image ini berukuran sekitar 2 GB dan bergantung pada aplikasi LLM eksternal dan embedding.
  181. ```bash
  182. git clone https://github.com/infiniflow/ragflow.git
  183. cd ragflow/
  184. docker build --build-arg LIGHTEN=1 -f Dockerfile -t infiniflow/ragflow:nightly-slim .
  185. ```
  186. ## 🔧 Membangun Docker Image Termasuk Model Embedding
  187. Image ini berukuran sekitar 9 GB. Karena sudah termasuk model embedding, ia hanya bergantung pada aplikasi LLM eksternal.
  188. ```bash
  189. git clone https://github.com/infiniflow/ragflow.git
  190. cd ragflow/
  191. docker build -f Dockerfile -t infiniflow/ragflow:nightly .
  192. ```
  193. ## 🔨 Menjalankan Aplikasi dari untuk Pengembangan
  194. 1. Instal uv, atau lewati langkah ini jika sudah terinstal:
  195. ```bash
  196. pipx install uv
  197. ```
  198. 2. Clone kode sumber dan instal dependensi Python:
  199. ```bash
  200. git clone https://github.com/infiniflow/ragflow.git
  201. cd ragflow/
  202. uv sync --python 3.10 --all-extras # install RAGFlow dependent python modules
  203. ```
  204. 3. Jalankan aplikasi yang diperlukan (MinIO, Elasticsearch, Redis, dan MySQL) menggunakan Docker Compose:
  205. ```bash
  206. docker compose -f docker/docker-compose-base.yml up -d
  207. ```
  208. Tambahkan baris berikut ke `/etc/hosts` untuk memetakan semua host yang ditentukan di **conf/service_conf.yaml** ke `127.0.0.1`:
  209. ```
  210. 127.0.0.1 es01 infinity mysql minio redis
  211. ```
  212. 4. Jika Anda tidak dapat mengakses HuggingFace, atur variabel lingkungan `HF_ENDPOINT` untuk menggunakan situs mirror:
  213. ```bash
  214. export HF_ENDPOINT=https://hf-mirror.com
  215. ```
  216. 5. Jalankan aplikasi backend:
  217. ```bash
  218. source .venv/bin/activate
  219. export PYTHONPATH=$(pwd)
  220. bash docker/launch_backend_service.sh
  221. ```
  222. 6. Instal dependensi frontend:
  223. ```bash
  224. cd web
  225. npm install
  226. ```
  227. 7. Jalankan aplikasi frontend:
  228. ```bash
  229. npm run dev
  230. ```
  231. _Output berikut menandakan bahwa sistem berhasil diluncurkan:_
  232. ![](https://github.com/user-attachments/assets/0daf462c-a24d-4496-a66f-92533534e187)
  233. ## 📚 Dokumentasi
  234. - [Quickstart](https://ragflow.io/docs/dev/)
  235. - [Panduan Pengguna](https://ragflow.io/docs/dev/category/guides)
  236. - [Referensi](https://ragflow.io/docs/dev/category/references)
  237. - [FAQ](https://ragflow.io/docs/dev/faq)
  238. ## 📜 Roadmap
  239. Lihat [Roadmap RAGFlow 2025](https://github.com/infiniflow/ragflow/issues/4214)
  240. ## 🏄 Komunitas
  241. - [Discord](https://discord.gg/4XxujFgUN7)
  242. - [Twitter](https://twitter.com/infiniflowai)
  243. - [GitHub Discussions](https://github.com/orgs/infiniflow/discussions)
  244. ## 🙌 Kontribusi
  245. RAGFlow berkembang melalui kolaborasi open-source. Dalam semangat ini, kami menerima kontribusi dari komunitas.
  246. Jika Anda ingin berpartisipasi, tinjau terlebih dahulu [Panduan Kontribusi](./CONTRIBUTING.md).