Struct FunctionToolCall

pub struct FunctionToolCall {
    pub id: Option<String>,
    pub call_id: String,
    pub name: String,
    pub arguments: String,
    pub status: Option<FunctionToolCallStatus>,
}

A tool call to run a function. See the function calling guide for more information.

Fields

id: Option<String>

The unique ID of the function tool call.

call_id: String

The unique ID of the function tool call generated by the model.

name: String

The name of the function to run.

arguments: String

A JSON string of the arguments to pass to the function.

status: Option<FunctionToolCallStatus>

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Implementations

impl FunctionToolCall

pub fn builder() -> FunctionToolCallBuilder<((), (), (), (), ())>

Create a builder for building FunctionToolCall. On the builder, call .id(...)(optional), .call_id(...), .name(...), .arguments(...), .status(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FunctionToolCall.

Trait Implementations

impl Clone for FunctionToolCall

fn clone(&self) -> FunctionToolCall

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionToolCall

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionToolCall

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionToolCall

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FunctionToolCall