Skip to content

Add "tag" as a parameter in OrcaHello API  #127

Closed
@scottveirs

Description

@scottveirs

As a bioacoustician looking for patterns in OrcaHello moderated candidates,
I want to be able to include any "tags" added by moderators when I am requesting detections from the OrcaHello API,
at least for the GET detections API call.

Proposed solution

As of early 2023, it is possible to request all detections via
https://aifororcasdetections.azurewebsites.net/api/detections or subsets of detections via, for example https://aifororcasdetections.azurewebsites.net/api/detections/falsepositives. The result includes any tags added to candidates by OrcaHello moderators, in JSON format, e.g. "tags": "jingle;mystery" and these can be parsed to study temporal or spatial patterns in the tags. This is exciting and useful because it enables bioacousticians to analyze tagged detections to understand the source of a "mystery" sound, or to look for differences in confirmed SRKW signals -- between pods, matrilines, locations, or over time.

This data exploration could be accelerated and integrated with other Orcasound visualization efforts, like the bioacoustic dashboard, by enhancing the OrcaHello API. The proposed solution is to add a tag parameter to the GET API detection calls so that the response only includes candidates that have that single tag.

A stretch goal would be to allow an array of tags to specified in the new tag parameter with OR and AND logic. For example, this could allow a bioacoustician to efficiently explore SRKW calls, but only S01 or S16 calls made by a single pod.

Metadata

Metadata

Labels

2023-hackathonGoals or topics for the 2023 annual Microsoft hackathonAddressed by #155enhancementNew feature or requestmoderator portalIssues pertaining to ModeratorPortal at https://aifororcas.azurewebsites.net

Type

No type

Projects

  • Status

    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions