Fix: Correct parameter name in _encode method for BGEM3FlagModel #45
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.
Fix: BGEM3EmbeddingFunction encode() parameter mismatch
Issue
When using the
BGEM3EmbeddingFunction
class, users encounter the following error:This occurs because the
_encode()
method is usingsentences
as the parameter name when callingself.model.encode()
, but the underlyingBGEM3FlagModel
expects the parameter to be namedqueries
.Solution
Changed the parameter name in the
_encode()
method fromsentences
toqueries
to match the expected parameter name of the underlying model:Testing
BGEM3EmbeddingFunction
and successfully encoding both documents and queriesAdditional Context
This fix aligns with the FlagEmbedding implementation which uses
queries
as the parameter name in its encode method.Related Issues
Resolves the error reported in various contexts where users attempt to use the BGE-M3 model with Milvus.