com.ibm.watson.discovery.v2.model

Class DefaultQueryParamsPassages

java.lang.Object

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

com.ibm.watson.discovery.v2.model.DefaultQueryParamsPassages

All Implemented Interfaces:

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

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

Default settings configuration for passage search options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Long	characters() Gets the characters.
Long	count() Gets the count.
Boolean	enabled() Gets the enabled.
List<String>	fields() Gets the fields.
Long	maxPerDocument() Gets the maxPerDocument.
DefaultQueryParamsPassages.Builder	newBuilder() New builder.
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

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public DefaultQueryParamsPassages.Builder newBuilder()

New builder.

Returns:

a DefaultQueryParamsPassages builder

enabled

public Boolean enabled()

Gets the enabled.

When `true`, a passage search is performed by default.

Returns:

the enabled

count

public Long count()

Gets the count.

The number of passages to return.

Returns:

the count

fields

public List<String> fields()

Gets the fields.

An array of field names to perform the passage search on.

Returns:

the fields

characters

public Long characters()

Gets the characters.

The approximate number of characters that each returned passage will contain.

Returns:

the characters

perDocument

public Boolean perDocument()

Gets the perDocument.

When `true` the number of passages that can be returned from a single document is restricted to the *max_per_document* value.

Returns:

the perDocument

maxPerDocument

public Long maxPerDocument()

Gets the maxPerDocument.

The default maximum number of passages that can be taken from a single document as the result of a passage query.

Returns:

the maxPerDocument