Research what fields document_highlights are searching

[patphongs]

What we’re after

Keyword search is searching more than just documents. In the code, it is searching for: Highlight searched: "text", "name", "no", "summary", "documents.text", "documents.description". We need to find out what each of these things are so we can better explain to the user.

Maybe we don't need to include no? Are all of the fields relevant?

Action item(s)

(These are the smaller tasks that should happen in order to complete this work)

• List out and define all of the searched fields of keyword search

Completion criteria

(What does the end state look like - as long as this task(s) is done, this work is complete)

• We have the dictionary above

[tmpayton]

Here is a list of definitions for all of the searched fields. Some of the definitions differ based on document type.

Document type	Text	Name	No	Summary	Documents.text	Documents.description
Statutes	Full text of a section of a statute	Section subheading	Section number of a statute	N/A	N/A	N/A
MUR	N/A	Primary respondent	MUR number	N/A	Full text from all documents related to a matter under review	Titles of all the related documents
ADR	N/A	Primary respondent	ADR number	N/A	Full text from all documents related to an alternative dispute resolution	Titles of all the related documents
AF	N/A	Committee_name	AF number	N/A	Full text from all documents related to an admin fine case	Titles of all the related documents
Archived MUR	N/A	N/A	MUR number	N/A	Full text of the archived MUR	N/A
AO	N/A	Requestor	AO number	A short summary of the advisory opinion subject	Full text from all documents related to the advisory opinion	Titles of all the related documents

Documents (documents.text and documents.description) refer to all documents related to a case/number. For instance AO 2024-05 has 11 related documents such as final opinion, drafts, and comments. So documents.text refers to the full text from all 11 of those documents and documents.description refers to the titles of those 11 documents.

I think for now we should keep the no field because it is helpful when searching for statute section numbers.