Method: models.generateText

根據輸入訊息,從模型產生回應。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
model

string

必要欄位。用於產生完成項目的 ModelTunedModel 名稱。範例:model/text-bison-001tuneModels/sentence-translator-u3b7m

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "prompt": {
    object (TextPrompt)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "stopSequences": [
    string
  ],
  "temperature": number,
  "candidateCount": integer,
  "maxOutputTokens": integer,
  "topP": number,
  "topK": integer
}
欄位
prompt

object (TextPrompt)

必要欄位。提供給模型提示的任意形式輸入文字。

每當出現提示,模型就會產生文字完成回應,預測該回應是否完整。

safetySettings[]

object (SafetySetting)

選用設定。用於封鎖不安全內容的不重複 SafetySetting 例項清單。

將在 GenerateTextRequest.promptGenerateTextResponse.candidates 上強制執行。每種 SafetyCategory 類型只能有一項設定。凡是未達到這些設定門檻的提示和回應,API 都會遭到封鎖。這份清單會覆寫 safetySettings 中指定的每個 SafetyCategory 預設設定。如果清單中指定的 SafetyCategory 沒有 SafetySetting,API 就會使用該類別的預設安全設定。文字服務支援有害類別 HARM_CATEGORY_DEROGATORY、HARM_CATEGORY_TOXICITY、HARM_CATEGORY_VIOLENCE、HARM_CATEGORY_SEXUAL、HARM_CATEGORY_MEDICAL、HARM_CATEGORY_DANGEROUS。

stopSequences[]

string

停止產生輸出的字元序列組合 (最多 5 個)。如果指定此值,API 會在停靠序列的首次出現時停止。停止序列不會包含在回應中。

temperature

number

選用設定。控制輸出內容的隨機性。注意:預設值因模型而異,請查看 ModelModel.temperature 屬性傳回 getModel 函式。

值的範圍為 [0.0,1.0] (含頭尾)。如果值較接近 1.0,產生的回應不但豐富多元,也更有創意;如果值趨近於 0.0,則模型的回應通常會較為簡單。

candidateCount

integer

選用設定。要傳回的回應數量。

這個值必須介於 [1, 8] (含頭尾)。如未設定,則預設值為 1。

maxOutputTokens

integer

選用設定。要納入候選項目的數量上限。

如未設定,會預設為 Model 規格中指定的 outputTokenLimit。

topP

number

選用設定。取樣時要列入計算的最大符記累積機率。

這個模型使用「Top-K」和「nucleus」取樣。

系統會依據指派的可能性來排序符記,因此只會考慮最有可能的符記。「Top-K」取樣會直接限制要納入考量的符記數量上限,而 Nucleus 取樣會根據累積機率限制符記數量。

注意:預設值因模型而異,請查看 ModelModel.top_p 屬性傳回 getModel 函式。

topK

integer

選用設定。取樣時要考量的權杖數量上限。

這個模型使用「Top-K」和「nucleus」取樣。

「前 K 個」取樣作業會考量 topK 個機率最高的符記組合。預設值為 40。

注意:預設值因模型而異,請查看 ModelModel.top_k 屬性傳回 getModel 函式。

回應主體

如果成功,回應主體會包含 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

詳情請參閱驗證總覽