QueryResultMetadata (IBM Watson Java SDK 9.2.1 API)

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 Description

static interface QueryResultMetadata.DocumentRetrievalSource
The document retrieval source that produced this search result.
Constructor Summary

Constructors

Constructor Description

QueryResultMetadata()

Method Summary

Modifier and Type	Method	Description
`String`	`getCollectionId()`	Gets the collectionId.
`Double`	`getConfidence()`	Gets the confidence.
`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

getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- QueryResultMetadata
  
  public QueryResultMetadata()
Method Details
- getDocumentRetrievalSource
  
  public String getDocumentRetrievalSource()
  
  Gets the documentRetrievalSource.
  The document retrieval source that produced this search result.
  
  Returns:
  
  the documentRetrievalSource
- getCollectionId
  
  public String getCollectionId()
  
  Gets the collectionId.
  The collection id associated with this training data set.
  
  Returns:
  
  the collectionId
- getConfidence
  
  public 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