Method: models.streamGenerateContent

入力 GenerateContentRequest が与えられると、モデルからストリーミングされたレスポンスを生成します。

HTTP リクエスト

POST https://generativelanguage.googleapis.com/v1/{model=models/*}:streamGenerateContent

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
model

string

必須。補完の生成に使用する Model の名前。

形式: name=models/{model}

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "contents": [
    {
      object (Content)
    }
  ],
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "generationConfig": {
    object (GenerationConfig)
  }
}
フィールド
contents[]

object (Content)

必須。モデルとの現在の会話の内容。

シングルターン クエリの場合、これは単一のインスタンスです。マルチターン クエリの場合、これは会話履歴と最新のリクエストを含む繰り返しフィールドです。
safetySettings[]

object (SafetySetting)

（省略可）安全でないコンテンツをブロックするための一意の SafetySetting インスタンスのリスト。

これは GenerateContentRequest.contents と GenerateContentResponse.candidates に適用されます。SafetyCategory のタイプごとに複数の設定を指定することはできません。API は、これらの設定で設定されたしきい値を満たさないコンテンツやレスポンスをブロックします。このリストは、safetySettings で指定された各 SafetyCategory のデフォルト設定をオーバーライドします。リストで指定された特定の SafetyCategory に SafetySetting がない場合、API はそのカテゴリのデフォルトの安全性設定を使用します。有害カテゴリ HARM_CATEGORY_HATE_SPEECH、HARM_CATEGORY_SEXUALLY_EXPLICIT、HARM_CATEGORY_DANGEROUS_CONTENT、HARM_CATEGORY_HARASSMENT がサポートされています。
generationConfig

object (GenerationConfig)

（省略可）モデルの生成と出力の構成オプション。

レスポンスの本文

成功した場合、レスポンスの本文には GenerateContentResponse インスタンスのストリームが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/generative-language
  • https://www.googleapis.com/auth/generative-language.tuning
  • https://www.googleapis.com/auth/generative-language.tuning.readonly
  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

詳細については、認証の概要をご覧ください。