Other objects¶
Other types of data provided by the DocumentCloud system.
Annotations¶
Notes left in documents.
-
annotation_obj.
access
¶ The privacy level of the resource within the DocumentCloud system. It will be either
public
orprivate
.
-
annotation_obj.
description
¶ Space for a lengthy text block that will be published below the highlighted text in the DocumentCloud design.
-
annotation_obj.
id
¶ The unique identifer of the document in DocumentCloud’s system.
-
annotation_obj.
location
¶ The location of where the annotation appears on the document’s page. Defined by the Locations class.
-
annotation_obj.
page
¶ The page where the annotation appears.
-
annotation_obj.
title
¶ The name of the annotation, which appears in the table of contents and above the highlighted text when published by DocumentCloud.
Entities¶
Keywords extracted from documents with OpenCalais.
-
location_obj.
relevance
¶ The weighting associated with this connection by OpenCalais. Higher numbers are supposed to be more relevant.
-
location_obj.
type
¶ The category of entity the value belongs to.
-
location_obj.
value
¶ The name of the entity extracted from the document (i.e. “Los Angeles” or “Museum of Modern Art”)
Locations¶
The location where Annotations are placed within a document.
-
location_obj.
bottom
¶ The value of the bottom edge of an annotation.
-
location_obj.
left
¶ The value of the left edge of an annotation.
-
location_obj.
right
¶ The value of the right edge of an annotation.
-
location_obj.
top
¶ The value of the top edge of an annotation.