Struct google_api_proto::google::ai::generativelanguage::v1beta3::TunedModel

pub struct TunedModel {
    pub name: String,
    pub display_name: String,
    pub description: String,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub top_k: Option<i32>,
    pub state: i32,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub tuning_task: Option<TuningTask>,
    pub source_model: Option<SourceModel>,
}

A fine-tuned model created using ModelService.CreateTunedModel.

Fields

name: String

Output only. The tuned model name. A unique name will be generated on create. Example: tunedModels/az2mb0bpw6i If display_name is set on create, the id portion of the name will be set by concatenating the words of the display_name with hyphens and adding a random portion for uniqueness. Example: display_name = “Sentence Translator” name = “tunedModels/sentence-translator-u3b7m”

display_name: String

Optional. The name to display for this model in user interfaces. The display name must be up to 40 characters including spaces.

description: String

Optional. A short description of this model.

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.

This value specifies default to be the one used by the base model while creating the model.

top_p: Option<f32>

Optional. 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 the one used by the base model while creating the model.

top_k: Option<i32>

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

This value specifies default to be the one used by the base model while creating the model.

state: i32

Output only. The state of the tuned model.

create_time: Option<Timestamp>

Output only. The timestamp when this model was created.

update_time: Option<Timestamp>

Output only. The timestamp when this model was updated.

tuning_task: Option<TuningTask>

Required. The tuning task that creates the tuned model.

source_model: Option<SourceModel>

The model used as the starting point for tuning.

Implementations

impl TunedModel

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

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 TunedModel

fn clone(&self) -> TunedModel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TunedModel

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

Formats the value using the given formatter.

impl Default for TunedModel

fn default() -> Self

Returns the “default value” for a type.

impl Message for TunedModel

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 TunedModel

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