com.ibm.watson.discovery.v1.model

Class QueryPassages

java.lang.Object

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

com.ibm.watson.discovery.v1.model.QueryPassages

All Implemented Interfaces:

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

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

A passage query result.

Method Summary

Modifier and Type	Method and Description
String	getDocumentId() Gets the documentId.
Long	getEndOffset() Gets the endOffset.
String	getField() Gets the field.
Double	getPassageScore() Gets the passageScore.
String	getPassageText() Gets the passageText.
Long	getStartOffset() Gets the startOffset.

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

getDocumentId

public String getDocumentId()

Gets the documentId.

The unique identifier of the document from which the passage has been extracted.

Returns:

the documentId

getPassageScore

public Double getPassageScore()

Gets the passageScore.

The confidence score of the passages's analysis. A higher score indicates greater confidence.

Returns:

the passageScore

getPassageText

public String getPassageText()

Gets the passageText.

The content of the extracted passage.

Returns:

the passageText

getStartOffset

public Long getStartOffset()

Gets the startOffset.

The position of the first character of the extracted passage in the originating field.

Returns:

the startOffset

getEndOffset

public Long getEndOffset()

Gets the endOffset.

The position of the last character of the extracted passage in the originating field.

Returns:

the endOffset

getField

public String getField()

Gets the field.

The label of the field from which the passage has been extracted.

Returns:

the field