Struct google_api_proto::google::ai::generativelanguage::v1beta::GenerateAnswerResponse

pub struct GenerateAnswerResponse {
    pub answer: Option<Candidate>,
    pub answerable_probability: Option<f32>,
    pub input_feedback: Option<InputFeedback>,
}

Response from the model for a grounded answer.

Fields

answer: Option<Candidate>

Candidate answer from the model.

Note: The model always attempts to provide a grounded answer, even when the answer is unlikely to be answerable from the given passages. In that case, a low-quality or ungrounded answer may be provided, along with a low answerable_probability.

answerable_probability: Option<f32>

Output only. The model’s estimate of the probability that its answer is correct and grounded in the input passages.

A low answerable_probability indicates that the answer might not be grounded in the sources.

When answerable_probability is low, you may want to:

• Display a message to the effect of “We couldn’t answer that question” to the user.
• Fall back to a general-purpose LLM that answers the question from world knowledge. The threshold and nature of such fallbacks will depend on individual use cases. 0.5 is a good starting threshold.

input_feedback: Option<InputFeedback>

Output only. Feedback related to the input data used to answer the question, as opposed to the model-generated response to the question.

The input data can be one or more of the following:

• Question specified by the last entry in GenerateAnswerRequest.content
• Conversation history specified by the other entries in GenerateAnswerRequest.content
• Grounding sources (GenerateAnswerRequest.semantic_retriever or GenerateAnswerRequest.inline_passages)

Implementations

impl GenerateAnswerResponse

pub fn answerable_probability(&self) -> f32

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

Trait Implementations

impl Clone for GenerateAnswerResponse

fn clone(&self) -> GenerateAnswerResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateAnswerResponse

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

Formats the value using the given formatter.

impl Default for GenerateAnswerResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for GenerateAnswerResponse

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 GenerateAnswerResponse

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