Struct GenerateContentResponse

pub struct GenerateContentResponse {
    pub candidates: Vec<Candidate>,
    pub prompt_feedback: Option<PromptFeedback>,
    pub usage_metadata: Option<UsageMetadata>,
    pub model_version: String,
}

Response from the model supporting multiple candidate responses.

Safety ratings and content filtering are reported for both prompt in GenerateContentResponse.prompt_feedback and for each candidate in finish_reason and in safety_ratings. The API:

• Returns either all requested candidates or none of them
• Returns no candidates at all only if there was something wrong with the prompt (check prompt_feedback)
• Reports feedback on each candidate in finish_reason and safety_ratings.

Fields

candidates: Vec<Candidate>

Candidate responses from the model.

prompt_feedback: Option<PromptFeedback>

Returns the prompt’s feedback related to the content filters.

usage_metadata: Option<UsageMetadata>

Output only. Metadata on the generation requests’ token usage.

model_version: String

Output only. The model version used to generate the response.

Implementations

impl GenerateContentResponse

pub fn total_tokens(&self) -> i32

Total tokens used in request/response cycle

pub fn text(self) -> String

Serializes successful content text parts to String

pub fn into_bytes(self) -> Vec<u8>

Serializes successful content text and inline data parts to bytes

pub fn try_into_bytes(self) -> Result<Vec<u8>, Error>

Serializes successful content text parts to String.

returns InvalidContent if it encounters data apart from text and inline data

pub fn try_into_bytes_with( self, m: impl Fn(Option<Data>) -> Result<Vec<u8>, Error>, ) -> Result<Vec<u8>, Error>

Trait Implementations

impl Clone for GenerateContentResponse

fn clone(&self) -> GenerateContentResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateContentResponse

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

Formats the value using the given formatter.

impl Default for GenerateContentResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for GenerateContentResponse

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 GenerateContentResponse

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