com.languagecomputer.api
Interface SummarizationService

All Superinterfaces:

Service

public interface SummarizationService
extends Service

Summarization service. Creates a summary from a set of Documents and an (optional) Query.

The Query is useful for query-focused summarization, which can improve the quality of the summaries. Often documents contain multiple topics, the Query helps narrow down to just the information the user is looking for. This also allows the system to filter out documents that have no relevance to the user's focus.

Since:

1.0

Author:

Kirk Roberts

Method Summary

String

summarize(Iterable<Document> documents, Query query) Summarizes the given Documents using the given (optional) Query.

Methods inherited from interface com.languagecomputer.api.Service

getName, setSession

Method Detail

summarize

String summarize(Iterable<Document> documents,
                 Query query)

Summarizes the given Documents using the given (optional) Query. If the query parameter is null, that indicates that the user has chosen not to provide one and a summary should be generated without it. If the implementor of this service requires a Query, then the method should return null.

Parameters:

documents - The Iterable of Documents to generate the summary from. An Iterable is chosen over a standard Collection to allow for SummarizationServices capable of summarizing a larger number of documents than can exist in memory.

query - The optional Query to aid the summarization system in focusing in on the user's desired information.

Returns:

A summary of the documents that takes into account the query if it exists.