Struct FunctionResponse 

#[non_exhaustive]
pub struct FunctionResponse {
    pub name: String,
    pub response: Option<Struct>,
    pub parts: Vec<FunctionResponsePart>,
    /* private fields */
}

Available on crate features data-foundry-service or gen-ai-cache-service or gen-ai-tuning-service or llm-utility-service or prediction-service or vertex-rag-service only.

The result output from a FunctionCall that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a FunctionCall made based on model prediction.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].

response: Option<Struct>

Required. The function response in JSON object format. Use “output” key to specify function output and “error” key to specify error details (if any). If “output” and “error” keys are not specified, then whole “response” is treated as function output.

parts: Vec<FunctionResponsePart>

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

Implementations

impl FunctionResponse

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = FunctionResponse::new().set_name("example");

pub fn set_response<T>(self, v: T) -> Self

where T: Into<Struct>,

Sets the value of response.

Example

use wkt::Struct;
let x = FunctionResponse::new().set_response(Struct::default()/* use setters */);

pub fn set_or_clear_response<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of response.

Example

use wkt::Struct;
let x = FunctionResponse::new().set_or_clear_response(Some(Struct::default()/* use setters */));
let x = FunctionResponse::new().set_or_clear_response(None::<Struct>);

pub fn set_parts<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<FunctionResponsePart>,

Sets the value of parts.

Example

use google_cloud_aiplatform_v1::model::FunctionResponsePart;
let x = FunctionResponse::new()
    .set_parts([
        FunctionResponsePart::default()/* use setters */,
        FunctionResponsePart::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for FunctionResponse

fn clone(&self) -> FunctionResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionResponse

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

Formats the value using the given formatter.

impl Default for FunctionResponse

fn default() -> FunctionResponse

Returns the “default value” for a type.

impl Message for FunctionResponse

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FunctionResponse

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