Method: models.generateContent

透過指定輸入 GenerateContentRequest 從模型產生回應。

不同模型的輸入功能不同，包括經過調整的模型。詳情請參閱模型指南和調整指南。

HTTP 要求

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

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

路徑參數

參數
model

string

必要欄位。用於產生完成項目的 Model 名稱。

格式：name=models/{model}。

要求主體

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

JSON 表示法 
{
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string
}
欄位
contents[]

object (Content)

必要欄位。目前與模型對話的內容。

如果是單輪查詢，這只是單一例項。如為多輪查詢，則這指的是包含對話記錄和最新要求的重複欄位。
tools[]

object (Tool)

選用設定。模型可以用來產生下一次回應的 Tools 清單。

Tool 是一段程式碼，可讓系統與外部系統互動，在模型知識和範圍外，執行操作或一組動作。目前唯一支援的工具是 Function。
toolConfig

object (ToolConfig)

選用設定。要求中指定任何 Tool 的工具設定。
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。
systemInstruction

object (Content)

選用設定。開發人員設定系統操作說明。目前僅支援文字。
generationConfig

object (GenerationConfig)

選用設定。模型產生和輸出的設定選項。
cachedContent

string

選用設定。為提供預測而使用的快取內容名稱。注意：僅適用於明確快取，使用者能控制快取內容 (例如要快取的內容)，同時保證能節省成本。格式：cachedContents/{cachedContent}

回應主體

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

詳情請參閱驗證總覽。