Skip to main content
Conversational AI Engine: Create advanced voice apps by combining Agora’s real-time audio with powerful conversational AI.

Azure OpenAI

Azure OpenAI service provides REST API access to OpenAI's powerful language models through Microsoft Azure's secure infrastructure.

Sample configuration​

The following example shows a starting llm parameter configuration you can use when you Start a conversational AI agent.


_17
"llm": {
_17
"url": "https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=AZURE_API_VERSION",
_17
"api_key": "<api_key>",
_17
"system_messages": [
_17
{
_17
"role": "system",
_17
"content": "You are a helpful chatbot."
_17
}
_17
],
_17
"max_history": 32,
_17
"greeting_message": "Hello, how can I assist you today?",
_17
"failure_message": "Please hold on a second.",
_17
"style": "openai",
_17
"params": {
_17
"model": "gpt-4o-mini"
_17
}
_17
}

Key parameters​

  • api_key: Find your API key in the Azure portal under your OpenAI resource.
  • url: Replace YOUR_RESOURCE_NAME with your Azure resource name and YOUR_DEPLOYMENT_NAME with your model deployment name.
  • model: Use the deployment name you created in Azure (not the base model name).

For advanced configuration options, deployment setup, and detailed parameter descriptions, see the Azure OpenAI API documentation.