mirror of
https://github.com/Mintplex-Labs/anything-llm.git
synced 2024-11-15 10:50:31 +01:00
236 lines
16 KiB
Markdown
236 lines
16 KiB
Markdown
<a name="readme-top"></a>
|
||
|
||
<p align="center">
|
||
<a href="https://anythingllm.com"><img src="https://github.com/Mintplex-Labs/anything-llm/blob/master/images/wordmark.png?raw=true" alt="AnythingLLM logo"></a>
|
||
</p>
|
||
|
||
<div align='center'>
|
||
<a href="https://trendshift.io/repositories/2415" target="_blank"><img src="https://trendshift.io/api/badge/repositories/2415" alt="Mintplex-Labs%2Fanything-llm | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
|
||
</div>
|
||
|
||
<p align="center">
|
||
<b>AnythingLLM:</b> あなたが探していたオールインワンAIアプリ。<br />
|
||
ドキュメントとチャットし、AIエージェントを使用し、高度にカスタマイズ可能で、複数ユーザー対応、面倒な設定は不要です。
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://discord.gg/6UyHPeGZAC" target="_blank">
|
||
<img src="https://img.shields.io/badge/chat-mintplex_labs-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAAIGNIUk0AAHomAACAhAAA+gAAAIDoAAB1MAAA6mAAADqYAAAXcJy6UTwAAAH1UExURQAAAP////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////r6+ubn5+7u7/3+/v39/enq6urq6/v7+97f39rb26eoqT1BQ0pOT4+Rkuzs7cnKykZKS0NHSHl8fdzd3ejo6UxPUUBDRdzc3RwgIh8jJSAkJm5xcvHx8aanqB4iJFBTVezt7V5hYlJVVuLj43p9fiImKCMnKZKUlaaoqSElJ21wcfT09O3u7uvr6zE0Nr6/wCUpK5qcnf7+/nh7fEdKTHx+f0tPUOTl5aipqiouMGtubz5CRDQ4OsTGxufn515hY7a3uH1/gXBydIOFhlVYWvX29qaoqCQoKs7Pz/Pz87/AwUtOUNfY2dHR0mhrbOvr7E5RUy8zNXR2d/f39+Xl5UZJSx0hIzQ3Odra2/z8/GlsbaGjpERHSezs7L/BwScrLTQ4Odna2zM3Obm7u3x/gKSmp9jZ2T1AQu/v71pdXkVISr2+vygsLiInKTg7PaOlpisvMcXGxzk8PldaXPLy8u7u7rm6u7S1tsDBwvj4+MPExbe4ueXm5s/Q0Kyf7ewAAAAodFJOUwAABClsrNjx/QM2l9/7lhmI6jTB/kA1GgKJN+nea6vy/MLZQYeVKK3rVA5tAAAAAWJLR0QB/wIt3gAAAAd0SU1FB+cKBAAmMZBHjXIAAAISSURBVDjLY2CAAkYmZhZWNnYODnY2VhZmJkYGVMDIycXNw6sBBbw8fFycyEoYGfkFBDVQgKAAPyMjQl5IWEQDDYgIC8FUMDKKsmlgAWyiEBWMjGJY5YEqxMAqGMWFNXAAYXGgAkYJSQ2cQFKCkYFRShq3AmkpRgYJbghbU0tbB0Tr6ukbgGhDI10gySfBwCwDUWBsYmpmDqQtLK2sbTQ0bO3sHYA8GWYGWWj4WTs6Obu4ami4OTm7exhqeHp5+4DCVJZBDmqdr7ufn3+ArkZgkJ+fU3CIRmgYWFiOARYGvo5OQUHhEUAFTkF+kVHRsLBgkIeyYmLjwoOc4hMSk5JTnINS06DC8gwcEEZ6RqZGlpOfc3ZObl5+gZ+TR2ERWFyBQQFMF5eklmqUpQb5+ReU61ZUOvkFVVXXQBSAraitq29o1GiKcfLzc29u0mjxBzq0tQ0kww5xZHtHUGeXhkZhdxBYgZ4d0LI6c4gjwd7siQQraOp1AivQ6CuAKZCDBBRQQQNQgUb/BGf3cqCCiZOcnCe3QQIKHNRTpk6bDgpZjRkzg3pBQTBrdtCcuZCgluAD0vPmL1gIdvSixUuWgqNs2YJ+DUhkEYxuggkGmOQUcckrioPTJCOXEnZ5JS5YslbGnuyVERlDDFvGEUPOWvwqaH6RVkHKeuDMK6SKnHlVhTgx8jeTmqy6Eij7K6nLqiGyPwChsa1MUrnq1wAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMy0xMC0wNFQwMDozODo0OSswMDowMB9V0a8AAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjMtMTAtMDRUMDA6Mzg6NDkrMDA6MDBuCGkTAAAAKHRFWHRkYXRlOnRpbWVzdGFtcAAyMDIzLTEwLTA0VDAwOjM4OjQ5KzAwOjAwOR1IzAAAAABJRU5ErkJggg==" alt="Discord">
|
||
</a> |
|
||
<a href="https://github.com/Mintplex-Labs/anything-llm/blob/master/LICENSE" target="_blank">
|
||
<img src="https://img.shields.io/static/v1?label=license&message=MIT&color=white" alt="ライセンス">
|
||
</a> |
|
||
<a href="https://docs.anythingllm.com" target="_blank">
|
||
ドキュメント
|
||
</a> |
|
||
<a href="https://my.mintplexlabs.com/aio-checkout?product=anythingllm" target="_blank">
|
||
ホストされたインスタンス
|
||
</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href='../README.md'>English</a> · <a href='./README.zh-CN.md'>简体中文</a> · <b>日本語</b>
|
||
</p>
|
||
|
||
<p align="center">
|
||
👉 デスクトップ用AnythingLLM（Mac、Windows、Linux対応）！<a href="https://anythingllm.com/download" target="_blank">今すぐダウンロード</a>
|
||
</p>
|
||
|
||
これは、任意のドキュメント、リソース、またはコンテンツの断片を、チャット中にLLMが参照として使用できるコンテキストに変換できるフルスタックアプリケーションです。このアプリケーションを使用すると、使用するLLMまたはベクトルデータベースを選択し、マルチユーザー管理と権限をサポートできます。
|
||
|
||
|
||
|
||
<details>
|
||
<summary><kbd>デモを見る！</kbd></summary>
|
||
|
||
[](https://youtu.be/f95rGD9trL0)
|
||
|
||
</details>
|
||
|
||
### 製品概要
|
||
|
||
AnythingLLMは、市販のLLMや人気のあるオープンソースLLM、およびベクトルDBソリューションを使用して、妥協のないプライベートChatGPTを構築できるフルスタックアプリケーションです。ローカルで実行することも、リモートでホストすることもでき、提供されたドキュメントと知的にチャットできます。
|
||
|
||
AnythingLLMは、ドキュメントを`ワークスペース`と呼ばれるオブジェクトに分割します。ワークスペースはスレッドのように機能しますが、ドキュメントのコンテナ化が追加されています。ワークスペースはドキュメントを共有できますが、互いに通信することはないため、各ワークスペースのコンテキストをクリーンに保つことができます。
|
||
|
||
AnythingLLMのいくつかのクールな機能
|
||
|
||
- **マルチユーザーインスタンスのサポートと権限付与**
|
||
- ワークスペース内のエージェント（ウェブを閲覧、コードを実行など）
|
||
- [ウェブサイト用のカスタム埋め込み可能なチャットウィジェット](./embed/README.md)
|
||
- 複数のドキュメントタイプのサポート（PDF、TXT、DOCXなど）
|
||
- シンプルなUIからベクトルデータベース内のドキュメントを管理
|
||
- 2つのチャットモード`会話`と`クエリ`。会話は以前の質問と修正を保持します。クエリはドキュメントに対するシンプルなQAです
|
||
- チャット中の引用
|
||
- 100%クラウドデプロイメント対応。
|
||
- 「独自のLLMを持参」モデル。
|
||
- 大規模なドキュメントを管理するための非常に効率的なコスト削減策。巨大なドキュメントやトランスクリプトを埋め込むために一度以上支払うことはありません。他のドキュメントチャットボットソリューションよりも90%コスト効率が良いです。
|
||
- カスタム統合のための完全な開発者API！
|
||
|
||
### サポートされているLLM、埋め込みモデル、音声モデル、およびベクトルデータベース
|
||
|
||
**言語学習モデル：**
|
||
|
||
- [llama.cpp互換の任意のオープンソースモデル](/server/storage/models/README.md#text-generation-llm-selection)
|
||
- [OpenAI](https://openai.com)
|
||
- [OpenAI (汎用)](https://openai.com)
|
||
- [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service)
|
||
- [Anthropic](https://www.anthropic.com/)
|
||
- [Google Gemini Pro](https://ai.google.dev/)
|
||
- [Hugging Face (チャットモデル)](https://huggingface.co/)
|
||
- [Ollama (チャットモデル)](https://ollama.ai/)
|
||
- [LM Studio (すべてのモデル)](https://lmstudio.ai)
|
||
- [LocalAi (すべてのモデル)](https://localai.io/)
|
||
- [Together AI (チャットモデル)](https://www.together.ai/)
|
||
- [Perplexity (チャットモデル)](https://www.perplexity.ai/)
|
||
- [OpenRouter (チャットモデル)](https://openrouter.ai/)
|
||
- [Mistral](https://mistral.ai/)
|
||
- [Groq](https://groq.com/)
|
||
- [Cohere](https://cohere.com/)
|
||
- [KoboldCPP](https://github.com/LostRuins/koboldcpp)
|
||
|
||
**埋め込みモデル：**
|
||
|
||
- [AnythingLLMネイティブ埋め込み](/server/storage/models/README.md)（デフォルト）
|
||
- [OpenAI](https://openai.com)
|
||
- [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service)
|
||
- [LocalAi (すべて)](https://localai.io/)
|
||
- [Ollama (すべて)](https://ollama.ai/)
|
||
- [LM Studio (すべて)](https://lmstudio.ai)
|
||
- [Cohere](https://cohere.com/)
|
||
|
||
**音声変換モデル：**
|
||
|
||
- [AnythingLLM内蔵](https://github.com/Mintplex-Labs/anything-llm/tree/master/server/storage/models#audiovideo-transcription)（デフォルト）
|
||
- [OpenAI](https://openai.com/)
|
||
|
||
**TTS（テキストから音声へ）サポート：**
|
||
|
||
- ネイティブブラウザ内蔵（デフォルト）
|
||
- [OpenAI TTS](https://platform.openai.com/docs/guides/text-to-speech/voice-options)
|
||
- [ElevenLabs](https://elevenlabs.io/)
|
||
|
||
**STT（音声からテキストへ）サポート：**
|
||
|
||
- ネイティブブラウザ内蔵（デフォルト）
|
||
|
||
**ベクトルデータベース：**
|
||
|
||
- [LanceDB](https://github.com/lancedb/lancedb)（デフォルト）
|
||
- [Astra DB](https://www.datastax.com/products/datastax-astra)
|
||
- [Pinecone](https://pinecone.io)
|
||
- [Chroma](https://trychroma.com)
|
||
- [Weaviate](https://weaviate.io)
|
||
- [QDrant](https://qdrant.tech)
|
||
- [Milvus](https://milvus.io)
|
||
- [Zilliz](https://zilliz.com)
|
||
|
||
### 技術概要
|
||
|
||
このモノレポは、主に3つのセクションで構成されています：
|
||
|
||
- `frontend`: LLMが使用できるすべてのコンテンツを簡単に作成および管理できるviteJS + Reactフロントエンド。
|
||
- `server`: すべてのインタラクションを処理し、すべてのベクトルDB管理およびLLMインタラクションを行うNodeJS expressサーバー。
|
||
- `collector`: UIからドキュメントを処理および解析するNodeJS expressサーバー。
|
||
- `docker`: Dockerの指示およびビルドプロセス + ソースからのビルド情報。
|
||
- `embed`: [埋め込みウィジェット](./embed/README.md)の生成に特化したコード。
|
||
|
||
## 🛳 セルフホスティング
|
||
|
||
Mintplex Labsおよびコミュニティは、AnythingLLMをローカルで実行できる多数のデプロイメント方法、スクリプト、テンプレートを維持しています。以下の表を参照して、お好みの環境でのデプロイ方法を読むか、自動デプロイを行ってください。
|
||
| Docker | AWS | GCP | Digital Ocean | Render.com |
|
||
|----------------------------------------|----:|-----|---------------|------------|
|
||
| [![Docker上でデプロイ][docker-btn]][docker-deploy] | [![AWS上でデプロイ][aws-btn]][aws-deploy] | [![GCP上でデプロイ][gcp-btn]][gcp-deploy] | [![DigitalOcean上でデプロイ][do-btn]][do-deploy] | [![Render.com上でデプロイ][render-btn]][render-deploy] |
|
||
|
||
| Railway |
|
||
| --------------------------------------------------- |
|
||
| [![Railway上でデプロイ][railway-btn]][railway-deploy] |
|
||
|
||
[Dockerを使用せずに本番環境のAnythingLLMインスタンスを設定する →](./BARE_METAL.md)
|
||
|
||
## 開発環境のセットアップ方法
|
||
|
||
- `yarn setup` 各アプリケーションセクションに必要な`.env`ファイルを入力します（リポジトリのルートから）。
|
||
- 次に進む前にこれらを入力してください。`server/.env.development`が入力されていないと正しく動作しません。
|
||
- `yarn dev:server` ローカルでサーバーを起動します（リポジトリのルートから）。
|
||
- `yarn dev:frontend` ローカルでフロントエンドを起動します（リポジトリのルートから）。
|
||
- `yarn dev:collector` ドキュメントコレクターを実行します（リポジトリのルートから）。
|
||
|
||
[ドキュメントについて学ぶ](./server/storage/documents/DOCUMENTS.md)
|
||
|
||
[ベクトルキャッシュについて学ぶ](./server/storage/vector-cache/VECTOR_CACHE.md)
|
||
|
||
## 貢献する方法
|
||
|
||
- issueを作成する
|
||
- `<issue number>-<short name>`の形式のブランチ名でPRを作成する
|
||
- マージしましょう
|
||
|
||
## テレメトリーとプライバシー
|
||
|
||
Mintplex Labs Inc.によって開発されたAnythingLLMには、匿名の使用情報を収集するテレメトリー機能が含まれています。
|
||
|
||
<details>
|
||
<summary><kbd>AnythingLLMのテレメトリーとプライバシーについての詳細</kbd></summary>
|
||
|
||
### なぜ？
|
||
|
||
この情報を使用して、AnythingLLMの使用方法を理解し、新機能とバグ修正の優先順位を決定し、AnythingLLMのパフォーマンスと安定性を向上させるのに役立てます。
|
||
|
||
### オプトアウト
|
||
|
||
サーバーまたはdockerの.env設定で`DISABLE_TELEMETRY`を「true」に設定して、テレメトリーからオプトアウトします。アプリ内でも、サイドバー > `プライバシー`に移動してテレメトリーを無効にすることができます。
|
||
|
||
### 明示的に追跡するもの
|
||
|
||
製品およびロードマップの意思決定に役立つ使用詳細のみを追跡します。具体的には：
|
||
|
||
- インストールのタイプ（Dockerまたはデスクトップ）
|
||
- ドキュメントが追加または削除されたとき。ドキュメントについての情報はありません。イベントが発生したことのみを知ります。これにより、使用状況を把握できます。
|
||
- 使用中のベクトルデータベースのタイプ。どのベクトルデータベースプロバイダーが最も使用されているかを知り、更新があったときに優先して変更を行います。
|
||
- 使用中のLLMのタイプ。最も人気のある選択肢を知り、更新があったときに優先して変更を行います。
|
||
- チャットが送信された。これは最も一般的な「イベント」であり、すべてのインストールでのこのプロジェクトの日常的な「アクティビティ」についてのアイデアを提供します。再び、イベントのみが送信され、チャット自体の性質や内容に関する情報はありません。
|
||
|
||
これらの主張を検証するには、`Telemetry.sendTelemetry`が呼び出されるすべての場所を見つけてください。また、これらのイベントは出力ログに書き込まれるため、送信された具体的なデータも確認できます。IPアドレスやその他の識別情報は収集されません。テレメトリープロバイダーは[PostHog](https://posthog.com/)です。
|
||
|
||
[ソースコード内のすべてのテレメトリーイベントを表示](https://github.com/search?q=repo%3AMintplex-Labs%2Fanything-llm%20.sendTelemetry\(&type=code)
|
||
|
||
</details>
|
||
|
||
## 🔗 その他の製品
|
||
|
||
- **[VectorAdmin][vector-admin]**：ベクトルデータベースを管理するためのオールインワンGUIおよびツールスイート。
|
||
- **[OpenAI Assistant Swarm][assistant-swarm]**：単一のエージェントから指揮できるOpenAIアシスタントの軍隊に、ライブラリ全体を変換します。
|
||
|
||
<div align="right">
|
||
|
||
[![][back-to-top]](#readme-top)
|
||
|
||
</div>
|
||
|
||
---
|
||
|
||
Copyright © 2024 [Mintplex Labs][profile-link]。<br />
|
||
このプロジェクトは[MIT](./LICENSE)ライセンスの下でライセンスされています。
|
||
|
||
<!-- LINK GROUP -->
|
||
|
||
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-222628?style=flat-square
|
||
[profile-link]: https://github.com/mintplex-labs
|
||
[vector-admin]: https://github.com/mintplex-labs/vector-admin
|
||
[assistant-swarm]: https://github.com/Mintplex-Labs/openai-assistant-swarm
|
||
[docker-btn]: ./images/deployBtns/docker.png
|
||
[docker-deploy]: ./docker/HOW_TO_USE_DOCKER.md
|
||
[aws-btn]: ./images/deployBtns/aws.png
|
||
[aws-deploy]: ./cloud-deployments/aws/cloudformation/DEPLOY.md
|
||
[gcp-btn]: https://deploy.cloud.run/button.svg
|
||
[gcp-deploy]: ./cloud-deployments/gcp/deployment/DEPLOY.md
|
||
[do-btn]: https://www.deploytodo.com/do-btn-blue.svg
|
||
[do-deploy]: ./cloud-deployments/digitalocean/terraform/DEPLOY.md
|
||
[render-btn]: https://render.com/images/deploy-to-render-button.svg
|
||
[render-deploy]: https://render.com/deploy?repo=https://github.com/Mintplex-Labs/anything-llm&branch=render
|
||
[render-btn]: https://render.com/images/deploy-to-render-button.svg
|
||
[render-deploy]: https://render.com/deploy?repo=https://github.com/Mintplex-Labs/anything-llm&branch=render
|
||
[railway-btn]: https://railway.app/button.svg
|
||
[railway-deploy]: https://railway.app/template/HNSCS1?referralCode=WFgJkn
|