com.ibm.watson.discovery.v2.model

Class QueryGroupByAggregationResult

java.lang.Object

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

com.ibm.watson.discovery.v2.model.QueryGroupByAggregationResult

All Implemented Interfaces:

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

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

Result group for the `group_by` aggregation.

Method Summary

Modifier and Type	Method and Description
List<Map<String,Object>>	getAggregations() Gets the aggregations.
Double	getEstimatedMatchingResults() Gets the estimatedMatchingResults.
String	getKey() Gets the key.
Long	getMatchingResults() Gets the matchingResults.
Double	getRelevancy() Gets the relevancy.
Long	getTotalMatchingDocuments() Gets the totalMatchingDocuments.

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

getKey

public String getKey()

Gets the key.

The condition that is met by the documents in this group. For example, `YEARTXT<2000`.

Returns:

the key

getMatchingResults

public Long getMatchingResults()

Gets the matchingResults.

Number of documents that meet the query and condition.

Returns:

the matchingResults

getRelevancy

public Double getRelevancy()

Gets the relevancy.

The relevancy for this group. Returned only if `relevancy:true` is specified in the request.

Returns:

the relevancy

getTotalMatchingDocuments

public Long getTotalMatchingDocuments()

Gets the totalMatchingDocuments.

Number of documents that meet the condition in the whole set of documents in this collection. Returned only when `relevancy:true` is specified in the request.

Returns:

the totalMatchingDocuments

getEstimatedMatchingResults

public Double getEstimatedMatchingResults()

Gets the estimatedMatchingResults.

The number of documents that are estimated to match the query and condition. Returned only when `relevancy:true` is specified in the request.

Returns:

the estimatedMatchingResults

getAggregations

public List<Map<String,Object>> getAggregations()

Gets the aggregations.

An array of subaggregations. Returned only when this aggregation is returned as a subaggregation.

Returns:

the aggregations