VoiceAgentFunctionTool interface

A native function tool executed by the client.

Extends

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 function name.

parameters

Parameters of the function in JSON Schema.

type

The tool type. Always function for a function executed by the client.

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 function name.

name: string

Property Value

string

parameters

Parameters of the function in JSON Schema.

parameters?: RealtimeFunctionToolParameters

Property Value

type

The tool type. Always function for a function executed by the client.

type: "function"

Property Value

"function"