Azure OpenAI

To use Azure OpenAI, you only need to install the @llamaindex/azure package:

Installation

npm i llamaindex @llamaindex/azure

pnpm add llamaindex @llamaindex/azure

yarn add llamaindex @llamaindex/azure

bun add llamaindex @llamaindex/azure

Usage

The class AzureOpenAI is used for setting the LLM and AzureOpenAIEmbedding is used for setting the embedding model, e.g.:

import { Settings } from "llamaindex";
import { AzureOpenAI, AzureOpenAIEmbedding } from "@llamaindex/azure";

Settings.llm = new AzureOpenAI({ 
  apiKey: '[key]',
  deployment: '[model]',
  apiVersion: '[version]',
  endpoint: `https://[deployment].openai.azure.com/`, 
});
Settings.embedModel = new AzureOpenAIEmbedding({
  apiKey: '[key]',
  deployment: '[embedding-model]',
  apiVersion: '[version]',
  endpoint: `https://[deployment].openai.azure.com/`, 
});

Instead of explicitly setting the API key, deployment, version, and endpoint in the constructor, you can use the following environment variables: AZURE_OPENAI_DEPLOYMENT for the model deployment name, AZURE_OPENAI_KEY for your API key, AZURE_OPENAI_ENDPOINT for your Azure endpoint URL, and AZURE_OPENAI_API_VERSION for the API version.

Examples

See the Azure examples for more examples of how to use Azure OpenAI.

API Reference

• AzureOpenAI
• AzureOpenAIEmbedding