ユーザーガイド
API とプレイグラウンドの使用
プレイグラウンドでAIモデルをオンラインでテストおよび体験し、OpenAI互換インターフェースを通じてNew APIを呼び出します。
プレイグラウンド
- プレイグラウンドは、AIモデルをオンラインで簡単にテストおよび体験するために使用されます。ユーザーは質問や指示を入力し、モデルと対話して生成結果を確認できます。
- グループとモデルの選択：入力ボックスの右下で利用可能なモデルグループと具体的なモデルを選択し、今回の対話で使用するモデルを確認します。
- リクエストパラメータの設定：パラメータ設定ボタンをクリックし、必要に応じて温度、Top P、頻度ペナルティ、存在ペナルティ、最大Tokensなどの生成パラメータを有効にして調整します。
- 対話内容の入力：下部の入力ボックスに質問、指示、またはプロンプトを入力します。検索、ファイルのアップロード、写真のアップロード、スクリーンショット、写真撮影機能は現在未実装です。
- リクエストの送信：モデル、パラメータ、入力内容を確認後、「送信」ボタンをクリックしてリクエストを送信します。
- 応答結果の確認：モデルの生成が完了したら、対話エリアで返された内容を確認し、新しい質問を入力して複数回の対話を行うことができます。
APIアドレスと認証
ゲートウェイのOpenAI互換アドレスは通常次のとおりです。
https://your-host/v1APIキーをBearer Tokenとして使用します。
Authorization: Bearer sk-your-api-keyチャット補完の例：
curl https://your-host/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-your-api-key" \
-d '{"model":"gpt-4o-mini","messages":[{"role":"user","content":"你好"}]}'SDKの例
Python（OpenAI SDK）
from openai import OpenAI
client = OpenAI(
api_key="sk-xxxxxxxx",
base_url="https://your-host/v1",
)
response = client.chat.completions.create(
model="gpt-4o-mini",
messages=[{"role": "user", "content": "你好"}],
)
print(response.choices[0].message.content)Claudeネイティブ形式
curl https://your-platform.com/v1/messages \
-H "x-api-key: sk-xxxxxxxx" \
-H "anthropic-version: 2023-06-01" \
-H "content-type: application/json" \
-d '{"model": "claude-3-5-sonnet-20241022", "max_tokens": 1024, "messages": [{"role": "user", "content": "Hello"}]}'Geminiネイティブ形式
curl "https://your-platform.com/v1beta/models/gemini-1.5-pro:generateContent?key=sk-xxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"contents": [{"parts": [{"text": "Hello"}]}]}'サポートされているAPIエンドポイント
| API | パス | 説明 |
|---|---|---|
| チャット補完 | POST /v1/chat/completions | OpenAI Chat Completions互換API。modelとmessagesの提供が必要で、ストリーミングまたは通常の応答をサポートします。 |
| プレイグラウンドチャット | POST /pg/chat/completions | ウェブプレイグラウンド専用API。ログインセッションを使用してグループとモデルを選択し、統一されたトラフィックルーティング、プロトコル変換、課金、再試行のリンクを再利用します。 |
| テキスト補完 | POST /v1/completions | 従来のテキスト補完API。promptとmodelの提供が必要です。 |
| ベクトル埋め込み | POST /v1/embeddings | テキストまたはテキスト配列をベクトルに変換します。inputの提供が必要で、チャネルアダプターによってアップストリーム形式に変換されます。 |
| Gemini埋め込み互換API | POST /v1/engines/{model}/embeddings | 旧バージョンのGeminiスタイルの埋め込みパスと互換性があり、URL内のモデル名に基づいて埋め込みリクエストを処理します。 |
| 画像生成 | POST /v1/images/generations | プロンプトに基づいて画像を生成します。具体的なモデル、サイズ、品質、数量は、リクエストパラメータと設定済みのチャネルによって異なります。 |
| 画像編集 | POST /v1/images/edits | 入力画像とプロンプトに基づいて画像を編集します。JSONおよびmultipart/form-dataリクエストをサポートします。 |
| 旧版編集API | POST /v1/edits | 互換性維持のために残されたパスで、コードは画像リレー処理に入ります。新しいクライアントは/v1/images/editsを優先して使用することをお勧めします。 |
| 音声テキスト変換 | POST /v1/audio/transcriptions | 音声をテキストに変換し、OpenAI音声API形式に従って対応する音声認識チャネルに転送します。 |
| 音声翻訳 | POST /v1/audio/translations | 音声内容を認識し、翻訳されたテキストを出力します。 |
| テキスト音声変換 | POST /v1/audio/speech | 入力テキストを音声に変換します。 |
| リランキング | POST /v1/rerank | queryに基づいて候補documentsの関連性を並べ替えます。クエリ内容とドキュメントリストが空でないことが必要です。 |
| コンテンツモデレーション | POST /v1/moderations | テキストまたはその他の入力に対してコンテンツモデレーションを実行します。モデルが提供されていない場合は、デフォルトのモデレーションモデル候補が使用されます。 |
| Responses API | POST /v1/responses | OpenAI Responses形式のAPI。入力、ツール、応答イベントなどの機能をサポートします。 |
| Responses圧縮 | POST /v1/responses/compact | Responsesリクエストコンテキストに対して圧縮処理を実行します。 |
| Codexウェブ検索 | POST /v1/alpha/search | Codex独立ウェブ検索形式のAPI。現在、この機能をサポートするSub2API、New API、Codex、および高度なカスタムチャネルのみが処理を許可されています。 |
| Claude Messages | POST /v1/messages | Anthropic Claude Messages互換API。modelとメッセージ内容の提供が必要で、必要に応じてNew APIによってアップストリームプロトコルに変換されます。 |
| リアルタイム対話 | GET /v1/realtime（WebSocket） | OpenAI Realtimeスタイルの双方向リアルタイム通信API。モデルは通常クエリパラメータを介して渡され、APIキーはBearer TokenまたはWebSocketサブプロトコルを介して渡すことができます。 |
| Geminiネイティブモデル呼び出し | POST /v1beta/models/{model}:{action} | Geminiネイティブ形式のAPI。generateContent、streamGenerateContent、埋め込み関連操作などのモデル操作パスをサポートします。 |
| Gemini互換モデル呼び出し | POST /v1/models/{model}:{action} | /v1プレフィックスでGeminiスタイルのモデル操作リクエストを受け入れ、Gemini Relayが解析と変換を担当します。 |
| モデルリスト | GET /v1/models | デフォルトではOpenAI形式のモデルリストを返します。Anthropicリクエストヘッダーを使用する場合はClaude形式、x-goog-api-keyまたはkeyクエリパラメータを使用する場合はGemini形式を返します。 |
| モデル詳細 | GET /v1/models/{model} | 単一のモデル情報を照会します。モデルが存在しない場合はmodel_not_foundエラーオブジェクトを返します。 |
| Geminiモデルリスト | GET /v1beta/models | Gemini形式で利用可能なモデルリストを返します。応答フィールドにはmodelsとnextPageTokenが含まれます。 |
| OpenAI形式モデルリスト | GET /v1beta/openai/models | Gemini互換ネームスペースの下で、OpenAI形式でモデルリストを返します。 |
このガイドはいかがですか？
最終更新