IDOL 12.13

# Query Summary Response Format

When you set the `QuerySummary` parameter to `True` in a query, a tag of the following form returns in the results:

    <autn:querysummary>Apollo program, Greek mythology, Apollo Theater, HMS Apollo, Volkswagen Apollo, Apollo Computer</autn:querysummary>

This tag is known as a Dynamic Thesaurus and it gives a list of elements that are related to the original query string (in this case Apollo). According to your situation, you can interpret it as:

- a list of synonyms for the query string.

- suggestions for refining the search.

- subgroupings of the query topic.

If you have turned on the `QuerySummaryAdvanced` configuration option, then additional elements return. For example:

    <autn:qs>
       <autn:element pdocs="498"poccs="1734"cluster="-1"docs="498">Apollo</autn:element>
       <autn:element pdocs="53"poccs="75"cluster="0"docs="115">Apollo program</autn:element>
       <autn:element pdocs="47"poccs="99"cluster="0"docs="55">lunar module</autn:element>
       <autn:element pdocs="47"poccs="60"cluster="1"docs="55">Greek mythology/autn:element>
       <autn:element pdocs="36"poccs="60"cluster="0"docs="38">Space Shuttle</autn:element>
       <autn:element pdocs="29"poccs="43"cluster="0"docs="50">lunar orbit</autn:element>
       <autn:element pdocs="19" poccs="31" cluster="1" docs="77">Mount Olympus</autn:element>
       <autn:element pdocs="25"poccs="31"cluster="0"docs="82">Apollo spacecraft</autn:element>
       <autn:element pdocs="20"poccs="24"cluster="2"docs="33">Apollo Theater/autn:element>
       <autn:element pdocs="20"poccs="23"cluster="0"docs="20">Neil Armstrong/autn:element>
       ...
    </autn:qs>

Each `autn:element` tag contains information on the specified element. The entries are:

`pdocs` | The number of documents of the results set in which the element appears as a phrase.
`poccs` | The total number of occurrences of this element phrase in the results set.
`docs` | The number of documents of the results set in which all terms of this element appear.
`cluster` | The cluster into which the phrase has been grouped. This value allows you to cluster the elements according to their occurrence. In the previous example: cluster 0 corresponds to the Apollo space flights. cluster 1 is the Greek God Apollo. cluster 2 is the Apollo Theater. Unless the result set is unusually broad, there are rarely more than three strong clusters. When using the clusters for cluster analysis, you should ignore elements with negative cluster numbers (because they are too common, too rare, or too indiscriminate).
`ids` | An additional attribute, which is returned if you have set `QuerySummaryIDs` to `True` in your configuration. It contains a comma-separated list of the document IDs of the results set in which this element occurs as a phrase.

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL 12.13

Topic Title: Query Summary Response Format