IDOL Content Component 24.3

# Summary

The type of summary to return for each result document. IDOL Content Component automatically generates the summaries from the contents of SourceType fields.

You can use one of the following summary options:

`Concept` | A conceptual summary of each result document. A concept summary contains sentences that are typical of the result content (these sentences can be from different parts of the result document).
`Context` | A conceptual summary of each result document, biased by the terms in the query Text. A context summary contains sentences that are particularly relevant to the terms in the query (these sentences can be from different parts of the result document). To ensure that the summary contains the query terms, use the Characters parameter to specify how many characters to use in the summary. You can also use the MaxSourceCharacters configuration parameter to use more than the first 10,000 characters of a document to generate summaries.
`Quick` | A brief summary of each result document. A quick summary contains the first few sentences of the document.
`ParagraphConcept` | A conceptual summary of each result document which contains the paragraphs that are most typical of the result content (these paragraphs can be from different parts of the result document).
`ParagraphContext` | A conceptual summary of each result document, biased by the terms in the query Text and FieldText. This summary contains paragraphs that are particularly relevant to the terms in the query.
`RAG` | A combination of a contextual summary with a vector summary. IDOL Content Component uses approximately 70% of the available characters for a contextual summary, and then appends the text corresponding to matching vectors in the result document for the remaining space. Text from matching vectors is appended only if it does not already appear in the contextual summary. The summary uses both text and `VECTOR` elements from the query. If a result does not match the vector in the query, IDOL Content Component produces a `Context` summary for that result. If IDOL Content Component cannot generate a contextual summary for a result in the characters available, it produces a `Vector` summary for that result. You can use TotalCharacters to set a total maximum number of characters for all summaries for the query. When you use the summary results in a RAG system, this option allows you to limit the total amount of text that IDOL Server generates. If you do not set TotalCharacters, IDOL Content Component allocates 750 characters for each result summary. This option is available only for Query. If you request a `RAG` summary for the Suggest or SuggestOnText actions, IDOL Content Component returns a `Context` summary.
`Vector` | A summary that contains the text corresponding to the vectors that match in the result document. Multiple vectors are concatenated with an ellipsis (...). Where a vector starts or ends inside a term in the source field, the summary includes the whole term. When a document contains multiple vectors that match the search, the summary includes all matching vectors. NOTE: If you request a vector summary, and a document returns in the query without matching any vectors, IDOL Content Component returns a `Context` summary. For example, if you request a `Vector`summary and do not use a `VECTOR` operator, IDOL Content Component returns context summaries for the results. If the `Context` summary fails for any reason, IDOL Content Component returns a `Quick` summary. This option is available only for Query. If you request a `Vector` summary for the Suggest or SuggestOnText actions, IDOL Content Component returns a `Quick` summary.
`Off` | No summary.

NOTE: To ensure the quality of summaries, OpenText recommends that the documents or document sections that you generate them for are smaller than 4 KB.

Actions: | Query Suggest SuggestOnText
Type: | String
Default: | Off
Example: | `Summary=Quick`
See Also: | Characters Sentences TotalCharacters MaxSourceCharacters configuration parameter

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 IDOL Content Component 24.3

Topic Title: Summary