Query Manipulation Server 24.3

# ModelSummarize

Summarizes text or a document that you provide using an LLM model that you have configured.

You specify the configured model to use by setting the Model parameter to the name of the generative model configuration section. You can summarize text by setting the Text parameter, or you can summarize an IDOL document or set of documents by setting ID, Reference, or StateID.

When you provide multiple document IDs or references, or a state token, QMS returns a single summary of all the source documents, rather than multiple summaries.

NOTE: You can set only one of the Text, ID, Reference, or StateID parameters.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Model | The configured model to use to generate embeddings.

You must set one of the following parameters.

Parameter | Description
--- | ---
ID | The IDOL document ID of the document that you want to summarize.
Reference | The IDOL document reference of the document that you want to summarize.
StateID | The IDOL state token for the documents that you want to summarize.
Text | The text to summarize.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
SecurityInfo | A security info string to use to access the documents to summarize.

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.

## Example

The following action generates a summary for each of the documents in the EVHO1AC8P1K1-4 state ID, using the configured `Summarizer` model.

    http://qms:16000/action=ModelSummarize&StateID=EVHO1AC8P1K1-4&Model=Summarizer

Copyright 2024 Open Text
Version 24.3 | Last updated June 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 Query Manipulation Server 24.3

Topic Title: ModelSummarize