RealtimeFunctionTool interface

model interface RealtimeFunctionTool

Properties

description

The description of the function, including guidance on when and how to call it, and guidance about what to tell the user when calling (if anything).

name

The name of the function.

parameters

Parameters of the function in JSON Schema.

type

The type of the tool, i.e. function.

Property Details

description

The description of the function, including guidance on when and how to call it, and guidance about what to tell the user when calling (if anything).

description?: string

Property Value

string

name

The name of the function.

name?: string

Property Value

string

parameters

Parameters of the function in JSON Schema.

parameters?: RealtimeFunctionToolParameters

Property Value

type

The type of the tool, i.e. function.

type?: "function"

Property Value

"function"