IDOL Server 24.2

# Summarize

Allows you to generate a conceptual summary for documents, document sections, or text. You can generate various summary types.

You must set Summary to the type of summary that you want to generate, and you must provide the text to summarize by setting one of ID, Reference, StateID, or Text. When you set Summary to `Concepts`, you must set Text.

NOTE: If you distribute the `Summarize` action by using a Distributed Action Handler, you cannot use any parameters that specify the IDs of documents. Use parameters that identify documents by their reference instead.

## Example

    http://12.3.4.56:9000/action=Summarize&ID=30

This action generates a concept summary from the content of the document with the ID `30` in IDOL Server.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Summary | The type of summary to generate.

You must set at least one of the following parameters.

Parameter | Description
--- | ---
ID | The document IDs of documents to summarize.
Reference | The references of documents to summarize.
StateID | The state token of the group of documents to summarize.
Text | The text to summarize. This parameter is required when you set Summary to `Concepts`.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Characters | The number of characters that a summary can contain.
CustomWeight | Whether to use your custom term weight file, if one exists.
DetectLanguageType | Whether to detect the language type of the text.
LanguageType | The language type of the query text.
OutputEncoding | The encoding to convert the results to.
ReferenceField | Restricts the Reference parameter to the specified reference field.
SecurityInfo | Security details for the user sending the action.
Sentences | The number of sentences that the summary can contain.
StateMatchOriginalSection | Whether to return only sections from a state token that were matched in the original query.
Synchronous | Whether to run the action synchronously or asynchronously.

The following optional parameters are available when you set Summary to `Concepts`.

Parameter | Description
--- | ---
Delimiter | A delimiter string to use for separating multiple inputs within the `Text` parameter.
QuerySummaryAdvanced | Whether to enable the advanced algorithm for query summaries, for dynamic summaries and automatic query guidance.
QuerySummaryLength | The maximum number of best terms to use in a query summary.
QuerySummaryMaxDocLength | The maximum number of characters in each document to use to generate a query summary.
QuerySummaryNumbers | Whether to allow numeric and alphanumeric values in query summaries.
QuerySummaryPlus | Whether to enable the `QuerySummaryPlus` algorithm for query summaries.
QuerySummaryStopPhraseMode | Disable the configured QuerySummaryStopPhraseMode.
QuerySummaryTerms | The number of terms to use to generate a query summary.
QuerySummaryWhiteListMode | Disable the configured QuerySummaryWhiteListMode.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

Copyright 2024 Open Text
Version 24.2 | Last updated March 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Server 24.2

Topic Title: Summarize