Skip to content

README_JP.MD

Latest commit

 

History

History
177 lines (122 loc) · 8.78 KB

README_JP.MD

File metadata and controls

177 lines (122 loc) · 8.78 KB
Raw
プロジェクトロゴ

中文 | English | 日本語

多プラットフォームモデルの統合、拡張性、多様な出力形式を提供するLLMチャットサービスのボットプラグイン。

npm npm node version github top language

Telegram QQ doc Ask DeepWiki

プロジェクトのステータス：1.0 公式リリース（緩やかな開発、v2バージョンの準備中）

📸 スクリーンショット

プリセット プラグインモード & ストリーミング出力 画像レンダリング
preset plugin code

✨ 特徴

  • 🚀 高度に拡張可能（LangChain & Koishi API）
  • 🎭 カスタム会話プリセット
  • 🛡️ レート制限 & ブラックリストシステム
  • 🎨 多形式出力（テキスト、音声、画像、混合）
  • 🧠 長期記憶によるコンテキスト認識
  • 🔀 3つのモード：チャット、ブラウジング、プラグイン
  • 🔒 Koishi検閲によるコンテンツモデレーション

📝 ロードマップ

  • ルームベースの会話システム
  • コンテンツモデレーション
  • TTSサポート（vitsサービス経由）
  • 返信の画像レンダリング
  • 複数モデルの統合
  • プリセットシステム
  • 会話のインポート/エクスポート（廃止）
  • v1リファクタリング
  • ストリーミング応答
  • 画像マルチモーダル入力サポート
  • MCPプロトコルクライアントサポート
  • i18nサポート

🚀 クイックスタート

Koishi にプラグインを直接インストールでき、設定ファイルを編集する必要はありません。詳細については、ドキュメントを参照してください。

🔌 サポートされているモデル

モデル/プラットフォーム 統合 特徴
OpenAI 公式API カスタマイズ可能、Agent/ブラウジングモード
Azure OpenAI 公式API OpenAIに類似
Google Gemini 公式API 高速、GPT-3.5を上回る性能
Claude API 公式API 大きなコンテキスト、GPT-3.5を上回ることが多い
Deepseek 公式API 国内有名モデル
Tongyi Qianwen 公式API 無料クォータあり
Doubao ローカルクライアント、公式APIアクセス ByteDance製モデル、無料クォータ提供
Zhipu 公式API 新規ユーザーに無料トークン
Xunfei Spark 公式API 新規ユーザーに無料クォータ
Wenxin Yiyan 公式API Baiduのモデル
Hunyuan 公式API Tencentのモデル
Ollama 自己ホスト オープンソース、CPU/GPUサポート
RWKV 自己ホスト オープンソースモデル

ウェブ検索サポート:

  • Google (API)
  • Bing (API & Web)
  • DuckDuckGO (Lite)
  • Tavily (API)

🎭 プリセット

1.0.0-alpha.10から、よりカスタマイズ可能なプリセットを使用します。デフォルトのプリセット: catgirl.yml

プリセットフォルダ: <koishi_dir>/data/chathub/presets

詳細については、プリセットシステムドキュメントを参照してください。

🔧 開発

リポジトリをクローンします:

# yarn
yarn clone ChatLunaLab/chatluna
# npm
npm run clone ChatLunaLab/chatluna

tsconfig.jsonを更新します:

{
  "extends": "./tsconfig.base",
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "koishi-plugin-chatluna-*": ["external/chatluna/packages/*/src"]
    }
  }
}

プロジェクトをビルドします:

# yarn
yarn workspace @root/chatluna-koishi build
# npm
npm run build -w @root/chatluna-koishi

yarn devまたはnpm run devで開発を開始します。

注: HMRは完全に互換性がない場合があります。問題が発生した場合は、再ビルドして再起動してください。

🆘 貢献

以下の分野での支援が必要です:

  • Web UI
  • HTTPサーバー
  • プロジェクトドキュメント

PRやディスカッションを歓迎します！

👥 貢献者

Alt

Star History Chart

📢 使用上の注意

ChatLunaLabによって開発されました。

ChatLunaはLLMベースのチャットボットフレームワークです。私たちはオープンソースコミュニティと協力してLLM技術を進歩させています。ユーザーはオープンソースの合意を遵守し、このプロジェクトを潜在的に有害な目的や評価されていないサービスに使用しないようにする必要があります。

このプロジェクトはAIサービスを直接提供しません。ユーザーはAIサービスプロバイダーからAPIアクセスを取得する必要があります。

ユーザーは現地の法律を遵守し、現地で利用可能なAIサービスを使用する責任があります。

プロジェクトはアルゴリズム生成結果に対して責任を負いません。すべての結果と操作はユーザーの責任です。

ユーザーは独自のデータストレージを構成します。プロジェクトは直接のデータストレージを提供しません。

プロジェクトは、ユーザーが引き起こしたデータセキュリティ問題、世論リスク、またはモデルの誤用に対して責任を負いません。

🙏 謝辞

Koishi - クロスプラットフォーム、拡張可能、高性能な Node.js チャットボットフレームワーク。

AstrBot - 個人およびグループチャット向けワンストップ Agentic Python フレームワーク、マルチプラットフォームボットデプロイメント。

以下のオープンソースプロジェクトを参考にしました:

koishi-plugin-openai

chathub