com.languagecomputer.api
Interface AnnotationMetaWebService

All Superinterfaces:

BaseWebService

All Known Implementing Classes:

AnnotationMetaWebServiceImpl

public interface AnnotationMetaWebService
extends BaseWebService

Interface for annotation meta web service. Wrapper around the DocumentService and AnnotationServices (such as the EntityService).

Since:

1.0

Author:

Kirk Roberts

Method Summary

String	annotate(String sessionID, String document, String format, List<String> services) Annotates the document with the provided services.
String	process(String sessionID, String url, String type, String format, List<String> services) Processes and annotations a document at a specific URL by downloading it and ingesting it.

Methods inherited from interface com.languagecomputer.api.BaseWebService

registerSession, unregisterSession

Method Detail

process

String process(String sessionID,
               String url,
               String type,
               String format,
               List<String> services)
               throws Exception

Processes and annotations a document at a specific URL by downloading it and ingesting it. Strips extraneous markup and normalizes the text. Then annotates it with the provided services.

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 given document is in. Defaults to XML.

services - List of services to run across the document.

Returns:

The identified annotations in the format requested.

Throws:

Exception - If there was an error indexing the document.

annotate

String annotate(String sessionID,
                String document,
                String format,
                List<String> services)
                throws Exception

Annotates the document with the provided services.

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 given document is in. Defaults to XML.

services - List of services to run across the document.

Returns:

The identified annotations in the format requested.

Throws:

Exception - If there was an error indexing the document.