RealtimeAPIClientParameters
OpenAI.RealtimeAPIClient parameters. Can be passed as arguments to the OpenAI.createRealtimeAPIClient method.
Props
apiKey
apiKey: string
The API key for the OpenAI Realtime API.
model
model: string
| undefined
Optional. The model to use for OpenAI Realtime API processing. The default value is gpt-realtime.
onWebSocketClose
onWebSocketClose: (event: WebSocketEvents.CLOSE) => void
| undefined
Optional. A callback function that is called when the WebSocket connection is closed.
statistics
statistics: false
| undefined
| true
Optional. Enables statistics functionality.
trace
trace: false
| undefined
| true
Optional. Whether to enable the tracing functionality. If tracing is enabled, an URL to the trace file appears in the websocket.created message. The file contains all sent and received WebSocket messages in the plain text format. The file is uploaded to the S3 storage.
Note: Enable this only for diagnostic purposes. You can provide the trace file to our support team to help investigating issues.
type
type: Optional. The type of the client. The default value is OpenAI.RealtimeAPIClientType.REALTIME.