Struct google_api_proto::google::ai::generativelanguage::v1::Candidate

pub struct Candidate {
    pub index: Option<i32>,
    pub content: Option<Content>,
    pub finish_reason: i32,
    pub safety_ratings: Vec<SafetyRating>,
    pub citation_metadata: Option<CitationMetadata>,
    pub token_count: i32,
}

A response candidate generated from the model.

Fields

index: Option<i32>

Output only. Index of the candidate in the list of response candidates.

content: Option<Content>

Output only. Generated content returned from the model.

finish_reason: i32

Optional. Output only. The reason why the model stopped generating tokens.

If empty, the model has not stopped generating tokens.

safety_ratings: Vec<SafetyRating>

List of ratings for the safety of a response candidate.

There is at most one rating per category.

citation_metadata: Option<CitationMetadata>

Output only. Citation information for model-generated candidate.

This field may be populated with recitation information for any text included in the content. These are passages that are “recited” from copyrighted material in the foundational LLM’s training data.

token_count: i32

Output only. Token count for this candidate.

Implementations

impl Candidate

pub fn finish_reason(&self) -> FinishReason

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

pub fn set_finish_reason(&mut self, value: FinishReason)

Sets finish_reason to the provided enum value.

pub fn index(&self) -> i32

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

Trait Implementations

impl Clone for Candidate

fn clone(&self) -> Candidate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Candidate

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

Formats the value using the given formatter.

impl Default for Candidate

fn default() -> Self

Returns the “default value” for a type.

impl Message for Candidate

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 Candidate

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