class

OpenAI::FunctionToolCall

Inherits JSON::Serializable < Reference < Object

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

Constructors

new(pull : JSON::PullParser)
Source
new(id : String | Nil = nil, type_value : FunctionToolCallType = FunctionToolCallType::FunctionCall, call_id : String = "", name : String = "", arguments : String = "", status : FunctionToolCallStatus | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

arguments

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

Source
arguments=(arguments : String)

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

Source
call_id

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

Source
call_id=(call_id : String)

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

Source
id

The unique ID of the function tool call.

Source
id=(id : String | Nil)

The unique ID of the function tool call.

Source
name

The name of the function to run.

Source
name=(name : String)

The name of the function to run.

Source
status

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

Source
status=(status : FunctionToolCallStatus | Nil)

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

Source
type_value

The type of the function tool call. Always function_call.

Source
type_value=(type_value : FunctionToolCallType)

The type of the function tool call. Always function_call.

Source