Method: models.generateMessage

入力された MessagePrompt を基に、モデルからレスポンスを生成します。

HTTP リクエスト

POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateMessage

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

パスパラメータ

パラメータ
model

string

必須。使用するモデルの名前。

形式: name=models/{model}

リクエスト本文

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

JSON 表現 
{
  "prompt": {
    object (MessagePrompt)
  },
  "temperature": number,
  "candidateCount": integer,
  "topP": number,
  "topK": integer
}
フィールド
prompt

object (MessagePrompt)

必須。モデルにプロンプトとして与えられる構造化テキスト入力。

プロンプトが与えられると、モデルはディスカッションの次のメッセージであると予測したものを返します。
temperature

number

（省略可）出力のランダム性を制御します。

値は [0.0,1.0]以上で指定できます。値が 1.0 に近いほど応答にばらつきがあり、0.0 に近いほど、モデルからの予想外のレスポンスが少なくなります。
candidateCount

integer

（省略可）生成して返すレスポンス メッセージの数。

この値は [1, 8] の範囲内で指定してください。未設定のままにした場合は、デフォルトで 1 に設定されます。
topP

number

（省略可）サンプリング時に考慮すべきトークンの最大累積確率。

このモデルでは、トップ K サンプリングと核サンプルの組み合わせを使用します。

核のサンプリングでは、確率の合計が topP 以上である最小のトークンのセットが考慮されます。
topK

integer

（省略可）サンプリング時に考慮するトークンの最大数。

このモデルでは、トップ K サンプリングと核サンプルの組み合わせを使用します。

トップ K サンプリングでは、最も確率が高い topK 個のトークンのセットが考慮されます。

レスポンスの本文

モデルからの回答。

これには、候補のメッセージと会話の履歴が時系列で記載されたものが含まれます。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}
フィールド
candidates[]

object (Message)

モデルからのレスポンス メッセージ候補。
messages[]

object (Message)

モデルが使用する会話履歴。
filters[]

object (ContentFilter)

プロンプトとレスポンスのテキストのコンテンツ フィルタリング メタデータのセット。

これは、このレスポンスから候補をブロックした SafetyCategory、ブロックをトリガーした最小の HarmProbability、そのカテゴリの HarmThreshold 設定を示します。

認可スコープ

次の 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

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