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 和细核采样。

核采样考虑的是概率总和至少为 topP 的最小词元集。
topK

integer

可选。采样时要考虑的令牌数量上限。

该模型结合使用了 Top-k 和细核采样。

Top-k 采样考虑的是概率最高的 topK 个词元集。

响应正文

模型的响应。

这包括按时间顺序排列的候选消息和对话历史记录。

如果成功，响应正文将包含结构如下的数据：

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

object (Message)

来自模型的候选响应消息。
messages[]

object (Message)

模型使用的对话历史记录。
filters[]

object (ContentFilter)

提示和回复文本的一组内容过滤元数据。

这表示哪个（些）SafetyCategory 在此响应中屏蔽了候选资格、触发了广告屏蔽的最低 HarmProbability，以及该类别的 HarmThreshold 设置。

授权范围

需要以下 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

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