入力メッセージが与えられると、モデルからレスポンスを生成します。
HTTP リクエスト
POST https://generativelanguage.googleapis.com/v1beta/{model=models/*}:generateText
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
model |
必須。補完の生成に使用する |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "prompt": { object ( |
フィールド | |
---|---|
prompt |
必須。プロンプトとしてモデルに与えられる自由形式の入力テキスト。 プロンプトを指定すると、モデルは入力テキストの完成として予測する TextComplete レスポンスを生成します。 |
safetySettings[] |
(省略可)安全でないコンテンツをブロックするための一意の
|
stopSequences[] |
出力の生成を停止する文字シーケンスのセット(最大 5 つ)。指定すると、API は停止シーケンスが最初に出現した時点で停止します。停止シーケンスはレスポンスには含まれません。 |
temperature |
(省略可)出力のランダム性を制御します。注: デフォルト値はモデルによって異なります。 値は [0.0, 1.0] の範囲で指定できます。値が 1.0 に近いほど、より多様性と創造性のある回答が生成されます。0.0 に近いほど、通常はモデルからのわかりやすい回答になります。 |
candidateCount |
(省略可)生成して返すレスポンスの数。 この値は 1 ~ 8 の範囲で指定する必要があります。設定しない場合、デフォルトの 1 になります。 |
maxOutputTokens |
(省略可)候補に含めるトークンの最大数。 未設定の場合、デフォルトで |
topP |
(省略可)サンプリング時に考慮すべきトークンの最大累積確率。 このモデルでは、トップ K サンプリングと核サンプルの組み合わせを使用します。 トークンは割り当てられた確率に基づいて並べ替えられ、最も可能性が高いトークンのみが考慮されます。トップ K サンプリングでは考慮すべきトークンの最大数が直接制限されますが、ニュークリアス サンプリングでは累積確率に基づいてトークンの数が制限されます。 注: デフォルト値はモデルによって異なります。 |
topK |
(省略可)サンプリング時に考慮するトークンの最大数。 このモデルでは、トップ K サンプリングと核サンプルの組み合わせを使用します。 トップ K サンプリングでは、最も確率が高い 注: デフォルト値はモデルによって異なります。 |
レスポンスの本文
成功した場合、レスポンスの本文には GenerateTextResponse
のインスタンスが含まれます。
認可スコープ
次の 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
詳細については、認証の概要をご覧ください。