The standard query results object consists of an answer element and its children. Most of the answer recapitulates information about the original query and its settings. The actual search results are contained in answer/response elements.
answer
The answer element is the root response element for a standard query request. See the Standard Query XML section for attributes that refer back to the query.
Attribute | Description |
|---|---|
| ContentID of index. |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| For grouping by property, the type, name, and default value. |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Value of the query’s |
| Reserved for future use. |
| Total number of results returned. |
| Total number of groups returned. |
| Total number of preferred answers returned. Not used in Search 2007.3. |
| Total number of unstructured results returned. |
| Relevancy score of the top result. |
| Relevancy score of top preferred answer result. |
| Relevancy score of top unstructured result. |
| Number of document candidates considered during retrieval. |
| Estimate of how many documents are retrievable using the current query. |
| Minimum number of documents that could be returned, if all query terms were in the same documents. |
| Number of sentence candidates considered during retrieval. |
| Estimate of how many sentences are retrievable with the current query. |
| Minimum number of sentences that could be considered, if all query terms were in the same sentence. |
| Number of sentence results before grouping and paging. |
Child Elements | Description |
|---|---|
| User search string after processing and modifications. No child elements. |
| Prior or secondary user input. No child elements. |
| Raw user search string, unmodified. No child elements. |
| Miscellaneous information. No child elements. |
| Document constraint expression. See Constraint Expressions. |
| Preferred answer constraint expression. See Constraint Expressions. |
| Document preference expression. See Constraint Expressions. |
| Query categorization results. Contains |
| Debugging information. No child elements. |
| Advanced query term vector data. Contains |
| Spelling suggestions and feedback. Contains |
| Natural language processing options. The children of this element contain detailed information about document parsing options; see the ATG Search Administration Guide. |
| Query analysis rule results. Contains an |
| Action arguments. Contains a |
| A single search result. See the answer/response section in this chapter. |
| Categorization of the results. Contains a |
| Query feedback data. Contains |
| Query refinement data. Contains child elements representing different data types for refinement. |
answer/response
Attributes | Description |
|---|---|
| Relevancy score of the result. See the Relevancy Calculation section in the Query Concepts and Processes chapter. |
| Result index in this response. |
| Result group identifier. |
| Type of result. |
| Whether or not the document or preferred answer is viewable. |
| The ACA segment identifier. |
| The text field name. |
| Value of the |
Child Elements | Description |
|---|---|
| Matching statement text of the result. No child elements. |
| Normalized statement text. No child elements. |
| Question text for preferred answer results. No child elements. |
| Document of the result. See the answer/response/document section of this chapter. |
| Debugging information. No child elements. |
answer/response/document
A single document within the response element.
Attributes | Description |
|---|---|
| View context information in the form:
|
| Document identifier. |
| Jump to off-set of this result in the document text. |
| Size of source of document. |
| Physical document set of the document. |
| Major format of document. |
| Language of document. |
| File name (excluding path). |
| Relevance score of document. |
Child Elements | Description |
|---|---|
| Title of document. No child elements. |
| Summary of the document. No child elements. |
| URL of the document. No child elements. |
| Last modified date/time of document. No child elements. |
| Question text if the document is a preferred answer. No child elements. |
| Answer text if the document is a preferred answer. No child elements. |
| List of meta-data properties for this document, contained by simple meta child elements. |
| List of related document sets or categories, contained by simple set child elements. |
Constraint Expressions
When present in a query’s result XML, a constraint expression contains any constraint information that has been applied to the query, including:
document set path
document format
document file extension type (such as .doc or .htm)
document URL
last modified date
etc.
See the Query Constraints section of the Query Component Reference chapter for more information. Constraints can also be configured using metadata or query rules; see the ATG Search Administration Guide for information.
