Struct google_api_proto::google::ai::generativelanguage::v1beta3::Model

pub struct Model {
    pub name: String,
    pub base_model_id: String,
    pub version: String,
    pub display_name: String,
    pub description: String,
    pub input_token_limit: i32,
    pub output_token_limit: i32,
    pub supported_generation_methods: Vec<String>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub top_k: Option<i32>,
}

Information about a Generative Language Model.

Fields

name: String

Required. The resource name of the Model.

Format: models/{model} with a {model} naming convention of:

• “{base_model_id}-{version}”

Examples:

• models/chat-bison-001

base_model_id: String

Required. The name of the base model, pass this to the generation request.

Examples:

• chat-bison

version: String

Required. The version number of the model.

This represents the major version

display_name: String

The human-readable name of the model. E.g. “Chat Bison”.

The name can be up to 128 characters long and can consist of any UTF-8 characters.

description: String

A short description of the model.

input_token_limit: i32

Maximum number of input tokens allowed for this model.

output_token_limit: i32

Maximum number of output tokens available for this model.

supported_generation_methods: Vec<String>

The model’s supported generation methods.

The method names are defined as Pascal case strings, such as generateMessage which correspond to API methods.

temperature: Option<f32>

Controls the randomness of the output.

Values can range over \[0.0,1.0\], inclusive. A value closer to 1.0 will produce responses that are more varied, while a value closer to 0.0 will typically result in less surprising responses from the model. This value specifies default to be used by the backend while making the call to the model.

top_p: Option<f32>

For Nucleus sampling.

Nucleus sampling considers the smallest set of tokens whose probability sum is at least top_p. This value specifies default to be used by the backend while making the call to the model.

top_k: Option<i32>

For Top-k sampling.

Top-k sampling considers the set of top_k most probable tokens. This value specifies default to be used by the backend while making the call to the model.

Implementations

impl Model

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 Model

fn clone(&self) -> Model

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Model

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

Formats the value using the given formatter.

impl Default for Model

fn default() -> Self

Returns the “default value” for a type.

impl Message for Model

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for Model

fn eq(&self, other: &Model) -> 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 Model