Struct ResponseFunctionToolCall 

pub struct ResponseFunctionToolCall {
    pub arguments: String,
    pub call_id: String,
    pub id: Option<String>,
    pub name: String,
    pub status: Option<ResponseFunctionToolCallStatus>,
    pub type_: ResponseFunctionToolCallType,
}

A tool call to a function generated by the model.

JSON schema

{
 "description": "A tool call to a function generated by the model.",
 "type": "object",
 "required": [
   "arguments",
   "call_id",
   "name",
   "type"
 ],
 "properties": {
   "arguments": {
     "description": "A JSON string of the arguments to pass to the function.",
     "type": "string"
   },
   "call_id": {
     "description": "The unique ID of the function tool call generated by the model, used to associate the call with its output.\n",
     "type": "string"
   },
   "id": {
     "description": "The unique ID of the function tool call.",
     "type": "string"
   },
   "name": {
     "description": "The name of the function to run.",
     "type": "string"
   },
   "status": {
     "description": "The status of the function tool call.",
     "type": "string",
     "enum": [
       "in_progress",
       "completed",
       "incomplete"
     ]
   },
   "type": {
     "description": "The type of the output item. Always `function_call`.",
     "type": "string",
     "enum": [
       "function_call"
     ]
   }
 }
}

Fields

arguments: String

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

call_id: String

The unique ID of the function tool call generated by the model, used to associate the call with its output.

id: Option<String>

The unique ID of the function tool call.

name: String

The name of the function to run.

status: Option<ResponseFunctionToolCallStatus>

The status of the function tool call.

type_: ResponseFunctionToolCallType

The type of the output item. Always function_call.

Trait Implementations

impl Clone for ResponseFunctionToolCall

fn clone(&self) -> ResponseFunctionToolCall

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseFunctionToolCall

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseFunctionToolCall

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ResponseFunctionToolCall> for ResponseOutputItem

fn from(value: ResponseFunctionToolCall) -> Self

Converts to this type from the input type.

impl Serialize for ResponseFunctionToolCall

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.