-
Notifications
You must be signed in to change notification settings - Fork 25
v6: Simplify WeaviateObject interface #503
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
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Secrets | View in Orca |
This is _definitely_ a server-side issue and needs investigating
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR is decouples "read-objects" (returned from queries) from "write-objects" (used to insert new objects in a collection. This allows us to get rid of the 2 generic parameters (R -> reference type, and M -> metadata type), which also depended on the context in which the object was being used.
Since the values for generic types were strictly bound to the context, they did not offer any additional benefit to the end user and only added unnecessary burden (more typing + more thinking about generics).
The new approach is to have dedicated
WriteWeaviateObject, which exposes all fields a user can set when inserting new objects, and aReadWeaviateObject, which holds query metadata and retrieved reference objects (if any).Previously WeaviateObject class could be used in
Reference.objects()to insert newly created / retrieved objects as references. We cover that use case by makingWeaviateObjectan interface that both read- and write- variants implement.This works:
The syntax for providing a custom UUID and vector is simplified too: instead of putting these behind a
metadatacall, the builder for WriteWeaviateObject has methods to set them directly:Adding multiple vectors is simpler too, as
.vectors()calls can now be chained.When iterating over a list of vectors from another source, it is not necessary to collect them in a
Vectors[]first, as it was before.Call
object.vectors().size()to see how many vectors were inserted / retrieved.N.B.:
ReadWeaviateObjectdoes not have thetenantfield, because it's not part of the server's response.