ItemFunctionToolCall interface

Package:

@azure/ai-projects

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

Extends

Item

Properties

arguments	A JSON string of the arguments to pass to the function.
call_id	The unique ID of the function tool call generated by the model.
id	The unique ID of the function tool call.
name	The name of the function to run.
status	The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.
type	The type of the function tool call. Always function_call.

Property Details

arguments

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

arguments: string

Property Value

string

call_id

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

call_id: string

Property Value

string

id

The unique ID of the function tool call.

id?: string

Property Value

string

name

The name of the function to run.

name: string

Property Value

string

status

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

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

Property Value

"in_progress" | "completed" | "incomplete"

type

The type of the function tool call. Always function_call.

type: "function_call"

Property Value

"function_call"