AB-415: Create similarity API endpoints #355
Closed
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
aidanlw17
changed the title
- Adds tests for adding/deleting metrics
|
Closed as the content of this PR is covered in #364. |
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.
AB-415: Create similarity API endpoints
After building indices, we need to create endpoints that will allow users to interact with the similarity data that we have computed. In order to do this, we should start by creating the following endpoints:
Get similar recordings
/api/v1/uuid:mbid/similarity
This endpoint should take required parameters that are the metric to be used, and the MBID in question, with an optional parameter for the offset. For now, it will also accept index parameters which are the number of trees in the index, and the distance type. These parameters will allow us to select specific index builds while we are evaluating the effectiveness of parameter combinations.
Get bulk similar recordings
/api/v1/similarity
This endpoint takes the same index parameters metric, distance type, and number of trees as the single get similar recordings endpoint, however instead of taking mbid and offset parameters, it should accept a list of recordings similarly to other bulk endpoints.
Get similarity between recordings
/api/v1/<uuid(strict=False):mbid>/<uuid(strict=False):mbid>/similarity
This will return the distance (vector) for similarity between two specified recordings.