目次
- 概要
- 前提条件
- ステップ 1: Agent に SDK を統合する
- ステップ 2: CLI で設定ファイルを生成する
- ステップ 3: ワンクリックで Novita にデプロイする
- ステップ 4: CLI または SDK で Agent を呼び出す
- FAQ
概要
完全なワークフローは 4 つのステップで構成されます。- ✅ SDK を統合 - Agent コードにデコレーターを追加します
- ✅ Agent を設定 - CLI を使用して設定ファイルを生成します
- ✅ Agent をデプロイ - クラウドへワンクリックでデプロイします
- ✅ Agent を呼び出し - SDK または CLI を使用して Agent を呼び出します
前提条件
以下の前提条件を満たしていることを確認してください。- ✅ Python 3.9+ と Node.js 20+ がインストールされている
- ✅ ベータ版 Python SDK と Node.js CLI がインストールされている(インストールガイドを参照)
- ✅ Novita AI API Key を取得済み(Consoleから取得)
- ✅ Docker がインストールされている
ステップ 1: Agent に SDK を統合する
1.1 Agent コードを作成する
プロジェクトディレクトリにapp.py を作成します。
1.2 依存関係ファイルを準備する
プロジェクトルートに、必要な依存関係を含むrequirements.txt ファイルがあることを確認してください。
1.3 ローカルテスト
デプロイ前にローカルでテストします。ステップ 2: CLI で設定ファイルを生成する
CLI を使用して Agent を対話形式で設定します。novita.Dockerfile- Docker ビルドファイル.dockerignore- Docker ignore ファイル.novita-agent.yaml- Agent 設定ファイル
ステップ 3: ワンクリックで Novita AI にデプロイする
⚠️ 重要: デプロイが成功すると、agent_id が生成されます。これは Agent を呼び出すための一意の識別子です。必ず保存してください。
3.1 デプロイコマンド
CLI を使用してワンクリックでデプロイします。3.2 デプロイ結果を確認する
デプロイが成功すると、.novita-agent.yaml ファイルの status フィールドが更新されます。
agent_id を記録してください。以降の呼び出しで必要になります。
ステップ 4: CLI または SDK で Agent を呼び出す
オプション 1: CLI でクイックテストする
CLI を使用して Agent をすばやくテストします。.novita-agent.yaml 内の status.agent_id フィールドから Agent ID を自動的に読み取ります。
期待される出力:
オプション 2: SDK による呼び出し(本番環境に推奨)
SDK を使用して、バックエンドサービスから Agent を呼び出します。サンプルコード
FAQ
Q1: Agent ID はどのように取得しますか?
デプロイが成功すると、Agent ID は.novita-agent.yaml ファイルの status.agent_id フィールドに保存されます。
Q2: デプロイに失敗した場合はどうすればよいですか?
- 依存関係ファイルを確認する:
requirements.txtにすべての依存関係が含まれていることを確認してください - 詳細ログを確認する:
--verboseフラグを使用します - ネットワーク接続を確認する: Novita AI Sandbox ドメイン(例:
sandbox.novita.ai)にアクセスできることを確認してください - API Key を検証する:
NOVITA_API_KEYが正しいことを確認してください
Q3: デプロイ済み Agent を更新するにはどうすればよいですか?
コードを変更して再デプロイします。Q4: ローカルでは動作するのに、デプロイ後に失敗する場合は?
考えられる原因:- 環境変数が sandbox instance に渡されていない
- 依存パッケージのバージョンに不整合がある
- ファイルパスの問題
envVars パラメーターを使用して、環境変数を sandbox instance に渡します。