メインコンテンツまでスキップ
バージョン: 2025-11-14

1. バックエンド仕様 (API)

前提知識レベル:

  • FastAPI, Pydantic, SQLAlchemyに関する開発経験
  • REST API, OAuth2, JWTに関する知識

FastAPIで構築されたバックエンドAPI。主な責務は、認証、ビジネスロジックの実行、外部サービス連携です。

1.1. コンポーネント図​

コンポーネント説明
RoutersAPIエンドポイントを定義し、リクエストを適切なサービスにルーティングする。
Servicesビジネスロジックを実装する。LLMサービス連携やNetworkXMCPの呼び出しなど。
Models/SchemasPydanticモデルとデータベーススキーマを定義する。
Database InterfaceSQLAlchemyを使用してデータベースとのやり取りを抽象化する。
Auth LogicOAuth2/JSON Web Tokenによるユーザー認証・認可のロジックを実装する。

1.2. APIエンドポイント一覧​

1.2.1. 認証 (/auth)​

MethodPath説明
POST/register新規ユーザーを登録する。
POST/tokenユーザー名とパスワードで認証し、JWTアクセストークンを発行する。
GET/users/me現在認証中のユーザー情報を取得する。

1.2.2. 運用​

MethodPath説明
GET/healthサービスのヘルスチェックを行う。

1.2.3. チャット・LLM連携 (/chat)​

MethodPath説明
POST/conversations新しい会話を作成する。
GET/conversationsユーザーの会話一覧を取得する。
GET/conversations/{id}特定の会話の詳細を取得する。
GET/conversations/{id}/messages特定の会話のメッセージ一覧を取得する。
POST/processチャットUIからのメッセージを処理し、LLMやツール呼び出しを実行して最終結果を返す。
POST/recommend-layoutネットワーク概要に基づき、LLMが最適なレイアウトを推薦する。
GET/conversations/{id}/streamWebSocketの接続を確立するエンドポイント。ネットワークの更新通知、計算の進捗、LLMの思考プロセスなどをリアルタイムで送信する。

/chat/process の詳細​

  • Request Body:
{
"conversation_id": 12345,
"message": {
"role": "user",
"content": "次数中心性を計算して、重要なノードを大きく表示してください。"
}
}
  • Response Body (Success):
{
"message": {
"role": "assistant",
"content": "次数中心性を計算し、ノードのサイズに反映しました。"
}
}

このエンドポイントが呼び出された際の、Backend、LLM、NetworkXMCP間のより詳細な連携フローについては、以下のドキュメントを参照してください。

1.2.4. ネットワーク (/network)​

MethodPath説明
POST/uploadGraphMLファイルをアップロードし、新しい会話とネットワークを作成する。 multipart/form-data を使用。この処理の中でNetworkXMCPを呼び出し、デフォルトのレイアウトを計算して属性として保存する。詳細は新規会話開始(ネットワークアップロード)フローを参照。
GET/{network_id}/visdata**【注意: 非推奨】**ネットワークの基本的な構造(ノードとエッジ)を返す。動的なレンダリングデータ生成は/chat/processフローに移行されたため、このエンドポイントはスタイル情報を含まない。
GET/{network_id}/exportネットワークをGraphMLファイルとしてダウンロードする。

/network/upload の詳細​

  • Response Body (Success):
{
"conversation_id": "conv_67890",
"network_id": "net_54321"
}

1.3. Backendの役割: LLMとツールのオーケストレーター​

新アーキテクチャにおいて、Backendの役割はレンダリングデータを自ら組み立てることではなく、LLMと専門ツール(NetworkXMCP)間の指示を調整する**オーケストレーター(指揮者)**に特化します。これにより、ビジネスロジックと専門的な計算処理が明確に分離されます。

データ変換フロー図​

プロセスは以下のステップで実行されます。

  1. BackendがLLMに指示を送信:

    • Frontendから受け取ったユーザーの自然言語指示(例:「次数中心性でノードを色分けして」)と、利用可能なツールリスト(list_attributes, calculate_centrality, generate_visualizationなど)をLLMに送信します。
  2. LLMが実行プランを計画:

    • LLMはユーザーの意図を解釈します。
    • ネットワークの現状を把握するためにlist_attributesを呼び出し、必要な属性(例:degree_centrality)が存在するか確認します。
    • 属性が存在しない場合は、calculate_centralityを呼び出して計算させます。
    • 最終的に、レイアウト、ノードサイズ、ノードカラーなどの割り当てをすべて定義した、generate_visualizationツールのパラメータを組み立て、Backendに返します。
  3. BackendがNetworkXMCPを呼び出す:

    • Backendは、LLMから受け取ったgenerate_visualizationの呼び出しプラン(リクエストボディ)をそのままNetworkXMCPの/tools/generate_visualizationエンドポイントに送信します。
  4. NetworkXMCPがレンダリングデータを生成:

    • NetworkXMCPは、リクエストされたすべての視覚的割り当て(レイアウト、サイズ、色など)に基づき、データベースから必要な属性値を取得し、マッピング計算を行い、フロントエンドが直接描画できる最終的なJSONデータを生成します。
  5. Backendが結果を中継:

    • NetworkXMCPから返された最終的なレンダリングデータを、BackendはWebSocketを通じてFrontendに送信します。Frontendはこれを受け取り、画面を更新します。

この設計により、Backendは視覚化の具体的なロジックに関与せず、LLMの知能とNetworkXMCPの計算能力を最大限に引き出すことに集中できます。

5. デフォルトの視覚スタイル​

上記のプロセスにおいて、特定の視覚的特徴(例: NODE_SIZE)に適用されるマッピングルールが存在しない場合、システムは以下のデフォルト値を適用します。これにより、ユーザーがファイルをアップロードした直後でも、常に一定のスタイルでネットワークが描画されることを保証します。

  • 初期レイアウト (x, y座標)

    • 値: ネットワークのアップロード時にNetworkXMCPが計算したSpring Layoutの結果が、xおよびyという名前の属性として永続化されています。Backendはこれを読み込み、デフォルトのノード座標として使用します。
  • ノードサイズ (size)

    • デフォルト値: 5
  • ノードカラー (color)

    • デフォルト値: #82b3ff (システムのテーマカラーに合わせた明るい青)
  • エッジ幅 (width)

    • デフォルト値: 1
  • エッジカラー (color)

    • デフォルト値: #cccccc (他の要素を邪魔しない薄いグレー)

1.4. 主要なデータモデル (Pydantic Schemas)​

APIで送受信される主要なデータ構造です。

  • User
フィールド名型説明
idintユーザーID (Auto-increment)
usernamestrユーザー名
  • Token
フィールド名型説明
access_tokenstrJWTアクセストークン
token_typestrトークン種別 (例: "bearer")
  • Conversation
フィールド名型説明
idint会話ID
titlestr会話のタイトル
user_idintこの会話を所有するユーザーのID
created_atdatetime作成日時
updated_atdatetime更新日時
  • ChatMessage
フィールド名型説明
idintメッセージID
conversation_idstr所属する会話のID
rolestr発言者の役割 (user or assistant)
contentstrメッセージの本文
meta_datadict拡張用のメタデータ (JSON)
created_atdatetime作成日時
  • Network (DBモデル)

networksテーブルのスキーマ定義は、このドキュメント群における唯一の信頼できる情報源(Single Source of Truth)である 4. データベーススキーマ仕様 を参照してください。

conversationsテーブルがnetwork_idを保持し、networksテーブルへの1対1の参照を持ちます。

1.5. 外部サービス連携​

  • NetworkXMCP: グラフ計算が必要なリクエストを http://networkx-mcp:8001 に転送(プロキシ)します。(このURLは、環境変数 NETWORKX_MCP_URL によって設定されます。デフォルト値は http://networkx-mcp:8001 です。)
  • LLMサービス: ユーザーの指示解釈、ツールコール変換、結果の要約のために外部LLM(OpenAI, Gemini等)のAPIを呼び出します。

1.6. エラーハンドリング​

APIは、エラー発生時にHTTPステータスコードと、詳細情報を含むJSONオブジェクトを返却します。

  • エラーレスポンス形式:
{
"detail": {
"error_code": "RESOURCE_NOT_FOUND",
"message": "指定された会話が見つかりません。",
"context": {
"conversation_id": "unknown_id"
}
}
}
フィールド名型説明
error_codestrエラーの種類を一意に識別するコード。
messagestr開発者向けのエラー詳細メッセージ。
contextdictエラーが発生した際の関連情報(デバッグ用)。
  • 主要なHTTPステータスコード:
コード説明主な用途
400 Bad Requestリクエストの形式が不正(例: 必須パラメータの欠如、データ型の不一致)。
401 Unauthorized認証が必要なリソースに対し、認証なしでアクセスした場合。
403 Forbidden認証済みだが、リソースへのアクセス権限がない場合。
404 Not Found指定されたリソースが存在しない場合。
500 Internal Server Errorサーバー内部で予期せぬエラーが発生した場合。