com.ibm.watson.discovery.v1.model

Class QueryTopHitsAggregation

java.lang.Object

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

com.ibm.watson.discovery.v1.model.QueryAggregation

com.ibm.watson.discovery.v1.model.QueryTopHitsAggregation

All Implemented Interfaces:

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

public class QueryTopHitsAggregation
extends QueryAggregation

Returns the top documents ranked by the score of the query.

Method Summary

Modifier and Type	Method and Description
QueryTopHitsAggregationResult	getHits() Gets the hits.
String	getName() Gets the name.
Long	getSize() Gets the size.

Methods inherited from class com.ibm.watson.discovery.v1.model.QueryAggregation

getType

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

getSize

public Long getSize()

Gets the size.

The number of documents to return.

Returns:

the size

getName

public String getName()

Gets the name.

Identifier specified in the query request of this aggregation.

Returns:

the name

getHits

public QueryTopHitsAggregationResult getHits()

Gets the hits.

Returns:

the hits