Method: models.generateText

根据输入消息从模型生成响应。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
model

string

必需。用于生成完成的 ModelTunedModel 的名称。示例:models/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)

必需。作为提示提供给模型的自由格式输入文本。

在收到提示后,模型将生成它预测为输入文本完成的 TextCompletion 响应。

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_MEDIAL 和 HARM_CATEGORY_DANGEROUS。

stopSequences[]

string

停止生成输出的字符序列集(最多 5 个)。如果指定,API 将在第一次出现停止序列时停止。停止序列不会包含在回复中。

temperature

number

可选。控制输出的随机性。注意:默认值因模型而异,请参阅返回 getModel 函数的 ModelModel.temperature 属性。

值的范围为 [0.0,1.0](含 [0.0,1.0])。接近 1.0 的值将产生更加多样化和更具创造性的回答,而接近 0.0 的值通常会使模型给出的回答更直接。

candidateCount

integer

可选。要返回的已生成响应数。

此值必须介于 [1, 8] 之间(含 [1, 8])。如果未设置,则默认为 1。

maxOutputTokens

integer

可选。候选令牌中可包含的令牌数量上限。

如果未设置,则默认为 Model 规范中指定的 outputTokenLimit。

topP

number

可选。采样时要考虑的词元的最大累积概率。

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

系统会根据词元为其分配的概率对词元进行排序,因此只考虑最可能的词元。Top-k 采样会直接限制要考虑的最大令牌数,而 Nucleus 采样会根据累计概率限制令牌数量。

注意:默认值因模型而异,请参阅返回 getModel 函数的 ModelModel.top_p 属性。

topK

integer

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

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

Top-k 采样考虑的是概率最高的 topK 个词元集。默认值为 40。

注意:默认值因模型而异,请参阅返回 getModel 函数的 ModelModel.top_k 属性。

响应正文

如果成功,则响应正文包含一个 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

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