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

IIIF content search service #5793

Open
7 tasks done
elynema opened this issue Apr 19, 2024 · 2 comments
Open
7 tasks done

IIIF content search service #5793

elynema opened this issue Apr 19, 2024 · 2 comments
Assignees

Comments

@elynema
Copy link
Contributor

elynema commented Apr 19, 2024

Description

Create an API wrapper around Solr that submits the appropriate query and returns results formatted as IIIF content search results. At this time, we are just implementing the q search parameter, as others are optional.

IIIF content search API: https://iiif.io/api/search/2.0/

See #5786 for suggestion of format for search results

Done Looks Like

  • Search service available on masterfiles (other objects out of scope for now)
  • Service route example URI: avalon.xyz/master_files/ft848q60n/search?q=searchterm"
  • Service returns results only for transcripts associated with the masterfile
  • Each match result provides one annotation:
    • Annotation targets specific transcript routes, with time fragments for timed text sources (.vtt)
    • Annotation target refers to the URI for the body of the original annotation, which is a stable identifier
  • annotation motivation should match the motivation of the original annotation (ex: supplementing)
@masaball masaball self-assigned this May 17, 2024
@elynema
Copy link
Contributor Author

elynema commented May 22, 2024

Per conversation at Swarm on 5/22, we approved using a search service route that references the master_file directly and looks like:
avalon.xyz/master_file/ft848q60n/search?q=searchterm

@elynema
Copy link
Contributor Author

elynema commented May 22, 2024

Per the #search channel in IIIF slack, recommend that the motivation used for the annotation in the search response is the same as the motivation from the original annotation. In our case, that motivation = supplementing, since we currently only have supplementing motivations. In the future, we might have other types of annotations, though!

image.png

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

2 participants