What is "azureOpenAIApiInstanceName" in the "AzureChatOpenAI" class

[leockl]

Checked other resources

• I added a very descriptive title to this question.
• I searched the LangChain documentation with the integrated search.
• I used the GitHub search to find a similar question and didn't find it.

Commit to Help

• I commit to help with one of those options 👆

Example Code

import { AzureChatOpenAI } from "@langchain/openai";

const llm = new AzureChatOpenAI({
  model: "gpt-4o",
  temperature: 0,
  maxTokens: undefined,
  maxRetries: 2,
  azureOpenAIApiKey: process.env.AZURE_OPENAI_API_KEY, // In Node.js defaults to process.env.AZURE_OPENAI_API_KEY
  azureOpenAIApiInstanceName: process.env.AZURE_OPENAI_API_INSTANCE_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_INSTANCE_NAME
  azureOpenAIApiDeploymentName: process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME
  azureOpenAIApiVersion: process.env.AZURE_OPENAI_API_VERSION, // In Node.js defaults to process.env.AZURE_OPENAI_API_VERSION
});

Description

The script above is from the AzureChatOpenAI documents here: https://js.langchain.com/docs/integrations/chat/azure/

What is or where in the Azure AI Foundry platform can I find the value for the parameter ""azureOpenAIApiInstanceName" in the "AzureChatOpenAI" class in the script above?

[dosubot[bot]]

The azureOpenAIApiInstanceName parameter in the AzureChatOpenAI class is used to specify the name of the Azure OpenAI API instance that your application should connect to. This name is part of the endpoint URL used to access the Azure OpenAI service ^[1].

Unfortunately, I couldn't find specific information within the LangChain JS repository about where exactly in the Azure AI Foundry platform you can find the instance name. However, typically, this name is the one you assign to your Azure OpenAI resource when you create it in the Azure portal. You should be able to find it in the Azure portal under the "OpenAI" service section, where your resources are listed.

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}

[leockl]

@dosu is the value for the "azureOpenAIApiInstanceName" parameter in the "AzureChatOpenAI" class the entire endpoint URL or just part of the endpoint URL used to access the Azure OpenAI service?

[dosubot[bot]]

The value for the azureOpenAIApiInstanceName parameter is just a part of the endpoint URL, not the entire URL. It specifically refers to the name of your Azure OpenAI resource, which is used in constructing the full endpoint URL.

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}