Struct google_api_proto::google::ai::generativelanguage::v1beta::GenerateMessageRequest

pub struct GenerateMessageRequest {
    pub model: String,
    pub prompt: Option<MessagePrompt>,
    pub temperature: Option<f32>,
    pub candidate_count: Option<i32>,
    pub top_p: Option<f32>,
    pub top_k: Option<i32>,
}

Request to generate a message response from the model.

Fields

model: String

Required. The name of the model to use.

Format: name=models/{model}.

prompt: Option<MessagePrompt>

Required. The structured textual input given to the model as a prompt.

Given a prompt, the model will return what it predicts is the next message in the discussion.

temperature: Option<f32>

Optional. 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.

candidate_count: Option<i32>

Optional. The number of generated response messages to return.

This value must be between \[1, 8\], inclusive. If unset, this will default to 1.

top_p: Option<f32>

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

The model uses combined Top-k and nucleus sampling.

Nucleus sampling considers the smallest set of tokens whose probability sum is at least top_p.

top_k: Option<i32>

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

The model uses combined Top-k and nucleus sampling.

Top-k sampling considers the set of top_k most probable tokens.

Implementations

impl GenerateMessageRequest

pub fn temperature(&self) -> f32

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

pub fn candidate_count(&self) -> i32

Returns the value of candidate_count, or the default value if candidate_count 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 GenerateMessageRequest

fn clone(&self) -> GenerateMessageRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateMessageRequest

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

Formats the value using the given formatter.

impl Default for GenerateMessageRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for GenerateMessageRequest

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 GenerateMessageRequest

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