はじめに
Kotaemonは、RAG（Retrieval Augmented Generation）ベースのQ&A機能をエンドユーザーや開発者に提供するために設計されたオープンソースのドキュメントQ&Aツールです。Cinnamonによって開発されたこのプロジェクトは、ネイティブLLMだけでなく、様々なLLM APIプロバイダー(例：OpenAI、AzureOpenAI、Cohereなど)をサポートしています。 Kotaemonは、ドキュメントのクイズや、Q&Aを構築するためのクリーンでカスタマイズ可能なユーザーインターフェースを提供します。 ラグ パイプ。
機能一覧
- 複数ユーザーログインのサポート、プライベート/パブリックコレクションでのファイル整理
- ネイティブLLMと一般的なAPIプロバイダーをサポート
- 最適な回収品質を確保するため、RAG混合配管を装備
- 図表を含む文書のマルチモーダルQ&Aサポート
- 環境設定が不要で、簡単にインストールできるスクリプトを提供
機能的特徴
- 独自のドキュメンテーション・クイズ（RAG）ウェブ・ユーザー・インターフェースをホストする.複数のユーザーログインをサポートし、プライベート/パブリックコレクションでファイルを整理し、他の人と協力し、お気に入りのチャットを共有します。
- LLMとエンベッディング・モデルの編成.ネイティブLLMと一般的なAPIプロバイダー（OpenAI、Azure、Ollama、Groq）をサポート。
- 混合RAGパイプ.最適な検索品質を確保するために、ハイブリッド（フルテキストとベクトル）サーチャーと並べ替えを組み合わせた合理的なデフォルトのRAGパイプラインを提供します。
- マルチモーダルQ&Aサポート.グラフと表をサポートした複数文書のQ&A。マルチモーダル文書解析のサポート（ユーザーインターフェースで利用可能なオプション）。
- 文書プレビューによる高度な引用.LLMの解答が正しいことを保証するために、システムはデフォルトで詳細な参考文献を提供します。これはPDFビューア引用（関連性スコアを含む）を表示し、ハイライトする。検索パイプラインが関連性の低い記事を返した場合に警告を出す。
- 複雑な推論手法のサポート.質問分解を使用して、複雑な質問やマルチホップの質問に答える。ReAct、ReWOO、その他のエージェントを使用したエージェントベースの推論をサポートします。
- 設定可能なユーザーインターフェース.ユーザーインターフェイスでは、検索と生成プロセスの重要な側面のほとんど（プロンプトを含む）を調整することができます。
- スケーラビリティ.Gradio上に構築されているため、好きなUI要素を自由にカスタマイズ/追加することができます。さらに、我々は、複数のドキュメントのインデックスと検索戦略をサポートすることを目指しています。
グラフラグインデックス・パイプラインは、その一例である。
ヘルプの使用
一般ユーザー向けのインストール手順
ダウンロードをとおして新着情報ダウンロードkotaemon-app.zipドキュメンテーション
インストール：
- ダウンロードしたファイルを解凍します。
- 入る
スクリプトフォルダを開き、お使いのオペレーティングシステムに合ったインストーラを起動します：- ウィンドウズ
ラン_ウィンドウズ.バット.ファイルをダブルクリックするだけです。 - macOS。
run_macos.sh- ファイルを右クリックし、「別のアプリケーションで開く」を選択します。
- すべてのアプリケーション」を有効にし、「ターミナル」を選択します。
- 注意：常にターミナルを使ってファイルを開きたい場合は、"Always open with this application "にチェックを入れてください。
- これからは、ファイルをダブルクリックすればうまくいくはずだ。
- Linuxだ。
run_linux.sh.をご利用ください。バッシュ run_linux.shスクリプトを実行する。
- ウィンドウズ
- インストールが完了すると、インストーラーがktemのユーザーインターフェイスを起動するか聞いてきますので、続けてくださいと答えてください。
- 起動に成功すると、アプリケーションが自動的にブラウザで開きます。
デベロッパーのインストールプロセス
Dockerデプロイメント（推奨）
docker run -e GRADIO_SERVER_NAME=0.0.0.0 ￤ GRADIO_SERVER_PORT=7860 -GRADIO_SERVER_NAME=0.0.0.0 GRADIO_SERVER_PORT=7860 -p 7860:7860 -it --rm taprosoft/kotaemon:v1.0
http://localhost:7860/、ウェブインターフェイスにアクセスする。
ソースコードの展開
必要なパッケージをクローンし、新しいPython環境にインストールします。
# オプション (セットアップ環境) conda create -n kotaemon python=3.10 conda は kotaemon を起動する # このリポジトリをクローンする git clone https://github.com/Cinnamon/kotaemon cd kotaemon pip install -e "libs/kotaemon[all]" pip install -e "libs/ktem"
で環境変数（APIキー、エンドポイント）を表示および編集します。 環境 真ん中だ。
(オプ シ ョ ナル） PDF_JS ビ ュ アーをブ ラ ウ ザで有効にす る には、 次の コ ン ポーネ ン ト をダ ウ ン ロ ー ド し て く だ さ い。 PDF_JS_DIST に抽出する。 libs/ktem/ktem/assets/prebuilt
ウェブサーバーの起動
python app.py
デフォルトのユーザー名/パスワードはadmin / adminです。 UI上で他のユーザーを直接設定することができます。
使用ガイドライン
- ログインと文書管理::
- ユーザーは、マルチユーザーログインシステムを通じてプラットフォームにアクセスし、ドキュメントコレクションを整理・管理することができる。
- ファイルをプライベートまたはパブリックコレクションに分類し、コラボレーションや共有を容易にします。
- Q&A機能::
- ユーザーはインターフェイス上で文書のアップロードやQ&A操作を行うことができる。
- マルチモダルのQ&Aをサポートし、図表を含む文書コンテンツを扱うことができる。
- RAGパイプのカスタマイズ::
- 開発者は、提供されたUIを使用してRAGパイプラインをカスタマイズし、表示することができます。
- ネイティブのLLMと一般的なAPIプロバイダーをサポートしているため、ユーザーはニーズに応じて適切なモデルを選択できる。
- ハイブリッド検索::
- このシステムは、最適な検索品質を確保するために、全文検索とベクトル検索を組み合わせたハイブリッド検索パイプラインを提供する。
- 検索結果の関連性を高めるために、並び替え機能をサポート。
- マルチモーダルサポート::
- このプラットフォームはマルチモーダルQ&Aをサポートし、より包括的なQ&A体験のために図表を含む文書を扱うことができる。
高度な機能
- モデル・マネージメント::
- ユーザーは自分のLLMや組み込みモデルを整理し、管理することができます。
- ネイティブ・モデルと一般的なAPIプロバイダーをサポートしているため、ユーザーはニーズに応じて適切なモデルを選択できる。
- コラボレーションと共有::
- ユーザーはお気に入りのチャットを他のユーザーと共有し、コラボレーションやコミュニケーションを簡単に行うことができる。
- 複数ユーザーのログインをサポートすることで、ユーザーはプラットフォーム上で共同作業や共有を行うことができる。
- フィードバックと貢献::
- このプロジェクトは現在活発に開発が進められており、ユーザーからのフィードバック、問題の報告、PRの提出を歓迎しています。
