com.ibm.watson.discovery.v2.model

Class QueryTermAggregationResult

java.lang.Object

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

com.ibm.watson.discovery.v2.model.QueryTermAggregationResult

All Implemented Interfaces:

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

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

Top value result for the `term` 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.

Value of the field with a nonzero frequency in the document set.

Returns:

the key

getMatchingResults

public Long getMatchingResults()

Gets the matchingResults.

Number of documents that contain the 'key'.

Returns:

the matchingResults

getRelevancy

public Double getRelevancy()

Gets the relevancy.

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

Returns:

the relevancy

getTotalMatchingDocuments

public Long getTotalMatchingDocuments()

Gets the totalMatchingDocuments.

Number of documents in the collection that contain the term in the specified field. Returned only when `relevancy:true` is specified in the request.

Returns:

the totalMatchingDocuments

getEstimatedMatchingResults

public Double getEstimatedMatchingResults()

Gets the estimatedMatchingResults.

Number of documents that are estimated to match the query and also meet the 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 combined with other aggregations in the request or is returned as a subaggregation.

Returns:

the aggregations