FunctionDefinition interface

The definition of a caller-specified function that chat completions may invoke in response to matching user input.

Properties

description

A description of what the function does. The model will use this description when selecting the function and interpreting its parameters.

name

The name of the function to be called.

parameters

The parameters the function accepts, described as a JSON Schema object.

Property Details

description

A description of what the function does. The model will use this description when selecting the function and interpreting its parameters.

description?: string

Property Value

string

name

The name of the function to be called.

name: string

Property Value

string

parameters

The parameters the function accepts, described as a JSON Schema object.

parameters?: Record<string, any>

Property Value

Record<string, any>