public class DefaultQueryParamsPassages
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
DefaultQueryParamsPassages.Builder
Builder.
|
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.
|
public DefaultQueryParamsPassages.Builder newBuilder()
public Boolean enabled()
When `true`, a passage search is performed by default.
public Long count()
The number of passages to return.
public List<String> fields()
An array of field names to perform the passage search on.
public Long characters()
The approximate number of characters that each returned passage will contain.
public Boolean perDocument()
When `true` the number of passages that can be returned from a single document is restricted to the *max_per_document* value.
public Long maxPerDocument()
The default maximum number of passages that can be taken from a single document as the result of a passage query.
Copyright © 2023 IBM Cloud. All rights reserved.