Thrift module: annotate

Services

Service: AnnotateCommunicationService

Annotator service methods. For concrete analytics that
are to be stood up as independent services, accessible
from any programming language.

communication.Communication annotate(communication.Communication original)
    throws ex.ConcreteThriftException

Main annotation method. Takes a communication as input
and returns a new one as output.

It is up to the implementing service to verify that
the input communication is valid.

Can throw a ConcreteThriftException upon error
(invalid input, analytic exception, etc.).

metadata.AnnotationMetadata getMetadata()

Return the tool's AnnotationMetadata.

string getDocumentation()

Return a detailed description of what the particular tool
does, what inputs and outputs to expect, etc.

Developers whom are not familiar with the particular
analytic should be able to read this string and
understand the essential functions of the analytic.

void shutdown()

Indicate to the server it should shut down.

Service: AnnotateCommunicationBatchService

Batch annotator service methods. For concrete analytics that
are to be stood up as independent services, accessible
from any programming language.

Intended to supersede AnnotateCommunicationService.

list<communication.Communication> annotate(list<communication.Communication> originals)
    throws services.ServicesException

Main annotation method. Takes a list of communications as input
and returns a new list as output.  The returned list of
Communications should correspond one-to-one to the original list.

It is up to the implementing service to verify that
the input communications are valid.

Can throw a ServicesException upon error
(invalid input, analytic exception, etc.).

metadata.AnnotationMetadata getMetadata()

Return the tool's AnnotationMetadata.

Service: AnnotateWithContextService

A service that provides an alternative to Annotate,
with the ability to pass along an additional Context
parameter that conveys additional information about the
Communication.

communication.Communication annotate(communication.Communication original,
                                     context.Context context)
    throws ex.ConcreteThriftException

Takes a Communication and a Context as input
and returns a new one as output.

It is up to the implementing service to verify that
the input communication is valid, as well as interpret
the Context in an appropriate manner.

Can throw a ConcreteThriftException upon error
(invalid input, analytic exception, etc.).