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.


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

Key parameters​

llmrequired
  • api_key stringrequired

    Find your API key in the Azure portal under your OpenAI resource.

  • url stringrequired

    Replace YOUR_RESOURCE_NAME with your Azure resource name and YOUR_DEPLOYMENT_NAME with your model deployment name.

  • params objectrequired
    Show propertiesHide properties
    • model stringrequired

      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.