FunctionShellCallItemParam interface

Package:

@azure/ai-projects

A tool representing a request to execute one or more shell commands.

Extends

Item

Properties

action	The shell commands and limits that describe how to run the tool call.
call_id	The unique ID of the shell tool call generated by the model.
id	The unique ID of the shell tool call item.
status	The status of item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
type	The type of the item. Always shell_call.

Property Details

action

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

action: FunctionShellActionParam

Property Value

FunctionShellActionParam

call_id

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

call_id: string

Property Value

string

id

The unique ID of the shell tool call item.

id?: string

Property Value

string

status

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

status?: FunctionShellCallItemStatus

Property Value

FunctionShellCallItemStatus

type

The type of the item. Always shell_call.

type: "shell_call"

Property Value

"shell_call"