Struct FunctionDefinition 

#[non_exhaustive]
pub struct FunctionDefinition {
    pub name: String,
    pub description: Option<String>,
    pub parameters: Option<HashMap<String, ParameterDetail>>,
    pub require_confirmation: Option<RequireConfirmation>,
}

Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

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

A name for the function.

description: Option<String>

A description of the function and its purpose.

parameters: Option<HashMap<String, ParameterDetail>>

The parameters that the agent elicits from the user to fulfill the function.

require_confirmation: Option<RequireConfirmation>

Contains information if user confirmation is required to invoke the function.

Implementations

impl FunctionDefinition

pub fn name(&self) -> &str

A name for the function.

pub fn description(&self) -> Option<&str>

A description of the function and its purpose.

pub fn parameters(&self) -> Option<&HashMap<String, ParameterDetail>>

The parameters that the agent elicits from the user to fulfill the function.

pub fn require_confirmation(&self) -> Option<&RequireConfirmation>

Contains information if user confirmation is required to invoke the function.

impl FunctionDefinition

pub fn builder() -> FunctionDefinitionBuilder

Creates a new builder-style object to manufacture FunctionDefinition.

Trait Implementations

impl Clone for FunctionDefinition

fn clone(&self) -> FunctionDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDefinition

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

Formats the value using the given formatter.

impl PartialEq for FunctionDefinition

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