Gemini API 支持使用图片、音频、代码、工具等生成内容。如需详细了解这些功能,请继续阅读并查看以任务为中心的示例代码,或阅读全面的指南。
方法:models.generateContent
根据输入 GenerateContentRequest
生成模型回答。如需了解详细的使用信息,请参阅文本生成指南。输入功能因型号而异,包括调谐模型。如需了解详情,请参阅模型指南和调优指南。
端点
帖子https: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:generateContent
路径参数
model
string
必需。用于生成补全的 Model
的名称。
格式:models/{model}
。其格式为 models/{model}
。
请求正文
请求正文中包含结构如下的数据:
toolConfig
object (ToolConfig
)
可选。请求中指定的任何 Tool
的工具配置。如需查看使用示例,请参阅函数调用指南。
safetySettings[]
object (SafetySetting
)
可选。用于屏蔽不安全内容的唯一 SafetySetting
实例的列表。
此限制将在 GenerateContentRequest.contents
和 GenerateContentResponse.candidates
上强制执行。每种 SafetyCategory
类型不应有多个设置。API 会屏蔽任何不符合这些设置所设阈值的内容和响应。此列表会替换 safetySettings 中指定的每个 SafetyCategory
的默认设置。如果列表中未提供给定 SafetyCategory
的 SafetySetting
,API 将使用相应类别的默认安全设置。支持的危害类别包括 HARM_CATEGORY_HATE_SPEECH、HARM_CATEGORY_SEXUALLY_EXPLICIT、HARM_CATEGORY_DANGEROUS_CONTENT、HARM_CATEGORY_HARASSMENT、HARM_CATEGORY_CIVIC_INTEGRITY。如需详细了解可用的安全设置,请参阅指南。您还可以参阅安全指南,了解如何在 AI 应用中纳入安全注意事项。
generationConfig
object (GenerationConfig
)
可选。模型生成和输出的配置选项。
cachedContent
string
可选。用作提供预测的上下文的缓存内容的名称。格式:cachedContents/{cachedContent}
示例请求
文本
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
图片
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
音频
Python
Node.js
Go
Shell
视频
Python
Node.js
Go
Shell
Python
Go
Shell
聊天
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
缓存
Python
Node.js
Go
经调整的模型
Python
JSON 模式
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
代码执行
Python
Go
Kotlin
Java
函数调用
Python
Go
Node.js
Shell
Kotlin
Swift
Dart
Java
生成配置
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
安全设置
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
系统指令
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
响应正文
如果成功,则响应正文包含一个 GenerateContentResponse
实例。
方法:models.streamGenerateContent
根据输入 GenerateContentRequest
生成来自模型的流式传输回答。
端点
帖子https: / /generativelanguage.googleapis.com /v1beta /{model=models /*}:streamGenerateContent
路径参数
model
string
必需。用于生成补全的 Model
的名称。
格式:models/{model}
。其格式为 models/{model}
。
请求正文
请求正文中包含结构如下的数据:
toolConfig
object (ToolConfig
)
可选。请求中指定的任何 Tool
的工具配置。如需查看使用示例,请参阅函数调用指南。
safetySettings[]
object (SafetySetting
)
可选。用于屏蔽不安全内容的唯一 SafetySetting
实例的列表。
此限制将在 GenerateContentRequest.contents
和 GenerateContentResponse.candidates
上强制执行。每种 SafetyCategory
类型不应有多个设置。API 会屏蔽任何不符合这些设置所设阈值的内容和响应。此列表会替换 safetySettings 中指定的每个 SafetyCategory
的默认设置。如果列表中未提供给定 SafetyCategory
的 SafetySetting
,API 将使用相应类别的默认安全设置。支持的危害类别包括 HARM_CATEGORY_HATE_SPEECH、HARM_CATEGORY_SEXUALLY_EXPLICIT、HARM_CATEGORY_DANGEROUS_CONTENT、HARM_CATEGORY_HARASSMENT、HARM_CATEGORY_CIVIC_INTEGRITY。如需详细了解可用的安全设置,请参阅指南。您还可以参阅安全指南,了解如何在 AI 应用中纳入安全注意事项。
generationConfig
object (GenerationConfig
)
可选。模型生成和输出的配置选项。
cachedContent
string
可选。用作提供预测的上下文的缓存内容的名称。格式:cachedContents/{cachedContent}
示例请求
文本
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
图片
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
音频
Python
Go
Shell
视频
Python
Node.js
Go
Shell
Python
Go
Shell
聊天
Python
Node.js
Go
Shell
Kotlin
Swift
Dart
Java
响应正文
如果成功,响应正文将包含一个 GenerateContentResponse
实例流。
GenerateContentResponse
支持多个候选回答的模型的回答。
系统会在 GenerateContentResponse.prompt_feedback
中报告提示的安全等级和内容过滤情况,并在 finishReason
和 safetyRatings
中报告每个候选答案的安全等级和内容过滤情况。该 API: - 要么返回所有请求的候选内容,要么不返回任何候选内容 - 仅当提示存在问题时(请检查 promptFeedback
),才不返回任何候选内容 - 在 finishReason
和 safetyRatings
中报告有关每个候选内容的反馈。
candidates[]
object (Candidate
)
模型给出的候选回答。
promptFeedback
object (PromptFeedback
)
返回与内容过滤器相关的提示反馈。
usageMetadata
object (UsageMetadata
)
仅限输出。有关生成请求的令牌使用情况的元数据。
modelVersion
string
仅限输出。用于生成回答的模型版本。
responseId
string
仅输出。responseId 用于标识每个响应。
JSON 表示法 |
---|
{ "candidates": [ { object ( |
PromptFeedback
提示在 GenerateContentRequest.content
中指定的一组反馈元数据。
blockReason
enum (BlockReason
)
可选。如果设置了此值,则提示被屏蔽,并且不返回任何候选结果。改述提示。
safetyRatings[]
object (SafetyRating
)
提示的安全评级。每个类别最多只能有一个分级。
JSON 表示法 |
---|
{ "blockReason": enum ( |
BlockReason
指定屏蔽提示的原因。
枚举 | |
---|---|
BLOCK_REASON_UNSPECIFIED |
默认值。此值未使用。 |
SAFETY |
出于安全原因,系统屏蔽了相应提示。检查 safetyRatings 以了解是哪个安全类别屏蔽了它。 |
OTHER |
提示因未知原因被屏蔽。 |
BLOCKLIST |
提示因包含术语屏蔽名单中的术语而被屏蔽。 |
PROHIBITED_CONTENT |
提示因包含禁止的内容而被屏蔽。 |
IMAGE_SAFETY |
因生成不安全的图片内容而屏蔽了候选回答。 |
UsageMetadata
生成请求的令牌使用情况的相关元数据。
promptTokenCount
integer
提示中的 token 数量。设置 cachedContent
后,这仍然是有效提示的总大小,这意味着它包含缓存内容中的词元数。
cachedContentTokenCount
integer
提示的缓存部分(缓存的内容)中的 token 数量
candidatesTokenCount
integer
所有生成的回答候选对象的词元总数。
toolUsePromptTokenCount
integer
仅限输出。工具使用提示中的 token 数量。
thoughtsTokenCount
integer
仅限输出。思考模型的思考 token 数。
totalTokenCount
integer
生成请求(提示 + 候选响应)的总令牌数。
promptTokensDetails[]
object (ModalityTokenCount
)
仅限输出。请求输入中处理的模态列表。
cacheTokensDetails[]
object (ModalityTokenCount
)
仅限输出。请求输入中缓存内容的模态列表。
candidatesTokensDetails[]
object (ModalityTokenCount
)
仅限输出。响应中返回的模态列表。
toolUsePromptTokensDetails[]
object (ModalityTokenCount
)
仅限输出。为工具使用请求输入处理的模态列表。
JSON 表示法 |
---|
{ "promptTokenCount": integer, "cachedContentTokenCount": integer, "candidatesTokenCount": integer, "toolUsePromptTokenCount": integer, "thoughtsTokenCount": integer, "totalTokenCount": integer, "promptTokensDetails": [ { object ( |
候选人
- JSON 表示法
- FinishReason
- GroundingAttribution
- AttributionSourceId
- GroundingPassageId
- SemanticRetrieverChunk
- GroundingMetadata
- SearchEntryPoint
- GroundingChunk
- Web
- GroundingSupport
- 细分
- RetrievalMetadata
- LogprobsResult
- TopCandidates
- 候选版本
- UrlContextMetadata
- UrlMetadata
- UrlRetrievalStatus
模型生成的回答候选对象。
content
object (Content
)
仅限输出。模型返回的生成内容。
finishReason
enum (FinishReason
)
可选。仅限输出。模型停止生成词元的原因。
如果为空,则模型尚未停止生成令牌。
safetyRatings[]
object (SafetyRating
)
候选回答的安全评分列表。
每个类别最多只能有一个分级。
citationMetadata
object (CitationMetadata
)
仅限输出。模型生成的候选回答的引用信息。
此字段可能会填充 content
中包含的任何文本的朗读信息。这些段落是从基础 LLM 的训练数据中的受版权保护的内容“背诵”出来的。
tokenCount
integer
仅限输出。相应候选对象的令牌数量。
groundingAttributions[]
object (GroundingAttribution
)
仅限输出。为有依据的答案做出贡献的来源的提供方信息。
系统会针对 GenerateAnswer
调用填充此字段。
groundingMetadata
object (GroundingMetadata
)
仅限输出。候选对象的 grounding 元数据。
系统会针对 GenerateContent
调用填充此字段。
avgLogprobs
number
仅限输出。候选者的平均对数概率得分。
logprobsResult
object (LogprobsResult
)
仅限输出。回答 token 和热门 token 的对数似然得分
urlContextMetadata
object (UrlContextMetadata
)
仅限输出。与网址上下文检索工具相关的元数据。
index
integer
仅限输出。响应候选列表中的候选索引。
JSON 表示法 |
---|
{ "content": { object ( |
FinishReason
定义模型停止生成令牌的原因。
枚举 | |
---|---|
FINISH_REASON_UNSPECIFIED |
默认值。此值未使用。 |
STOP |
模型的自然停止点或提供的停止序列。 |
MAX_TOKENS |
已达到请求中指定的 token 数量上限。 |
SAFETY |
出于安全原因,回答候选内容被标记。 |
RECITATION |
回答候选内容因背诵原因而被标记。 |
LANGUAGE |
系统标记了候选回答内容,原因是其使用了不受支持的语言。 |
OTHER |
原因未知。 |
BLOCKLIST |
由于内容包含禁用词,因此 token 生成操作已停止。 |
PROHIBITED_CONTENT |
由于可能包含禁止的内容,因此 token 生成操作已停止。 |
SPII |
由于内容可能包含敏感的个人身份信息 (SPII),因此 token 生成操作已停止。 |
MALFORMED_FUNCTION_CALL |
模型生成的函数调用无效。 |
IMAGE_SAFETY |
由于生成的图片包含违规内容,因此 token 生成已停止。 |
UNEXPECTED_TOOL_CALL |
模型生成了工具调用,但请求中未启用任何工具。 |
GroundingAttribution
对促成回答的来源的提供方信息。
sourceId
object (AttributionSourceId
)
仅限输出。促成相应归因的来源的标识符。
content
object (Content
)
构成此提供方信息的依据来源内容。
JSON 表示法 |
---|
{ "sourceId": { object ( |
AttributionSourceId
促成相应归因的来源的标识符。
source
Union type
source
只能是下列其中一项:groundingPassage
object (GroundingPassageId
)
内嵌段落的标识符。
semanticRetrieverChunk
object (SemanticRetrieverChunk
)
通过语义检索器提取的 Chunk
的标识符。
JSON 表示法 |
---|
{ // source "groundingPassage": { object ( |
GroundingPassageId
GroundingPassage
中某个部分的标识符。
passageId
string
仅限输出。与 GenerateAnswerRequest
的 GroundingPassage.id
匹配的段落的 ID。
partIndex
integer
仅限输出。GenerateAnswerRequest
的 GroundingPassage.content
中相应部分的索引。
JSON 表示法 |
---|
{ "passageId": string, "partIndex": integer } |
SemanticRetrieverChunk
通过 SemanticRetrieverConfig
使用 GenerateAnswerRequest
中指定的语义检索器检索到的 Chunk
的标识符。
source
string
仅限输出。与请求的 SemanticRetrieverConfig.source
匹配的来源的名称。示例:corpora/123
或 corpora/123/documents/abc
chunk
string
仅限输出。包含归因文本的 Chunk
的名称。示例:corpora/123/documents/abc/chunks/xyz
JSON 表示法 |
---|
{ "source": string, "chunk": string } |
GroundingMetadata
启用 grounding 后返回给客户端的元数据。
groundingChunks[]
object (GroundingChunk
)
从指定的事实依据来源检索到的佐证参考资料列表。
groundingSupports[]
object (GroundingSupport
)
支持的接地列表。
webSearchQueries[]
string
后续网页搜索的网页搜索查询。
searchEntryPoint
object (SearchEntryPoint
)
可选。Google 搜索条目,用于后续的网页搜索。
retrievalMetadata
object (RetrievalMetadata
)
与接地流程中的检索相关的元数据。
JSON 表示法 |
---|
{ "groundingChunks": [ { object ( |
SearchEntryPoint
Google 搜索入口点。
renderedContent
string
可选。可嵌入网页或应用 WebView 中的 Web 内容代码段。
sdkBlob
string (bytes format)
可选。以 Base64 编码的 JSON,表示 <搜索字词、搜索网址> 元组的数组。
使用 base64 编码的字符串。
JSON 表示法 |
---|
{ "renderedContent": string, "sdkBlob": string } |
GroundingChunk
接地块。
JSON 表示法 |
---|
{
// chunk_type
"web": {
object ( |
Web
来自网络的块。
uri
string
块的 URI 引用。
title
string
块的标题。
JSON 表示法 |
---|
{ "uri": string, "title": string } |
GroundingSupport
接地支持。
groundingChunkIndices[]
integer
一个索引(指向“grounding_chunk”)列表,用于指定与声明关联的引用。例如,[1,3,4] 表示 grounding_chunk[1]、grounding_chunk[3]、grounding_chunk[4] 是归因于相应声明的检索到的内容。
confidenceScores[]
number
支持参考的置信度分数。范围为 0 到 1。1 表示最有信心。此列表的大小必须与 groundingChunkIndices 相同。
segment
object (Segment
)
相应支持所涉及的内容片段。
JSON 表示法 |
---|
{
"groundingChunkIndices": [
integer
],
"confidenceScores": [
number
],
"segment": {
object ( |
Segment
内容片段。
partIndex
integer
仅限输出。Part 对象在其父 Content 对象中的索引。
startIndex
integer
仅限输出。指定 Part 中的起始索引(以字节为单位)。从 Part 开始处的偏移量(含),从零开始。
endIndex
integer
仅限输出。指定 Part 中的结束索引(以字节为单位)。从相应部分的开头开始的偏移量(不含边界值),从零开始。
text
string
仅限输出。响应中与相应片段对应的文本。
JSON 表示法 |
---|
{ "partIndex": integer, "startIndex": integer, "endIndex": integer, "text": string } |
RetrievalMetadata
与接地流程中的检索相关的元数据。
googleSearchDynamicRetrievalScore
number
可选。一个分数,用于指示 Google 搜索中的信息可能有助于回答提示的程度。得分介于 [0, 1] 范围内,其中 0 表示可能性最低,1 表示可能性最高。仅当启用 Google 搜索接地和动态检索时,系统才会填充此得分。系统会将该值与阈值进行比较,以确定是否触发 Google 搜索。
JSON 表示法 |
---|
{ "googleSearchDynamicRetrievalScore": number } |
LogprobsResult
Logprobs 结果
topCandidates[]
object (TopCandidates
)
长度 = 解码步总数。
chosenCandidates[]
object (Candidate
)
长度 = 解码步总数。所选候选词元可能位于 topCandidates 中,也可能不在其中。
JSON 表示法 |
---|
{ "topCandidates": [ { object ( |
TopCandidates
每个解码步骤中具有最高对数概率的候选对象。
candidates[]
object (Candidate
)
按对数概率降序排序。
JSON 表示法 |
---|
{
"candidates": [
{
object ( |
候选人
logprobs 令牌和得分的候选对象。
token
string
候选人的令牌字符串值。
tokenId
integer
候选人的令牌 ID 值。
logProbability
number
候选词元的对数概率。
JSON 表示法 |
---|
{ "token": string, "tokenId": integer, "logProbability": number } |
UrlContextMetadata
与网址上下文检索工具相关的元数据。
urlMetadata[]
object (UrlMetadata
)
网址上下文列表。
JSON 表示法 |
---|
{
"urlMetadata": [
{
object ( |
UrlMetadata
单个网址检索的上下文。
retrievedUrl
string
由工具检索到的网址。
urlRetrievalStatus
enum (UrlRetrievalStatus
)
网址检索的状态。
JSON 表示法 |
---|
{
"retrievedUrl": string,
"urlRetrievalStatus": enum ( |
UrlRetrievalStatus
网址检索的状态。
枚举 | |
---|---|
URL_RETRIEVAL_STATUS_UNSPECIFIED |
默认值。此值未使用。 |
URL_RETRIEVAL_STATUS_SUCCESS |
网址检索成功。 |
URL_RETRIEVAL_STATUS_ERROR |
由于出错,网址检索失败。 |
CitationMetadata
一段内容的一组来源提供方信息。
citationSources[]
object (CitationSource
)
特定回答的来源引用。
JSON 表示法 |
---|
{
"citationSources": [
{
object ( |
CitationSource
对特定回答的部分内容所引用来源的引用。
startIndex
integer
可选。归因于相应来源的回答部分的起始位置。
索引表示分段的起始位置(以字节为单位)。
endIndex
integer
可选。归因细分的结束时间(不含)。
uri
string
可选。被归因于部分文本的来源的 URI。
license
string
可选。被归因于细分的 GitHub 项目的许可。
代码引用必须包含许可信息。
JSON 表示法 |
---|
{ "startIndex": integer, "endIndex": integer, "uri": string, "license": string } |
GenerationConfig
- JSON 表示法
- 模态
- SpeechConfig
- VoiceConfig
- PrebuiltVoiceConfig
- MultiSpeakerVoiceConfig
- SpeakerVoiceConfig
- ThinkingConfig
- MediaResolution
模型生成和输出的配置选项。并非所有模型的参数都可以配置。
stopSequences[]
string
可选。将停止输出生成的字符序列集(最多 5 个)。如果指定了此参数,API 将在首次出现 stop_sequence
时停止。停止序列不会包含在回答中。
responseMimeType
string
可选。生成的候选文本的 MIME 类型。支持的 MIME 类型包括:text/plain
:(默认)文本输出。application/json
:响应候选项中的 JSON 响应。text/x.enum
:响应候选项中以字符串形式表示的 ENUM。如需查看所有受支持的文本 MIME 类型的列表,请参阅文档。
responseSchema
object (Schema
)
可选。生成的候选文本的输出架构。架构必须是 OpenAPI 架构的子集,并且可以是对象、基元或数组。
如果设置了此字段,还必须设置兼容的 responseMimeType
。兼容的 MIME 类型:application/json
:JSON 响应的架构。如需了解详情,请参阅 JSON 文本生成指南。
responseJsonSchema
value (Value
format)
可选。生成的回答的输出架构。这是 responseSchema
的替代方案,可接受 JSON 架构。
如果设置了此参数,则必须省略 responseSchema
,但必须设置 responseMimeType
。
虽然可以发送完整的 JSON 架构,但并非所有功能都受支持。具体来说,仅支持以下属性:
$id
$defs
$ref
$anchor
type
format
title
description
enum
(适用于字符串和数字)items
prefixItems
minItems
maxItems
minimum
maximum
anyOf
oneOf
(与anyOf
的解读方式相同)properties
additionalProperties
required
还可以设置非标准 propertyOrdering
属性。
循环引用会展开到一定程度,因此只能在非必需属性中使用。(可为 null 的属性不足。)如果子架构中设置了 $ref
,则除了以 $
开头的属性之外,不得设置任何其他属性。
responseModalities[]
enum (Modality
)
可选。响应的请求模态。表示模型可以返回并在响应中应预期的模态集合。这与回答的模态完全匹配。
一个模型可能支持多种模态组合。如果所请求的模态与任何受支持的组合都不匹配,则会返回错误。
空列表相当于仅请求文本。
candidateCount
integer
可选。要返回的生成响应数量。如果未设置,则默认为 1。请注意,此功能不适用于上一代模型(Gemini 1.0 系列)
maxOutputTokens
integer
可选。候选回答中包含的 token 数量上限。
注意:默认值因模型而异,请参阅 getModel
函数返回的 Model
的 Model.output_token_limit
属性。
temperature
number
可选。控制输出的随机性。
注意:默认值因模型而异,请参阅 getModel
函数返回的 Model
的 Model.temperature
属性。
值可介于 [0.0, 2.0] 之间。
topP
number
可选。抽样时要考虑的 token 的最大累积概率。
该模型使用组合的 Top-k 和 Top-p(核心)抽样。
系统会根据词元的分配概率对其进行排序,以便仅考虑最有可能的词元。Top-k 抽样直接限制要考虑的 token 的数量上限,而 Nucleus 抽样则根据累积概率限制 token 的数量。
注意:默认值因 Model
而异,由 getModel
函数返回的 Model.top_p
属性指定。如果 topK
属性为空,则表示模型不应用 top-k 抽样,并且不允许在请求中设置 topK
。
topK
integer
可选。抽样时要考虑的令牌数量上限。
Gemini 模型使用 Top-p(核)抽样或 Top-k 与核抽样的组合。Top-k 抽样会考虑 topK
个最可能的 token。采用核采样的模型不允许设置 topK。
注意:默认值因 Model
而异,由 getModel
函数返回的 Model.top_p
属性指定。如果 topK
属性为空,则表示模型不应用 top-k 抽样,并且不允许在请求中设置 topK
。
seed
integer
可选。解码中使用的种子。如果未设置,请求会使用随机生成的种子。
presencePenalty
number
可选。如果下一个令牌已在响应中出现,则应用于该令牌的 logprobs 的存在惩罚。
此惩罚是二元(开启/关闭)的,不取决于令牌的使用次数(首次使用后)。使用 frequencyPenalty
表示每次使用都会增加的惩罚。
正值惩罚会阻止使用已在回答中使用的令牌,从而增加词汇量。
负惩罚会鼓励使用已在回答中使用的令牌,从而减少词汇量。
frequencyPenalty
number
可选。应用于下一个词元的对数概率的频次惩罚,乘以每个词元在目前为止的回答中出现的次数。
正惩罚会抑制对已使用过的 token 的使用,抑制程度与 token 的使用次数成正比:token 的使用次数越多,模型就越难再次使用该 token,从而增加回答的词汇量。
注意:负惩罚会促使模型重复使用 token,重复使用的次数与 token 的使用次数成正比。较小的负值会减少回答的词汇量。负值越大,模型开始重复常见令牌的次数就越多,直到达到 maxOutputTokens
限制。
responseLogprobs
boolean
可选。如果为 true,则在响应中导出 logprobs 结果。
logprobs
integer
可选。仅在 responseLogprobs=True
时有效。此参数用于设置在 Candidate.logprobs_result
的每个解码步骤中返回的对数概率最高的候选词元数量。
enableEnhancedCivicAnswers
boolean
可选。启用增强型公民问题解答。此功能可能不适用于所有型号。
speechConfig
object (SpeechConfig
)
可选。语音生成配置。
thinkingConfig
object (ThinkingConfig
)
可选。思考功能的配置。如果为不支持思考的模型设置此字段,系统将返回错误。
mediaResolution
enum (MediaResolution
)
可选。如果指定,则使用指定的媒体分辨率。
JSON 表示法 |
---|
{ "stopSequences": [ string ], "responseMimeType": string, "responseSchema": { object ( |
模态
支持的响应模态。
枚举 | |
---|---|
MODALITY_UNSPECIFIED |
默认值。 |
TEXT |
表示模型应返回文本。 |
IMAGE |
表示模型应返回图片。 |
AUDIO |
表示模型应返回音频。 |
SpeechConfig
语音生成配置。
voiceConfig
object (VoiceConfig
)
单语音输出时的配置。
multiSpeakerVoiceConfig
object (MultiSpeakerVoiceConfig
)
可选。多音箱设置的配置。它与 voiceConfig 字段互斥。
languageCode
string
可选。用于语音合成的语言代码(采用 BCP 47 格式,例如“en-US”)。
有效值包括:de-DE、en-AU、en-GB、en-IN、en-US、es-US、fr-FR、hi-IN、pt-BR、ar-XA、es-ES、fr-CA、id-ID、it-IT、ja-JP、tr-TR、vi-VN、bn-IN、gu-IN、kn-IN、ml-IN、mr-IN、ta-IN、te-IN、nl-NL、ko-KR、cmn-CN、pl-PL、ru-RU 和 th-TH。
JSON 表示法 |
---|
{ "voiceConfig": { object ( |
VoiceConfig
要使用的语音的配置。
voice_config
Union type
voice_config
只能是下列其中一项:prebuiltVoiceConfig
object (PrebuiltVoiceConfig
)
要使用的预构建语音的配置。
JSON 表示法 |
---|
{
// voice_config
"prebuiltVoiceConfig": {
object ( |
PrebuiltVoiceConfig
预构建扬声器的配置。
voiceName
string
要使用的预设语音的名称。
JSON 表示法 |
---|
{ "voiceName": string } |
MultiSpeakerVoiceConfig
多音箱设置的配置。
speakerVoiceConfigs[]
object (SpeakerVoiceConfig
)
必需。所有已启用的音箱语音。
JSON 表示法 |
---|
{
"speakerVoiceConfigs": [
{
object ( |
SpeakerVoiceConfig
多音箱设置中单个音箱的配置。
speaker
string
必需。要使用的扬声器的名称。应与提示中的内容相同。
voiceConfig
object (VoiceConfig
)
必需。要使用的语音的配置。
JSON 表示法 |
---|
{
"speaker": string,
"voiceConfig": {
object ( |
ThinkingConfig
思考功能的配置。
includeThoughts
boolean
指示是否在回答中包含想法。如果为 true,则仅在有想法时返回想法。
thinkingBudget
integer
模型应生成的想法 token 数。
JSON 表示法 |
---|
{ "includeThoughts": boolean, "thinkingBudget": integer } |
MediaResolution
输入媒体的媒体分辨率。
枚举 | |
---|---|
MEDIA_RESOLUTION_UNSPECIFIED |
尚未设置媒体分辨率。 |
MEDIA_RESOLUTION_LOW |
媒体分辨率设置为低 (64 个令牌)。 |
MEDIA_RESOLUTION_MEDIUM |
媒体分辨率设置为中等(256 个令牌)。 |
MEDIA_RESOLUTION_HIGH |
媒体分辨率设置为高(使用 256 个令牌进行缩放重构)。 |
HarmCategory
评分的类别。
这些类别涵盖了开发者可能希望调整的各种危害。
枚举 | |
---|---|
HARM_CATEGORY_UNSPECIFIED |
未指定类别。 |
HARM_CATEGORY_DEROGATORY |
PaLM - 针对身份和/或受保护属性的负面或有害评论。 |
HARM_CATEGORY_TOXICITY |
PaLM - 粗鲁、无礼或亵渎性的内容。 |
HARM_CATEGORY_VIOLENCE |
PaLM - 描述描绘针对个人或团体的暴力行为的场景,或一般性血腥描述。 |
HARM_CATEGORY_SEXUAL |
PaLM - 包含对性行为或其他淫秽内容的引用。 |
HARM_CATEGORY_MEDICAL |
PaLM - 宣传未经核实的医疗建议。 |
HARM_CATEGORY_DANGEROUS |
PaLM - 宣扬、助长或鼓励有害行为的危险内容。 |
HARM_CATEGORY_HARASSMENT |
Gemini - 骚扰内容。 |
HARM_CATEGORY_HATE_SPEECH |
Gemini - 仇恨言论和内容。 |
HARM_CATEGORY_SEXUALLY_EXPLICIT |
Gemini - 露骨色情内容。 |
HARM_CATEGORY_DANGEROUS_CONTENT |
Gemini - 危险内容。 |
HARM_CATEGORY_CIVIC_INTEGRITY |
Gemini - 可能被用于损害公民诚信的内容。 |
ModalityTokenCount
表示单个模态的令牌计数信息。
modality
enum (Modality
)
与此令牌数量关联的模态。
tokenCount
integer
词元数量。
JSON 表示法 |
---|
{
"modality": enum ( |
模态
内容部分的模态
枚举 | |
---|---|
MODALITY_UNSPECIFIED |
未指定模态。 |
TEXT |
纯文本。 |
IMAGE |
图片。 |
VIDEO |
视频。 |
AUDIO |
音频。 |
DOCUMENT |
文档,例如 PDF。 |
SafetyRating
内容的安全分级。
安全评级包含内容的危害类别以及该类别中的危害概率级别。内容会根据多个危害类别进行安全分类,并在此处显示危害分类的概率。
category
enum (HarmCategory
)
必需。相应评分的类别。
probability
enum (HarmProbability
)
必需。相应内容的有害概率。
blocked
boolean
此内容是否因该分级而被屏蔽?
JSON 表示法 |
---|
{ "category": enum ( |
HarmProbability
内容有害的概率。
分类系统会给出内容不安全的概率。这并不表示内容造成的伤害程度。
枚举 | |
---|---|
HARM_PROBABILITY_UNSPECIFIED |
概率未指定。 |
NEGLIGIBLE |
内容不安全的概率可忽略不计。 |
LOW |
内容不安全的概率较低。 |
MEDIUM |
内容不安全的可能性为中等。 |
HIGH |
内容不安全的概率较高。 |
SafetySetting
安全设置,会影响安全屏蔽行为。
为某个类别传递安全设置会更改允许的内容屏蔽概率。
category
enum (HarmCategory
)
必需。相应设置的类别。
threshold
enum (HarmBlockThreshold
)
必需。控制屏蔽有害内容的概率阈值。
JSON 表示法 |
---|
{ "category": enum ( |
HarmBlockThreshold
在达到或超过指定有害概率时进行屏蔽。
枚举 | |
---|---|
HARM_BLOCK_THRESHOLD_UNSPECIFIED |
未指定阈值。 |
BLOCK_LOW_AND_ABOVE |
内容中包含“微量”的酒精饮料将获准投放广告。 |
BLOCK_MEDIUM_AND_ABOVE |
系统会允许发布风险为“可忽略”和“低”的内容。 |
BLOCK_ONLY_HIGH |
风险等级为“可忽略”“低”和“中”的内容将允许发布。 |
BLOCK_NONE |
允许所有内容。 |
OFF |
关闭安全过滤条件。 |