Data Objects
Project Object
The project object is the main entry point to access the data (documents and entities and relationships) of a project.
|
Object Property |
Description |
see also |
|
$project.Name |
name of the project |
|
|
$project.Documents |
retrieves a list of all documents of the project |
Document Object |
|
$project.Entities |
retrieves a list of all found entities of the project |
Entity Object |
|
$project.getDocumentById(id) |
retrieves a Document object by its unique id |
Document Object |
|
$project.getEntityById(id) |
retrieves a single Entity object by its unique id |
Entity Object |
|
$project.getEntityByName(name) |
retrieves a single Entity object by its name |
Entity Object |
|
$project.getEntitiesByNamePattern(namePattern) |
retrieves a list of Entity objects matching a regular expression pattern |
Entity Object |
|
$project.getEntitiesByEntityType(typeId) |
retrieves a list of Entity objects matching the entity type id (2 letter code) |
Entity Object |
|
$project.DocumentEntityRelations |
retrieves a list of DocumentEntityRelation objects |
DocumentEntityRelation Object |
|
$project.EntityEntityRelations |
retrieves a list of EntityEntityRelation objects |
EntityEntityRelation Object |
|
$project.Bookmarks |
retrieves a list of all Bookmark objects in the project |
Bookmark Object |
Note: The algorithm to calculate the EntityEntityRelations list is currently quite slow and takes for large data sets a considerably amount of time. This is a known issue and will be improved in a future version.
Entity Object
The entity object represents a single entity found in a document of the project.
|
Object Property |
Description |
see also |
|
$entity.Id |
the unique Id of the entity |
|
|
$entity.Name |
the name of the entity |
|
|
$entity.RelatedDocuments |
a list of Document objects in which the entity occurs |
Document Object |
|
$entity.RelatedEntities |
a list of Entity objects which occur in the same document |
Entity Object |
|
$entity.Type |
the type acronym of the entity (for example “p” for Person) |
|
|
$entity.TypeName |
the type name (for example “Person”) |
Document Object
The document object represents a document of the selected project.
|
Object Property |
Description |
see also |
|
$document.Id |
the unique id of the document |
|
|
$document.Title |
the title of the document |
|
|
$document.Link |
the source link of the document if it was retrieved from the web |
|
|
$document.RelatedEntities |
a list of Entity objects which occur in the document |
Entity Object |
|
$document.FilePath |
the file path to the original document on local disk |
|
|
$document.Text |
the extracted text of the document |
|
|
$document.DocumentEntityRelations |
a list of DocumentEntityRelations involving this document |
DocumentEntityRelation Object |
DocumentEntityRelation Object
The documentEntityRelation object represents the relation between a document and an entity.
|
Object Property |
Description |
see also |
|
$documentEntityRelation.Document |
returns the document of this relation |
Document Object |
|
$documentEntityRelation.Entity |
returns the entity of this relation |
Entity Object |
|
$documentEntityRelation.TextPositions |
returns a list of TextPosition objects describing where the entity was detected in the document |
TextPosition Object |
TextPosition Object
The textPosition object represents a position in a document where an entity was detected (see $documentEntityRelation.TextPositions).
|
Object Property |
Description |
see also |
|
$textPosition.Pos |
the character position from the beginning of the document |
|
|
$textPosition.Length |
the length of the found entity |