com.ibm.watson.discovery.v2.model

Class QueryResultMetadata

java.lang.Object

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

com.ibm.watson.discovery.v2.model.QueryResultMetadata

All Implemented Interfaces:

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

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

Metadata of a query result.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryResultMetadata.DocumentRetrievalSource The document retrieval source that produced this search result.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	collectionId
protected java.lang.Double	confidence
protected java.lang.String	documentRetrievalSource

Constructor Summary

Constructors

Constructor and Description
QueryResultMetadata()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCollectionId() Gets the collectionId.
java.lang.Double	getConfidence() Gets the confidence.
java.lang.String	getDocumentRetrievalSource() Gets the documentRetrievalSource.

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

documentRetrievalSource

@SerializedName(value="document_retrieval_source")
protected java.lang.String documentRetrievalSource

collectionId

@SerializedName(value="collection_id")
protected java.lang.String collectionId

confidence

protected java.lang.Double confidence

Constructor Detail

QueryResultMetadata

public QueryResultMetadata()

Method Detail

getDocumentRetrievalSource

public java.lang.String getDocumentRetrievalSource()

Gets the documentRetrievalSource.

The document retrieval source that produced this search result.

Returns:

the documentRetrievalSource

getCollectionId

public java.lang.String getCollectionId()

Gets the collectionId.

The collection id associated with this training data set.

Returns:

the collectionId

getConfidence

public java.lang.Double getConfidence()

Gets the confidence.

The confidence score for the given result. Calculated based on how relevant the result is estimated to be. confidence can range from `0.0` to `1.0`. The higher the number, the more relevant the document. The `confidence` value for a result was calculated using the model specified in the `document_retrieval_strategy` field of the result set. This field is only returned if the **natural_language_query** parameter is specified in the query.

Returns:

the confidence