public class DefaultQueryParams
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Modifier and Type | Class and Description |
---|---|
static class |
DefaultQueryParams.Builder
Builder.
|
Modifier and Type | Method and Description |
---|---|
String |
aggregation()
Gets the aggregation.
|
List<String> |
collectionIds()
Gets the collectionIds.
|
Long |
count()
Gets the count.
|
Boolean |
highlight()
Gets the highlight.
|
DefaultQueryParams.Builder |
newBuilder()
New builder.
|
DefaultQueryParamsPassages |
passages()
Gets the passages.
|
String |
sort()
Gets the sort.
|
Boolean |
spellingSuggestions()
Gets the spellingSuggestions.
|
DefaultQueryParamsSuggestedRefinements |
suggestedRefinements()
Gets the suggestedRefinements.
|
DefaultQueryParamsTableResults |
tableResults()
Gets the tableResults.
|
List<String> |
xReturn()
Gets the xReturn.
|
public DefaultQueryParams.Builder newBuilder()
public List<String> collectionIds()
An array of collection identifiers to query. If empty or omitted all collections in the project are queried.
public DefaultQueryParamsPassages passages()
Default settings configuration for passage search options.
public DefaultQueryParamsTableResults tableResults()
Default project query settings for table results.
public String aggregation()
A string representing the default aggregation query for the project.
public DefaultQueryParamsSuggestedRefinements suggestedRefinements()
Object that contains suggested refinement settings. Available with Premium plans only.
public Boolean spellingSuggestions()
When `true`, a spelling suggestions for the query are returned by default.
public Boolean highlight()
When `true`, a highlights for the query are returned by default.
public Long count()
The number of document results returned by default.
public String sort()
A comma separated list of document fields to sort results by default.
Copyright © 2021 IBM Cloud. All rights reserved.