Struct GenerationSpec 

#[non_exhaustive]
pub struct GenerationSpec {
    pub model_id: String,
    pub language_code: String,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub top_k: Option<i32>,
    pub frequency_penalty: Option<f32>,
    pub seed: Option<i32>,
    pub presence_penalty: Option<f32>,
    pub max_output_tokens: Option<i32>,
    /* private fields */
}

Available on crate feature grounded-generation-service only.

Content generation specification.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

model_id: String

Specifies which Vertex model id to use for generation.

language_code: String

Language code for content. Use language tags defined by BCP47.

temperature: Option<f32>

If specified, custom value for the temperature will be used.

top_p: Option<f32>

If specified, custom value for nucleus sampling will be used.

top_k: Option<i32>

If specified, custom value for top-k sampling will be used.

frequency_penalty: Option<f32>

If specified, custom value for frequency penalty will be used.

seed: Option<i32>

If specified, custom value for the seed will be used.

presence_penalty: Option<f32>

If specified, custom value for presence penalty will be used.

max_output_tokens: Option<i32>

If specified, custom value for max output tokens will be used.

Implementations

impl GenerationSpec

pub fn new() -> Self

pub fn set_model_id<T: Into<String>>(self, v: T) -> Self

Sets the value of model_id.

Example

let x = GenerationSpec::new().set_model_id("example");

pub fn set_language_code<T: Into<String>>(self, v: T) -> Self

Sets the value of language_code.

Example

let x = GenerationSpec::new().set_language_code("example");

pub fn set_temperature<T>(self, v: T) -> Self

where T: Into<f32>,

Sets the value of temperature.

Example

let x = GenerationSpec::new().set_temperature(42.0);

pub fn set_or_clear_temperature<T>(self, v: Option<T>) -> Self

where T: Into<f32>,

Sets or clears the value of temperature.

Example

let x = GenerationSpec::new().set_or_clear_temperature(Some(42.0));
let x = GenerationSpec::new().set_or_clear_temperature(None::<f32>);

pub fn set_top_p<T>(self, v: T) -> Self

where T: Into<f32>,

Sets the value of top_p.

Example

let x = GenerationSpec::new().set_top_p(42.0);

pub fn set_or_clear_top_p<T>(self, v: Option<T>) -> Self

where T: Into<f32>,

Sets or clears the value of top_p.

Example

let x = GenerationSpec::new().set_or_clear_top_p(Some(42.0));
let x = GenerationSpec::new().set_or_clear_top_p(None::<f32>);

pub fn set_top_k<T>(self, v: T) -> Self

where T: Into<i32>,

Sets the value of top_k.

Example

let x = GenerationSpec::new().set_top_k(42);

pub fn set_or_clear_top_k<T>(self, v: Option<T>) -> Self

where T: Into<i32>,

Sets or clears the value of top_k.

Example

let x = GenerationSpec::new().set_or_clear_top_k(Some(42));
let x = GenerationSpec::new().set_or_clear_top_k(None::<i32>);

pub fn set_frequency_penalty<T>(self, v: T) -> Self

where T: Into<f32>,

Sets the value of frequency_penalty.

Example

let x = GenerationSpec::new().set_frequency_penalty(42.0);

pub fn set_or_clear_frequency_penalty<T>(self, v: Option<T>) -> Self

where T: Into<f32>,

Sets or clears the value of frequency_penalty.

Example

let x = GenerationSpec::new().set_or_clear_frequency_penalty(Some(42.0));
let x = GenerationSpec::new().set_or_clear_frequency_penalty(None::<f32>);

pub fn set_seed<T>(self, v: T) -> Self

where T: Into<i32>,

Sets the value of seed.

Example

let x = GenerationSpec::new().set_seed(42);

pub fn set_or_clear_seed<T>(self, v: Option<T>) -> Self

where T: Into<i32>,

Sets or clears the value of seed.

Example

let x = GenerationSpec::new().set_or_clear_seed(Some(42));
let x = GenerationSpec::new().set_or_clear_seed(None::<i32>);

pub fn set_presence_penalty<T>(self, v: T) -> Self

where T: Into<f32>,

Sets the value of presence_penalty.

Example

let x = GenerationSpec::new().set_presence_penalty(42.0);

pub fn set_or_clear_presence_penalty<T>(self, v: Option<T>) -> Self

where T: Into<f32>,

Sets or clears the value of presence_penalty.

Example

let x = GenerationSpec::new().set_or_clear_presence_penalty(Some(42.0));
let x = GenerationSpec::new().set_or_clear_presence_penalty(None::<f32>);

pub fn set_max_output_tokens<T>(self, v: T) -> Self

where T: Into<i32>,

Sets the value of max_output_tokens.

Example

let x = GenerationSpec::new().set_max_output_tokens(42);

pub fn set_or_clear_max_output_tokens<T>(self, v: Option<T>) -> Self

where T: Into<i32>,

Sets or clears the value of max_output_tokens.

Example

let x = GenerationSpec::new().set_or_clear_max_output_tokens(Some(42));
let x = GenerationSpec::new().set_or_clear_max_output_tokens(None::<i32>);

Trait Implementations

impl Clone for GenerationSpec

fn clone(&self) -> GenerationSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerationSpec

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

Formats the value using the given formatter.

impl Default for GenerationSpec

fn default() -> GenerationSpec

Returns the “default value” for a type.

impl Message for GenerationSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for GenerationSpec

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for GenerationSpec