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.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	documentId
protected java.lang.Long	endOffset
protected java.lang.String	field
protected java.lang.Double	passageScore
protected java.lang.String	passageText
protected java.lang.Long	startOffset

Constructor Summary

Constructors

Constructor and Description
QueryPassages()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDocumentId() Gets the documentId.
java.lang.Long	getEndOffset() Gets the endOffset.
java.lang.String	getField() Gets the field.
java.lang.Double	getPassageScore() Gets the passageScore.
java.lang.String	getPassageText() Gets the passageText.
java.lang.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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

documentId

@SerializedName(value="document_id")
protected java.lang.String documentId

passageScore

@SerializedName(value="passage_score")
protected java.lang.Double passageScore

passageText

@SerializedName(value="passage_text")
protected java.lang.String passageText

startOffset

@SerializedName(value="start_offset")
protected java.lang.Long startOffset

endOffset

@SerializedName(value="end_offset")
protected java.lang.Long endOffset

field

protected java.lang.String field

Constructor Detail

QueryPassages

public QueryPassages()

Method Detail

getDocumentId

public java.lang.String getDocumentId()

Gets the documentId.

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

Returns:

the documentId

getPassageScore

public java.lang.Double getPassageScore()

Gets the passageScore.

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

Returns:

the passageScore

getPassageText

public java.lang.String getPassageText()

Gets the passageText.

The content of the extracted passage.

Returns:

the passageText

getStartOffset

public java.lang.Long getStartOffset()

Gets the startOffset.

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

Returns:

the startOffset

getEndOffset

public java.lang.Long getEndOffset()

Gets the endOffset.

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

Returns:

the endOffset

getField

public java.lang.String getField()

Gets the field.

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

Returns:

the field