Old project page: FTS CJK Search (old project page)

Note: see Glossary at the bottom for definitions of technical terms and acronyms.

I. Problem/Value Statement

Problem Statement:

Harvard Yenching Library has performed optical character recognition (OCR) on a large corpus of ancient Chinese texts (including some Japanese and Korean texts) in its collection, and now would like deposit that text to the Digital Repository Service (DRS), associate it with existing Page Delivery Service (PDS) objects and have the OCR be searchable.  Additionally, a large collection of modern Chinese Documents on Contemporary Chinese Politics has been purchased and digitized by the Harvard-Yenching Institute. The collection, including CJK OCR has been loaded to the DRS but is not currently searchable in Full Text Search (FTS) because FTS doesn't support CJK search. The CJK OCR should be searchable in FTS and deliverable in PDS.

In order to accommodate these two existing collections and future collections with CJK OCR, an ability to add OCR to existing DRS objects needs to be developed and FTS needs to be upgraded to enable CJK search and delivery of the results to PDS.

Business Value:

Updating FTS to enable CJK search will make it possible for researchers to ask exploratory questions of the data and get quick on-the-fly responses.  Full-text search means that these questions can be answered immediately, and so will be practical to investigate in many cases in which examining every page of a scanned text by hand to find out the answer would not be an option worth contemplating. Updating DRS to allow adding OCR to existing PDS objects will allow the OCR for ancient Chinese texts and OCR for many similar projects to enrich existing PDS documents in DRS with OCR as OCR technology for non-Latin languages matures and gets better.

II. Vision and Approach

Describe the solution:
The solution will consist of an upgraded FTS search index using Solr which will be additionally tuned to support the CJK requirements. The upgraded index will use the DRS indexing functions to support the updating and full text indexing of documents in the FTS search index. As part of this solution existing documents will need to be reindexed to support updated features within the Solr environment.The updated FTS search servlet will submit a search and return the results of a search submitted through PDS or through an FTS form, in keeping with the current FTS functionality. The PDS will display the resulting search and the relevant PDS document pages, in keeping with the current FTS functionality. The API used for these functions will be kept as consistent as possible.

DRS will be enhanced to allow batch loading of OCR files and linking them with existing DRS PDS documents. The newly updated documents will be automatically submitted for FTS indexing.

Deliverables/Work Products: 
Upgraded FTS that supports CJK search.

An enhancement to the DRS to support batch loading OCR files and linking them with existing DRS PDS documents.

These are the individual deliverables that will be part of this project:

• Upgrade of the indexing engine
• Develop the DRS OCR batch import function
• Upgrade of the index / ingest process
  • Includes re-indexing of existing objects
• Update of the search APIs
• Update of PDS to support new search solution
• Tuning of search index for CJK materials

The deliverables may represent sub-projects which may represent different interested parties and different sub-teams.

Define how to measure “done”:
The overall project is considered done once:

• Existing PDS documents are re-indexed with the CJK-enabled indexing engine
• Newly ingested PDS documents are indexed with the CJK-enabled indexing engine
• Full text search queries can be submitted through PDS and Full Text Search stand-alone forms
• Results of the full text searches are correctly displayed in PDS and FTS
• CJK OCR for the corpus of ancient Chinese texts (currently residing on Imaging Services servers) has been successfully bulk-added to existing PDS objects in DRS and these objects have been re-indexed
  • FTS searches against these PDS objects are working with CJK and the correct results are being displayed in PDS and FTS
    

This project will iterate in phases. For each phase a separate definition of "done" will be defined in the project plan.

In Scope:

• Support for CJK indexing and search in FTS, delivery of results to PDS.
• Enhancement to support bulk-adding CJK OCR to existing PDS objects in the DRS

Out of Scope (for medium and large projects):

• Tuning of the indexing engine for additional non-Latin languages is out of scope of this project
• Supporting bulk-adding of content or metadata to the DRS as a standard generalized DRS process is out of scope of this project

III. Stakeholders/People

Who is the work being done for? (Sponsor)

Suzanne Wones, Associate University Librarian for Digital Strategies and Innovation

What organizations, departments, or people will benefit from this work (for medium and large projects)

Harvard Yenching Library, Harvard Yenching Institute, faculty and researchers will benefit from this work

Who is funding the work?
Harvard Library is funding the supplemental resource assigned to this effort

Who will accept the work?
Suzanne Wones, Associate University Librarian for Digital Strategies and Innovation (or her designee) Sharon Yang, Librarian for Public Services and E-Resources at Harvard Yenching Library, and Elizabeth Perry, Director of the Harvard-Yenching Institute (or her designee) will accept this work

Who is the project manager?
Vitaly Zakuta is the project manager for this project

Who will be involved in doing the work (service area, department, etc …)? [Include name, project role, and estimated percentage of time per month for the project duration]

IV. Schedule and Cost

Schedule:

[include project phases, known reporting dates, and delivery deadlines]

Cost:

Cost Breakdown (for large projects):

V. Other

Constraints:

• May not finish all the stages of the project before we run out of budgeted resources (currently estimated at 6 months worth of work budgeted)

Assumptions:

• Language experts will be available from Harvard Yenching Library or Harvard Yenching Institute when needed in order to help tuning the search index for CJK
• The stakeholders, which are accepting the work, will be available to review iterated product releases on relatively short notice and accept them

Dependencies:

• Language experts need to be available from Harvard Yenching Library or Harvard Yenching Institute when needed in order to help tuning the search index for CJK
• Stable contractor relationship

Risks (description, plan, impact, owner):

• Sustainability plan 
• Contents are in various Chinese character sets (Modern vs Traditional Chinese) which would complicate tuning the index
• Contents are in additional languages besides Chinese (Japanese, Korean), which would complicate tuning the index
• The product may meet the "done" measurements but may not contain desired features beyond what was specified in the "definition of done."
• CJK upgrade may require changing other applications in the DRS ecosystem which is currently not planned as part of the project (this will not be definitely known until the upgrade is close to complete)
• Appropriate affiliation between CJK files and existing page images in the DRS is not correct or only partially correct
• Staged CJK OCR files (at Imaging Services or elsewhere) are not staged in the directory structure and using naming convention that are expected by the DRS

Glossary

CJK – Chinese, Japanese, Korean

DRS – Digital Repository Service

FTS - Full Text Search

OCR – Optical Character Recognition

PDS – Page Delivery Service

Solr – Indexing engine technology used by LTS