Field Search
Canopy’s Fields Search feature allows you to refine your results by searching within specific fields. This guide explains how to construct queries using Meta Field Properties to target particular fields in Canopy.
To perform a field-specific search, enter the Meta Field Property name, followed by a colon (:), your search terms, and any necessary operators into the search bar.
In Canopy version 4.0 and later, users can customize their search strategy by utilizing two modes: Precision and Recall.
By default, field search utilizes Precision Search. To switch to Recall Search, simply add .recall to your field search query. The option to use .precision is available if you want to explicitly indicate that you are using Precision Search. Here are some examples:
subject:reportreturns Precision Search results for the Subject field that contain the word"report"subject.recall:reportreturns Recall Search results for the Subject field that contain the word"report"subject.precision:reportreturns Precision Search results for the Subject field that contain the word"report"
For a completed list of fields mapped by Canopy, refer to the Fields guide.
In Canopy Version 4.0 and later, the Meta Field Property name is simply the snake_case version of the displayed Field Name.
Use the following syntax when specifying field names in your queries. Please note that Meta Field Properties are case-sensitive.
| Field Name | Meta Field Properties (Releases > 4.0) | Field Type | Examples |
|---|---|---|---|
| All Family IDs | all_family_ids | Keyword | all_family_ids:<family ids>all_family_ids:"2FG2G55FGF; 3FG2G55FGF" |
| All Parent IDs | all_parent_ids | Keyword | all_parent_ids:<parent ids>all_parent_ids:"2FG2G55FGF; 3FG2G55FGF" |
| All Source Paths | all_source_path | Keyword | all_source_path:<all_source_path>all_source_path:master* |
| Alt Workflow Reviewer | alt_workflow_reviewer | Keyword | alt_workflow_reviewer:<reviewer_name> |
| Alt Workflow Reviewer Email | alt_workflow_reviewer_email | Keyword | alt_workflow_reviewer_email:<email> |
| Alt Workflow Tags | alt_workflow_tags | Keyword | alt_workflow_tags:<user-created-tags> |
| Audio Duration | audio_duration | Long | audio_duration:<value in seconds>audio_duration:>30.0 |
| Author | author | Keyword | author:<author name>author:"jane doe" |
| Auto-detected PII | pii.[element search name] | pii.<element search name>:<detected element>pii.name:"Jane Doe" | |
| Auto Review Confidence Level | auto_review_confidence_level | Keyword | auto_review_confidence_level:<level of confidence>auto_review_confidence_level:high |
| Auto Review Entity Count | auto_review_entity_count | Long | auto_review_entity_count:<number of entities>auto_review_entity_count:[10 TO 25] |
| Batch | batch | Keyword | batch:<batch name>batch:"prefix_001" |
| Batch Set | batch_set | Keyword | batch_set:<batch set>batch_set:"SSN Documents" |
| Batch Type | batch_type | Keyword | batch_type:<batch type>batch_type:review |
| BCC | bcc | Keyword | bcc:<email>, bcc:<bcc_recipient_name> |
| Classification | classification | Keyword | classification:<class> |
| CC | cc | Keyword | cc:<email>, cc:<cc_recipient_name> |
| Confirmed Entity Count | confirmed_entity_count | Long | confirmed_entity_count:<number of entities>confirmed_entity_count:[5 TO 10] |
| Custodian | custodian | Keyword | custodian:<custodian name>custodian:"Jane Doe" |
| Custom PII Tags | custom_pii_tags | Keyword | custom_pii_tags:<custom PII tags> |
| Email Client Submit Date/Time | email_client_submit_datetime | Date | email_client_submit_datetime:<date>email_client_submit_datetime:"2010-01-30" |
| Email Conversation Index | email_conversation_index | Keyword | email_conversation_index:<exact_index>email_conversation_index:AQHc5fUAEuRWmZ2a2k6c7FyCkdK6R6kB |
| Email Created Date/Time | email_created_datetime | Date | email_created_datetime:<date> |
| Email Delivery Date/Time | email_delivery_datetime | Date | email_message_delivery_datetime:<date>email_message_delivery_datetime:"2001-01-30 00:00:00.000" |
| Email Message ID | email_message_id | Keyword | email_message_id:<exact_id> |
| Email Modified Date/Time | email_modified_datetime | Date | email_modified_datetime:<date> |
| Email Provider Submit Date/Time | email_provider_submit_datetime | Date | email_provider_submit_datetime:<date> |
| Email Report Date/Time | email_report_datetime | Date | email_report_datetime:<date>email_report_datetime:"2010-01-30" |
| Email Thread Index | email_thread_index | Keyword | email_thread_index:<exact_index>email_thread_index:AcvXMOs3E1WvsR6hBkapQSV6HVwCHQ== |
| Family ID | family_id | Keyword | family_id:2FG2G55FGFfamily_id:(2FG2G55FGF 2FG2G55CGF 3FG2G55FGF) |
| File Created Date/Time | file_created_datetime | Date | file_created_datetime:<date> |
| File Modified Date/Time | file_modified_datetime | Date | file_modified_datetime:<date> |
| File Name | file_name | Keyword | file_name:<file_name> |
| File Size | file_size | Long | file_size:<size in bytes>file_size:>1000 |
| File Type | file_type | Keyword | filetype:.docfiletype:.pdf |
| From | from | Keyword | from:<name or domain>from:johndoe or from:.gmail.com |
| Has Attachment | has_attachment | Boolean | has_attachment:Truehas_attachment:False |
| ID | id | Keyword | id:2FG2G55FGFid:(2FG2G55FGF 2FG2G55CGF 3FG2G55FGF) |
| Image Dimension (in pixels) | image_dimension.height image_dimension.width | Long | image.dimension.height:<size in pixels> or image.dimension.width:<size in pixels>image.dimension.width:>1000 or image.dimension.height:>1000 |
| Language | language | Keyword | language:<language name>language:french |
| Language Confidence (in %) | language_confidence_level | Long | language_confidence_level:<number 1-100>language_confidence_level:>80 |
| MD5 Hash | md5_hash | Keyword | md5_hash:<hash value> |
| Master Created Date/Time | master_created_datetime | Date | master_created_datetime:<date> |
| Master Created Date/Time Source | master_created_datetime_source | Keyword | master_created_datetime_source:<string> |
| Master Created Date/Time Source ID | master_created_datetime_source_id | Keyword | master_created_datetime_source_id:<id> |
| Master Modified Date/Time | master_modified_datetime | Date | master_modified_datetime:<date> |
| Master Modified Date/Time Source | master_modified_datetime_source | Keyword | master_modified_datetime_source:<date> |
| Master Modified Date/Time Source ID | master_modified_datetime_source_id | Keyword | master_modified_datetime_source_id:<id> |
| Name | name | Text | name:<file name or email subject>name:Acadia* |
| OCR Confidence | ocr_confidence | Long | ocr_confidence:<number from 0 - 100>ocr_confidence:>90 |
| Page Count | page_count | Long | page_count:<number>page_count:1 |
| Parent ID | parent_id | Keyword | parent_id:2FG2G55FGFparent_id:(2FG2G55FGF 2FG2G55CGF 3FG2G55FGF) |
| PII Count By Element | pii_count.[element search name] | Long | pii_count.<element search name>:<number>pii_count.aba:[100 TO 1000]pii_count.austria passport:[100 TO 1000] |
| PII Tags | pii_tags | Keyword | pii_tags:<pii element search name>pii_tags:aba |
| Preserved Created Date/Time | preserved_created_datetime | Date | preserved_created_datetime:<date>preserved_created_datetime:"2001-01-30" |
| Preserved Modified Date/Time | preserved_modified_datetime | Date | preserved_modified_datetime:<date>preserved_modified_datetime:"2001-01-30" |
| QA Change Reason | qa_change_reason | Keyword | qa_change_reason:<reason tag>qa_change_reason:"ssn required" |
| QA Date/Time | qa_datetime | Date | qa_datetime:<date>qa_datetime:"2010-01-30" |
| QA Reviewer | qa_reviewer | Keyword | qa_reviewer:<name>qa_reviewer:"jane doe" |
| QA Reviewer Email | qa_reviewer_email | Keyword | qa_reviewer_email:<name>qa_reviewer_email:"jane@gmail.com |
| QA Status | qa_status | Keyword | qa_status:<status>qa_status:"qa accepted" |
| Recipient Count | recipients_count | Long | recipients_count:<number>recipients_count:<10> |
| Reviewed Date/Time | reviewed_datetime | Date | reviewed_datetime:<date>reviewed_datetime:"2010-01-30" |
| Review Method | review_method | Keyword | review_method:<method>review_method:"manual review" |
| Review Phase | review_phase | Keyword | review_phase:<review phase name>review_phase:"auto review phase 1" |
| Review Status | review_status | Keyword | review_status:<status>review_status:reviewed |
| Review Type | review_type | Keyword | review_type:<type>review_type:qa |
| Reviewer Info | reviewer_info | Keyword | reviewer_info:<name>reviewer_info:"jane doe" |
| Reviewer Email | reviewer_email | Keyword | reviewer_email:<name>reviewer_email:"jane@gmail.com |
| Sender/Recipient Domain | sender_domains recipient_domains | Keyword | sender_domain:<email domain>recipient_domain:<email domain>sender_domain:"gmail.com"recipient_domain:"gmail.com" |
| SHA256 Hash | sha256_hash | Keyword | sha256_hash:<hash value> |
| Source Container | source_container | Keyword | source_container:<zip_container>source_container:upload.pst |
| Source Path | source_path | Keyword | source_path:<source_path> |
| Subject | subject | Keyword | subject:<email_or_document_subject> |
| Suggested Entity Count | suggested_entity_count | Long | suggested_entity_count:<number>suggested_entity_count:>2 |
| Tags | tags | Keyword | tags:<user-created-tag>tags:healthcare |
| Text Length (in number of characters) | text_length | Long | text_length:<number>text_length:130 |
| Text Source | text_source | Keyword | text_source:<source>text_source:"ocr text" |
| Title | title | Keyword | title:<document_title>title:"finance report" |
| To | to | Keyword | to:<name or domain>to:johndoe or to:.gmail.com |
| Total PII Count (number of PIIs in a document) | total_pii_count | Long | total_pii_count:<number>total_pii_count:3 |
| Uploaded End Date/Time | uploaded_end_datetime | Date | uploaded_end_datetime:<date>uploaded_end_datetime:"2020-01-30 00:00:00.000" |
In Version 4.0, Canopy has upgraded the Text Analyzer to support precision and recall search, delivering a significantly improved and more robust search experience.
We’ve also enhanced Field Search to make properties more intuitive and easier to remember.
The table below compares the Field Search functionality in Version 4.0 and later with earlier versions, for users who may still be using the Canopy version 3.
| Field Name | Meta Field Properties (Releases 4.0.0) | Meta Field Properties (Releases 3.0.0) | Examples (Releases < 4.0) |
|---|---|---|---|
| Alt Workflow Tags | alt_workflow_tags | meta.alt_workflow | meta.alt_workflow:<user-created-tags> |
| Audio Duration | audio_duration | meta.audio_video_length | meta.audio_video_length:<value in seconds>meta.audio_video_length:>30.0 |
| Auto-detected PII | pii.[element search name] | pii.[element search name] | pii.<element search name>:<detected element>pii.name:"Jane Doe" |
| Batch | batch | batching.batchset_name | batching.batchset_name:<batch set name>batching.batchset_name:"batch A" |
| Batch Set | batch_set | ||
| Batch Type | batch_type | ||
| BCC | bcc | meta.eml_bcc_displayname | meta.eml_bcc_displayname:<email> |
| CC | cc | meta.eml_cc_displayname | meta.eml_cc_displayname:<email> |
| Custodian | custodian | meta.custodian | meta.custodian:<custodian name>meta.custodian:"Jane Doe" |
| Custom PII Tags | custom_pii_tags | meta.custom_tags | meta.custom_tags:<custom detection tags> |
| Decrypted File | meta.is_password_protected | meta.is_password_protected:1 or meta.is_password_protected:Truemeta.is_password_protected:0 or meta.is_password_protected:False | |
| Email Created Date/Time | email_created_datetime | meta.eml_created_datetime | meta.eml_created_datetime:<date> |
| Email Delivery Date/Time | email_delivery_datetime | meta.eml_message_delivery_datetime | meta.eml_message_delivery_datetime:<date>meta.eml_message_delivery_datetime:"2001-01-30 00:00:00.000" |
| Email Modified Date/Time | email_modified_datetime | meta.eml_last_modified_datetime | meta.eml_last_modified_datetime:<date> |
| Email Provider Submit Date/Time | email_provider_submit_datetime | meta.eml_provider_submit_datetime | meta.eml_provider_submit_datetime:<date> |
| Email Report Date/Time | email_report_datetime | meta.eml_report_datetime | meta.eml_report_datetime:<date>meta.eml_report_datetime:"2010-01-30" |
| Email Client Submit Date/Time | email_client_submit_datetime | meta.eml_client_submit_datetime | meta.eml_client_submit_datetime:<date>meta.eml_client_submit_datetime:"2010-01-30" |
| From | from | meta.eml_from meta.eml_from_displayname from | meta.eml_from:<name or domain>meta.eml_from:johndoe or from:johndoemeta.eml_from:.gmail.com or from:.gmail.com |
| File Created Date/Time | file_created_datetime | meta.metadata_created_datetime | meta.metadata_created_datetime:<date> |
| File Modified Date/Time | file_modified_datetime | meta.metadata_modified_datetime | meta.metadata_modified_datetime:<date> |
| File Size | file_size | meta.size size | meta.size:<size in bytes> or size:<size in bytes>meta.size:>1000 or size:>1000 |
| File Type | file_type | meta.extension filetype | filetype:.doc or meta.extension:.docfiletype:.pdf or meta.extension:.pdf |
| Has Attachment | has_attachment | has_attachment | has_attachment:1 or has_attachment:Truehas_attachment:0 or has_attachment:False |
| ID | id | meta.search_id search_id id | id:2FG2G55FGFid:(2FG2G55FGF 2FG2G55CGF 3FG2G55FGF) |
| Image Classification | image_classification | image_classification.image_class | image_classification.image_class:<image class> |
| Image Dimension (in pixels) | image_dimension.height image_dim | meta.dimension.height meta.dimension.width | meta.dimension.height:<size in pixels> or meta.dimension.width:<size in pixels>meta.dimension.width:>1000 or meta.dimension.height:>1000 |
| Language | language | meta.language | meta.language:<language name>meta.language:french |
| Language Confidence (in %) | language_confidence_level | meta.language_confidence_level | meta.language_confidence_level:<number 1-100>meta.language_confidence_level:>80 |
| MD5 Hash | md5_hash | meta.md5 | meta.md5:<hash value> |
| Master Created Date/Time | master_created_datetime | meta.master_created_datetime | meta.master_created_datetime:<date> |
| Master Created Date/Time Source | master_created_datetime_source | meta.master_created_datetime_source_field | meta.master_created_datetime_source_field:<string> |
| Master Created Date/Time Source ID | master_created_datetime_source_id | meta.master_created_datetime_source_document_id | meta.master_created_datetime_source_document_id:<id> |
| Master Modified Date/Time | master_modified_datetime | meta.master_modified_datetime | meta.master_modified_datetime:<date> |
| Master Modified Date/Time Source | master_modified_datetime_source | meta.master_modified_datetime_source_field | meta.master_modified_datetime_source_field:<date> |
| Master Modified Date/Time Source ID | master_modified_datetime_source_id | meta.master_modified_datetime_source_document_id | meta.master_modified_datetime_source_document_id:<id> |
| Name | name | meta.short_name display_name | meta.short_name:<file name or email subject> or display_name:<file name or email subject>meta.short_name:Acadia* or display_name:Acadia* |
| OCR-Performed | meta.ocr_performed | meta.ocr_performed:truemeta.ocr_performed:false | |
| Page Count | page_count | page_count | page_count:<number>page_count:1 |
| PII Count By Element | pii_count.[element search name] | meta.pii_count.[element search name] | meta.pii_count.<element search name>:<number>meta.pii_count.aba:[100 TO 1000]meta.pii_count.austria passport:[100 TO 1000] |
| PII Tags | pii_tags | meta.tags piitag | piitag:<pii element search name> or meta.tag:<pii element search name> |
| Preserved Created Date/Time | preserved_created_datetime | meta.archive_created_datetime | meta.archive_created_datetime:<date>meta.archive_created_datetime:"2001-01-30" |
| Preserved Modified Date/Time | preserved_modified_datetime | meta.archive_modified_datetime | meta.archive_modified_datetime:<date>meta.archive_modified_datetime:"2001-01-30" |
| QA Change Reason | N/A | N/A | N/A |
| QA Created Date | N/A | meta.batching.create_datetime | meta.batching.create_datetime:<date> |
| QA Reviewer | N/A | N/A | N/A |
| QA Reviewer Email ID | N/A | N/A | N/A |
| QA Status | N/A | N/A | N/A |
| Recipient Count | recipients_count | meta.eml_all_recipients_nos | meta.eml_all_recipients_nos:<number> |
| Reviewer | N/A | N/A | N/A |
| Reviewer Batch Name | N/A | N/A | N/A |
| Reviewer Email ID | N/A | N/A | N/A |
| Sender/Recipient Domain | sender_domains recipient_domains | eml_domains_from eml_domains_to | eml_domains_from:<email domain>eml_domains_from:"gmail.com"eml_domains_to:"gmail.com" |
| SHA1 Hash | N/A | N/A | N/A |
| SHA256 Hash | sha256_hash | meta.sha256 | meta.sha256:<hash value> |
| Source Path | source_path | meta.source_path | meta.source_path:<your file with wildcards?*> |
| Tags | tags | meta.manual_tags tag | tag:<user-created-tag> or meta.manual_tags:<user-create-tag>tag:qa or meta.manual_tags:qa |
| Text Length (in number of characters) | text_length | meta.length | meta.length:<number>meta.length:130 |
| To | to | meta.eml_to meta.eml_to_displayname to | meta.eml_to:<name or domain>meta.eml_to:johndoe or to:johndoemeta.eml_to:.gmail.com or to:.gmail.com |
| Total PII Count (number of PIIs in a document) | total_pii_count | meta.pii_total | meta.pii_total:<number>meta.pii_total:3 |
| Uploaded End Date/Time | uploaded_end_datetime | uploaded_datetime | uploaded_datetime:<date>uploaded_datetime:"2020-01-30 00:00:00.000" |
In Version 3.0, Canopy integrates Elasticsearch (ES) version 8.0 into the application.
Elasticsearch does not exhibit backward compatibility. As a result, the Field Search feature in Canopy Version 3.0 and beyond will differ from that in earlier versions.
The following table compares the Field Search functionality in Version 3.0 and later with that in earlier versions, for those who may still be using the previous version of Canopy.
| Field Name | RegEx | Shortcut | Search Field (Releases 3.0.0) | Search Field (Releases < 3.0) |
|---|---|---|---|---|
| Alt Workflow Tags | Yes | meta.alt_workflow | meta.workflow | |
| Archival Created Date/Time | meta.archive_created_datetime | meta.archive_created_datetime | ||
| Archival Modified Date/Time | meta.archive_modified_datetime | meta.archive_modified_datetime | ||
| Audio Duration | meta.audio_video_length | meta.Audio_video_Length | ||
| Batch Set Name | batching.batchset_name | |||
| Confirmed Entities | Not Searchable | |||
| Custodian | Yes | meta.custodian | custodian | |
| Custom Detection Rules | Yes | meta.custom_tags | meta.custom_tags | |
| Decrypted File | meta.is_password_protected | meta.Is_password_protected | ||
| Document ID | Yes | id | meta.search_id | search_id |
| Document Page Count | page_count | |||
| Email Attachment | has_attachment | is_Attachment | ||
| Email BCC | Yes | meta.eml_bcc_displayname | meta.eml_Bcc_DisplayName | |
| Email CC | Yes | meta.eml_cc_displayname | meta.eml_Cc_DisplayName | |
| Email Classification | Yes | N/A | meta.eml_clsf_type | |
| Email Created Date/Time | meta.eml_created_datetime | meta.eml_CreationTime | ||
| Email From | Yes | from | meta.eml_from meta.eml_from_displayname | from |
| Email Modified Date/Time | meta.eml_last_modified_datetime | meta.eml_LastModificationTime | ||
| Email Provider Send Date/Time | meta.eml_provider_submit_datetime | meta.eml_ProviderSubmitTime | ||
| Email Received Date/Time | meta.eml_message_delivery_datetime | meta.eml_MessageDeliveryTime | ||
| Email Recipient Number | meta.eml_all_recipients_nos | meta.eml_AllRecipientsNos | ||
| Email Report Date/Time | meta.eml_report_datetime | meta.eml_ReportTime | ||
| Email Send Date/Time | meta.eml_client_submit_datetime | meta.eml_ClientSubmitTime | ||
| Email Sender/Recipient Domain | eml_domains_from eml_domains_to | |||
| Email To | Yes | to | meta.eml_to meta.eml_to_displayname | to |
| File Created Date/Time | meta.metadata_created_datetime | meta.metadata_created_datetime | ||
| File Extension | Yes | filetype | meta.extension | filetype |
| File Modified Date/Time | meta.metadata_modified_datetime | meta.metadata_modified_datetime | ||
| File Size | size | meta.size | size | |
| Folder Path | meta.full_name | meta.full_name | ||
| Image Classification | Yes | image_classification.image_class | img_clsf_filter | |
| Image Dimension | meta.dimension.height meta.dimension.width | |||
| Language | Yes | meta.language | Language | |
| Language Confidence | meta.language_confidence_level | Language_confidence_level | ||
| MD5 Hash | Yes | meta.md5 | md5 | |
| Master Created Date/Time | meta.master_created_datetime | meta.master_created_datetime | ||
| Master Created Date/Time Source Field | meta.master_created_datetime_source_field | meta.master_created_datetime_source_field | ||
| Master Created Date/Time Source Search ID | meta.master_created_datetime_source_document_id | meta.master_created_datetime_source_document_id | ||
| Master Modified Date/Time | meta.master_modified_datetime | meta.master_last_modified_datetime | ||
| Master Modified Date/Time Source Field | meta.master_modified_datetime_source_field | meta.master_modified_datetime_source_field | ||
| Master Modified Date/Time Source Search ID | meta.master_modified_datetime_source_document_id | meta.master_modified_datetime_source_document_id | ||
| Name | Yes | filename | meta.short_name | meta.short_name |
| OCR-Performed | meta.ocr_performed | |||
| PII Count By Element | meta.pii_count.[element search name] | meta.pii_density.[element search name] | ||
| PII Elements | Yes | piitag | meta.tags | meta.tags |
| QA Batch Name | N/A | N/A | ||
| QA Change Reason | N/A | N/A | ||
| QA Created Date | meta.batching.create_datetime | |||
| QA Reviewer | N/A | N/A | ||
| QA Reviewer Email ID | N/A | N/A | ||
| QA Status | N/A | N/A | ||
| Reviewer | N/A | reviewer | ||
| Reviewer Batch Name | N/A | N/A | ||
| Reviewer Email ID | N/A | N/A | ||
| SHA1 Hash | Yes | N/A | sha1 | |
| SHA256 Hash | Yes | meta.sha256 | sha256 | |
| Source | Yes | meta.source_path | meta.sourcepath | |
| Suggested Entities | Yes | suggestedType | ||
| Tags | Yes | tag | meta.manual_tags | tag |
| Text Length | meta.length | content.length | ||
| Total PII Count | meta.pii_total | meta.total_pii | ||
| Uploaded Date/Time | uploaded_datetime | uploaded_datetime |