Struct google_api_proto::google::ai::generativelanguage::v1::GenerationConfig

pub struct GenerationConfig {
    pub candidate_count: Option<i32>,
    pub stop_sequences: Vec<String>,
    pub max_output_tokens: Option<i32>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub top_k: Option<i32>,
}

Configuration options for model generation and outputs. Not all parameters may be configurable for every model.

Fields

candidate_count: Option<i32>

Optional. Number of generated responses to return.

Currently, this value can only be set to 1. If unset, this will default to 1.

stop_sequences: Vec<String>

Optional. The set of character sequences (up to 5) that will stop output generation. If specified, the API will stop at the first appearance of a stop sequence. The stop sequence will not be included as part of the response.

max_output_tokens: Option<i32>

Optional. The maximum number of tokens to include in a candidate.

Note: The default value varies by model, see the Model.output_token_limit attribute of the Model returned from the getModel function.

temperature: Option<f32>

Optional. Controls the randomness of the output.

Note: The default value varies by model, see the Model.temperature attribute of the Model returned from the getModel function.

Values can range from [0.0, 2.0].

top_p: Option<f32>

Optional. The maximum cumulative probability of tokens to consider when sampling.

The model uses combined Top-k and nucleus sampling.

Tokens are sorted based on their assigned probabilities so that only the most likely tokens are considered. Top-k sampling directly limits the maximum number of tokens to consider, while Nucleus sampling limits number of tokens based on the cumulative probability.

Note: The default value varies by model, see the Model.top_p attribute of the Model returned from the getModel function.

top_k: Option<i32>

Optional. The maximum number of tokens to consider when sampling.

Models use nucleus sampling or combined Top-k and nucleus sampling. Top-k sampling considers the set of top_k most probable tokens. Models running with nucleus sampling don’t allow top_k setting.

Note: The default value varies by model, see the Model.top_k attribute of the Model returned from the getModel function. Empty top_k field in Model indicates the model doesn’t apply top-k sampling and doesn’t allow setting top_k on requests.

Implementations

impl GenerationConfig

pub fn candidate_count(&self) -> i32

Returns the value of candidate_count, or the default value if candidate_count is unset.

pub fn max_output_tokens(&self) -> i32

Returns the value of max_output_tokens, or the default value if max_output_tokens is unset.

pub fn temperature(&self) -> f32

Returns the value of temperature, or the default value if temperature is unset.

pub fn top_p(&self) -> f32

Returns the value of top_p, or the default value if top_p is unset.

pub fn top_k(&self) -> i32

Returns the value of top_k, or the default value if top_k is unset.

Trait Implementations

impl Clone for GenerationConfig

fn clone(&self) -> GenerationConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GenerationConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GenerationConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for GenerationConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for GenerationConfig

fn eq(&self, other: &GenerationConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GenerationConfig