com.languagecomputer.api
Interface EntityWebService

All Superinterfaces:

BaseWebService

All Known Implementing Classes:

EntityWebServiceImpl

public interface EntityWebService
extends BaseWebService

Interface for named entitiy annotation web service. The service takes a document and identifies the named entities in the document text.

Since:

1.0

Author:

Toby Jungen

Method Summary

String

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

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 named entities.

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 entities in the format requested.

Throws:

Exception - If there was an error processing the document.