Allows you to generate a conceptual summary for documents, document sections, or text. You can generate various summary types.
http://12.3.4.56:9000/action=Summarize&ID=30
This action uses port 9000
to generate a concept summary from the content of the document with the ID 30
in IDOL Content Component, which is located on a machine with the IP address 12.3.4.56
.
Parameter | Description | Required |
---|---|---|
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. | |
ID | The document IDs of documents to summarize. | See Comments |
LanguageType | The language type of the query text. | |
OutputEncoding | The encoding to convert the results to. | |
Reference | The references of documents to summarize. | See Comments |
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. | |
StateID | The state token of the group of documents to summarize. | |
Summary | The type of summary to generate. | Yes |
Synchronous | Whether to run the action synchronously or asynchronously. | |
Text | The text to summarize. | See Comments |
The following optional parameters are available when you set Summary to Concepts
.
Parameter | Description |
---|---|
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. |
EncryptResponse | Encrypt the output. |
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. |
You must set one of the following parameters or parameter combinations:
When you set Summary to Concepts
, you must set the Text parameter.
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.
|