Display instrument to instrument similarities in front end

[woodthom2]

Description

The API is now calculating an instrument to instrument similarity. e.g. the GAD-7 is e.g. 60% similar to the PHQ-9
See this PR for more details: harmonydata/harmony#81

Please can we display them in a nice way in the UI

You can see this in the call to /text/match, e.g.:

curl -X 'POST' \
  'http://localhost:8000/text/match?include_catalogue_matches=false&is_negate=true' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "instruments": [
    {
      
      "questions": [
        {
          "question_text": "Feeling nervous, anxious, or on edge"
        },
        {
          "question_text": "Not being able to stop or control worrying"
        }
      ]
    },
    {
      "questions": [
        {
          "question_text": "Sentir-se nervoso/a, ansioso/a ou muito tenso/a"
        },
        {
          "question_text": " Não ser capaz de impedir ou de controlar as preocupações"
        }
      ]
    }
  ]
}'

{
  "instruments": [
  
///... ///
    }
  ],
   "instrument_to_instrument_similarities": [
    {
      "instrument_1_idx": 0,
      "instrument_2_idx": 1,
      "instrument_1_name": "GAD-7 English",
      "instrument_2_name": "GAD-7 Portuguese",
      "precision": 1,
      "recall": 1,
      "f1": 1
    }
  ],
...

Rationale

Many users have requested this feature.

[ronnyTodgers]

Looks really good! so we'd want an instrument view displaying instrument to instrument, should this be primary do you think?

[woodthom2]

It could be on the first page - don't know what users would expect? but I think definitely it's much more concise than the item to item similarity - maybe it needs a UX discussion?

…

On Sat, 25 Jan 2025 at 19:03, ronnyTodgers ***@***.***> wrote: Looks really good! so we'd want an instrument view displaying instrument to instrument, should this be primary do you think? — Reply to this email directly, view it on GitHub <#43 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADUBTVO5X53JKA64AKKHGT32MPNZZAVCNFSM6AAAAABV3QO4NOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJUGA3DONZWGU> . You are receiving this because you authored the thread.Message ID: ***@***.***>