Thrift module: base

Typedef: Text

Base type: string

Typedef: Source

Base type: string

Struct: Span

Field	Type	Description	Requiredness	Default value
start	i32	start index of span in the raw text (inclusive).	required
ending	i32	ending index of span in the raw text (exclusive).	required
label	string	label for span.	optional
score	double	score of span.	optional
source	Source	source of span.	optional
attributes	map<string, string>	any additional attributes assoicated with this span.	optional
multiIndex	i32	index of the text (in the multirecord) to which this span references.	optional

Span covers a portion of text.

start - start index of span in the raw text (inclusive).
ending - end index of span in the raw text (exclusive).
label - label for span.
score - score of span.
source - the source annotator of this span.
attributes - any additional attributes assoicated with this span. a map of attribute_name => value.
multiIndex - if associated with a MultiRecord which Record object is this span for.

Struct: Labeling

Field	Type	Description	Requiredness	Default value
labels	list<Span>	the labels as spans.	required
source	Source	the source of this labeling came from.	optional
score	double	score for this labeling.	optional
rawText	string	the raw text for this labeling (if null then consult the labeling's parent's rawText field)	optional

A labeling of text. Really a list of Spans.

labels - the labels for this labeling. Each label represented as a Span.
source - the source annotator this labeling came from.
score - the score for this labeling.
rawText - the raw text for this labeling (if null then consult the labeling's parent's rawText field, i.e., the Record's)

Struct: Clustering

Field	Type	Description	Requiredness	Default value
clusters	list<Labeling>	the clusters, each cluster is a Labeling.	required
source	Source	the source of this Clustering	optional
score	double	score for this clustering	optional
rawText	string	the raw text for this clustering (if null then consult the clustering's parent's rawText field)	optional

A clustering of labels for the text. Each cluster is represented as a Labeling which in turn will have labels (list) representing each item in the cluster.

clusters - the clusters for the this clustering. Each cluster represented as a Labeling.
source - the source annotator this clustering came from.
score - the score for this clustering.
rawText - the raw text for this clustering (if null then consult the labeling's parent's rawText field, i.e., the Record's)

Struct: Node

Field	Type	Description	Requiredness	Default value
label	string	the label of the node.	required
span	Span	the span this node covers.	optional
children	map<i32, string>	the children of the node represented as a map of . Empty string implies no label.	optional
source	Source	source of the node .	optional
score	double	the score for this node.	optional

Nodes store their children. Referenced as index into list in the containing struct. Here the link between Node can be labeled.

label - the label for this Node.
span - the span this node covers.
children - the children of the node represented as a map of . Empty string implies no label. The index is the index of the node in the parent data structure (i.e., the tree's nodes).
source - the source annotator this node came from.
score - the score for this node.

Struct: Tree

Field	Type	Description	Requiredness	Default value
nodes	list<Node>	list of labeled nodes.	required
top	i32	the index of top/root node in nodes.	required
source	Source	the source of this tree.	optional
score	double	the score of this tree.	optional

Trees are a set of connected nodes with a top node.

nodes - the list of labeled nodes.
top - the index in nodes of the top node.
source - the source annotator this Tree came from.
score - the score for this Tree.

Struct: Forest

Field	Type	Description	Requiredness	Default value
trees	list<Tree>	the trees in this Forest	required
rawText	string	the raw text for this Forest (if null then consult the tree's parent's rawText field)	optional
source	Source	the source of this Forest	optional

Forest is a set of trees.

trees - the trees for the this forest.
source - the source annotator this forest came from.
score - the score for this forest.
rawText - the raw text for this forest (if null then consult the labeling's parent's rawText field, i.e., the Record's)

Struct: Relation

Field	Type	Description	Requiredness	Default value
start	i32		required
ending	i32		required
label	string		optional
source	Source		optional
score	double		optional

Relations are between two spans.

start - the index of the span that starts this relation.
ending - the index of the span that ends this relation.
label - the label for this relation.
source - where this relation came from.
score - the score for this relation.

Struct: View

Field	Type	Description	Requiredness	Default value
spans	list<Span>		required
relations	list<Relation>		required
rawText	string		optional
source	Source		optional
score	double		optional

A View is the most general data structure. Spans and their relations.

spans - the spans of for this view.
relations - the relations of this view.
source - the source annotator this view came from.
score - the score for this view.
rawText - the raw text for this view (if null then consult the labeling's parent's rawText field, i.e., the Record's)

Exception: ServiceUnavailableException

Field	Type	Description	Requiredness	Default value
reason	string		default

Exception: ServiceSecurityException

Field	Type	Description	Requiredness	Default value
reason	string		default

Exception: AnnotationFailedException

Field	Type	Description	Requiredness	Default value
reason	string		default

Function: BaseService.ping

bool ping()

Ping? Pong! return True!

Function: BaseService.getName

string getName()

Return the name of this service.

Function: BaseService.getVersion

string getVersion()

Return the version of this service.

Function: BaseService.getSourceIdentifier

string getSourceIdentifier()

Return the an identifier to be used in source fields. This should be of the form - where contains no spaces or hypens and is parsable into a number (double, int etc). i.e.,. server-1.0.

Any datastructures returned must have the source field populated with the result of this function.