com.ibm.watson.discovery.v2.model

Class QueryResponse

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.discovery.v2.model.QueryResponse

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class QueryResponse
extends com.ibm.cloud.sdk.core.service.model.GenericModel

A response that contains the documents and aggregations for the query.

Method Summary

Modifier and Type	Method and Description
List<QueryAggregation>	getAggregations() Gets the aggregations.
Long	getMatchingResults() Gets the matchingResults.
List<QueryResponsePassage>	getPassages() Gets the passages.
List<QueryResult>	getResults() Gets the results.
RetrievalDetails	getRetrievalDetails() Gets the retrievalDetails.
String	getSuggestedQuery() Gets the suggestedQuery.
List<QuerySuggestedRefinement>	getSuggestedRefinements() Deprecated. this method is deprecated and may be removed in a future release
List<QueryTableResult>	getTableResults() Gets the tableResults.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getMatchingResults

public Long getMatchingResults()

Gets the matchingResults.

The number of matching results for the query. Results that match due to a curation only are not counted in the total.

Returns:

the matchingResults

getResults

public List<QueryResult> getResults()

Gets the results.

Array of document results for the query.

Returns:

the results

getAggregations

public List<QueryAggregation> getAggregations()

Gets the aggregations.

Array of aggregations for the query.

Returns:

the aggregations

getRetrievalDetails

public RetrievalDetails getRetrievalDetails()

Gets the retrievalDetails.

An object contain retrieval type information.

Returns:

the retrievalDetails

getSuggestedQuery

public String getSuggestedQuery()

Gets the suggestedQuery.

Suggested correction to the submitted **natural_language_query** value.

Returns:

the suggestedQuery

getSuggestedRefinements

@Deprecated
public List<QuerySuggestedRefinement> getSuggestedRefinements()

Deprecated. this method is deprecated and may be removed in a future release

Gets the suggestedRefinements.

Array of suggested refinements. **Note**: The `suggested_refinements` parameter that identified dynamic facets from the data is deprecated.

Returns:

the suggestedRefinements

getTableResults

public List<QueryTableResult> getTableResults()

Gets the tableResults.

Array of table results.

Returns:

the tableResults

getPassages

public List<QueryResponsePassage> getPassages()

Gets the passages.

Passages that best match the query from across all of the collections in the project. Returned if **passages.per_document** is `false`.

Returns:

the passages