GenerationConfig

Generation config.

Fields
stopSequences[] string

Optional. Stop sequences.

responseMimeType string

Optional. Output response mimetype of the generated candidate text. Supported mimetype: - text/plain: (default) Text output. - application/json: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.

responseModalities[] enum (Modality)

Optional. The modalities of the response.

thinkingConfig object (ThinkingConfig)

Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.

modelConfig
(deprecated) object (ModelConfig)

Optional. Config for model selection.

temperature number

Optional. Controls the randomness of predictions.

topP number

Optional. If specified, nucleus sampling will be used.

topK number

Optional. If specified, top-k sampling will be used.

candidateCount integer

Optional. Number of candidates to generate.

maxOutputTokens integer

Optional. The maximum number of output tokens to generate per message.

responseLogprobs boolean

Optional. If true, export the logprobs results in response.

logprobs integer

Optional. Logit probabilities.

presencePenalty number

Optional. Positive penalties.

frequencyPenalty number

Optional. Frequency penalties.

seed integer

Optional. Seed.

responseSchema object (Schema)

Optional. The Schema object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an OpenAPI 3.0 schema object. If set, a compatible responseMimeType must also be set. Compatible mimetypes: application/json: Schema for JSON response.

responseJsonSchema value (Value format)

Optional. Output schema of the generated response. This is an alternative to responseSchema that accepts JSON Schema.

If set, responseSchema must be omitted, but responseMimeType is required.

While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported:

  • $id
  • $defs
  • $ref
  • $anchor
  • type
  • format
  • title
  • description
  • enum (for strings and numbers)
  • items
  • prefixItems
  • minItems
  • maxItems
  • minimum
  • maximum
  • anyOf
  • oneOf (interpreted the same as anyOf)
  • properties
  • additionalProperties
  • required

The non-standard propertyOrdering property may also be set.

Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If $ref is set on a sub-schema, no other properties, except for than those starting as a $, may be set.

routingConfig object (RoutingConfig)

Optional. Routing configuration.

audioTimestamp boolean

Optional. If enabled, audio timestamp will be included in the request to the model.

mediaResolution enum (MediaResolution)

Optional. If specified, the media resolution specified will be used.

speechConfig object (SpeechConfig)

Optional. The speech generation config.

enableAffectiveDialog boolean

Optional. If enabled, the model will detect emotions and adapt its responses accordingly.

imageConfig object (ImageConfig)

Optional. Config for image generation features.

JSON representation 
{
  "stopSequences": [
    string
  ],
  "responseMimeType": string,
  "responseModalities": [
    enum (Modality)
  ],
  "thinkingConfig": {
    object (ThinkingConfig)
  },
  "modelConfig": {
    object (ModelConfig)
  },
  "temperature": number,
  "topP": number,
  "topK": number,
  "candidateCount": integer,
  "maxOutputTokens": integer,
  "responseLogprobs": boolean,
  "logprobs": integer,
  "presencePenalty": number,
  "frequencyPenalty": number,
  "seed": integer,
  "responseSchema": {
    object (Schema)
  },
  "responseJsonSchema": value,
  "routingConfig": {
    object (RoutingConfig)
  },
  "audioTimestamp": boolean,
  "mediaResolution": enum (MediaResolution),
  "speechConfig": {
    object (SpeechConfig)
  },
  "enableAffectiveDialog": boolean,
  "imageConfig": {
    object (ImageConfig)
  }
}

RoutingConfig

The configuration for routing the request to a specific model.

Fields
routing_config Union type
Routing mode. routing_config can be only one of the following:
autoMode object (AutoRoutingMode)

Automated routing.

manualMode object (ManualRoutingMode)

Manual routing.

JSON representation 
{

  // routing_config
  "autoMode": {
    object (AutoRoutingMode)
  },
  "manualMode": {
    object (ManualRoutingMode)
  }
  // Union type
}

AutoRoutingMode

When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.

Fields
modelRoutingPreference enum (ModelRoutingPreference)

The model routing preference.

JSON representation 
{
  "modelRoutingPreference": enum (ModelRoutingPreference)
}

ModelRoutingPreference

The model routing preference.

Enums
UNKNOWN Unspecified model routing preference.
PRIORITIZE_QUALITY Prefer higher quality over low cost.
BALANCED Balanced model routing preference.
PRIORITIZE_COST Prefer lower cost over higher quality.

ManualRoutingMode

When manual routing is set, the specified model will be used directly.

Fields
modelName string

The model name to use. Only the public LLM models are accepted. See Supported models.

JSON representation 
{
  "modelName": string
}

Modality

The modalities of the response.

Enums
MODALITY_UNSPECIFIED Unspecified modality. Will be processed as text.
TEXT Text modality.
IMAGE Image modality.
AUDIO Audio modality.

MediaResolution

Media resolution for the input media.

Enums
MEDIA_RESOLUTION_UNSPECIFIED Media resolution has not been set.
MEDIA_RESOLUTION_LOW Media resolution set to low (64 tokens).
MEDIA_RESOLUTION_MEDIUM Media resolution set to medium (256 tokens).
MEDIA_RESOLUTION_HIGH Media resolution set to high (zoomed reframing with 256 tokens).

SpeechConfig

The speech generation config.

Fields
voiceConfig object (VoiceConfig)

The configuration for the speaker to use.

languageCode string

Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.

multiSpeakerVoiceConfig object (MultiSpeakerVoiceConfig)

The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with voiceConfig.

JSON representation 
{
  "voiceConfig": {
    object (VoiceConfig)
  },
  "languageCode": string,
  "multiSpeakerVoiceConfig": {
    object (MultiSpeakerVoiceConfig)
  }
}

VoiceConfig

The configuration for the voice to use.

Fields
voice_config Union type
The configuration for the speaker to use. voice_config can be only one of the following:
prebuiltVoiceConfig object (PrebuiltVoiceConfig)

The configuration for the prebuilt voice to use.

JSON representation 
{

  // voice_config
  "prebuiltVoiceConfig": {
    object (PrebuiltVoiceConfig)
  }
  // Union type
}

PrebuiltVoiceConfig

The configuration for the prebuilt speaker to use.

Fields
voiceName string

The name of the preset voice to use.

JSON representation 
{
  "voiceName": string
}

MultiSpeakerVoiceConfig

Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.

Fields
speakerVoiceConfigs[] object (SpeakerVoiceConfig)

Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.

JSON representation 
{
  "speakerVoiceConfigs": [
    {
      object (SpeakerVoiceConfig)
    }
  ]
}

SpeakerVoiceConfig

Configuration for a single speaker in a multi speaker setup.

Fields
speaker string

Required. The name of the speaker. This should be the same as the speaker name used in the prompt.

voiceConfig object (VoiceConfig)

Required. The configuration for the voice of this speaker.

JSON representation 
{
  "speaker": string,
  "voiceConfig": {
    object (VoiceConfig)
  }
}

ThinkingConfig

Config for thinking features.

Fields
includeThoughts boolean

Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.

thinkingBudget integer

Optional. Indicates the thinking budget in tokens.

JSON representation 
{
  "includeThoughts": boolean,
  "thinkingBudget": integer
}

ModelConfig

Config for model selection.

Fields
featureSelectionPreference enum (FeatureSelectionPreference)

Required. feature selection preference.

JSON representation 
{
  "featureSelectionPreference": enum (FeatureSelectionPreference)
}

FeatureSelectionPreference

Options for feature selection preference.

Enums
FEATURE_SELECTION_PREFERENCE_UNSPECIFIED Unspecified feature selection preference.
PRIORITIZE_QUALITY Prefer higher quality over lower cost.
BALANCED Balanced feature selection preference.
PRIORITIZE_COST Prefer lower cost over higher quality.

ImageConfig

Config for image generation features.

Fields
imageOutputOptions object (ImageOutputOptions)

Optional. The image output format for generated images.

aspectRatio string

Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported:

"1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"

personGeneration enum (PersonGeneration)

Optional. Controls whether the model can generate people.

JSON representation 
{
  "imageOutputOptions": {
    object (ImageOutputOptions)
  },
  "aspectRatio": string,
  "personGeneration": enum (PersonGeneration)
}

ImageOutputOptions

The image output format for generated images.

Fields
mimeType string

Optional. The image format that the output should be saved as.

compressionQuality integer

Optional. The compression quality of the output image.

JSON representation 
{
  "mimeType": string,
  "compressionQuality": integer
}

PersonGeneration

Enum that controls the generation of people.

Enums
PERSON_GENERATION_UNSPECIFIED Generation images of people unspecified.
ALLOW_ALL Generate images that include adults and children.
ALLOW_ADULT Generate images of adults, but not children.
ALLOW_NONE Block generation of images of people.