Text Mining Overview - Annotopia/AtConnectors GitHub Wiki

Text Mining Connectors are components that allow to integrate text mining algorithms or services in the Annotopia framework. The framework will in turn make them available to third parties through the same protocol/schema of communication.

The idea is to provide a set of methods and tools allowing us and third parties to easily write connectors to the text mining services of choice. The connectors will take care of communications and will all expose the same JSON-LD based format. The goal is to simplify the work of those that write applications and web applications for creating manual and automatic annotation.

Service

All the services offering Text Mining need to implement the interface ITextMiningService which includes the method:

   JSONObject textmine(String resourceUri, String content, HashMap parameters);

with attributes:

• resourceUri: the URI of the resource undergoing text mining
• content: the content to mine
• parameters: the map with all parameters, including authorization tokens or apikeys

Controller

All the controllers offering Text Mining need to extend the class BaseController which provides some basic utilities such as the API key validation.

POST /textmine

Parameter	Description	Default	Impl
apiKey	The application assigned apikey. The API calls are available only for registered and authorized applications.	REQUIRED	YES
text	The text to analyze.	REQUIRED	YES
format	The format of the results	annotopia	yes

Additional parameters can be defined by the different implementations.