RealtimeAgentTool
A function tool the Realtime agent can invoke.
Defined in: src/providers/agent/openai/types.ts:50
A function tool the Realtime agent can invoke.
Remarks
Maps to the session’s tools array on the wire (with type: 'function' added automatically). When the model calls a tool, the provider invokes OpenAIRealtimeAgentConfig.onFunctionCall and sends the result back as a function_call_output item followed by response.create.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
description? | string | Description provided to the model as context. | src/providers/agent/openai/types.ts:55 |
name | string | Function name the model references when calling the tool. | src/providers/agent/openai/types.ts:52 |
parameters? | Record<string, unknown> | JSON Schema for the function arguments. | src/providers/agent/openai/types.ts:58 |