GenerationConfig

google_genai::datatypes

Struct GenerationConfig

pub struct GenerationConfig {Show 15 fields
    pub audio_timestamp: Option<bool>,
    pub candidate_count: Option<i64>,
    pub frequency_penalty: Option<f64>,
    pub logprobs: Option<i64>,
    pub max_output_tokens: Option<i64>,
    pub presence_penalty: Option<f64>,
    pub response_logprobs: Option<bool>,
    pub response_mime_type: Option<String>,
    pub response_schema: Option<Schema>,
    pub routing_config: Option<GenerationConfigRoutingConfig>,
    pub seed: Option<i64>,
    pub stop_sequences: Option<Vec<String>>,
    pub temperature: Option<f64>,
    pub top_k: Option<f64>,
    pub top_p: Option<f64>,
}

Expand description

Configuration for generation settings.

Fields§

§audio_timestamp: Option<bool>

Optional. If enabled, audio timestamp will be included.

§candidate_count: Option<i64>

Optional. Number of candidates to generate.

§frequency_penalty: Option<f64>

Optional. Frequency penalties.

§logprobs: Option<i64>

Optional. Logit probabilities.

§max_output_tokens: Option<i64>

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

§presence_penalty: Option<f64>

Optional. Positive penalties.

§response_logprobs: Option<bool>

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

§response_mime_type: Option<String>

Optional. Output response MIME type of the generated candidate text.

§response_schema: Option<Schema>

Optional. Schema object allows the definition of input and output data types.

§routing_config: Option<GenerationConfigRoutingConfig>

Optional. Routing configuration.

§seed: Option<i64>

Optional. Seed.

§stop_sequences: Option<Vec<String>>

Optional. Stop sequences.

§temperature: Option<f64>

Optional. Controls the randomness of predictions.

§top_k: Option<f64>

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

§top_p: Option<f64>

Optional. If specified, nucleus sampling will be used.

Implementations§

impl GenerationConfig

pub fn audio_timestamp(self, value: impl Into<bool>) -> Self

Sets the audio_timestamp field of this struct.

pub fn candidate_count(self, value: impl Into<i64>) -> Self

Sets the candidate_count field of this struct.

pub fn frequency_penalty(self, value: impl Into<f64>) -> Self

Sets the frequency_penalty field of this struct.

pub fn logprobs(self, value: impl Into<i64>) -> Self

Sets the logprobs field of this struct.

pub fn max_output_tokens(self, value: impl Into<i64>) -> Self

Sets the max_output_tokens field of this struct.

pub fn presence_penalty(self, value: impl Into<f64>) -> Self

Sets the presence_penalty field of this struct.

pub fn response_logprobs(self, value: impl Into<bool>) -> Self

Sets the response_logprobs field of this struct.

pub fn response_mime_type(self, value: impl Into<String>) -> Self

Sets the response_mime_type field of this struct.

pub fn response_schema(self, value: impl Into<Schema>) -> Self

Sets the response_schema field of this struct.

pub fn routing_config( self, value: impl Into<GenerationConfigRoutingConfig>, ) -> Self

Sets the routing_config field of this struct.

pub fn seed(self, value: impl Into<i64>) -> Self

Sets the seed field of this struct.

pub fn stop_sequences(self, value: impl Into<Vec<String>>) -> Self

Sets the stop_sequences field of this struct.

pub fn temperature(self, value: impl Into<f64>) -> Self

Sets the temperature field of this struct.

pub fn top_k(self, value: impl Into<f64>) -> Self

Sets the top_k field of this struct.

pub fn top_p(self, value: impl Into<f64>) -> Self

Sets the top_p field of this struct.

Trait Implementations§

impl Clone for GenerationConfig

fn clone(&self) -> GenerationConfig

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for GenerationConfig

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

Formats the value using the given formatter. Read more

impl Default for GenerationConfig

fn default() -> GenerationConfig

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for GenerationConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for GenerationConfig

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for GenerationConfig

impl RefUnwindSafe for GenerationConfig

impl Send for GenerationConfig

impl Sync for GenerationConfig

impl Unpin for GenerationConfig

impl UnwindSafe for GenerationConfig

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,