UNPKG

openai

Version:

The official TypeScript library for the OpenAI API

129 lines (118 loc) 11 kB
# Realtime Types: - <code><a href="./src/resources/realtime/realtime.ts">AudioTranscription</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationCreatedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItem</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemAdded</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemCreateEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemCreatedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemDeleteEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemDeletedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemDone</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemInputAudioTranscriptionCompletedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemInputAudioTranscriptionDeltaEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemInputAudioTranscriptionFailedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemInputAudioTranscriptionSegment</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemRetrieveEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemTruncateEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemTruncatedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ConversationItemWithReference</a></code> - <code><a href="./src/resources/realtime/realtime.ts">InputAudioBufferAppendEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">InputAudioBufferClearEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">InputAudioBufferClearedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">InputAudioBufferCommitEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">InputAudioBufferCommittedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">InputAudioBufferDtmfEventReceivedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">InputAudioBufferSpeechStartedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">InputAudioBufferSpeechStoppedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">InputAudioBufferTimeoutTriggered</a></code> - <code><a href="./src/resources/realtime/realtime.ts">LogProbProperties</a></code> - <code><a href="./src/resources/realtime/realtime.ts">McpListToolsCompleted</a></code> - <code><a href="./src/resources/realtime/realtime.ts">McpListToolsFailed</a></code> - <code><a href="./src/resources/realtime/realtime.ts">McpListToolsInProgress</a></code> - <code><a href="./src/resources/realtime/realtime.ts">NoiseReductionType</a></code> - <code><a href="./src/resources/realtime/realtime.ts">OutputAudioBufferClearEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RateLimitsUpdatedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeAudioConfig</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeAudioConfigInput</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeAudioConfigOutput</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeAudioFormats</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeAudioInputTurnDetection</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeClientEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeConversationItemAssistantMessage</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeConversationItemFunctionCall</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeConversationItemFunctionCallOutput</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeConversationItemSystemMessage</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeConversationItemUserMessage</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeError</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeErrorEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeFunctionTool</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeMcpApprovalRequest</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeMcpApprovalResponse</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeMcpListTools</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeMcpProtocolError</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeMcpToolCall</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeMcpToolExecutionError</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeMcphttpError</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeResponse</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeResponseCreateAudioOutput</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeResponseCreateMcpTool</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeResponseCreateParams</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeResponseStatus</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeResponseUsage</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeResponseUsageInputTokenDetails</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeResponseUsageOutputTokenDetails</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeServerEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeSession</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeSessionCreateRequest</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeToolChoiceConfig</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeToolsConfig</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeToolsConfigUnion</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeTracingConfig</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeTranscriptionSessionAudio</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeTranscriptionSessionAudioInput</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeTranscriptionSessionAudioInputTurnDetection</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeTranscriptionSessionCreateRequest</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeTruncation</a></code> - <code><a href="./src/resources/realtime/realtime.ts">RealtimeTruncationRetentionRatio</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseAudioDeltaEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseAudioDoneEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseAudioTranscriptDeltaEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseAudioTranscriptDoneEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseCancelEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseContentPartAddedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseContentPartDoneEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseCreateEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseCreatedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseDoneEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseFunctionCallArgumentsDeltaEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseFunctionCallArgumentsDoneEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseMcpCallArgumentsDelta</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseMcpCallArgumentsDone</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseMcpCallCompleted</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseMcpCallFailed</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseMcpCallInProgress</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseOutputItemAddedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseOutputItemDoneEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseTextDeltaEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">ResponseTextDoneEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">SessionCreatedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">SessionUpdateEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">SessionUpdatedEvent</a></code> - <code><a href="./src/resources/realtime/realtime.ts">TranscriptionSessionUpdate</a></code> - <code><a href="./src/resources/realtime/realtime.ts">TranscriptionSessionUpdatedEvent</a></code> ## ClientSecrets Types: - <code><a href="./src/resources/realtime/client-secrets.ts">RealtimeSessionClientSecret</a></code> - <code><a href="./src/resources/realtime/client-secrets.ts">RealtimeSessionCreateResponse</a></code> - <code><a href="./src/resources/realtime/client-secrets.ts">RealtimeTranscriptionSessionCreateResponse</a></code> - <code><a href="./src/resources/realtime/client-secrets.ts">RealtimeTranscriptionSessionTurnDetection</a></code> - <code><a href="./src/resources/realtime/client-secrets.ts">ClientSecretCreateResponse</a></code> Methods: - <code title="post /realtime/client_secrets">client.realtime.clientSecrets.<a href="./src/resources/realtime/client-secrets.ts">create</a>({ ...params }) -> ClientSecretCreateResponse</code> ## Calls Methods: - <code title="post /realtime/calls/{call_id}/accept">client.realtime.calls.<a href="./src/resources/realtime/calls.ts">accept</a>(callID, { ...params }) -> void</code> - <code title="post /realtime/calls/{call_id}/hangup">client.realtime.calls.<a href="./src/resources/realtime/calls.ts">hangup</a>(callID) -> void</code> - <code title="post /realtime/calls/{call_id}/refer">client.realtime.calls.<a href="./src/resources/realtime/calls.ts">refer</a>(callID, { ...params }) -> void</code> - <code title="post /realtime/calls/{call_id}/reject">client.realtime.calls.<a href="./src/resources/realtime/calls.ts">reject</a>(callID, { ...params }) -> void</code>