com.ibm.watson.discovery.v1.model

Class QueryResponse

java.lang.Object

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

com.ibm.watson.discovery.v1.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	duplicatesRemoved
protected java.lang.Long	matchingResults
protected java.util.List<QueryPassages>	passages
protected java.util.List<QueryResult>	results
protected RetrievalDetails	retrievalDetails
protected java.lang.String	sessionToken
protected java.lang.String	suggestedQuery

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	getDuplicatesRemoved() Gets the duplicatesRemoved.
java.lang.Long	getMatchingResults() Gets the matchingResults.
java.util.List<QueryPassages>	getPassages() Gets the passages.
java.util.List<QueryResult>	getResults() Gets the results.
RetrievalDetails	getRetrievalDetails() Gets the retrievalDetails.
java.lang.String	getSessionToken() Gets the sessionToken.
java.lang.String	getSuggestedQuery() Gets the suggestedQuery.

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

passages

protected java.util.List<QueryPassages> passages

duplicatesRemoved

@SerializedName(value="duplicates_removed")
protected java.lang.Long duplicatesRemoved

sessionToken

@SerializedName(value="session_token")
protected java.lang.String sessionToken

retrievalDetails

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

suggestedQuery

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

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 aggregation results for the query.

Returns:

the aggregations

getPassages

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

Gets the passages.

Array of passage results for the query.

Returns:

the passages

getDuplicatesRemoved

public java.lang.Long getDuplicatesRemoved()

Gets the duplicatesRemoved.

The number of duplicate results removed.

Returns:

the duplicatesRemoved

getSessionToken

public java.lang.String getSessionToken()

Gets the sessionToken.

The session token for this query. The session token can be used to add events associated with this query to the query and event log.

**Important:** Session tokens are case sensitive.

Returns:

the sessionToken

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.

The suggestions for a misspelled natural language query.

Returns:

the suggestedQuery