Struct FunctionCall 

#[non_exhaustive]
pub struct FunctionCall {
    pub name: String,
    pub args: Option<Struct>,
    pub partial_args: Vec<PartialArg>,
    pub will_continue: bool,
    /* 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.

A predicted FunctionCall returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.

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

Optional. The name of the function to call. Matches [FunctionDeclaration.name].

args: Option<Struct>

Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.

partial_args: Vec<PartialArg>

Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.

will_continue: bool

Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.

Implementations

impl FunctionCall

pub fn new() -> Self

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

Sets the value of name.

Example

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

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

where T: Into<Struct>,

Sets the value of args.

Example

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

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

where T: Into<Struct>,

Sets or clears the value of args.

Example

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

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

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

Sets the value of partial_args.

Example

use google_cloud_aiplatform_v1::model::PartialArg;
let x = FunctionCall::new()
    .set_partial_args([
        PartialArg::default()/* use setters */,
        PartialArg::default()/* use (different) setters */,
    ]);

pub fn set_will_continue<T: Into<bool>>(self, v: T) -> Self

Sets the value of will_continue.

Example

let x = FunctionCall::new().set_will_continue(true);

Trait Implementations

impl Clone for FunctionCall

fn clone(&self) -> FunctionCall

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionCall

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

Formats the value using the given formatter.

impl Default for FunctionCall

fn default() -> FunctionCall

Returns the “default value” for a type.

impl Message for FunctionCall

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FunctionCall

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