Vertex AI v1 API - Class GenerationConfig (3.63.0)

Reference documentation and code samples for the Vertex AI v1 API class GenerationConfig.

Generation config.

Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.

Optional. Number of candidates to generate.

Optional. Frequency penalties.

Gets whether the "audio_timestamp" field is set

Gets whether the "candidate_count" field is set

Gets whether the "frequency_penalty" field is set

Gets whether the "logprobs" field is set

Gets whether the "max_output_tokens" field is set

Gets whether the "media_resolution" field is set

Gets whether the "presence_penalty" field is set

Gets whether the "response_logprobs" field is set

Gets whether the "seed" field is set

Gets whether the "temperature" field is set

Gets whether the "top_k" field is set

Gets whether the "top_p" field is set

Optional. Config for image generation features.

Optional. Logit probabilities.

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

Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.

Optional. Positive penalties.

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

If set, response_schema must be omitted, but response_mime_type 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.

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

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.

Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to [TEXT, IMAGE], the response will include both text and an image.

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 response_mime_type must also be set. Compatible mimetypes: application/json: Schema for JSON response.

Optional. Routing configuration.

Optional. Seed.

Optional. The speech generation config.

Optional. Stop sequences.

Optional. Controls the randomness of predictions.

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

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

Optional. If specified, nucleus sampling will be used.