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

Improve full-text searching by expanding reference primary #100

Closed
7 tasks done
prowns opened this issue Apr 12, 2024 · 9 comments
Closed
7 tasks done

Improve full-text searching by expanding reference primary #100

prowns opened this issue Apr 12, 2024 · 9 comments
Assignees
Labels
important Priority Level: 2 (Important Priority). This issue needs to be addressed sooner than normal issues. search

Comments

@prowns
Copy link

prowns commented Apr 12, 2024

Problem Description:
All records (YPM, AAT, Wikidata, GBIF) have the same primary name: Equus Caballus. Most users would search "horse". The issue is raised by art museums, who use Horse as subject heading, and include this in their data under "represents". Discussion surfaced an inconsistency in how simple search is working.

Question: how is simple search working? It is not consistent for this use case.

  • boxley horse retrieves the right records
  • boxley sheep does NOT retrieve the right record (this one) but it should as Ovis is listed in Depicts.

Expected Behavior/Solution:
Simple search should work such that boxley sheep would retrieve the correct record, even though the primary name is Ovis.

Change simple search to use referenceName instead of referencePrimaryName

Make the same change for the Name field in Advanced Search.

More detailed description of changes:

  1. The related documents portion of the keyword search pattern switched from the referencePrimaryName field to the referenceName field. By search scope, here are the record types that included or excluded from reference fields:
    • Included:
      • Agent: Group, Person
      • Concept: Language, MeasurementUnit, Type
      • Event: Activity, Period
      • Place: Place
    • Excluded:
      • Concept: Currency, Material
      • Item: DigitalObject, HumanMadeObject
      • Work: LinguisticObject, Set, VisualItem
  2. All name search terms less the set search scope switched from their search scope-specific primary name field to their broader name field; for instance, the name search term in the agent scope was changed from agentPrimaryName to agentName.

Requirements:

  • New Simple Search index name will be referencePrimaryName
  • Advanced Search name field will use the extended index in Simple Search (referencePrimaryName)

Needed for promotion:
If an item on the list is not needed, it should be crossed off but not removed.

  • Wireframe/Mockup - Mike
  • Committee discussions - Sarah
  • Feasibility/Team discussion - Sarah
  • Performance test
  • Backend requirements - TBD
  • Frontend requirements- TBD
  • Questions
  • List of questions for discussions. Answers should be documented within the issue.

UAT/LUX Examples:

The searches below should show this record in the results: https://lux.collections.yale.edu/view/visual/b50fb93f-dc1d-4e49-a3b8-acc1cfd4a174

Dependencies/Blocks:

  • Blocked By: Issues that are blocking the completion of the current issue.
  • Blocking: Issues being blocked by the completion of the current issue.

Related Github Issues:

  • Issues that contain similar work but are not blocking or being blocked by the current issue.

Related links:

Wireframe/Mockup:
Place wireframe/mockup for the proposed solution at end of ticket.

@prowns
Copy link
Author

prowns commented Apr 23, 2024

Horse is a primary name in Equus Caballus, but not labelled as english. This is why it appears, but Ovis does not have this. @clarkepeterf will try using the referencename index to in DEV so it can be reviewed. This include anything in identifedBy with type of name.

@clarkepeterf
Copy link
Contributor

clarkepeterf commented Apr 24, 2024

Preliminary deployment in DEV looks good. Propose to also do the following:

  • change LUX JSON name searches to use the [scope]Name fields instead of [scope]PrimaryName.
  • add a new LUX JSON primaryName field in each scope which uses [scope]PrimaryName

@prowns
Copy link
Author

prowns commented Apr 26, 2024

Per Interactions 4/25

  • New Simple Search name index is great; will continue testing
  • Advanced Search
    • Name search should used this extended index as well
    • No need for a separate “primary” name option in Adv. Search

@prowns
Copy link
Author

prowns commented Apr 29, 2024

Performance test needed before this is deployed.

@brent-hartwig
Copy link
Contributor

@clarkepeterf, #11 (comment) captures related comparisons.

clarkepeterf pushed a commit that referenced this issue May 9, 2024
… term to use setName index field, as that does not exist yet)
@prowns prowns added the blocked Issues can't move forward because it is blocked by other repo issues, data, discussion, etc. label May 10, 2024
@prowns
Copy link
Author

prowns commented May 10, 2024

Performance tests on 5/9 failed; still determining if issue is with this issue or ML.

@roamye roamye added the important Priority Level: 2 (Important Priority). This issue needs to be addressed sooner than normal issues. label May 16, 2024
@roamye roamye removed the blocked Issues can't move forward because it is blocked by other repo issues, data, discussion, etc. label Jun 21, 2024
@roamye
Copy link

roamye commented Jun 21, 2024

IT meeting 6/21:
Performance test 6/7 results are successful. This ticket is no longer blocked and will be deployed in 6/24 cycle.

brent-hartwig added a commit that referenced this issue Jul 1, 2024
brent-hartwig added a commit that referenced this issue Jul 1, 2024
@clarkepeterf clarkepeterf added the Awaiting Review The issue has been deployed and a review is required to close it. label Jul 9, 2024
@roamye
Copy link

roamye commented Jul 12, 2024

Approved by UAT

@roamye
Copy link

roamye commented Jul 16, 2024

Looks good in prod! Closing.

@roamye roamye closed this as completed Jul 16, 2024
@brent-hartwig brent-hartwig removed the Awaiting Review The issue has been deployed and a review is required to close it. label Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
important Priority Level: 2 (Important Priority). This issue needs to be addressed sooner than normal issues. search
Projects
None yet
Development

No branches or pull requests

6 participants