Field Path Notation Syntax

The following details the Field Path Notation syntax.

Document Properties and Tags

Document Properties and Tags are found in the Document structure, when viewing documents. See Documents.

Document properties contain metadata and other information about an ingested document and can be found within a Sintelix document in the Content section.

Syntax:
Copy 
:document.prop.[CATEGORY].[NAME]
Example:
Copy 
:document.prop.Metadata.content_type

Used to reference a document tag when creating a network node/link field or network table view column.

Syntax:
Copy 
:document.tags.[CATEGORY]
Example:
Copy 
:document.tags.Industry

Entity Features

Entity Features can be identified when viewing the node details. See Node Details: View, Edit & Report.

Used to reference entity features of the string data type.

Syntax:
Copy 
features.[ENTRY]
Example:
Copy 
features.First Name

Used to reference an entity features of the datetime data type.

Syntax:
Copy 
datetime-features.[ENTRY]
Example:
Copy 
datetime-features.value

Used to reference an entity features of the geocoordinate data type.

Syntax:
Copy 
geocoordinate-features.[ENTRY]
Example:
Copy 
geocoordinate-features.coordinates

This syntax is used to reference the values of a node connected to another node via a link.

Syntax:
Copy 
:neighbours.[LINK TYPE].[NODE TYPE].[ENTRY]
Example:
Copy 
:neighbours.Position-organisation.Organisation.label

Used to referencing text references in a document.

Syntax:
Copy 
ref.System.[TEXT REFERENCE TAG]
Example:
Copy 
ref.System.Person.text:tokens:significant

More examples of this syntax and their details are:

  • Field path - ref.System.Person.text:tokens:significant
  • Description - Look for text references of type Person, tokenize the text and filter to significant words
  • Field path - ref.System.Person.text:significant
  • Description - Look for text references of type Person and filter the text to significant words