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

Implementation Plan: Determine and design how machine-generated tags will be displayed/conveyed in the API #4038

Closed
Tracked by #431
AetherUnbound opened this issue Apr 4, 2024 · 0 comments · Fixed by #4189
Assignees
Labels
📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧭 project: implementation plan An implementation plan for a project 🧱 stack: documentation Related to Sphinx documentation

Comments

@AetherUnbound
Copy link
Collaborator

AetherUnbound commented Apr 4, 2024

Description

Implementation plan for #431

Context: https://docs.openverse.org/projects/proposals/rekognition_data/20240320-project_proposal_rekognition_data.html#api

Draft an implementation plan for determining how machine-generated labels will be conveyed in the API. This may leverage the accuracy and provider keys within the array of objects in the tags field. It should be relatively easy to expose the provider in the tags field on the API by adding it to the TagSerializer

Special care will need to be taken when determining how to handle multiple instances of a machine-generated tag. We will need to consider one of the following approaches for resolving this in Elasticsearch:

  • Prefer creator-generated tags and exclude machine-generated tags
  • Prefer machine-generated tags and exclude creator-generated tags
  • Keep both tags, acknowledging that this will increase the score of a particular result for searches that match said tag
  • Prefer the creator-generated tags, but use the presence of an identical machine-labeled tag to boost the score/weight of the creator-generated tag in searches
@AetherUnbound AetherUnbound added 🌟 goal: addition Addition of new feature 📄 aspect: text Concerns the textual material in the repository 🟨 priority: medium Not blocking but should be addressed soon 🧭 project: implementation plan An implementation plan for a project 🧱 stack: documentation Related to Sphinx documentation labels Apr 4, 2024
@openverse-bot openverse-bot moved this to 📋 Backlog in Openverse Backlog Apr 4, 2024
@AetherUnbound AetherUnbound self-assigned this Apr 4, 2024
@AetherUnbound AetherUnbound moved this from 📋 Backlog to 📅 To Do in Openverse Backlog Apr 4, 2024
@openverse-bot openverse-bot moved this from 📅 To Do to 🏗 In Progress in Openverse Backlog Apr 23, 2024
@openverse-bot openverse-bot moved this from 🏗 In Progress to ✅ Done in Openverse Backlog May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧭 project: implementation plan An implementation plan for a project 🧱 stack: documentation Related to Sphinx documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant