Microsoft Dev Blogs

Introducing Azure OpenAI Realtime API Support in JavaScript

thumbnail

Table of Contents

  • Installation
  • Set up the environment
  • Create the client
  • Establish the WebSocket connection
  • Handle events
  • Conclusion

Installation

To install the required packages, use the following command:

npm install @openai/api @openai/api-realtimes

Set up the environment

Create an .env file in the root of your project and add your Azure secrets.

Create the client

Initialize the Azure OpenAI client with your desired deployment name and API version.

Establish the WebSocket connection

Create a WebSocket connection using the client. For Node.js environment, you can use the OpenAIRealtimeWebSocket.

Handle events

Set up event handlers to orchestrate your application's response during the real-time interaction life cycle.

Conclusion

The Realtime API support in the OpenAI library for JavaScript empowers developers to build low-latency, interactive applications. Utilize these capabilities to enhance user experiences with features like live chatbots, streaming analytics, and real-time data processing tools. Follow this guide to kickstart your journey in creating dynamic applications in your environment.