Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Demo tool to stakeholders #69

Closed
Rabshab opened this issue Nov 25, 2019 · 1 comment
Closed

Demo tool to stakeholders #69

Rabshab opened this issue Nov 25, 2019 · 1 comment
Assignees

Comments

@Rabshab
Copy link
Contributor

Rabshab commented Nov 25, 2019

Get feedback from Rory about current prototype

@rorads
Copy link

rorads commented Nov 25, 2019

Thoughts from an initial look at the tool:

Wishlist

  • Inclusion of IATI Identifier in returned results. This this would allow for linking out to DevTracker or D-Portal, meaning that results could be easily inspected for other attributes (such as project partners, locations, etc.)
  • The reporting-org identifier of the activity. It's not always easy to deduce the publisher of each activity, so this would be useful to quickly aggregate if there were many results (i.e. 25% of the top 100 matched activities were published by .
  • Some numerical rating of similarity according to the algorithm used i.e. the top result would have the lowest/highest 'score'. Granted, this will be different for each algorithm - not important to normalise between them IMO, just useful to have a sense of proximity between searches in the same algorithm. For instance knowing that the 'best' result for search x is 'better' than the 'best' for search y would be useful in understanding and confidently using the results.
  • Minimally, a simple JSON endpoint including the fields above, with a fairly high maximum number list. I'm imagining something like this:
{
  "array": [
    {
      "iati_identifier": "XM-DAC-12345-abcde",
      "reporting_org": "XM-DAC-12345",
      "title": "Project tite text. Project title text. etc.",
      "description": "Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. etc.",
      "proximity": "0.835"
    },
    {
      "iati_identifier": "GB-COH-12345-abcde",
      "reporting_org": "XM-COH-12345",
      "title": "Project tite text. Project title text. etc.",
      "description": "Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. etc.",
      "proximity": "0.735"
    },
    {
      "iati_identifier": "XI-IATI-12345-abcde",
      "reporting_org": "XI-IATI-12345",
      "title": "Project tite text. Project title text. etc.",
      "description": "Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. Project description text. etc.",
      "proximity": "0.835"
    },
    {
      "iati_identifier": "ETC",
      "reporting_org": "etc",
      "title": "Etc.",
      "description": "Etc.",
      "proximity": "0.123"
    }
  ]
}

API Discussion

The above JSON example is just a point of reference, and shouldn't supervene on discussions about API specification, but rather inform our requirements etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants