feat: add support for custom headers #4040
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
allow users to specify additional headers they want to pass when sending
requests to the weavate server
Related Issues
Proposed Changes:
Add additional_headers parameter to the weaviate document store's constructor. This parameter contains a dictionary of headers that the weaviate client will pass to the weaviate server each time a request is time.
For example, users can pass their OpenAI key using:
additional_headers = {'X-OpenAI-Api-Key': 'KEY'}
How did you test it?
I'm not sure how to test this. Please advise.
Notes for the reviewer
Should we remove the
raise NotImplementedError("WeaviateDocumentStore does not support headers.")
and replace with a warning message saying that the headers will be ignored because in weaviate, the headers are configured when the client is initialized, not when a query is made.Checklist
fix:
,feat:
,build:
,chore:
,ci:
,docs:
,style:
,refactor:
,perf:
,test:
.