Server API

ADK-Rust サーバーは、エージェントの実行、セッションの管理、アーティファクトへのアクセスを行うための REST API を提供します。サーバーモードで Launcher を使用してエージェントをデプロイすると、これらのエンドポイントがWeb UIとともに公開されます。

概要

このサーバーはAxumを基盤として構築されており、以下を提供します:

• REST API: エージェントの実行とセッション管理のための HTTP エンドポイント
• Server-Sent Events (SSE): エージェントの応答のリアルタイムストリーミング
• Web UI: インタラクティブなブラウザベースのインターフェース
• CORS サポート: クロスオリジンリクエストが有効
• Telemetry: トレース機能を備えた組み込みの可観測性

ServerConfig は、長期間実行されるデプロイメント向けに、ランナーレベルのパススルーも公開しています:

let config = ServerConfig::new(agent_loader, session_service)
    .with_compaction(compaction_config)
    .with_context_cache(context_cache_config, cache_capable_model);

サーバーの起動

Launcherを使用してサーバーを起動します:

use adk_rust::prelude::*;
use adk_rust::Launcher;
use std::sync::Arc;

#[tokio::main]
async fn main() -> Result<()> {
    let api_key = std::env::var("GOOGLE_API_KEY")?;
    let model = Arc::new(GeminiModel::new(&api_key, "gemini-2.5-flash")?);
    
    let agent = LlmAgentBuilder::new("my_agent")
        .description("A helpful assistant")
        .instruction("You are a helpful assistant.")
        .model(model)
        .build()?;
    
    Launcher::new(Arc::new(agent)).run().await
}

検証済みの API スキャフォールドから開始します:

cargo adk new my-api --template api
cd my-api
cargo run

REST API エンドポイント

ヘルスチェック

サーバーが実行中か確認します:

GET /api/health

応答:

OK

ストリーミングによるエージェントの実行

エージェントを実行し、Server-Sent Eventsを使用して応答をストリーミングします:

POST /api/run_sse

リクエストボディ:

{
  "appName": "my_agent",
  "userId": "user123",
  "sessionId": "session456",
  "newMessage": {
    "role": "user",
    "parts": [
      {
        "text": "What is the capital of France?"
      }
    ]
  },
  "streaming": true
}

応答:

• Content-Type: text/event-stream
• イベントを JSON オブジェクトとしてストリーミングします

イベント形式:

{
  "id": "evt_123",
  "timestamp": 1234567890,
  "author": "my_agent",
  "content": {
    "role": "model",
    "parts": [
      {
        "text": "The capital of France is Paris."
      }
    ]
  },
  "actions": {},
  "llm_response": {
    "content": {
      "role": "model",
      "parts": [
        {
          "text": "The capital of France is Paris."
        }
      ]
    }
  }
}

セッション管理

セッションの作成

新しいセッションを作成します:

POST /api/sessions

リクエストボディ:

{
  "appName": "my_agent",
  "userId": "user123",
  "sessionId": "session456"
}

応答:

{
  "id": "session456",
  "appName": "my_agent",
  "userId": "user123",
  "lastUpdateTime": 1234567890,
  "events": [],
  "state": {}
}

セッションの取得

セッションの詳細を取得します:

GET /api/sessions/:app_name/:user_id/:session_id

応答:

{
  "id": "session456",
  "appName": "my_agent",
  "userId": "user123",
  "lastUpdateTime": 1234567890,
  "events": [],
  "state": {}
}

セッションの削除

セッションを削除します:

DELETE /api/sessions/:app_name/:user_id/:session_id

応答:

• ステータス：204 No Content

セッションの一覧表示

ユーザーのすべてのセッションを一覧表示します:

GET /api/apps/:app_name/users/:user_id/sessions

応答:

[
  {
    "id": "session456",
    "appName": "my_agent",
    "userId": "user123",
    "lastUpdateTime": 1234567890,
    "events": [],
    "state": {}
  }
]

アーティファクト管理

アーティファクトの一覧表示

セッションのすべてのアーティファクトを一覧表示します:

GET /api/sessions/:app_name/:user_id/:session_id/artifacts

応答:

[
  "image1.png",
  "document.pdf",
  "data.json"
]

アーティファクトの取得

アーティファクトをダウンロードします:

GET /api/sessions/:app_name/:user_id/:session_id/artifacts/:artifact_name

応答:

• Content-Type: ファイル拡張子によって決定されます
• Body: バイナリまたはテキストコンテンツ

アプリケーション管理

アプリケーションの一覧表示

利用可能なすべてのエージェントを一覧表示します:

GET /api/apps
GET /api/list-apps  (legacy compatibility)

応答:

{
  "apps": [
    {
      "name": "my_agent",
      "description": "A helpful assistant"
    }
  ]
}

Web UI

サーバーには、以下でアクセスできる組み込みのWeb UIが含まれており:

http://localhost:8080/ui/

機能

• インタラクティブチャット: メッセージを送信し、ストリーミング応答を受信します
• Session Management: セッションの作成、表示、切り替え
• Multi-Agent Support: エージェントの転送と階層を視覚化します
• Artifact Viewer: セッションアーティファクトの表示とダウンロード
• リアルタイム更新: 即時応答のための SSE-ベースのストリーミング

UI ルート

• / - /ui/ にリダイレクトします
• /ui/ - メインチャットインターフェース
• /ui/assets/* - 静的アセット (CSS, JS, images)
• /ui/assets/config/runtime-config.json - ランタイム設定

クライアントの例

JavaScript/TypeScript

Fetch API を SSE とともに使用する:

async function runAgent(message) {
  const response = await fetch('http://localhost:8080/api/run_sse', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      appName: 'my_agent',
      userId: 'user123',
      sessionId: 'session456',
      newMessage: {
        role: 'user',
        parts: [{ text: message }]
      },
      streaming: true
    })
  });

  const reader = response.body.getReader();
  const decoder = new TextDecoder();

  while (true) {
    const { done, value } = await reader.read();
    if (done) break;
    
    const chunk = decoder.decode(value);
    const lines = chunk.split('\n');
    
    for (const line of lines) {
      if (line.startsWith('data: ')) {
        const event = JSON.parse(line.slice(6));
        console.log('Event:', event);
      }
    }
  }
}

Python

requests ライブラリを使用する:

import requests
import json

def run_agent(message):
    url = 'http://localhost:8080/api/run_sse'
    payload = {
        'appName': 'my_agent',
        'userId': 'user123',
        'sessionId': 'session456',
        'newMessage': {
            'role': 'user',
            'parts': [{'text': message}]
        },
        'streaming': True
    }
    
    response = requests.post(url, json=payload, stream=True)
    
    for line in response.iter_lines():
        if line:
            line_str = line.decode('utf-8')
            if line_str.startswith('data: '):
                event = json.loads(line_str[6:])
                print('Event:', event)

run_agent('What is the capital of France?')

cURL

# Create session
curl -X POST http://localhost:8080/api/sessions \
  -H "Content-Type: application/json" \
  -d '{
    "appName": "my_agent",
    "userId": "user123",
    "sessionId": "session456"
  }'

# Run agent with streaming
curl -X POST http://localhost:8080/api/run_sse \
  -H "Content-Type: application/json" \
  -d '{
    "appName": "my_agent",
    "userId": "user123",
    "sessionId": "session456",
    "newMessage": {
      "role": "user",
      "parts": [{"text": "What is the capital of France?"}]
    },
    "streaming": true
  }'

サーバー設定

カスタムポート

カスタムポートの場合、生成されたサーバーを起動する前に PORT を設定します:

PORT=3000 cargo run

カスタム Artifact Service

独自のアーティファクトサービスを提供します:

use adk_artifact::InMemoryArtifactService;

let artifact_service = Arc::new(InMemoryArtifactService::new());

Launcher::new(Arc::new(agent))
    .with_artifact_service(artifact_service)
    .run()
    .await

カスタム Session Service

本番環境でのデプロイメントには、永続的なセッションサービスを使用します:

use adk_session::SqliteSessionService;

// Note: This requires implementing a custom server setup
// The Launcher uses InMemorySessionService by default

エラー処理

API は、エラーカテゴリから派生した HTTP ステータスコードを持つ構造化されたエラー応答を使用します:

エラー応答形式 (問題 JSON):

{
  "error": {
    "code": "model.openai.rate_limited",
    "message": "OpenAI rate limit exceeded",
    "component": "model",
    "category": "rate_limited",
    "requestId": "req-abc123",
    "retryAfter": 5000,
    "upstreamStatusCode": 429
  }
}

フィールド requestId、retryAfter、および upstreamStatusCode は、利用可能な場合に含められます（それ以外の場合はnull）。

CORS 設定

サーバーはデフォルトで許可的な CORS を有効にしており、任意のオリジンからのリクエストを許可します。これは開発には適していますが、本番環境では制限する必要があります。

テレメトリー

サーバーは起動時にテレメトリーを自動的に初期化します。ログは構造化された形式で標準出力に出力されます。

ログレベル:

• ERROR: 致命的なエラー
• WARN: 警告
• INFO: 一般情報（デフォルト）
• DEBUG: 詳細なデバッグ
• TRACE: 非常に詳細なトレース

RUST_LOG 環境変数でログレベルを設定します:

RUST_LOG=debug cargo run

ベストプラクティス

1. セッション管理: エージェントを実行する前に必ずセッションを作成します
2. エラー処理: HTTP ステータスコードを確認し、適切にエラーを処理します
3. ストリーミング: リアルタイム応答には SSE を使用し、イベントを1行ずつ解析します
4. セキュリティ: 本番環境では、認証を実装し、CORS を制限します
5. 永続性: 本番デプロイメントには SqliteSessionService または PostgresSessionService を使用します
6. 監視: テレメトリーを有効にし、ログを監視して問題を特定します

フルスタックの例

完全に動作するサーバーの足場として、検証済みの cargo-adk API テンプレートを使用してください。これは以下を示します:

• フロントエンド: リアルタイムストリーミングを備えた HTML/JavaScript クライアント
• バックエンド: カスタムリサーチおよび PDF 生成ツールを備えた ADK エージェント
• 統合: SSE ストリーミングを使用した完全な REST API の使用
• アーティファクト: PDF の生成とダウンロード
• セッション管理: 自動セッション作成と処理

この例は、ADK-Rust を使用してAI搭載ウェブアプリケーションを構築するための本番環境対応パターンを示しています。

クイックスタート:

cargo adk new my-api --template api
cd my-api
cargo run

ファイル:

• バックエンド: adk-rust-guide/examples/deployment/full_stack_research.rs
• フロントエンド: examples/research_paper/frontend.html
• ドキュメント: examples/research_paper/README.md
• アーキテクチャ: examples/research_paper/architecture.md

関連

• ランチャー - サーバーの起動
• セッション - セッション管理
• アーティファクト - アーティファクトストレージ
• 可観測性 - テレメトリーとロギング

---

前へ: ← Launcher | 次へ: A2A プロトコル →