Add nearest neighbors support #1182
Open
Conversation
This file contains 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
mvanschellebeeck
force-pushed
the
mv/knn
branch
from
66f0550 to
c6b924f
Compare
mvanschellebeeck
force-pushed
the
mv/knn
branch
from
c6b924f to
cabac0a
Compare
ssanjay1
reviewed
Feb 7, 2025
| | { | ||
| [K in L]?: "asc" | "desc"; | ||
| } | ||
| | "relevance"; |
There was a problem hiding this comment.
Can we not sort by ascending or descending relevance as well?
There was a problem hiding this comment.
Nope.
By default, nearest neighbors returns objects with the highest scores first, so sorting by relevance is equivalent to sorting by score in descending order.
| * @param query - Queries support either a vector matching the embedding model defined on the property, or text that is | ||
| automatically embedded. | ||
| * @param numNeighbors - The number of objects to return. If the number of documents in the objectType is less than the provided | ||
| value, all objects will be returned. This value is limited to 1 ≤ numNeighbors ≥ 500. |
There was a problem hiding this comment.
nit: I'm not actually sure how &le will render, does throwing in < not work?
There was a problem hiding this comment.
Yeah, when I used <, the markdown would show:
// Warning: (tsdoc-malformed-html-name) Invalid HTML element: Expecting an HTML name
| @@ -235,318 +235,28 @@ exports[`Load Ontologies Metadata > Loads action types with media refs, interfac | |||
| This is some more text.", | |||
| "rid": "rid", | |||
| }, | |||
| "startDate": { | |||
There was a problem hiding this comment.
Hmm why this large diff in the snapshots?
| @@ -147,6 +147,65 @@ describe("ObjectSet", () => { | |||
| expect(iter).toEqual(2); | |||
| }); | |||
|
|
|||
| it("nearest neighbors object set", async () => { | |||
| const numNeighbors = 3; | |||
| const nearestNeighborsObjectSet = client(Employee).nearestNeighbors( | |||
There was a problem hiding this comment.
Can we add some type tests in here to make sure the type of the call signature is what we expect?
mvanschellebeeck
force-pushed
the
mv/knn
branch
from
c53a50f to
3695874
Compare
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.
Add
nearestNeighborquery support.See runNearestNeighborsTest.ts for example usage