Method: models.generateMessage

根據輸入 MessagePrompt 從模型產生回應。

HTTP 要求

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

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

路徑參數

參數
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

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

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

Nucleus 取樣會將機率總和至少達 topP 的最小符記納入考量。
topK

integer

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

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

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

回應主體

模型的回應。

包括以時間順序排序的候選訊息和對話記錄。

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "candidates": [
    {
      object (Message)
    }
  ],
  "messages": [
    {
      object (Message)
    }
  ],
  "filters": [
    {
      object (ContentFilter)
    }
  ]
}
欄位
candidates[]

object (Message)

模型的候選回應訊息。
messages[]

object (Message)

模型使用的對話記錄。
filters[]

object (ContentFilter)

一組提示和回應文字的內容篩選中繼資料。

這會指出有哪些 SafetyCategory 封鎖了候選回覆的候選人、觸發封鎖條件的最低 HarmProbability，以及該類別的「損害程度」設定。

授權範圍

需要下列其中一種 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

詳情請參閱驗證總覽。