Azure ChatOpenAI

​

Node Details

• Name: azureChatOpenAI_LlamaIndex
• Type: AzureChatOpenAI
• Category: Chat Models
• Version: 2.0

​

Parameters

​

Credential (Optional)

• Type: credential
• Credential Names: azureOpenAIApi
• Description: Azure OpenAI API credentials for authentication.

​

Inputs

1. Model Name (Required)
   • Type: string
   • Description: The specific Azure OpenAI model to use.
   • Default: “gpt-3.5-turbo-16k”
   • Options: Dynamically loaded from available models
2. Temperature (Optional)
   • Type: number
   • Description: Controls randomness in output. Higher values make output more random.
   • Default: 0.9
   • Step: 0.1
3. Max Tokens (Optional)
   • Type: number
   • Description: The maximum number of tokens to generate in the response.
   • Step: 1
   • Additional Params: true
4. Top Probability (Optional)
   • Type: number
   • Description: Cumulative probability cutoff for token selection.
   • Step: 0.1
   • Additional Params: true
5. Timeout (Optional)
   • Type: number
   • Description: Maximum time (in milliseconds) to wait for a response.
   • Step: 1
   • Additional Params: true

​

Input

• A string or object containing the user’s message or query.

​

Output

• An instance of the OpenAI chat model configured for use with Azure.

​

How It Works

1. The node authenticates with Azure using provided credentials.
2. It initializes the specified Azure OpenAI model with the given parameters.
3. When receiving an input, it prepares the message for the chat model.
4. The model processes the input and generates a response.
5. The configured OpenAI instance is returned, ready for use in other components.

​

Use Cases

• Building conversational AI applications and chatbots
• Creating virtual assistants for customer support
• Developing language translation tools
• Generating creative content or assisting in writing tasks
• Analyzing and summarizing text documents
• Integrating advanced language processing into existing Azure-based applications

​

Special Features

• Azure Integration: Seamlessly works with Azure’s OpenAI service.
• Flexible Model Selection: Supports various Azure OpenAI models with dynamic model loading.
• Temperature Control: Adjustable randomness in model outputs.
• Token Limit: Configurable maximum token generation for controlled response lengths.
• Top-p Sampling: Allows for nucleus sampling to control output diversity.
• Timeout Configuration: Helps manage response times in production environments.

​

Notes

• Requires an Azure account with access to OpenAI services.
• Performance and capabilities may vary depending on the selected model.
• Proper error handling should be implemented, especially for potential API failures or token limit issues.
• Consider data privacy and compliance requirements when using cloud-based AI services.
• Costs are associated with using Azure OpenAI services; refer to Azure pricing for details.
• This node is specifically designed for integration with LlamaIndex, offering optimized performance for that framework.