Skip to content

Optional fields for get and query - #845

Closed
jeffchuber wants to merge 1 commit into
mainfrom
dropEmbeddingsIfNotIncluded
Closed

jeffchuber wants to merge 1 commit into
mainfrom
dropEmbeddingsIfNotIncluded

Conversation

@jeffchuber

@jeffchuber jeffchuber commented Jul 18, 2023 •

Copy link
Copy Markdown
Contributor

This PR aims to clear up communication around what data users get back when using .get and .query

Specifically this issue: https://docs.trychroma.com/troubleshooting#using-get-or-query-embeddings-say-none

This PR updates get and query to only send back the fields you request. To add extra communication, we pass back a new field called included_fields that tells you what was included. This is added because we have defaults that a user may not be familiar with.
Screenshot 2023-07-18 at 1 25 29 PM

If we like this direction: I will continue on and add tests for it and make sure it operates well with the JS client.

NOTE: I expect tests to fail right now!

@jeffchuber
jeffchuber requested review from HammadB and atroyn July 18, 2023 20:29
@github-actions

Copy link
Copy Markdown

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 (Readbility, Modularity, Intuitiveness)

@HammadB HammadB closed this Aug 14, 2023
@HammadB

HammadB commented Aug 14, 2023

Copy link
Copy Markdown
Contributor

Offline discussion with @atroyn - this is not the approach we want so closing this out.

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