GenerateContentResponse

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

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

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

object (Candidate)

来自模型的候选响应。
promptFeedback

object (PromptFeedback)

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

候选人

模型生成的候选回答。

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 由于未知原因，提示已被屏蔽。