機能の概要
このAPIは、Google Vertex AIと互換性のあるストリーミングコンテンツ生成機能を提供します。AIが生成するコンテンツ（テキストやコードなど）をリアルタイムで継続的に取得する必要があるシナリオに適しています。このAPIを呼び出すと、生成されたコンテンツの断片を継続的に返すストリーミング応答が開始されます。
呼び出しの説明
API制約
- 呼び出し元はAPIキーを保有している必要があります。詳細については、AI APIキーの管理を参照してください。
リクエストパス
POST {BASE_URL}/api/vertex-ai/v1/publishers/{provider}/models/{model}:streamGenerateContent
注意：同じプロセッサは /api/v1 および /api/vertex-ai/v1beta パスにもマウントされており、/models/{provider}/{model}:streamGenerateContent エイリアスをサポートしています。
リクエストヘッダー
プロパティ |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
リクエストパラメータ
Pathパラメータ
プロパティ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| provider | string | はい | モデルの公開者 | |
| model | string | はい | gemini-pro | モデル名 |
Bodyパラメータ
プロパティ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| model | string | はい | gemini-pro | 使用するモデルを指定します。 |
| contents | array[object] | いいえ | [{"role": "user", "parts": [{"text": "Hello"}]}] | 対話内容のリスト |
| instances | array[object] | いいえ | [] | インスタンスのリスト |
| parameters | object | いいえ | {"temperature": 0.7} | 生成パラメータ |
| voice | object | いいえ | {} | 音声パラメータ |
実行結果
戻り値パラメータ
プロパティ |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうかを示します。 |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | ビジネスデータを返します。 |
dataフィールドの説明
プロパティ |
型 |
説明 |
|---|---|---|
| id | string | リソースの一意なID |
| name | string | リソース名 |
| status | string | リソースのステータス |
| createTime | string | 作成日時 |
リクエスト例
curl --request POST '{BASE_URL}/api/vertex-ai/v1/publishers/google/models/gemini-pro:streamGenerateContent' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"model": "gemini-pro",
"contents": [
{
"role": "user",
"parts": [
{
"text": "人工知能について紹介してください。"
}
]
}
],
"parameters": {
"temperature": 0.7,
"maxOutputTokens": 256
}
}'
戻り値の例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "gen-123456",
"name": "stream-generation-task",
"status": "STREAMING",
"createTime": "2026-04-10T10:00:00Z"
}
}