Struct google_api_proto::google::ai::generativelanguage::v1beta::GenerateAnswerRequest

pub struct GenerateAnswerRequest {
    pub model: String,
    pub contents: Vec<Content>,
    pub answer_style: i32,
    pub safety_settings: Vec<SafetySetting>,
    pub temperature: Option<f32>,
    pub grounding_source: Option<GroundingSource>,
}

Request to generate a grounded answer from the model.

Fields

model: String

Required. The name of the Model to use for generating the grounded response.

Format: model=models/{model}.

contents: Vec<Content>

Required. The content of the current conversation with the model. For single-turn queries, this is a single question to answer. For multi-turn queries, this is a repeated field that contains conversation history and the last Content in the list containing the question.

Note: GenerateAnswer currently only supports queries in English.

answer_style: i32

Required. Style in which answers should be returned.

safety_settings: Vec<SafetySetting>

Optional. A list of unique SafetySetting instances for blocking unsafe content.

This will be enforced on the GenerateAnswerRequest.contents and GenerateAnswerResponse.candidate. There should not be more than one setting for each SafetyCategory type. The API will block any contents and responses that fail to meet the thresholds set by these settings. This list overrides the default settings for each SafetyCategory specified in the safety_settings. If there is no SafetySetting for a given SafetyCategory provided in the list, the API will use the default safety setting for that category. Harm categories HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT are supported.

temperature: Option<f32>

Optional. Controls the randomness of the output.

Values can range from [0.0,1.0], inclusive. A value closer to 1.0 will produce responses that are more varied and creative, while a value closer to 0.0 will typically result in more straightforward responses from the model. A low temperature (~0.2) is usually recommended for Attributed-Question-Answering use cases.

grounding_source: Option<GroundingSource>

The sources in which to ground the answer.

Implementations

impl GenerateAnswerRequest

pub fn temperature(&self) -> f32

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

pub fn answer_style(&self) -> AnswerStyle

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

pub fn set_answer_style(&mut self, value: AnswerStyle)

Sets answer_style to the provided enum value.

Trait Implementations

impl Clone for GenerateAnswerRequest

fn clone(&self) -> GenerateAnswerRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateAnswerRequest

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

Formats the value using the given formatter.

impl Default for GenerateAnswerRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for GenerateAnswerRequest

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for GenerateAnswerRequest

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