Larkagentx

🚀 LarkAgentX プロジェクトドキュメント

LarkAgentXは、飛書（Feishu）プラットフォーム上に構築された強力なロボットエージェントシステムです。大規模言語モデル（LLM）を利用して機能呼び出しを実現し、メッセージをデータベースに永続的に保存します。このシステムは、企業内のコミュニケーション効率を向上させるために設計されており、グループチャットと個別チャットの両方の環境でコマンドを実行できます。

✨ 主な機能

• スマート関数呼び出し：ユーザーが入力した自然言語またはコマンドを解析し、事前に設定された関数操作をトリガーします。
• メッセージの永続化：すべての会話記録はMySQLデータベースに保存され、後で参照および分析することができます。
• 複数環境のサポート：Dockerイメージの構築と実行方法を提供し、デプロイプロセスを簡素化します。
• 飛書ロボットとの統合：飛書アカウントを直接エージェントとして使用でき、ロボットのIDを追加で設定する必要がありません。

📦 インストール

直接実行方法

python main.py

Docker方式（推奨）

方法一：個別にイメージを構築する

# イメージを構築する 
docker build -t feishuapp .

# コンテナを実行する 外部mysqlが必要で、dockerゲートウェイを介してホストマシンのmysqlに接続する 推奨--env-file
docker run -it feishuapp bash

方法二：Docker Composeを使用してサービスを起動する

# すべてのサービス（アプリケーションとデータベース）を起動する
docker-compose up -d

# ログを表示する
docker-compose logs -f

# すべてのサービスを停止する
docker-compose down

📚 設定説明

.env.exampleファイルをコピーして.envという名前にし、以下の設定を変更します。

# データベース設定
DB_HOST=localhost
DB_PORT=3306
DB_USER=root
DB_PASSWORD=123456
DB_NAME=lark_messages

# 飛書のCookie設定 - LARK_COOKIEのみを設定すれば、飛書ロボットを不要にできます
LARK_COOKIE=""

# 関数呼び出しのトリガー接頭辞 （FUNCTION_TRIGGER_FLAGで始まるメッセージは大規模言語モデルによって解析され、すべてのメッセージは接頭辞に関係なくデータベースに記録されます）
FUNCTION_TRIGGER_FLAG="/run"

# ロボットの発言接頭辞 （未使用）
AI_BOT_PREFIX="Lark AI Bot:"

# OpenAI API設定 デフォルトは通義千問で、OpenAI互換の大規模言語モデルをサポートするベンダーであれば使用できます
OPENAI_API_KEY=""
OPENAI_API_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
OPENAI_API_MODEL="qwen-plus"

💻 使用例

アプリケーションを起動する

• 直接実行

  python main.py
  

• Docker Composeを使用する

  docker-compose up -d
  

システムが起動した後：

1. MCPサーバーを初期化します。
2. 飛書APIに接続し、飛書アカウントをAIアシスタントとして使用します。
3. 受信したメッセージを監視します。
4. 大規模言語モデルが飛書を介して発行した関数呼び出しを処理して実行します。
5. メッセージをMySQLデータベースに保存します。

🔧 データベース構造

すべての会話記録はMySQLデータベースに保存され、具体的なテーブル構造は以下の通りです。

🤝 プロジェクトへの貢献

コミュニティの開発者の皆様からの貢献を歓迎します！

• Issueを提出して問題を報告してください。
• コードリポジトリをForkしてください。
• Pull Requestを開いてバグを修正したり、新機能を追加したりしてください。

📄 ライセンス

このプロジェクトはMITオープンソースライセンスに準拠しており、詳細な条項はLICENSEファイルを参照してください。

📞 連絡先

開発チームに連絡する場合は、contact@larkagentx.comまでメールを送信してください。