Skip to content
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

feat: add default_headers for azure embeddings #8535

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nuernber
Copy link

Related Issues

Proposed Changes:

Follows the logic from AzureOpenAIGenerator for default_headers:

default_headers: Optional[Dict[str, str]] = None,

and
default_headers=self.default_headers,

How did you test it?

Ran the unit tests and also tested with my Azure set up that uses a subscription key.

Notes for the reviewer

Checklist

@nuernber nuernber requested review from a team as code owners November 12, 2024 03:37
@nuernber nuernber requested review from dfokina and Amnah199 and removed request for a team November 12, 2024 03:37
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Benjamin Nuernberger seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions bot added topic:tests type:documentation Improvements on the docs labels Nov 12, 2024
@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 11790285279

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 36 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.002%) to 90.141%

Files with Coverage Reduction New Missed Lines %
components/embedders/azure_text_embedder.py 12 67.39%
components/embedders/azure_document_embedder.py 24 54.29%
Totals Coverage Status
Change from base Build 11781566054: 0.002%
Covered Lines: 7744
Relevant Lines: 8591

💛 - Coveralls

@Amnah199
Copy link
Contributor

@nuernber thanks for the contribution. Can you please sign the CLA?

@@ -95,6 +96,7 @@ def __init__( # noqa: PLR0913 (too-many-arguments)
`OPENAI_TIMEOUT` environment variable, or 30 seconds.
:param max_retries: Maximum number of retries to contact AzureOpenAI after an internal error.
If not set, defaults to either the `OPENAI_MAX_RETRIES` environment variable or to 5 retries.
:param default_headers: Default headers to use for the AzureOpenAI client.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:param default_headers: Default headers to use for the AzureOpenAI client.
:param default_headers: Default headers to send to the AzureOpenAI client.

@@ -82,6 +83,7 @@ def __init__(
A string to add at the beginning of each text.
:param suffix:
A string to add at the end of each text.
:param default_headers: Default headers to use for the AzureOpenAI client.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:param default_headers: Default headers to use for the AzureOpenAI client.
:param default_headers: Default headers to send to the AzureOpenAI client.

@davidsbatista
Copy link
Contributor

@nuernber left a few comments - one question still, is the default_header an optional or mandatory parameter according to the Azureus API?

@Amnah199
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic:tests type:documentation Improvements on the docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support default_headers for AzureOpenAIDocumentEmbedder and AzureOpenAITextEmbedder
5 participants