ragflow/README_ja.md at 8de6b9780681617ad83333ba01d78b46faf8d22f

mirror of https://gitee.com/infiniflow/ragflow.git synced 2025-12-06 07:19:03 +08:00

Files

Kevin Hu 249296e417 Feat: API supports toc_enhance. (#11437 )

### What problem does this PR solve?

Close #11433

### Type of change

- [x] New Feature (non-breaking change which adds functionality)

2025-11-21 14:51:58 +08:00

18 KiB

Raw Blame History

Document | Roadmap | Twitter | Discord | Demo

💡 RAGFlow とは？

RAGFlow は、先進的なRAG（Retrieval-Augmented Generation）技術と Agent 機能を融合し、大規模言語モデル（LLM）に優れたコンテキスト層を構築する最先端のオープンソース RAG エンジンです。あらゆる規模の企業に対応可能な合理化された RAG ワークフローを提供し、統合型コンテキストエンジンと事前構築されたAgentテンプレートにより、開発者が複雑なデータを驚異的な効率性と精度で高精細なプロダクションレディAIシステムへ変換することを可能にします。

🎮 Demo

デモをお試しください：https://demo.ragflow.io。

🔥 最新情報

2025-11-19 Gemini 3 Proをサポートしています
2025-11-12 Confluence、S3、Notion、Discord、Google Drive からのデータ同期をサポートします。
2025-10-23 ドキュメント解析方法として MinerU と Docling をサポートします。
2025-10-15 オーケストレーションされたデータパイプラインのサポート。
2025-08-08 OpenAI の最新 GPT-5 シリーズモデルをサポートします。
2025-08-01 エージェントワークフローとMCPをサポート。
2025-05-23 エージェントに Python/JS コードエグゼキュータコンポーネントを追加しました。
2025-05-05 言語間クエリをサポートしました。
2025-03-19 PDFまたはDOCXファイル内の画像を理解するために、多モーダルモデルを使用することをサポートします。
2024-12-18 DeepDoc のドキュメントレイアウト分析モデルをアップグレードします。
2024-08-22 RAG を介して SQL ステートメントへのテキストをサポートします。

🎉 続きを楽しみに

⭐️ リポジトリをスター登録して、エキサイティングな新機能やアップデートを最新の状態に保ちましょう！すべての新しいリリースに関する即時通知を受け取れます！ 🌟

🌟 主な特徴

🍭 "Quality in, quality out"

複雑な形式の非構造化データからの深い文書理解ベースの知識抽出。
無限のトークンから"干し草の山の中の針"を見つける。

🍱 テンプレートベースのチャンク化

知的で解釈しやすい。
テンプレートオプションが豊富。

🌱 ハルシネーションが軽減された根拠のある引用

可視化されたテキストチャンキング（text chunking）で人間の介入を可能にする。
重要な参考文献のクイックビューと、追跡可能な引用によって根拠ある答えをサポートする。

🍔 多様なデータソースとの互換性

Word、スライド、Excel、txt、画像、スキャンコピー、構造化データ、Web ページなどをサポート。

🛀 自動化された楽な RAG ワークフロー

個人から大企業まで対応できる RAG オーケストレーション（orchestration）。
カスタマイズ可能な LLM とエンベッディングモデル。
複数の想起と融合された再ランク付け。
直感的な API によってビジネスとの統合がシームレスに。

🔎 システム構成

🎬 初期設定

📝 必要条件

CPU >= 4 cores
RAM >= 16 GB
Disk >= 50 GB
Docker >= 24.0.0 & Docker Compose >= v2.26.1
gVisor: RAGFlowのコード実行（サンドボックス）機能を利用する場合のみ必要です。

Tip

ローカルマシン（Windows、Mac、または Linux）に Docker をインストールしていない場合は、Docker Engine のインストールを参照してください。

🚀 サーバーを起動

vm.max_map_count >= 262144 であることを確認する:
vm.max_map_count の値をチェックするには:
```
$ sysctl vm.max_map_count
```
vm.max_map_count が 262144 より大きい値でなければリセットする。
```
# In this case, we set it to 262144:
$ sudo sysctl -w vm.max_map_count=262144
```
この変更はシステム再起動後にリセットされる。変更を恒久的なものにするには、/etc/sysctl.conf の vm.max_map_count 値を適宜追加または更新する:
```
vm.max_map_count=262144
```

リポジトリをクローンする:

$ git clone https://github.com/infiniflow/ragflow.git

ビルド済みの Docker イメージをビルドし、サーバーを起動する:

Caution

現在、公式に提供されているすべての Docker イメージは x86 アーキテクチャ向けにビルドされており、ARM64 用の Docker イメージは提供されていません。 ARM64 アーキテクチャのオペレーティングシステムを使用している場合は、このドキュメントを参照して Docker イメージを自分でビルドしてください。

以下のコマンドは、RAGFlow Docker イメージの v0.22.1 エディションをダウンロードします。異なる RAGFlow エディションの説明については、以下の表を参照してください。v0.22.1 とは異なるエディションをダウンロードするには、docker/.env ファイルの RAGFLOW_IMAGE 変数を適宜更新し、docker compose を使用してサーバーを起動してください。

   $ cd ragflow/docker

   # git checkout v0.22.1
   # 任意: 安定版タグを利用 (一覧: https://github.com/infiniflow/ragflow/releases)
   # この手順は、コード内の entrypoint.sh ファイルが Docker イメージのバージョンと一致していることを確認します。

   # Use CPU for DeepDoc tasks:
   $ docker compose -f docker-compose.yml up -d

   # To use GPU to accelerate DeepDoc tasks:
   # sed -i '1i DEVICE=gpu' .env
   # docker compose -f docker-compose.yml up -d

注意：v0.22.0 より前のバージョンでは、embedding モデルを含むイメージと、embedding モデルを含まない slim イメージの両方を提供していました。詳細は以下の通りです：

RAGFlow image tag	Image size (GB)	Has embedding models?	Stable?
v0.21.1	≈9	✔️	Stable release
v0.21.1-slim	≈2	❌	Stable release

v0.22.0 以降、当プロジェクトでは slim エディションのみを提供し、イメージタグに -slim サフィックスを付けなくなりました。

サーバーを立ち上げた後、サーバーの状態を確認する:

$ docker logs -f docker-ragflow-cpu-1

以下の出力は、システムが正常に起動したことを確認するものです:

     ____   ___    ______ ______ __
    / __ \ /   |  / ____// ____// /____  _      __
   / /_/ // /| | / / __ / /_   / // __ \| | /| / /
  / _, _// ___ |/ /_/ // __/  / // /_/ /| |/ |/ /
 /_/ |_|/_/  |_|\____//_/    /_/ \____/ |__/|__/

 * Running on all addresses (0.0.0.0)

もし確認ステップをスキップして直接 RAGFlow にログインした場合、その時点で RAGFlow が完全に初期化されていない可能性があるため、ブラウザーがネットワーク異常エラーを表示するかもしれません。

ウェブブラウザで、プロンプトに従ってサーバーの IP アドレスを入力し、RAGFlow にログインします。

デフォルトの設定を使用する場合、デフォルトの HTTP サービングポート 80 は省略できるので、与えられたシナリオでは、http://IP_OF_YOUR_MACHINE（ポート番号は省略）だけを入力すればよい。
service_conf.yaml.template で、user_default_llm で希望の LLM ファクトリを選択し、API_KEY フィールドを対応する API キーで更新する。

詳しくは llm_api_key_setup を参照してください。

これで初期設定完了！ショーの開幕です！

🔧 コンフィグ

システムコンフィグに関しては、以下のファイルを管理する必要がある:

.env: SVR_HTTP_PORT、MYSQL_PASSWORD、MINIO_PASSWORD などのシステムの基本設定を保持する。
service_conf.yaml.template: バックエンドのサービスを設定します。
docker-compose.yml: システムの起動は docker-compose.yml に依存している。

.env ファイルの変更が service_conf.yaml.template ファイルの内容と一致していることを確認する必要があります。

./docker/README ファイル ./docker/README には、service_conf.yaml.template ファイルで ${ENV_VARS} として使用できる環境設定とサービス構成の詳細な説明が含まれています。

デフォルトの HTTP サービングポート(80)を更新するには、docker-compose.yml にアクセスして、80:80 を <YOUR_SERVING_PORT>:80 に変更します。

すべてのシステム設定のアップデートを有効にするには、システムの再起動が必要です:
$ docker compose -f docker-compose.yml up -d

Elasticsearch から Infinity にドキュメントエンジンを切り替えます

RAGFlow はデフォルトで Elasticsearch を使用して全文とベクトルを保存します。［Infinity］に切り替え（https://github.com/infiniflow/infinity/)、次の手順に従います。

実行中のすべてのコンテナを停止するには：
```
$ docker compose -f docker/docker-compose.yml down -v
```
Note: -v は docker コンテナのボリュームを削除し、既存のデータをクリアします。
docker/.env の「DOC _ ENGINE」を「infinity」に設定します。
起動コンテナ：
```
$ docker compose -f docker-compose.yml up -d
```
Warning

Linux/arm64 マシンでの Infinity への切り替えは正式にサポートされていません。

🔧 ソースコードで Docker イメージを作成

この Docker イメージのサイズは約 1GB で、外部の大モデルと埋め込みサービスに依存しています。

git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
docker build --platform linux/amd64 -f Dockerfile -t infiniflow/ragflow:nightly .

🔨 ソースコードからサービスを起動する方法

uv と pre-commit をインストールする。すでにインストールされている場合は、このステップをスキップしてください:
```
pipx install uv pre-commit
```

ソースコードをクローンし、Python の依存関係をインストールする:

git clone https://github.com/infiniflow/ragflow.git
cd ragflow/
uv sync --python 3.10 # install RAGFlow dependent python modules
uv run download_deps.py
pre-commit install

Docker Compose を使用して依存サービス（MinIO、Elasticsearch、Redis、MySQL）を起動する:
```
docker compose -f docker/docker-compose-base.yml up -d
```
/etc/hosts に以下の行を追加して、conf/service_conf.yaml に指定されたすべてのホストを 127.0.0.1 に解決します:
```
127.0.0.1       es01 infinity mysql minio redis sandbox-executor-manager
```
HuggingFace にアクセスできない場合は、HF_ENDPOINT 環境変数を設定してミラーサイトを使用してください:
```
export HF_ENDPOINT=https://hf-mirror.com
```

オペレーティングシステムにjemallocがない場合は、次のようにインストールします:

# ubuntu
sudo apt-get install libjemalloc-dev
# centos
sudo yum install jemalloc
# mac
sudo brew install jemalloc

バックエンドサービスを起動する:

source .venv/bin/activate
export PYTHONPATH=$(pwd)
bash docker/launch_backend_service.sh

フロントエンドの依存関係をインストールする:
```
cd web
npm install
```
フロントエンドサービスを起動する:
```
npm run dev
```
以下の画面で、システムが正常に起動したことを示します:
開発が完了したら、RAGFlow のフロントエンドサービスとバックエンドサービスを停止します:
```
pkill -f "ragflow_server.py|task_executor.py"
```

📚 ドキュメンテーション

📜 ロードマップ

RAGFlow ロードマップ 2025 を参照

🏄 コミュニティ

🙌 コントリビュート

RAGFlow はオープンソースのコラボレーションによって発展してきました。この精神に基づき、私たちはコミュニティからの多様なコントリビュートを受け入れています。参加を希望される方は、まずコントリビューションガイドをご覧ください。

18 KiB Raw Blame History Unescape Escape