Class GenerationConfig (1.122.0)

Version latest

• 1.122.0 (latest)
• 1.121.0
• 1.120.0
• 1.119.0
• 1.118.0
• 1.117.0
• 1.95.1
• 1.94.0
• 1.93.1
• 1.92.0
• 1.91.0
• 1.90.0
• 1.89.0
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.0
• 1.75.0
• 1.74.0
• 1.73.0
• 1.72.0
• 1.71.1
• 1.70.0
• 1.69.0
• 1.68.0
• 1.67.1
• 1.66.0
• 1.65.0
• 1.63.0
• 1.62.0
• 1.60.0
• 1.59.0

GenerationConfig(
    *,
    temperature: typing.Optional[float] = None,
    top_p: typing.Optional[float] = None,
    top_k: typing.Optional[int] = None,
    candidate_count: typing.Optional[int] = None,
    max_output_tokens: typing.Optional[int] = None,
    stop_sequences: typing.Optional[typing.List[str]] = None,
    presence_penalty: typing.Optional[float] = None,
    frequency_penalty: typing.Optional[float] = None,
    response_mime_type: typing.Optional[str] = None,
    response_schema: typing.Optional[typing.Dict[str, typing.Any]] = None,
    seed: typing.Optional[int] = None,
    audio_timestamp: typing.Optional[bool] = None,
    routing_config: typing.Optional[RoutingConfig] = None,
    logprobs: typing.Optional[int] = None,
    response_logprobs: typing.Optional[bool] = None,
    response_modalities: typing.Optional[typing.List[GenerationConfig.Modality]] = None,
    model_config: typing.Optional[GenerationConfig.ModelConfig] = None
)

Parameters for the generation.

Classes

Modality

Modality(value)

The modalities of the response.

ModelConfig

ModelConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Config for model selection.

RoutingConfig

RoutingConfig(
    *,
    routing_config: typing.Union[
        vertexai.generative_models._generative_models.GenerationConfig.RoutingConfig.AutoRoutingMode,
        vertexai.generative_models._generative_models.GenerationConfig.RoutingConfig.ManualRoutingMode,
    ]
)

The configuration for model router requests. Deprecated, please use ModelConfig to set routing preference instead.

The routing config is either one of the two nested classes:

• AutoRoutingMode: Automated routing.
• ManualRoutingMode: Manual routing.

Usage:

• AutoRoutingMode:

  routing_config=generative_models.RoutingConfig(
      routing_config=generative_models.RoutingConfig.AutoRoutingMode(
          model_routing_preference=generative_models.RoutingConfig.AutoRoutingMode.ModelRoutingPreference.BALANCED,
      ),
  )
  

• ManualRoutingMode:

  routing_config=generative_models.RoutingConfig(
      routing_config=generative_models.RoutingConfig.ManutalRoutingMode(
          model_name="gemini-1.5-pro-001",
      ),
  )
  

Methods

GenerationConfig

GenerationConfig(
    *,
    temperature: typing.Optional[float] = None,
    top_p: typing.Optional[float] = None,
    top_k: typing.Optional[int] = None,
    candidate_count: typing.Optional[int] = None,
    max_output_tokens: typing.Optional[int] = None,
    stop_sequences: typing.Optional[typing.List[str]] = None,
    presence_penalty: typing.Optional[float] = None,
    frequency_penalty: typing.Optional[float] = None,
    response_mime_type: typing.Optional[str] = None,
    response_schema: typing.Optional[typing.Dict[str, typing.Any]] = None,
    seed: typing.Optional[int] = None,
    audio_timestamp: typing.Optional[bool] = None,
    routing_config: typing.Optional[RoutingConfig] = None,
    logprobs: typing.Optional[int] = None,
    response_logprobs: typing.Optional[bool] = None,
    response_modalities: typing.Optional[typing.List[GenerationConfig.Modality]] = None,
    model_config: typing.Optional[GenerationConfig.ModelConfig] = None
)

Constructs a GenerationConfig object.