GenerateContentResponse

支持多个候选项的模型的响应。

关于安全分级和内容过滤的注意事项。系统会针对 GenerateContentResponse.prompt_feedback 中的提示以及 finishReason 和 safetyRatings 中的每个候选字符报告它们。API 协定：- 要么返回所有请求的候选项，要么完全不返回任何候选项 - 仅当提示出现问题时不返回任何候选项（请参阅 promptFeedback）- 有关每个候选者的反馈会在 finishReason 和 safetyRatings 中报告。

JSON 表示法 
{
  "candidates": [
    {
      object (Candidate)
    }
  ],
  "promptFeedback": {
    object (PromptFeedback)
  },
  "usageMetadata": {
    object (UsageMetadata)
  }
}
字段
candidates[]

object (Candidate)

来自模型的候选响应。
promptFeedback

object (PromptFeedback)

返回与内容过滤器相关的提示反馈。
usageMetadata

object (UsageMetadata)

仅限输出。有关生成请求令牌使用情况的元数据。

候选人

由模型生成的候选回答。

JSON 表示法 
{
  "content": {
    object (Content)
  },
  "finishReason": enum (FinishReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "citationMetadata": {
    object (CitationMetadata)
  },
  "tokenCount": integer,
  "index": integer
}
字段
content

object (Content)

仅限输出。从模型返回的生成内容。
finishReason

enum (FinishReason)

可选。仅限输出。模型停止生成词元的原因。

如果为空，则表示模型尚未停止生成令牌。
safetyRatings[]

object (SafetyRating)

候选回答的安全性评分列表。

每个类别最多只能有一个评分。
citationMetadata

object (CitationMetadata)

仅限输出。模型生成的候选字词的引用信息。

此字段可能会填入content中包含的任何文本的朗诵信息。这些内容是从 LLM 基础训练数据中受版权保护的材料中“背书”的段落。
tokenCount

integer

仅限输出。此候选定位设置的令牌数量。
index

integer

仅限输出。候选字词列表中候选字词的索引。

FinishReason

定义模型停止生成令牌的原因。

枚举
FINISH_REASON_UNSPECIFIED 默认值。此值未使用。
STOP 模型的自然停止点或提供的停止序列。
MAX_TOKENS 已达到请求中指定的令牌数量上限。
SAFETY 出于安全考虑，系统举报了候选人的内容。
RECITATION 候选人的内容因背书原因被举报。
OTHER 原因未知。

SafetyRating

一段内容的安全评级。

安全评级包含一段内容的伤害类别以及该类别中的伤害概率等级。内容已划分为若干个伤害类别的安全分类，而伤害分类的概率也包含在内。

JSON 表示法 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "blocked": boolean
}
字段
category

enum (HarmCategory)

必需。相应评分的类别。
probability

enum (HarmProbability)

必需。相应内容造成危害的概率。
blocked

boolean

此内容是否因为此分级而被禁播？

HarmProbability

一段内容有害的概率。

分类系统会给出内容不安全的可能性。但这并不代表某项内容受到损害的严重程度。

枚举
HARM_PROBABILITY_UNSPECIFIED 未指定概率。
NEGLIGIBLE 内容不安全的可能性微乎其微。
LOW 内容不安全的可能性较低。
MEDIUM 内容不安全的可能性为中等。
HIGH 内容很有可能不安全。

CitationMetadata

一组内容的来源提供方说明。

JSON 表示法 
{
  "citationSources": [
    {
      object (CitationSource)
    }
  ]
}
字段
citationSources[]

object (CitationSource)

特定回复对来源的引用。

CitationSource

对特定回复中某一部分内容的引用。

JSON 表示法 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "license": string
}
字段
startIndex

integer

可选。归因于此来源的响应细分的开始部分。

索引表示片段的开头（以字节为单位）。
endIndex

integer

可选。归因细分受众群的结束位置（不含边界值）。
uri

string

可选。归因于部分文本的来源的 URI。
license

string

可选。归因于细分来源的 GitHub 项目许可。

必须提供许可信息才能引用代码。

PromptFeedback

GenerateContentRequest.content 中指定的提示的一组反馈元数据。

JSON 表示法 
{
  "blockReason": enum (BlockReason),
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ]
}
字段
blockReason

enum (BlockReason)

可选。如果设置了此字段，则提示会被屏蔽，并且不会返回任何候选项。改述提示。
safetyRatings[]

object (SafetyRating)

提示的安全性评分。每个类别最多只能有一个评分。

BlockReason

指定提示被屏蔽的原因。

枚举
BLOCK_REASON_UNSPECIFIED 默认值。此值未使用。
SAFETY 由于安全原因，提示已被屏蔽。您可以检查 safetyRatings，了解哪个安全类别将其屏蔽。
OTHER 由于未知原因，提示已被屏蔽。

UsageMetadata

关于生成请求令牌使用情况的元数据。

JSON 表示法 
{
  "promptTokenCount": integer,
  "candidatesTokenCount": integer,
  "totalTokenCount": integer
}
字段
promptTokenCount

integer

提示中的令牌数量。
candidatesTokenCount

integer

所生成的候选词元的总数。
totalTokenCount

integer

生成请求（提示 + 候选项）的令牌总数。