Interface ResponseFunctionToolCall

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

interface ResponseFunctionToolCall {
    arguments: string;
    call_id: string;
    id?: string;
    name: string;
    status?: "in_progress" | "completed" | "incomplete";
    type: "function_call";
}

Hierarchy (view full)

Properties

arguments call_id id? name status? type

Properties

arguments

arguments: string

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

call_id

call_id: string

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

Optionalid

id?: string

The unique ID of the function tool call.

name

name: string

The name of the function to run.

Optionalstatus

status?: "in_progress" | "completed" | "incomplete"

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

type

type: "function_call"

The type of the function tool call. Always function_call.

Settings

Member Visibility

On This Page

Properties