-
Notifications
You must be signed in to change notification settings - Fork 458
docs: Adding in Docs for using Azure Default Credential Callable with OpenAI #1160
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds documentation for using ChatOpenAI and OpenAIEmbeddings with Azure OpenAI's v1 API, including Microsoft Entra ID authentication support. The changes introduce new sections explaining how to configure these classes for Azure endpoints while maintaining backward compatibility references to the Azure-specific implementations.
Key changes:
- Added comprehensive Azure OpenAI v1 API usage documentation for both chat and embeddings
- Documented Microsoft Entra ID authentication with token provider callables
- Added informational notes about the new v1 API across relevant pages
- Fixed a typo in the ChatOpenAI documentation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/oss/python/integrations/text_embedding/openai.mdx |
Added new "Using with Azure OpenAI" section documenting v1 API support with API key and Microsoft Entra ID authentication methods |
src/oss/python/integrations/chat/openai.mdx |
Added new "Using with Azure OpenAI" section with similar authentication patterns and fixed spelling typo ("instaed" → "instead") |
src/oss/python/integrations/chat/azure_chat_openai.mdx |
Added informational banner about v1 API availability and recommendations for migrating to newer approaches |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
Overview
This PR adds documentation for the new callable API key feature in
ChatOpenAI,OpenAI, andOpenAIEmbeddingsclasses, introduced in langchain-ai/langchain#33532.The documentation covers:
ChatOpenAIandOpenAIEmbeddingswith Azure OpenAI's new v1 API endpointsType of change
Type: Update existing documentation
Related issues/PRs
Checklist
make lint_mdsrc/docs.jsonif needed (not applicable - added sections to existing pages)Additional notes
Changes made:
src/oss/python/integrations/chat/openai.mdx:src/oss/python/integrations/chat/azure_chat_openai.mdx:AzureChatOpenAIremains supported for traditional API versionssrc/oss/python/integrations/text_embedding/openai.mdx:Key features documented:
api_keyparameterChatOpenAIwith Azure endpoints using/openai/v1/pathget_bearer_token_providerfrom Azure IdentityAll markdown linting issues have been addressed, and no new linting errors were introduced.