fix: HuggingFace embedder configuration validation error (#3995) #3996
+4,765
−4,201
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.
Summary
Fixes GitHub issue #3995 where users couldn't configure the HuggingFace embedder with the documented configuration format (
api_key,model,api_url).The root cause was that
HuggingFaceProviderwas using ChromaDB'sHuggingFaceEmbeddingServer(which requires aurlparameter for custom embedding servers) instead ofHuggingFaceEmbeddingFunction(which uses the HuggingFace Inference API withapi_keyandmodel_name).Changes:
HuggingFaceEmbeddingServertoHuggingFaceEmbeddingFunctionapi_key,model_name, andapi_key_env_varfields with appropriate validation aliasesapi_url/urlfor compatibility with docs but exclude frommodel_dump(not used by Inference API)HuggingFaceProviderConfigTypedDict with new fieldsReview & Testing Checklist for Human
api_urlbeing silently ignored is acceptable - The field is accepted for compatibility with the documented config but excluded from the underlying call. Users might expect it to configure a custom endpoint. Consider if a warning should be logged.urland usedHuggingFaceEmbeddingServer. Verify no existing users depend on that behavior (search for"provider": "huggingface"usage in production).Notes