com.languagecomputer.api
Interface SummarizationWebService

All Superinterfaces:

BaseWebService

All Known Implementing Classes:

SummarizationWebServiceImpl

public interface SummarizationWebService
extends BaseWebService

Interface for summarization web service. Takes in a set of documents and an (optional) query and returns a summary.

Since:

1.0

Author:

Kirk Roberts

Method Summary

String

summarize(String sessionID, String documents, String query, String format) Summarizes the documents with the (optional) query.

Methods inherited from interface com.languagecomputer.api.BaseWebService

registerSession, unregisterSession

Method Detail

summarize

String summarize(String sessionID,
                 String documents,
                 String query,
                 String format)
                 throws Exception

Summarizes the documents with the (optional) query.

Parameters:

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

documents - The documents to summarize in the format described in the format.

query - The optional query in the format described in the format parameter.

format - The format in which the documents and query are in. Defaults to XML.

Returns:

The summary of the documents.

Throws:

Exception - If there was an error processing the document.