IDOL Category Component 24.2

# About the QuerySummary Parameter

To perform an action with the `QuerySummary` parameter, add the following parameters to your `Query`, `Suggest`, or `SuggestOnText` action:

``QuerySummary`=True` | Content identifies the three most relevant terms and phrases of the clustered phrases, and returns them in an `<autn:querysummary>` field. It also returns a list of the specified `QuerySummaryLength` number of the best terms and phrases.
``Combine`=Simple` | If multiple sections in a result document match the query, Content displays only the section with the highest conceptual similarity (rather than returning different sections of the same result document). This increases the relevance of the final phrases.
``Print`=NoResults` | The purpose of the query is to provide query guidance, but not return results at the same time. Printing the results slows the IDOL Content component performance.
``MaxResults`=N` | Set `N` to the number of results from which to generate the clustered terms and phrases. Content can produce high-quality clusters only if it has enough result documents available. However, setting `MaxResults` too high can slow the query performance (a sensible maximum value might be 50–500).

For example:

    action=Query&Text=Apollo&QuerySummary=True&Combine=Simple&Print=NoResults&MaxResults=100

In this example, if you have set `QuerySummaryLength` to `10` in the configuration file, Content clusters the results that the query produces and lists the top 10 relevant terms or phrases that the results contain:

    <autn:element pdocs="52" poccs="108" cluster="0" docs="56">Apollo program</autn:element>
    <autn:element pdocs="29" poccs="83" cluster="0" docs="34">Neil Armstrong</autn:element>
    <autn:element pdocs="22" poccs="43" cluster="0" docs="27">command module</autn:element>
    <autn:element pdocs="18" poccs="61" cluster="0" docs="54">Lunar Module</autn:element>
    <autn:element pdocs="13" poccs="13" cluster="1" docs="13">Greek mythology</autn:element>
    <autn:element pdocs="15" poccs="22" cluster="2" docs="35">Royal Navy</autn:element>
    <autn:element pdocs="22" poccs="28" cluster="2" docs="26">HMS Apollo</autn:element>
    <autn:element pdocs="14" poccs="21" cluster="0" docs="14">moon landings</autn:element>
    <autn:element pdocs="8" poccs="8" cluster="2" docs="9">Leander-class frigate</autn:element>
    <autn:element pdocs="12" poccs="14" cluster="1" docs="15">Greek god Apollo</autn:element>

The information for the top phrases and terms in the clusters that Content has generated consists of the following elements:

`pdocs` | The number of documents in which the entire phrase appears.
`poccs` | The total number of times that the phrase appears in all documents.
`cluster` | The number of the cluster that the phrase falls into. A negative number indicates that the associated documents do not fall into any of the generated clusters.
`docs` | The number of documents in which all the terms appear.

For example:

    <autn:element pdocs="52" poccs="108" cluster="0" docs="56">Apollo program</autn:element>

In this example, the phrase "Apollo program" occurs in 52 documents out of the 100 results. The phrase appears 108 times in total in these documents. The phrase falls into cluster 0.

The terms "Apollo" and "program" appear in 56 documents.

Content also returns the best phrases or terms of the top three clusters in a comma-separated list in the `<autn:querysummary>` field:

    <autn:querysummary>Apollo program, Greek mythology, Royal Navy</autn:querysummary>

You can use each of these top cluster phrases as an alternative query, as well as the less relevant terms and phrases in each cluster.

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 IDOL Category Component 24.2

Topic Title: About the QuerySummary Parameter