Skip to content

[ENH]: return error on /add if embeddings are not provided #5033

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
Jul 6, 2025

Conversation

codetheweb
Copy link
Contributor

@codetheweb codetheweb commented Jul 6, 2025

Description of changes

Our official clients prevent this but the server does not have a check. A better solution is making AddCollectionRecordsPayload.embddings non-optional, but this works as a minimal patch for now.

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?

n/a

Copy link

github-actions bot commented Jul 6, 2025

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)

@codetheweb codetheweb marked this pull request as ready for review July 6, 2025 15:28
Copy link
Contributor

This PR adds server-side validation to the /add endpoint, ensuring an error is returned when embeddings are not provided in the AddCollectionRecordsPayload. A new ValidationError variant, MissingEmbeddings, was introduced and mapped to an invalid argument error code.

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

@blacksmith-sh blacksmith-sh bot deleted a comment from codetheweb Jul 6, 2025
@codetheweb codetheweb merged commit a9519d4 into main Jul 6, 2025
113 of 115 checks passed
@codetheweb codetheweb deleted the fix-error-if-embeddings-missing branch July 6, 2025 17:10
chroma-droid pushed a commit that referenced this pull request Jul 6, 2025
## Description of changes

Our official clients prevent this but the server does not have a check.
A better solution is making `AddCollectionRecordsPayload.embddings`
non-optional, but this works as a minimal patch for now.

## Test plan

_How are these changes tested?_

- [x] 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](https://github.com/chroma-core/chroma/tree/main/docs/docs.trychroma.com)?_

n/a
codetheweb added a commit that referenced this pull request Jul 6, 2025
This PR cherry-picks the PR #5033 onto release/2025-06-27. If there are
unresolved conflicts, please resolve them manually.
Inventrohyder pushed a commit to Inventrohyder/chroma that referenced this pull request Aug 5, 2025
…re#5033)

## Description of changes

Our official clients prevent this but the server does not have a check.
A better solution is making `AddCollectionRecordsPayload.embddings`
non-optional, but this works as a minimal patch for now.

## Test plan

_How are these changes tested?_

- [x] 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](https://github.com/chroma-core/chroma/tree/main/docs/docs.trychroma.com)?_

n/a
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.

1 participant