Uploaded image for project: 'Zapped: AcousticBrainz'
  1. Zapped: AcousticBrainz
  2. AB-415

Create similarity API endpoints

XMLWordPrintable

    • Icon: New Feature New Feature
    • Resolution: Fixed
    • Icon: Normal Normal
    • None
    • None
    • Server
    • None

      After building indices to query for similarity in AB-414, 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:

      1. 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.
      2. 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.
      3. 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.

            aidanlw17 Aidan Lawford-Wickham
            aidanlw17 Aidan Lawford-Wickham
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved:

                Version Package