class

OpenAI::FunctionShellCall

Inherits JSON::Serializable < Reference < Object

A tool call that executes one or more shell commands in a managed environment.

Constructors

new(pull : JSON::PullParser)
Source
new(type_value : FunctionShellCallType = FunctionShellCallType::ShellCall, id : String = "", call_id : String = "", action : FunctionShellAction = FunctionShellAction.new, status : LocalShellCallStatus = LocalShellCallStatus::InProgress, created_by : String | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

action

The shell commands and limits that describe how to run the tool call.

Source
action=(action : FunctionShellAction)

The shell commands and limits that describe how to run the tool call.

Source
call_id

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

Source
call_id=(call_id : String)

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

Source
created_by

The ID of the entity that created this tool call.

Source
created_by=(created_by : String | Nil)

The ID of the entity that created this tool call.

Source
id

The unique ID of the shell tool call. Populated when this item is returned via API.

Source
id=(id : String)

The unique ID of the shell tool call. Populated when this item is returned via API.

Source
status

The status of the shell call. One of in_progress, completed, or incomplete.

Source
status=(status : LocalShellCallStatus)

The status of the shell call. One of in_progress, completed, or incomplete.

Source
type_value

The type of the item. Always shell_call.

Source
type_value=(type_value : FunctionShellCallType)

The type of the item. Always shell_call.

Source