Table of Contents

Class GenerationConfig

Namespace
Google.GenAI.Types
Assembly
Google.GenAI.dll

Generation config.

public record GenerationConfig : IEquatable<GenerationConfig>
Inheritance
GenerationConfig
Implements
Inherited Members

Properties

AudioTimestamp

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. This field is not supported in Gemini API.

[JsonPropertyName("audioTimestamp")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? AudioTimestamp { get; set; }

Property Value

bool?

CandidateCount

Optional. The number of candidate responses to generate. A higher candidate_count can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.

[JsonPropertyName("candidateCount")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? CandidateCount { get; set; }

Property Value

int?

EnableAffectiveDialog

Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. This field is not supported in Gemini API.

[JsonPropertyName("enableAffectiveDialog")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? EnableAffectiveDialog { get; set; }

Property Value

bool?

EnableEnhancedCivicAnswers

Optional. Enables enhanced civic answers. It may not be available for all models. This field is not supported in Vertex AI.

[JsonPropertyName("enableEnhancedCivicAnswers")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? EnableEnhancedCivicAnswers { get; set; }

Property Value

bool?

FrequencyPenalty

Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].

[JsonPropertyName("frequencyPenalty")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? FrequencyPenalty { get; set; }

Property Value

double?

Logprobs

Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.

[JsonPropertyName("logprobs")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? Logprobs { get; set; }

Property Value

int?

MaxOutputTokens

Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.

[JsonPropertyName("maxOutputTokens")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? MaxOutputTokens { get; set; }

Property Value

int?

MediaResolution

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.

[JsonPropertyName("mediaResolution")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public MediaResolution? MediaResolution { get; set; }

Property Value

MediaResolution?

ModelSelectionConfig

Optional. Config for model selection.

[JsonPropertyName("modelSelectionConfig")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public ModelSelectionConfig? ModelSelectionConfig { get; set; }

Property Value

ModelSelectionConfig

PresencePenalty

Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].

[JsonPropertyName("presencePenalty")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? PresencePenalty { get; set; }

Property Value

double?

ResponseJsonSchema

Output schema of the generated response. This is an alternative to response_schema that accepts JSON Schema (https://json-schema.org/).

[JsonPropertyName("responseJsonSchema")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public object? ResponseJsonSchema { get; set; }

Property Value

object

ResponseLogprobs

Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.

[JsonPropertyName("responseLogprobs")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? ResponseLogprobs { get; set; }

Property Value

bool?

ResponseMimeType

Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined.

[JsonPropertyName("responseMimeType")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? ResponseMimeType { get; set; }

Property Value

string

ResponseModalities

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.

[JsonPropertyName("responseModalities")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public List<Modality>? ResponseModalities { get; set; }

Property Value

List<Modality>

ResponseSchema

Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the OpenAPI 3.0 schema object (https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the response_mime_type to application/json.

[JsonPropertyName("responseSchema")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public Schema? ResponseSchema { get; set; }

Property Value

Schema

RoutingConfig

Optional. Routing configuration. This field is not supported in Gemini API.

[JsonPropertyName("routingConfig")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public GenerationConfigRoutingConfig? RoutingConfig { get; set; }

Property Value

GenerationConfigRoutingConfig

Seed

Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like temperature, which control the level of randomness. seed ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.

[JsonPropertyName("seed")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? Seed { get; set; }

Property Value

int?

SpeechConfig

Optional. The speech generation config.

[JsonPropertyName("speechConfig")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public SpeechConfig? SpeechConfig { get; set; }

Property Value

SpeechConfig

StopSequences

Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.

[JsonPropertyName("stopSequences")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public List<string>? StopSequences { get; set; }

Property Value

List<string>

Temperature

Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].

[JsonPropertyName("temperature")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? Temperature { get; set; }

Property Value

double?

ThinkingConfig

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

[JsonPropertyName("thinkingConfig")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public ThinkingConfig? ThinkingConfig { get; set; }

Property Value

ThinkingConfig

TopK

Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a top_k of 40 means the model will choose the next word from the 40 most likely words.

[JsonPropertyName("topK")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? TopK { get; set; }

Property Value

double?

TopP

Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least top_p. This helps generate more diverse and less repetitive responses. For example, a top_p of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or top_p, but not both.

[JsonPropertyName("topP")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public double? TopP { get; set; }

Property Value

double?

Methods

FromJson(string, JsonSerializerOptions?)

Deserializes a JSON string to a GenerationConfig object.

public static GenerationConfig? FromJson(string jsonString, JsonSerializerOptions? options = null)

Parameters

jsonString string

The JSON string to deserialize.

options JsonSerializerOptions

Optional JsonSerializerOptions.

Returns

GenerationConfig

The deserialized GenerationConfig object, or null if deserialization fails.

Edit this page