BUG: JS Client - Make embedding function parameter optional #4305
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.
Description of changes
Referenced in issue: #3730
In the JS Client the
embeddingFunction
parameter forgetCollection
is optional, but in the type definition the?
is missing making the type checker think it is a mandatory parameter.The docustring for getCollection, indicating that
embeddingFunction
is optional is here:chroma/clients/js/packages/chromadb-core/src/ChromaClient.ts
Line 392 in 69dc794
Summarize the changes made by this PR.
embeddingFunction: IEmbeddingFunction;
toembeddingFunction?: IEmbeddingFunction;
Test plan
How are these changes tested?
getCollection
with just aname
fieldgetCollection
is called without anembeddingFunction
Documentation Changes
These changes make the code allign with the
getCollection
docustring, so no changes required.