public class QueryResponse
extends com.ibm.cloud.sdk.core.service.model.GenericModel
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.
|
public Long getMatchingResults()
The number of matching results for the query. Results that match due to a curation only are not counted in the total.
public List<QueryResult> getResults()
Array of document results for the query.
public List<QueryAggregation> getAggregations()
Array of aggregations for the query.
public RetrievalDetails getRetrievalDetails()
An object contain retrieval type information.
public String getSuggestedQuery()
Suggested correction to the submitted **natural_language_query** value.
@Deprecated public List<QuerySuggestedRefinement> getSuggestedRefinements()
Array of suggested refinements. **Note**: The `suggested_refinements` parameter that identified dynamic facets from the data is deprecated.
public List<QueryTableResult> getTableResults()
Array of table results.
public List<QueryResponsePassage> getPassages()
Passages that best match the query from across all of the collections in the project. Returned if **passages.per_document** is `false`.
Copyright © 2023 IBM Cloud. All rights reserved.