Skip to content

[BUG] Default embedding function in JS did not create the correct config dict #4539

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

Merged
merged 1 commit into from
May 14, 2025

Conversation

jairad26
Copy link
Contributor

@jairad26 jairad26 commented May 14, 2025

Description of changes

The Default EF in javascript incorrectly sets the config name to model_name, when the schema requires model. This PR fixes that.

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs section?

Copy link
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@jairad26 jairad26 force-pushed the jai/fix-js-default-config branch from 540352a to 827027b Compare May 14, 2025 00:41
@jairad26 jairad26 marked this pull request as ready for review May 14, 2025 00:42
Copy link
Contributor

Fix Default Embedding Function Configuration in JavaScript Client

This PR fixes a bug in the JavaScript client's DefaultEmbeddingFunction where the configuration dictionary incorrectly used 'model_name' as a key instead of 'model' as required by the schema. The PR changes all relevant references from 'model_name' to 'model' in the interface definition and methods that use it.

Key Changes:
• Changed StoredConfig interface to use 'model' instead of 'model_name'
• Updated getConfig(), buildFromConfig(), and validateConfigUpdate() methods to use the correct field name
• Bumped version numbers from 2.4.3 to 2.4.4 across package.json files

Affected Areas:
• JavaScript client DefaultEmbeddingFunction
• Package versions in package.json files

This summary was automatically generated by @propel-code-bot

@philipithomas
Copy link
Member

I'll merge and release tomorrow morning

@philipithomas philipithomas merged commit 7ecd59a into main May 14, 2025
13 checks passed
@philipithomas philipithomas deleted the jai/fix-js-default-config branch May 14, 2025 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants