Create similarity API endpoints

This issue belongs to an archived project. You can view it, but you can't modify it. Learn more

XMLWordPrintable

    • Type: New Feature
    • Resolution: Fixed
    • Priority: Normal
    • None
    • Affects Version/s: None
    • Component/s: 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.

            Assignee:
            Aidan Lawford-Wickham
            Reporter:
            Aidan Lawford-Wickham
            Archiver:
            julian45

              Created:
              Updated:
              Resolved:
              Archived:

                Version Package