AGTCloud API Docs
ガイドAPIリファレンス連携とリソース更新とヘルプ

SDK 概要

プロトコルに応じてOpenAI、Anthropic、またはGeminiのクライアント SDKを選び、接続前の確認を完了します。

AGTCloudは、OpenAI、Anthropic、Geminiの各プロトコルに対応する互換エンドポイントを提供します。対応する公式SDKを利用しているサーバー側プロジェクトでは、通常、主要な呼び出しメソッドを維持したまま、APIアドレス、API Key、モデルIDをAGTCloud向けに置き換えられます。

SDKのリクエスト構造はプロトコルごとに異なります。対象モデルが対応するプロトコルを確認し、モデル名だけで互換性を判断しないでください。

クライアント SDKを選ぶ

SDK対応プロトコル認証方式適した用途
OpenAI SDKChat Completions、ResponsesBearer API Keyすでに OpenAI SDK プロジェクトがあるか、メッセージ形式の会話、Typed Item、ストリーミング出力、ツール呼び出しが必要です
Anthropic SDKAnthropic Messagesx-api-key とバージョンヘッダーすでに Anthropic Messages プロジェクトがあるか、Content Blockと Anthropic ツール構造が必要です
Gemini SDKGemini Generate ContentBearer API Keyすでに Gemini SDK プロジェクトがあるか、contents、parts、および Gemini のネイティブ コンテンツ構造が必要です

SDK プロトコルを自動的に変換しません

OpenAIのmessagesまたはinput、AnthropicのContent Block、Geminiのcontentsとpartsは、それぞれ異なるデータ構造です。既存のビジネス コードと一致するプロトコル チュートリアルを使用してください。プロトコル間でリファクタリングする必要がある場合は、最初に 公式SDKからの移行 をお読みください。

3つのプロトコルの主な違い

比較項目OpenAI SDKAnthropic SDKGemini SDK
主な入口Chat Completions、ResponsesMessagesGenerate Content
ダイアログ入力messages または inputmessages とContent Blockcontents と parts
通常のテキスト出力チャットメッセージまたは Responses Output Itemcontent Content Blockcandidates[].content.parts
ストリーミング構造チャット デルタまたは response.* イベントMessages SSE イベントStream Generate Content
ツール構造関数ツールと Responses 組み込みツールtool_use、tool_resultfunctionCall、functionResponse

完全なフィールド、列挙値、レスポンス構造は、対応するAPI Referenceを参照してください。各SDKチュートリアルでは、スキーマ全体を繰り返さず、クライアントのインストール、初期化、結果の読み取りに重点を置きます。

接続前の準備

API Keyを作成します

まず、API Keys ページでAGTCloud API Keyを作成し、サーバー環境変数またはキー管理サービスに保存します。

実際の API Keyをブラウザ コード、モバイル インストール パッケージ、パブリック リポジトリ、スクリーンショット、またはログに書き込まないでください。

モデルとプロトコルを確認する

次に、モデルマーケットプレイスで完全なモデルIDをコピーし、使用予定のプロトコルと機能にモデルが対応していることを確認します。

このチャネルは、モデルのプレースホルダーを表すために一律に MODEL_ID を使用します。これは、実際の呼び出しの前に、API Key に現在表示されているモデルID に置き換える必要があります。

サーバー実行環境の選択

Python と TypeScript SDK は両方とも信頼されたサーバー環境で実行する必要があります。現在の安定バージョン SDK をインストールし、プロジェクトの依存関係ロック ファイルを通じて使用されている実際のバージョンを修正します。

推奨する確認順序

  1. SDK をインストールし、アプリケーションが API Keyを読み取れることを確認します。
  2. 設定チュートリアルで指定されている Base URL は、完全なAPIエンドポイントを入力しません。
  3. プレーンテキストと最小限のフィールドを含む非ストリーミングリクエストを送信します。
  4. テキストの結果、終了ステータス、トークンの使用状況を確認します。
  5. 次に、ビジネス ニーズに応じて、ストリーミング、ツール、マルチモーダル、または構造化された出力を検証します。
  6. タイムアウト、スロットル、サーバー側エラーのログ記録と制御された再試行が追加されました。

プロトコルの存在は、モデルがすべての機能をサポートすることを意味するものではありません

同じプロトコルのモデルが異なれば、入力モダリティ、ツール、構造化出力、ストリーミング機能が異なる場合があります。フィールドがサポートされていない場合、またはリクエストでモデルが使用できない場合は、最初にモデル情報と対応する API Referenceを確認してください。

次のステップ

このページの内容