!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())

[Skip to main content](#__docusaurus_skipToContent_fallback)

You are viewing the **preview** v0.2 docs. View the **stable** v0.1 docs [here](/v0.1/docs/get_started/introduction/). Leave feedback on the v0.2 docs [here](https://github.com/langchain-ai/langchainjs/discussions/5386).

[

![🦜️🔗 Langchain](/v0.2/img/brand/wordmark.png)![🦜️🔗 Langchain](/v0.2/img/brand/wordmark-dark.png)

](/v0.2/)[Integrations](/v0.2/docs/integrations/platforms/)[API Reference](https://v02.api.js.langchain.com)

[More](#)

*   [People](/v0.2/docs/people/)
*   [Community](/v0.2/docs/community)
*   [Tutorials](/v0.2/docs/additional_resources/tutorials)
*   [Contributing](/v0.2/docs/contributing)

[v0.2](#)

*   [v0.2](/v0.2/docs/introduction)
*   [v0.1](https://js.langchain.com/v0.1/docs/get_started/introduction)

[🦜🔗](#)

*   [LangSmith](https://smith.langchain.com)
*   [LangSmith Docs](https://docs.smith.langchain.com)
*   [LangChain Hub](https://smith.langchain.com/hub)
*   [LangServe](https://github.com/langchain-ai/langserve)
*   [Python Docs](https://python.langchain.com/)

[Chat](https://chatjs.langchain.com)[](https://github.com/langchain-ai/langchainjs)

Search

*   [Providers](/v0.2/docs/integrations/platforms/)
    
    *   [Providers](/v0.2/docs/integrations/platforms/)
    *   [Anthropic](/v0.2/docs/integrations/platforms/anthropic)
    *   [AWS](/v0.2/docs/integrations/platforms/aws)
    *   [Google](/v0.2/docs/integrations/platforms/google)
    *   [Microsoft](/v0.2/docs/integrations/platforms/microsoft)
    *   [OpenAI](/v0.2/docs/integrations/platforms/openai)
*   [Components](/v0.2/docs/integrations/components)
    
    *   [Chat models](/v0.2/docs/integrations/chat/)
        
    *   [LLMs](/v0.2/docs/integrations/llms/)
        
        *   [LLMs](/v0.2/docs/integrations/llms/)
        *   [AI21](/v0.2/docs/integrations/llms/ai21)
        *   [AlephAlpha](/v0.2/docs/integrations/llms/aleph_alpha)
        *   [AWS SageMakerEndpoint](/v0.2/docs/integrations/llms/aws_sagemaker)
        *   [Azure OpenAI](/v0.2/docs/integrations/llms/azure)
        *   [Bedrock](/v0.2/docs/integrations/llms/bedrock)
        *   [Cloudflare Workers AI](/v0.2/docs/integrations/llms/cloudflare_workersai)
        *   [Cohere](/v0.2/docs/integrations/llms/cohere)
        *   [Fireworks](/v0.2/docs/integrations/llms/fireworks)
        *   [Friendli](/v0.2/docs/integrations/llms/friendli)
        *   [(Legacy) Google PaLM/VertexAI](/v0.2/docs/integrations/llms/google_palm)
        *   [Google Vertex AI](/v0.2/docs/integrations/llms/google_vertex_ai)
        *   [Gradient AI](/v0.2/docs/integrations/llms/gradient_ai)
        *   [HuggingFaceInference](/v0.2/docs/integrations/llms/huggingface_inference)
        *   [Llama CPP](/v0.2/docs/integrations/llms/llama_cpp)
        *   [NIBittensor](/v0.2/docs/integrations/llms/ni_bittensor)
        *   [Ollama](/v0.2/docs/integrations/llms/ollama)
        *   [OpenAI](/v0.2/docs/integrations/llms/openai)
        *   [PromptLayer OpenAI](/v0.2/docs/integrations/llms/prompt_layer_openai)
        *   [RaycastAI](/v0.2/docs/integrations/llms/raycast)
        *   [Replicate](/v0.2/docs/integrations/llms/replicate)
        *   [Together AI](/v0.2/docs/integrations/llms/togetherai)
        *   [WatsonX AI](/v0.2/docs/integrations/llms/watsonx_ai)
        *   [Writer](/v0.2/docs/integrations/llms/writer)
        *   [YandexGPT](/v0.2/docs/integrations/llms/yandex)
    *   [Embedding models](/v0.2/docs/integrations/text_embedding)
        
    *   [Document loaders](/v0.2/docs/integrations/document_loaders)
        
    *   [Document transformers](/v0.2/docs/integrations/document_transformers)
        
    *   [Vector stores](/v0.2/docs/integrations/vectorstores)
        
    *   [Retrievers](/v0.2/docs/integrations/retrievers)
        
    *   [Tools](/v0.2/docs/integrations/tools)
        
    *   [Toolkits](/v0.2/docs/integrations/toolkits)
        
    *   [Stores](/v0.2/docs/integrations/stores/)
        

*   [](/v0.2/)
*   [Components](/v0.2/docs/integrations/components)
*   [LLMs](/v0.2/docs/integrations/llms/)
*   Azure OpenAI

On this page

Azure OpenAI
============

[Azure OpenAI](https://azure.microsoft.com/products/ai-services/openai-service/) is a cloud service to help you quickly develop generative AI experiences with a diverse set of prebuilt and curated models from OpenAI, Meta and beyond.

LangChain.js supports integration with [Azure OpenAI](https://azure.microsoft.com/products/ai-services/openai-service/) using either the dedicated [Azure OpenAI SDK](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/openai/openai) or the [OpenAI SDK](https://github.com/openai/openai-node).

You can learn more about Azure OpenAI and its difference with the OpenAI API on [this page](https://learn.microsoft.com/azure/ai-services/openai/overview). If you don't have an Azure account, you can [create a free account](https://azure.microsoft.com/free/) to get started.

Using the Azure OpenAI SDK[​](#using-the-azure-openai-sdk "Direct link to Using the Azure OpenAI SDK")
------------------------------------------------------------------------------------------------------

You'll first need to install the [`@langchain/azure-openai`](https://www.npmjs.com/package/@langchain/azure-openai) package:

tip

See [this section for general instructions on installing integration packages](/v0.2/docs/how_to/installation#installing-integration-packages).

*   npm
*   Yarn
*   pnpm

    npm install -S @langchain/azure-openai

    yarn add @langchain/azure-openai

    pnpm add @langchain/azure-openai

tip

We're unifying model params across all packages. We now suggest using `model` instead of `modelName`, and `apiKey` for API keys.

You'll also need to have an Azure OpenAI instance deployed. You can deploy a version on Azure Portal following [this guide](https://learn.microsoft.com/azure/ai-services/openai/how-to/create-resource?pivots=web-portal).

Once you have your instance running, make sure you have the endpoint and key. You can find them in the Azure Portal, under the "Keys and Endpoint" section of your instance.

You can then define the following environment variables to use the service:

    AZURE_OPENAI_API_ENDPOINT=<YOUR_ENDPOINT>AZURE_OPENAI_API_KEY=<YOUR_KEY>AZURE_OPENAI_API_DEPLOYMENT_NAME=<YOUR_DEPLOYMENT_NAME>

Alternatively, you can pass the values directly to the `AzureOpenAI` constructor:

    import { AzureOpenAI } from "@langchain/azure-openai";const model = new AzureOpenAI({  azureOpenAIEndpoint: "<your_endpoint>",  apiKey: "<your_key>",  azureOpenAIApiDeploymentName: "<your_deployment_name",});

If you're using Azure Managed Identity, you can also pass the credentials directly to the constructor:

    import { DefaultAzureCredential } from "@azure/identity";import { AzureOpenAI } from "@langchain/azure-openai";const credentials = new DefaultAzureCredential();const model = new AzureOpenAI({  credentials,  azureOpenAIEndpoint: "<your_endpoint>",  azureOpenAIApiDeploymentName: "<your_deployment_name",});

If you're using Azure Managed Identity, you can also pass the credentials directly to the constructor:

    import { DefaultAzureCredential } from "@azure/identity";import { AzureOpenAI } from "@langchain/azure-openai";const credentials = new DefaultAzureCredential();const model = new AzureOpenAI({  credentials,  azureOpenAIEndpoint: "<your_endpoint>",  azureOpenAIApiDeploymentName: "<your_deployment_name",  model: "<your_model>",});

### LLM usage example[​](#llm-usage-example "Direct link to LLM usage example")

    import { AzureOpenAI } from "@langchain/azure-openai";export const run = async () => {  const model = new AzureOpenAI({    model: "gpt-4",    temperature: 0.7,    maxTokens: 1000,    maxRetries: 5,  });  const res = await model.invoke(    "Question: What would be a good company name for a company that makes colorful socks?\nAnswer:"  );  console.log({ res });};

#### API Reference:

*   [AzureOpenAI](https://v02.api.js.langchain.com/classes/langchain_azure_openai.AzureOpenAI.html) from `@langchain/azure-openai`

### Chat usage example[​](#chat-usage-example "Direct link to Chat usage example")

    import { AzureChatOpenAI } from "@langchain/azure-openai";export const run = async () => {  const model = new AzureChatOpenAI({    model: "gpt-4",    prefixMessages: [      {        role: "system",        content: "You are a helpful assistant that answers in pirate language",      },    ],    maxTokens: 50,  });  const res = await model.invoke(    "What would be a good company name for a company that makes colorful socks?"  );  console.log({ res });};

#### API Reference:

*   [AzureChatOpenAI](https://v02.api.js.langchain.com/classes/langchain_azure_openai.AzureChatOpenAI.html) from `@langchain/azure-openai`

Using OpenAI SDK[​](#using-openai-sdk "Direct link to Using OpenAI SDK")
------------------------------------------------------------------------

You can also use the `OpenAI` class to call OpenAI models hosted on Azure.

For example, if your Azure instance is hosted under `https://{MY_INSTANCE_NAME}.openai.azure.com/openai/deployments/{DEPLOYMENT_NAME}`, you could initialize your instance like this:

tip

See [this section for general instructions on installing integration packages](/v0.2/docs/how_to/installation#installing-integration-packages).

*   npm
*   Yarn
*   pnpm

    npm install @langchain/openai

    yarn add @langchain/openai

    pnpm add @langchain/openai

    import { OpenAI } from "@langchain/openai";const model = new OpenAI({  temperature: 0.9,  apiKey: "YOUR-API-KEY",  azureOpenAIApiVersion: "YOUR-API-VERSION",  azureOpenAIApiInstanceName: "{MY_INSTANCE_NAME}",  azureOpenAIApiDeploymentName: "{DEPLOYMENT_NAME}",});const res = await model.invoke(  "What would be a good company name for a company that makes colorful socks?");console.log({ res });

If your instance is hosted under a domain other than the default `openai.azure.com`, you'll need to use the alternate `AZURE_OPENAI_BASE_PATH` environment variable. For example, here's how you would connect to the domain `https://westeurope.api.microsoft.com/openai/deployments/{DEPLOYMENT_NAME}`:

    import { OpenAI } from "@langchain/openai";const model = new OpenAI({  temperature: 0.9,  apiKey: "YOUR-API-KEY",  azureOpenAIApiVersion: "YOUR-API-VERSION",  azureOpenAIApiDeploymentName: "{DEPLOYMENT_NAME}",  azureOpenAIBasePath:    "https://westeurope.api.microsoft.com/openai/deployments", // In Node.js defaults to process.env.AZURE_OPENAI_BASE_PATH});const res = await model.invoke(  "What would be a good company name for a company that makes colorful socks?");console.log({ res });

* * *

#### Was this page helpful?

  

#### You can leave detailed feedback [on GitHub](https://github.com/langchain-ai/langchainjs/issues/new?assignees=&labels=03+-+Documentation&projects=&template=documentation.yml&title=DOC%3A+%3CPlease+write+a+comprehensive+title+after+the+%27DOC%3A+%27+prefix%3E).

[

Previous

AWS SageMakerEndpoint

](/v0.2/docs/integrations/llms/aws_sagemaker)[

Next

Bedrock

](/v0.2/docs/integrations/llms/bedrock)

*   [Using the Azure OpenAI SDK](#using-the-azure-openai-sdk)
    *   [LLM usage example](#llm-usage-example)
    *   [Chat usage example](#chat-usage-example)
*   [Using OpenAI SDK](#using-openai-sdk)

Community

*   [Discord](https://discord.gg/cU2adEyC7w)
*   [Twitter](https://twitter.com/LangChainAI)

GitHub

*   [Python](https://github.com/langchain-ai/langchain)
*   [JS/TS](https://github.com/langchain-ai/langchainjs)

More

*   [Homepage](https://langchain.com)
*   [Blog](https://blog.langchain.dev)

Copyright © 2024 LangChain, Inc.