com.languagecomputer.api
Interface EventWebService

All Superinterfaces:

BaseWebService

All Known Implementing Classes:

EventWebServiceImpl

public interface EventWebService
extends BaseWebService

Interface for event annotation web service. The service takes a document and identifies the events in the document text.

Since:

1.0

Author:

Kirk Roberts

Method Summary

String

process(String sessionID, String document, String format) Annotates the provided document with events.

Methods inherited from interface com.languagecomputer.api.BaseWebService

registerSession, unregisterSession

Method Detail

process

String process(String sessionID,
               String document,
               String format)
               throws Exception

Annotates the provided document with events.

Parameters:

sessionID - The unique identifier String for the session for this operation.

document - The document in the format described in the format parameter.

format - The format in which the annotations should be returned. Defaults to XML.

Returns:

The identified events in the format requested.

Throws:

Exception - If there was an error processing the document.