Files
ragflow/README_ja.md
Zhichang Yu 3f805a64f1 feat(agent): align Go agent behavior with Python (except retrieval component) (#16225)
## Summary

Aligns the **Go agent runtime/canvas/components/tools** behavior with
the **Python `agent/` implementation** so the same stored canvas DSL
produces the same execution result on either side. Every component,
tool, and runtime primitive in `internal/agent/` is now driven by the
same semantics as its Python counterpart — variable resolution, template
substitution, control flow, error reporting, retry/cancel, and stream
event shapes.

The **retrieval component is the one explicit exception** in this PR. It
is being reworked in a separate change and is excluded from this
alignment pass; the wrapper slot (`universe_a_wrappers.go →
newRetrievalComponent`) is preserved.

## Scope of alignment

### Components (all aligned with `agent/component/`)
`Begin` · `Message` · `LLM` (incl. ChatTemplateKwargs,
MessageHistoryWindowSize, VisualFiles, Cite, OutputStructure,
JSONOutput, TopP, MaxRetries, DelayAfterError, credentials) · `Agent`
(react + tool artifact capture + `Reset()` interface-assert) · `Switch`
(12/12 operators, Python-equivalent semantics) · `Categorize` · `Invoke`
· `Iteration` · `Loop` (macro-expansion through `workflowx.AddLoopNode`)
· `UserFillUp` (Python-equivalent interrupt/resume via eino
`compose.Interrupt`/`ResumeWithData`) · `FillUp` · `DataOperations` ·
`ListOperations` · `StringTransform` · `VariableAggregator` ·
`VariableAssigner` · `Browser` (full stagehand runtime parity) ·
`DocsGenerator` · `ExcelProcessor`.

### Tools (all aligned with `agent/tools/`)
`Retrieval` (wrapper slot only — logic out of scope) · `MCPToolAdapter`
(streamable-HTTP) · `CodeExec` (sandbox bridge with
`code_exec_contract.go` matching Python contract) · `AkShare` · `ArXiv`
· `Crawler` · `DeepL` · `DuckDuckGo` · `Email` · `ExeSQL` · `GitHub` ·
`Google` · `GoogleScholar` · `Jin10` · `PubMed` · `QWeather` · `SearXNG`
· `Tavily` · `Tushare` · `Wencai` · `Wikipedia` · `YahooFinance` —
uniform `eino tool.InvokableTool` interface, SSRF protection, shared
HTTP client.

### Canvas execution engine (`internal/agent/canvas/`)
Aligned with Python's `agent/canvas.py`:
- **Scheduler** (`scheduler.go`): state pre/post handlers, node lambdas,
per-component timeout resolver (4-level: per-class env → per-class table
→ uniform env → 600s fallback), `legacyNoOpNames`.
- **Loop subgraph** (`loop_subgraph.go`): Python-equivalent
`AddLoopNode` macro expansion + condition translation.
- **Multibranch** (`multibranch.go`): `Switch` / `Categorize` routing
via `compose.NewGraphMultiBranch` — same branch selection semantics as
Python.
- **Parallel subgraph** (`parallel_subgraph.go`): matches Python's
parallel fan-out contract.
- **Interrupt/Resume** (`interrupt_resume.go`): `UserFillUpNodeBody` /
`IsInterruptError` / `ExtractInterruptContexts` — replaces the
deprecated Python sentinel chain with eino's native interrupt API,
preserving the same external behavior.
- **Checkpoint** (`checkpoint_store.go`): `RedisCheckPointStore`
Get/Set/Delete, with business metadata (status / canvas_id /
parent_run_id) on a parallel Redis Hash.
- **RunTracker** (`run_tracker.go`): Start / MarkSucceeded / MarkFailed
/ MarkCancelled / AttachCheckpoint — same lifecycle as the Python run
record.
- **Cancel** (`cancel.go`): Redis pub/sub watch.
- **Stream** (`stream.go`): SSE channel with `messages` / `waiting` /
`errors` / `done` events, same shape as Python's `agent.canvas.RunEvent`
payload.

### DSL bridge (`internal/agent/dsl/`)
- `normalize.go`: v1↔v2 collapsed into a single wire format — Python and
Go consume the same stored JSON.
- `reset.go`: per-run state reset matches Python's `Canvas.reset()`
semantics.
- Testdata mirrors Python's `agent_msg.json` / `all.json` / etc.

### Runtime (`internal/agent/runtime/`)
- `CanvasState` / `NewCanvasState` / `GetVar` / `SetVar` / `ReadVars`:
same `{{cpn_id@param}}` resolution model.
- `ResolveTemplate` (regex fast path + gonja fallback) — Python
Jinja-style semantics.
- `selector.go`, `metrics.go`, `component.go`: shared runtime contracts.

## Out of scope (intentionally)

- **`Retrieval` component logic** — wrapped only; full parity lands in a
follow-up PR.
- **Frontend** — only minor dsl-bridge / canvas UX fixes ride along.
- **CLI / admin / model registry** — orthogonal to agent behavior.

## How alignment is verified

`internal/service/agent_run_e2e_test.go` exercises the **full production
chain** against real Python-shaped DSL fixtures:
```
loadCanvasForUser → versionDAO.GetLatest → decodeCanvasFromDSL →
canvas.Compile → cc.Workflow.Invoke → answer extraction
```
using in-memory SQLite + miniredis (no Docker). Covers:
- `TestRunAgent_RealCanvas_BeginMessage` — happy path, `{{sys.query}}`
resolution
- `TestRunAgent_RealCanvas_WaitForUserResume` — two-run resume cycle
(Python-equivalent)
- `TestRunAgent_RealCanvas_CompileFails` — unknown component name →
sanitized error (Python-equivalent)
- `TestRunAgent_RealCanvas_InvokeFails` — unresolvable template ref
(Python-equivalent)
- `TestRunAgent_RunTracker_AttachCheckpoint_CallSequence` —
Start→AttachCheckpoint→MarkSucceeded lifecycle

`internal/handler/agent_test.go` — SSE streaming parity (`Content-Type:
text/event-stream`, `data: {…}\n\n`, trailing `data: [DONE]\n\n`,
OpenAI-compatible non-stream `choices`).

`internal/agent/canvas/fixture_compile_test.go` + per-component tests
pin the Python-equivalent outputs.

```
go test -count=1 -v -run 'TestRunAgent_RealCanvas|TestRunAgent_RunTracker' ./internal/service/
```

## Design reference

`docs/develop/agent-go-port-design.md` (1329 lines, last cross-checked
2026-06-17) — module layout, per-component / per-tool inventory,
corner-case catalogue, and the actionable backlog (Section 14, including
the retrieval alignment follow-up).

---------

Co-authored-by: Claude <noreply@anthropic.com>
2026-06-22 11:58:29 +08:00

19 KiB
Raw Blame History

README in English 简体中文版自述文件 繁體中文版自述文件 日本語のREADME 한국어 README en Français Bahasa Indonesia Português(Brasil) README in Arabic Türkçe README

follow on X(Twitter) Static Badge docker pull infiniflow/ragflow:v0.26.1 Latest Release license Ask DeepWiki

Cloud | Document | Roadmap | Discord

infiniflow%2Fragflow | Trendshift

💡 RAGFlow とは?

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

🎮 はじめに

当社のクラウドサービスをぜひお試しください:https://cloud.ragflow.io

🔥 最新情報

  • 2026-06-15 Feishu、Discord、Telegram、Lineなどの複数のチャットチャンネルをサポートします。
  • 2026-04-24 DeepSeek v4 をサポート。
  • 2026-03-24 RAGFlow Skill on OpenClaw — OpenClaw経由でRAGFlowデータセットにアクセスする公式スキルを提供。
  • 2025-12-26 AIエージェントの「メモリ」機能をサポート。
  • 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-03-19 PDFまたはDOCXファイル内の画像を理解するために、多モーダルモデルを使用することをサポートします。

🎉 続きを楽しみに

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

🌟 主な特徴

🍭 "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
  • Python >= 3.13
  • gVisor: RAGFlowのコード実行サンドボックス機能を利用する場合のみ必要です。

Tip

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

🚀 サーバーを起動

  1. 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.confvm.max_map_count 値を適宜追加または更新する:

    vm.max_map_count=262144
    
  2. リポジトリをクローンする:

    $ git clone https://github.com/infiniflow/ragflow.git
    
  3. ビルド済みの Docker イメージをビルドし、サーバーを起動する:

Caution

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

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

   $ cd ragflow/docker

   # git checkout v0.26.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 サフィックスを付けなくなりました。

  1. サーバーを立ち上げた後、サーバーの状態を確認する:
$ docker logs -f docker-ragflow-cpu-1

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

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

 * Running on all addresses (0.0.0.0)

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

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

    デフォルトの設定を使用する場合、デフォルトの HTTP サービングポート 80 は省略できるので、与えられたシナリオでは、http://IP_OF_YOUR_MACHINE(ポート番号は省略)だけを入力すればよい。

  2. service_conf.yaml.template で、user_default_llm で希望の LLM ファクトリを選択し、API_KEY フィールドを対応する API キーで更新する。

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

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

🔧 コンフィグ

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

.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/)、次の手順に従います。

  1. 実行中のすべてのコンテナを停止するには:

    $ docker compose -f docker/docker-compose.yml down -v
    

    Note: -v は docker コンテナのボリュームを削除し、既存のデータをクリアします。

  2. docker/.env の「DOC _ ENGINE」を「infinity」に設定します。

  3. 起動コンテナ:

    $ 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 .

プロキシ環境下にいる場合は、プロキシ引数を指定できます:

docker build --platform linux/amd64 \
  --build-arg http_proxy=http://YOUR_PROXY:PORT \
  --build-arg https_proxy=http://YOUR_PROXY:PORT \
  -f Dockerfile -t infiniflow/ragflow:nightly .

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

  1. uvpre-commit をインストールする。すでにインストールされている場合は、このステップをスキップしてください:

    pipx install uv pre-commit
    
  2. ソースコードをクローンし、Python の依存関係をインストールする:

    git clone https://github.com/infiniflow/ragflow.git
    cd ragflow/
    uv sync --python 3.13 # install RAGFlow dependent python modules
    uv run python3 ragflow_deps/download_deps.py
    pre-commit install
    
  3. 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
    
  4. HuggingFace にアクセスできない場合は、HF_ENDPOINT 環境変数を設定してミラーサイトを使用してください:

    export HF_ENDPOINT=https://hf-mirror.com
    
  5. オペレーティングシステムにjemallocがない場合は、次のようにインストールします:

    # ubuntu
    sudo apt-get install libjemalloc-dev
    # centos
    sudo yum install jemalloc
    # mac
    sudo brew install jemalloc
    
  6. バックエンドサービスを起動する:

    source .venv/bin/activate
    export PYTHONPATH=$(pwd)
    bash docker/launch_backend_service.sh
    
  7. フロントエンドの依存関係をインストールする:

    cd web
    npm install
    
  8. フロントエンドサービスを起動する:

    npm run dev
    

    以下の画面で、システムが正常に起動したことを示します:

  9. 開発が完了したら、RAGFlow のフロントエンド サービスとバックエンド サービスを停止します:

    pkill -f "ragflow_server.py|task_executor.py"
    

📚 ドキュメンテーション

📜 ロードマップ

RAGFlow ロードマップ 2026 を参照

🏄 コミュニティ

🙌 コントリビュート

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