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 containing the documents and aggregations for the query.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<QueryAggregation>	aggregations
protected java.lang.Long	matchingResults
protected java.util.List<QueryResponsePassage>	passages
protected java.util.List<QueryResult>	results
protected RetrievalDetails	retrievalDetails
protected java.lang.String	suggestedQuery
protected java.util.List<QuerySuggestedRefinement>	suggestedRefinements
protected java.util.List<QueryTableResult>	tableResults

Constructor Summary

Constructors

Constructor and Description
QueryResponse()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<QueryAggregation>	getAggregations() Gets the aggregations.
java.lang.Long	getMatchingResults() Gets the matchingResults.
java.util.List<QueryResponsePassage>	getPassages() Gets the passages.
java.util.List<QueryResult>	getResults() Gets the results.
RetrievalDetails	getRetrievalDetails() Gets the retrievalDetails.
java.lang.String	getSuggestedQuery() Gets the suggestedQuery.
java.util.List<QuerySuggestedRefinement>	getSuggestedRefinements() Gets the suggestedRefinements.
java.util.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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

matchingResults

@SerializedName(value="matching_results")
protected java.lang.Long matchingResults

results

protected java.util.List<QueryResult> results

aggregations

protected java.util.List<QueryAggregation> aggregations

retrievalDetails

@SerializedName(value="retrieval_details")
protected RetrievalDetails retrievalDetails

suggestedQuery

@SerializedName(value="suggested_query")
protected java.lang.String suggestedQuery

suggestedRefinements

@SerializedName(value="suggested_refinements")
protected java.util.List<QuerySuggestedRefinement> suggestedRefinements

tableResults

@SerializedName(value="table_results")
protected java.util.List<QueryTableResult> tableResults

passages

protected java.util.List<QueryResponsePassage> passages

Constructor Detail

QueryResponse

public QueryResponse()

Method Detail

getMatchingResults

public java.lang.Long getMatchingResults()

Gets the matchingResults.

The number of matching results for the query.

Returns:

the matchingResults

getResults

public java.util.List<QueryResult> getResults()

Gets the results.

Array of document results for the query.

Returns:

the results

getAggregations

public java.util.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 java.lang.String getSuggestedQuery()

Gets the suggestedQuery.

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

Returns:

the suggestedQuery

getSuggestedRefinements

public java.util.List<QuerySuggestedRefinement> getSuggestedRefinements()

Gets the suggestedRefinements.

Array of suggested refinements.

Returns:

the suggestedRefinements

getTableResults

public java.util.List<QueryTableResult> getTableResults()

Gets the tableResults.

Array of table results.

Returns:

the tableResults

getPassages

public java.util.List<QueryResponsePassage> getPassages()

Gets the passages.

Passages returned by Discovery.

Returns:

the passages