Annotation fields

Nuix 'Annotation' fields contain information added by investigators or reviewers. This section details these fields in alphabetic order, with working examples of each.

automatic-classifier

Use the automatic-classifier field to search for items associated with the given automatic classifier. The parameters are classifier, classifier subset, and classification. They are separated by semicolons and are all optional. If a parameter is omitted, it is treated as a "match all" filter.

Available options for classifier subsets are training, automatically-classified and skipped. Additionally, use 'auto' as an alias for automatically-classified. Examples:

Query string	Results
automatic-classifier:"classifier1;training;relevant"	Matches items marked as relevant training items for the classifier "classifier1".
automatic-classifier:"classifier1;automatically-classified"	Matches all items automatically classified by the classifier "classifier1" regardless of classification.
automatic-classifier:"classifier1;;irrelevant"	Matches all items identified as irrelevant by the classifier "classifier1", that is, both training items and automatically classified items.
automatic-classifier:";automatically-classified;relevant"	Matches all items automatically classified as relevant regardless of the classifier used.
automatic-classifier:";auto;relevant"
automatic-classifier:";;"	Matches all items which form any part of any automatic classifier.

cluster

Use the cluster field to search for clustered items using up to three parameters. The parameters are cluster run name, cluster name, and pivot status. They are separated by semicolons and are all optional. If a parameter is omitted, it is treated as a "match all" filter.

Examples:

Query string	Results
cluster:investigation23	Matches items clustered during the cluster run "investigation23".
cluster:inv*	Matches items clustered during a cluster run beginning with "inv".
cluster:investigation23;568	Matches items belonging to the 568th cluster in cluster run "investigation23".
cluster:investigation\ 23;568
cluster:"investigation 23;568"	Matches items belonging to the 568th cluster in cluster run "investigation 23".
cluster:investigation23;568;pivot	Matches the pivot item of the 568th cluster in cluster run "investigation23".
cluster:investigation23;;pivot	Matches all the pivot items in cluster run "investigation23".
cluster:;;pivot	Matches all the pivot items in any cluster run.
cluster:*	Matches all items in any cluster run.
cluster:foobar;unclustered	Matches items that did not cluster during cluster run "foobar" despite being eligible to exist in a cluster.
cluster:foobar;ignored	Matches items that were ignored during cluster run "foobar" because they were ineligible to exist in a cluster.

comment

Use the comment field to search for text stored in the comments field by users. The text string used for searching is automatically treated as a match on characters rather than a whole word or, in other words, like a multi-character wild card used either side of the search term.

Example:

Query string	Results
comment:bank	Matches items containing the word "bank", "banking", and "embank" in the comments field.

custodian

Use the custodian field to search for items assigned to a specific custodian. Examples:

Query string	Results
custodian:"Bob"	Finds all items assigned to "Bob".
custodian:"High*"	Finds all items assigned to a custodian with a reference name starting with "High".

document-id

Use the document-id field to match all items with the specified document ID created by a production set. Examples:

Query string	Results
document-id:DOC-00001	Finds any items with the document ID "DOC-00001".
document-id:DOC-00001*	Finds any items with a document ID that start with, or match, "DOC-00001", such as "DOC-000012232".
document-id:[DOC-00001 TO DOC-00003]	Finds any items with a document ID with the prefix "DOC" and are numbered, ignoring padding, from 1 to 3.
document-id:[DOC-1 TO DOC-4}	Matches the same items as the query above, as padding is ignored and 4 is explicitly excluded with '}'.

exclusion

Use the exclusion field to match items excluded by the given exclusion name. Examples:

Query string	Results
exclusion:"my exclusion"	Finds all items excluded under "my exclusion".
exclusion:"irrelevant*"	Finds all items excluded with an exclusion name starting with "irrelevant".

export-rules-applied

Use the export-rules-applied field to match all items assigned to any production set based on if export rules were applied. Examples:

Query string	Results
export-rules-applied:true	Finds all items assigned to any production set with export rules applied.
export-rules-applied:false	Finds all items assigned to any production set without export rules applied.
export-rules-applied:true:5bca1b8cfcaa4896915f685d6a873eaf	Finds all items assigned to the production set that has GUID 5bca1b8cfcaa4896915f685d6a873eaf with export rules applied.

faces

Use the faces field to match items with a specified number of detected faces or a specified range of detected faces. Examples:

Query string	Results
faces:4	Matches items with exactly 4 detected faces.
faces:[3 TO 6]	Matches items with at least 3 and no more than 6 detected faces.
faces:[5 TO *]	Matches items with 5 or more detected faces.

face-confidence

Use the face-confidence field to match items with detected faces using a single confidence value or a range of confidence values.

Note: This query only works if you selected Face Detection during initial processing. The detected face filter uses the following ranges.

Level	Lower Range	Upper Range
High	30	*

Medium	10	29

Level	Lower Range	Upper Range
Low	1	9

Examples:

Query string	Results
face-confidence:15	Matches items with at least one detected face possessing a confidence value of exactly 15.
face-confidence:[20 TO 35]	Matches items with at least one detected face possessing a confidence value between 20 and 30 (inclusive).
face-confidence:{20 TO 35}	Matches items with at least one detected face possessing a confidence value between 20 and 30 (exclusive).
face-confidence:[40 TO *]	Matches items with at least one detected face possessing a confidence value greater than or equal to 40.
face-confidence:[* TO 30]	Matches items with at least one detected face possessing a confidence value less than or equal to 30.
face-confidence:*	Matches items with at least one detected face possessing any confidence value.

has-comment

Use the has-comment field to search for the existence or absence of any comments made by investigators. Examples:

Query string	Results
has-comment:1	Matches items with an associated comment.
has-comment:0	Matches items that do not contain a comment.

has-custodian

Use the has-custodian Boolean field to match all items assigned to any custodians. Examples:

Query string	Results
has-custodian:1	Finds all items assigned to any custodian.
has-custodian:0	Finds all items not assigned to a custodian.

has-exclusion

Use the has-exclusion Boolean field to match all items based on if they have exclusions. Examples:

Query string	Results
has-exclusion:1	Finds all items assigned to an exclusion.
has-exclusion:0	Finds all items not assigned to an exclusion.

has-item-set

Use the has-item-set field to match all items based on if they are or are not assigned to an item set. Examples:

Query string	Results
has-item-set:1	Finds all items assigned to any item set.
has-item-set:0	Finds all items not assigned to any item set.

has-print-preview

Use the has-print-preview field to match all items with a print preview as part of any production set.

Query string	Results
has-print-preview:1	Matches all items with a print preview in any production set.
has-print-preview:0	Matches all items that do not have a print preview in any production set.

has-print-preview-markup

Use the has-print-preview-markup field to match all items with or without a print preview as part of any production set. Examples:

Query string	Results
has-print-preview:1	Matches all items with a print preview in any production set.
has-print-preview:0	Matches all items that do not have a print preview in any production set.

has-production-set

Use the has-production-set Boolean field to match all items based on if they are assigned or not to any production set. Examples:

Query string	Results
has-production-set:1	Finds all items assigned to any production set.
has-production-set:0	Finds all items not assigned to any production set.

has-tag

Use the has-tag Boolean field to search for the presence of tags on data items. Examples:

Query string	Results
has-tag:1	Matches items tagged.
has-tag:0	Matches untagged items.

is-item-original

Use the is-item-original Boolean field to match all items deemed to be originals after deduplication in any item set. Examples:

Query string	Results
is-item-original:1	Matches all items deemed originals in any item set.
is-item-original:0	Matches all items not deemed originals in any item set. This includes duplicates in all sets and items not in any item set.

item-set

Use the item-set field to match items assigned to the specified item set in the named batch using up to three parameters separated by a semicolon. Examples:

Query string	Results
item-set:"Item Set 1"	Finds any items assigned to the set "Item Set 1".
item-set:"5bca1b8cfcaa4896915f685d6a873eaf"	Finds any items assigned to the set with the GUID 5bca1b8cfcaa4896915f685d6a873eaf.

item-set-batch

Use the item-set-batch field to match all original or duplicate items assigned to the specified item set in the named batch. This field is built with two or three parameters separated by a semicolon, as follows:

The set name or GUID

Optionally "originals" for original items or "duplicates" for duplicate items

The name of the batch load

Examples:

Query string	Results
item-set-batch:"Item Set 1;load 1"	Finds all items assigned to the set "Item Set 1" in the “load 1" batch.
item-set-batch:"Item Set 1;originals;load 1"	Finds all items assigned to the set "Item Set 1" in the “load 1" batch.
item-set-batch:"Item Set 1;duplicates;load 1"	Finds all duplicate items assigned to the set "Item Set 1" in the "load 1" batch.
item-set-batch:"5bca1b8cfcaa4896915f685d6a873eaf;load 1"	Finds all items assigned to the set with GUID 5bca1b8cfcaa4896915f685d6a873eaf in the "load 1" batch.
item-set-batch:"5bca1b8cfcaa4896915f685d6a873eaf;originals;load 1"	Finds all original items assigned to the item set with GUID 5bca1b8cfcaa4896915f685d6a873eaf in the "load 1" batch.
item-set-batch:"5bca1b8cfcaa4896915f685d6a873eaf;duplicates;load 1"	Finds all duplicate items assigned to the set with GUID 5bca1b8cfcaa4896915f685d6a873eaf in the "load 1" batch.

item-set-duplicates

Use the item-set-duplicates field to match all items assigned to the specified set as duplicates. Examples:

Query string	Results
item-set-duplicates:"Item Set 1"	Finds any items assigned to the set "Item Set 1" deemed to be duplicates.
item-set-duplicates:"5bca1b8cfcaa4896915f685d6a873eaf"	Finds any items assigned to the set with GUID 5bca1b8cfcaa4896915f685d6a873eaf deemed to be duplicates.

item-set-originals

Use the item-set-originals field to match all items assigned to the specified item set as originals. Examples:

Query string	Results
item-set-originals:"Item Set 1"	Finds any items assigned to the set "Item Set 1" deemed to be originals.
item-set-originals:"5bca1b8cfcaa4896915f685d6a873eaf"	Finds any items assigned to the set with GUID 5bca1b8cfcaa4896915f685d6a873eaf deemed to be originals.

markup-set

Use the markup-set field to search for items with markups stored against them. Examples:

Query string	Results
markup-set:first	Matches items with markups stored in markup set "first".
markup-set:"general public"	Matches items with markups stored in a markup set with a name that includes spaces, in this case, "general public".

number-valid

Use the number-valid field to match all items assigned to any production set depending on valid document numbering. Examples:

Query string	Results
number-valid:true	Finds all items assigned to any production set with valid document numbering.
number-valid:false	Finds all items assigned to any production set with invalid document numbering.
number-valid:true:5bca1b8cfcaa4896915f685d6a873eaf	Finds all items assigned to the production set that has GUID 5bca1b8cfcaa4896915f685d6a873eaf with valid document numbering.

print-preview

Use the print-preview field to match all items with a print preview in the production set GUID or name. Examples:

Query string	Results
print-preview:2b09b47c-efc8-11e0-a03f-8d0a4924019b	Matches any items with a print preview in the production set that has GUID "2b09b47c-efc8-11e0-a03f-8d0a4924019b".
print-preview:"Production Set 1"	Matches any items with a print preview in the production set named "Production Set 1".

production-set

Use the production-set field to match all items assigned to a specified production set.

Examples:

Query string	Results
production-set:"Production Set 1"	Finds any items assigned to the production set "Production Set 1".

production-set-guid

Use the production-set-guid field to match all items assigned to a specified production set based on its GUID. Examples:

Query string	Results
production-set-guid:2b09b47c-efc8-11e0-a03f-8d0a4924019b	Finds any items assigned to the production set with GUID "2b09b47c- efc8-11e0-a03f-8d0a4924019b".

scored

Use the scored field to search for “scored” or predicted items by an Automatic Classifier against a specific classification. This matches both training items and automatically classified items. This field has two parameters: classifier and classification. Both parameters are optional and separated by a semicolon. The omitted parameter(s) is treated as a “match all” filter.

Examples:

Query string	Results
scored:”classifier1;relevant”	Matches items scored as relevant by the classifier "classifier1".
scored:classifier1	Matches all items scored by the classifier "classifier1" regardless of classification.
scored:;relevant	Matches all items scored as relevant regardless of the classifier used.

score-confidence

Use the score-confidence field to match items with a score confidence (or prediction confidence) created by an Automatic Classifier in the specified range. This matches both training items (if a model has been built), and automatically classified items.

The minimum confidence for an item is 0.5, therefore there matches nothing under this value. Score confidence does not discriminate by classifier name, so you must combine it with the automatic-classifier search field in your search string, if you want to limit it to only one classifier.

Example:

Query string	Results
score-confidence:[0.5 TO 0.6]	Matches all data items with a confidence score between 0.5 and 0.6 inclusive.

tag

Use the tag field to search for a specific tag created by a user. If the tag name has any spaces, such as in Not Relevant, you must enclose the tag name in double- quotes. You can also use a minus sign (-) in front of the tag field to exclude a tag from a search. Separate all tags that exist as part of a nested structure by the "|" character.

Examples:

Query string	Results
tag:Pornography	Matches items tagged with the tag named "Pornography".
tag:"Not Relevant"	Matches items tagged with the tag named "Not relevant".
tag:top*	Matches items tagged with a tag beginning with "top", or any sub-tags of such tags.
tag:"top\|*"	Matches items tagged under a top-level tag named “top”.