AzureOpenAIEmbeddings with Azure Entra-Id Authentication

[thusithaC]

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

No code for now

Description

I'm trying to use AzureOpenAIEmbeddings class for an internal (work) application. We have a Azure Private endpoint enabled for ada-002 model.

The authentication is based on service principles. A good example on how Auth would work for the openai chat completion API is shown here https://github.com/LazaUK/AOAI-EntraIDAuth-SDKv1?tab=readme-ov-file#scenario-3-authenticating-with-entra-id---service-principal.

The problem I am facing is since AzureOpenAIEmbeddings does not accept Entra-id based authentication for the underlying openai client but expects a OPENAI_API_KEY key to be provided. Is there a workaround for this?

System Info

Not a bug, so not helpful.

[dosubot[bot]]

🤖

Hey @thusithaC, back at it with another interesting challenge, I see! Good to have you around.

Based on the LangChain codebase, it appears that the AzureOpenAIEmbeddings class does support Azure AD token-based authentication. This can be done either directly using the azure_ad_token field or via a function provided to the azure_ad_token_provider field.

Here's an example of how you can use the azure_ad_token_provider field:

from langchain_openai import AzureOpenAIEmbeddings

def my_token_provider():
    # Your logic to get the Azure AD token
    return "your_azure_ad_token"

openai = AzureOpenAIEmbeddings(
    model="text-embedding-3-large", 
    azure_ad_token_provider=my_token_provider
)

In this example, my_token_provider is a function that should return your Azure AD token. This function will be called on every request to get a fresh token.

Alternatively, if you want to use the azure_ad_token field directly, you can do it like this:

from langchain_openai import AzureOpenAIEmbeddings

openai = AzureOpenAIEmbeddings(
    model="text-embedding-3-large", 
    azure_ad_token="your_azure_ad_token"
)

In this case, you need to make sure that your token is valid for the duration of your application, as it won't be refreshed automatically.

You can find more details in the AzureOpenAIEmbeddings class definition.

Please let me know if this helps or if you need further assistance.

Sources

• libs/partners/openai/langchain_openai/embeddings/azure.py

---

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

[thusithaC]

Thanks! this is great. Didn't find in the doco.

[fhupsel-peers]

does anyone here know if i can use aad auth on azureChatOpenAi class? I have the same scenario