Vertex AI v1beta1 API - Class GenerationConfig (1.0.0-beta61) 

public sealed class GenerationConfig : IMessage<GenerationConfig>, IEquatable<GenerationConfig>, IDeepCloneable<GenerationConfig>, IBufferMessage, IMessage

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

Generation config.

Inheritance

object > GenerationConfig

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

GenerationConfig()

public GenerationConfig()

GenerationConfig(GenerationConfig)

public GenerationConfig(GenerationConfig other)
Parameter
Name Description
other GenerationConfig

Properties

AudioTimestamp

public bool AudioTimestamp { get; set; }

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

Property Value
Type Description
bool

CandidateCount

public int CandidateCount { get; set; }

Optional. Number of candidates to generate.

Property Value
Type Description
int

FrequencyPenalty

public float FrequencyPenalty { get; set; }

Optional. Frequency penalties.

Property Value
Type Description
float

HasAudioTimestamp

public bool HasAudioTimestamp { get; }

Gets whether the "audio_timestamp" field is set

Property Value
Type Description
bool

HasCandidateCount

public bool HasCandidateCount { get; }

Gets whether the "candidate_count" field is set

Property Value
Type Description
bool

HasFrequencyPenalty

public bool HasFrequencyPenalty { get; }

Gets whether the "frequency_penalty" field is set

Property Value
Type Description
bool

HasLogprobs

public bool HasLogprobs { get; }

Gets whether the "logprobs" field is set

Property Value
Type Description
bool

HasMaxOutputTokens

public bool HasMaxOutputTokens { get; }

Gets whether the "max_output_tokens" field is set

Property Value
Type Description
bool

HasMediaResolution

public bool HasMediaResolution { get; }

Gets whether the "media_resolution" field is set

Property Value
Type Description
bool

HasPresencePenalty

public bool HasPresencePenalty { get; }

Gets whether the "presence_penalty" field is set

Property Value
Type Description
bool

HasResponseLogprobs

public bool HasResponseLogprobs { get; }

Gets whether the "response_logprobs" field is set

Property Value
Type Description
bool

HasSeed

public bool HasSeed { get; }

Gets whether the "seed" field is set

Property Value
Type Description
bool

HasTemperature

public bool HasTemperature { get; }

Gets whether the "temperature" field is set

Property Value
Type Description
bool

HasTopK

public bool HasTopK { get; }

Gets whether the "top_k" field is set

Property Value
Type Description
bool

HasTopP

public bool HasTopP { get; }

Gets whether the "top_p" field is set

Property Value
Type Description
bool

ImageConfig

public ImageConfig ImageConfig { get; set; }

Optional. Config for image generation features.

Property Value
Type Description
ImageConfig

Logprobs

public int Logprobs { get; set; }

Optional. Logit probabilities.

Property Value
Type Description
int

MaxOutputTokens

public int MaxOutputTokens { get; set; }

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

Property Value
Type Description
int

MediaResolution

public GenerationConfig.Types.MediaResolution MediaResolution { get; set; }

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

Property Value
Type Description
GenerationConfigTypesMediaResolution

ModelConfig

public GenerationConfig.Types.ModelConfig ModelConfig { get; set; }

Optional. Config for model selection.

Property Value
Type Description
GenerationConfigTypesModelConfig

PresencePenalty

public float PresencePenalty { get; set; }

Optional. Positive penalties.

Property Value
Type Description
float

ResponseJsonSchema

public Value ResponseJsonSchema { get; set; }

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.

Property Value
Type Description
Value

ResponseLogprobs

public bool ResponseLogprobs { get; set; }

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

Property Value
Type Description
bool

ResponseMimeType

public string ResponseMimeType { get; set; }

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.
Property Value
Type Description
string

ResponseModalities

public RepeatedField<GenerationConfig.Types.Modality> ResponseModalities { get; }

Optional. The modalities of the response.

Property Value
Type Description
RepeatedFieldGenerationConfigTypesModality

ResponseSchema

public OpenApiSchema ResponseSchema { get; set; }

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.

Property Value
Type Description
OpenApiSchema

RoutingConfig

public GenerationConfig.Types.RoutingConfig RoutingConfig { get; set; }

Optional. Routing configuration.

Property Value
Type Description
GenerationConfigTypesRoutingConfig

Seed

public int Seed { get; set; }

Optional. Seed.

Property Value
Type Description
int

SpeechConfig

public SpeechConfig SpeechConfig { get; set; }

Optional. The speech generation config.

Property Value
Type Description
SpeechConfig

StopSequences

public RepeatedField<string> StopSequences { get; }

Optional. Stop sequences.

Property Value
Type Description
RepeatedFieldstring

Temperature

public float Temperature { get; set; }

Optional. Controls the randomness of predictions.

Property Value
Type Description
float

ThinkingConfig

public GenerationConfig.Types.ThinkingConfig ThinkingConfig { get; set; }

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

Property Value
Type Description
GenerationConfigTypesThinkingConfig

TopK

public float TopK { get; set; }

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

Property Value
Type Description
float

TopP

public float TopP { get; set; }

Optional. If specified, nucleus sampling will be used.

Property Value
Type Description
float