com.ibm.watson.discovery.v2.model

Class QueryLargePassages

java.lang.Object

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

com.ibm.watson.discovery.v2.model.QueryLargePassages

All Implemented Interfaces:

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

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

Configuration for passage retrieval.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryLargePassages.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Long	characters
protected java.lang.Long	count
protected java.lang.Boolean	enabled
protected java.util.List<java.lang.String>	fields
protected java.lang.Long	maxPerDocument
protected java.lang.Boolean	perDocument

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryLargePassages(QueryLargePassages.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	characters() Gets the characters.
java.lang.Long	count() Gets the count.
java.lang.Boolean	enabled() Gets the enabled.
java.util.List<java.lang.String>	fields() Gets the fields.
java.lang.Long	maxPerDocument() Gets the maxPerDocument.
QueryLargePassages.Builder	newBuilder() New builder.
java.lang.Boolean	perDocument() Gets the perDocument.

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

enabled

protected java.lang.Boolean enabled

perDocument

@SerializedName(value="per_document")
protected java.lang.Boolean perDocument

maxPerDocument

@SerializedName(value="max_per_document")
protected java.lang.Long maxPerDocument

fields

protected java.util.List<java.lang.String> fields

count

protected java.lang.Long count

characters

protected java.lang.Long characters

Constructor Detail

QueryLargePassages

protected QueryLargePassages(QueryLargePassages.Builder builder)

Method Detail

newBuilder

public QueryLargePassages.Builder newBuilder()

New builder.

Returns:

a QueryLargePassages builder

enabled

public java.lang.Boolean enabled()

Gets the enabled.

A passages query that returns the most relevant passages from the results.

Returns:

the enabled

perDocument

public java.lang.Boolean perDocument()

Gets the perDocument.

When `true`, passages will be returned within their respective result.

Returns:

the perDocument

maxPerDocument

public java.lang.Long maxPerDocument()

Gets the maxPerDocument.

Maximum number of passages to return per result.

Returns:

the maxPerDocument

fields

public java.util.List<java.lang.String> fields()

Gets the fields.

A list of fields that passages are drawn from. If this parameter not specified, then all top-level fields are included.

Returns:

the fields

count

public java.lang.Long count()

Gets the count.

The maximum number of passages to return. The search returns fewer passages if the requested total is not found. The maximum is `100`.

Returns:

the count

characters

public java.lang.Long characters()

Gets the characters.

The approximate number of characters that any one passage will have.

Returns:

the characters