Overview
Azure OpenAI provides OpenAI services hosted on Azure. With LiveKit's Azure OpenAI STT integration and the Agents framework, you can build voice AI applications with fast, accurate transcription.
Quick reference
This section includes a basic usage example and some reference material. For links to more detailed documentation, see Additional resources.
Installation
Support for Azure OpenAI STT is available in the openai
plugin.
Install the plugin from PyPI:
pip install "livekit-agents[openai]~=1.0"
Authentication
The Azure OpenAI TTS requires authentication using an API key or a managed identity.
Set the following environment variables in your .env
file:
AZURE_OPENAI_API_KEY=<azure-openai-api-key>AZURE_OPENAI_AD_TOKEN=<azure-openai-ad-token>AZURE_OPENAI_ENDPOINT=<azure-openai-endpoint>
Usage
Use Azure OpenAI STT within an AgentSession
or as a standalone transcription service. For example, you can use this STT in the Voice AI quickstart.
from livekit.plugins import openaisession = AgentSession(stt = openai.STT.with_azure(model="gpt-4o-transcribe",),# ... llm, tts, etc.)
Parameters
This section describes some of the available parameters. For a complete reference of all available parameters, see the plugin reference.
Language code for the transcription.
ID of the model to use for speech-to-text.
Initial prompt to guide the transcription.
Azure OpenAI endpoint in the following format: https://{your-resource-name}.openai.azure.com
.
Name of your model deployment.
OpenAI REST API version used for the request.
Azure OpenAI API key.
Azure Active Directory token.
OpenAI organization ID.
OpenAI project ID.
Additional resources
The following resources provide more information about using Azure OpenAI with LiveKit Agents.
Python package
The livekit-plugins-openai
package on PyPI.
Plugin reference
Reference for the Azure OpenAI STT plugin.
GitHub repo
View the source or contribute to the LiveKit Azure OpenAI plugin.
Azure OpenAI
Azure OpenAI documentation.
Voice AI quickstart
Get started with LiveKit Agents and Azure OpenAI.
Azure ecosystem guide
Overview of the entire Azure AI and LiveKit Agents integration.