answer

The answer element is the root response element for a query request. Based on the query string entered by the end-user and the search environment’s configuration, Oracle ATG Web Commerce Search returns a response containing the results retrieved. The results can then be displayed in the user interface or subjected to further processing. The search results include:

  • The matching statement

  • The index item that contains that statement

  • Secondary information about the results, such as where they fall in the category taxonomy

  • Feedback about the query, such as spelling suggestions or refinements

Each document object contains the list of document sets and categories of which it is a member. This information includes the size of the document set, and for categories, the relevance of the document to that category.

Attribute

Description

contentID

Content ID of the index item.

QUID

Value of the query’s QUID attribute.

sorting

Value of the query’s sorting attribute.

sortProp

For grouping by property, the type, name, and default value.

docSetSort

Value of the query’s docSetSort attribute.

mode

Value of the query’s mode attribute.

strategy

Value of the query’s strategy attribute.

debug

Value of the query’s debug attribute.

refineDebug

Value of the query’s refineDebug attribute.

refineMax

Value of the query’s refineMax attribute.

refineMin

Value of the query’s refineMin attribute.

refineTop

Value of the query’s refineTop attribute.

autospell

Value of the query’s autospell attribute.

highlight

Value of the query’s highlight attribute.

minScore

Value of the query’s minScore attribute.

pageNum

Value of the query’s pageNum attribute.

pageSize

Value of the query’s pageSize attribute.

docSort

Value of the query’s docSort attribute.

docSortPred

Value of the query’s docSortPred attribute.

docSortProp

Value of the query’s docSortProps attribute.

docSortPropDefault

Value of the query’s docSortPropDefault attribute.

docSortOrder

Value of the query’s docSortOrder attribute.

docSortCase

Value of the query’s docSortCase attribute.

relQuestSettings

Value of the query’s relQuestSettings attribute.

responseNumberSettings

Value of the query’s responseNumberSettings attribute.

topicSettings

Reserved for future use.

responseCount

Total number of results returned.

groupCount

Total number of groups returned.

docCand

Number of document candidates considered during retrieval.

docMax

Estimate of how many documents are retrievable using the current query.

docMin

Minimum number of documents that could be returned, if all query terms were in the same documents.

ansCand

Number of sentence candidates considered during retrieval.

ansMax

Estimate of how many sentences are retrievable with the current query.

ansMin

Minimum number of sentences that could be considered, if all query terms were in the same sentence.

ansPool

Number of sentence results before grouping and paging.

pageOffsetInfo

Value of the query’s pageOffsetInfo attribute.

maxRelatedSets

Value of the query’s maxRelatedSets attribute.

responseTimeMs

Amount of time taken to process the query.

The answer element contains the following child elements: