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.contentsGenerateContentResponse.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

如需了解详情,请参阅身份验证概览