com.ibm.watson.discovery.v2.model

Class QueryOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.QueryOptions

All Implemented Interfaces:

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

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

The query options.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	aggregation
protected java.util.List<java.lang.String>	collectionIds
protected java.lang.Long	count
protected java.lang.String	filter
protected java.lang.Boolean	highlight
protected java.lang.String	naturalLanguageQuery
protected java.lang.Long	offset
protected QueryLargePassages	passages
protected java.lang.String	projectId
protected java.lang.String	query
protected java.lang.String	sort
protected java.lang.Boolean	spellingSuggestions
protected QueryLargeSuggestedRefinements	suggestedRefinements
protected QueryLargeTableResults	tableResults
protected java.util.List<java.lang.String>	xReturn

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	aggregation() Gets the aggregation.
java.util.List<java.lang.String>	collectionIds() Gets the collectionIds.
java.lang.Long	count() Gets the count.
java.lang.String	filter() Gets the filter.
java.lang.Boolean	highlight() Gets the highlight.
java.lang.String	naturalLanguageQuery() Gets the naturalLanguageQuery.
QueryOptions.Builder	newBuilder() New builder.
java.lang.Long	offset() Gets the offset.
QueryLargePassages	passages() Gets the passages.
java.lang.String	projectId() Gets the projectId.
java.lang.String	query() Gets the query.
java.lang.String	sort() Gets the sort.
java.lang.Boolean	spellingSuggestions() Gets the spellingSuggestions.
QueryLargeSuggestedRefinements	suggestedRefinements() Gets the suggestedRefinements.
QueryLargeTableResults	tableResults() Gets the tableResults.
java.util.List<java.lang.String>	xReturn() Gets the xReturn.

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

projectId

protected java.lang.String projectId

collectionIds

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

filter

protected java.lang.String filter

query

protected java.lang.String query

naturalLanguageQuery

protected java.lang.String naturalLanguageQuery

aggregation

protected java.lang.String aggregation

count

protected java.lang.Long count

xReturn

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

offset

protected java.lang.Long offset

sort

protected java.lang.String sort

highlight

protected java.lang.Boolean highlight

spellingSuggestions

protected java.lang.Boolean spellingSuggestions

tableResults

protected QueryLargeTableResults tableResults

suggestedRefinements

protected QueryLargeSuggestedRefinements suggestedRefinements

passages

protected QueryLargePassages passages

Constructor Detail

QueryOptions

protected QueryOptions(QueryOptions.Builder builder)

Method Detail

newBuilder

public QueryOptions.Builder newBuilder()

New builder.

Returns:

a QueryOptions builder

projectId

public java.lang.String projectId()

Gets the projectId.

The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.

Returns:

the projectId

collectionIds

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

Gets the collectionIds.

A comma-separated list of collection IDs to be queried against.

Returns:

the collectionIds

filter

public java.lang.String filter()

Gets the filter.

A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.

Returns:

the filter

query

public java.lang.String query()

Gets the query.

A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first. Use a query search when you want to find the most relevant search results.

Returns:

the query

naturalLanguageQuery

public java.lang.String naturalLanguageQuery()

Gets the naturalLanguageQuery.

A natural language query that returns relevant documents by utilizing training data and natural language understanding.

Returns:

the naturalLanguageQuery

aggregation

public java.lang.String aggregation()

Gets the aggregation.

An aggregation search that returns an exact answer by combining query search with filters. Useful for applications to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference.

Returns:

the aggregation

count

public java.lang.Long count()

Gets the count.

Number of results to return.

Returns:

the count

xReturn

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

Gets the xReturn.

A list of the fields in the document hierarchy to return. If this parameter not specified, then all top-level fields are returned.

Returns:

the xReturn

offset

public java.lang.Long offset()

Gets the offset.

The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results.

Returns:

the offset

sort

public java.lang.String sort()

Gets the sort.

A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no prefix is specified. This parameter cannot be used in the same query as the **bias** parameter.

Returns:

the sort

highlight

public java.lang.Boolean highlight()

Gets the highlight.

When `true`, a highlight field is returned for each result which contains the fields which match the query with `` tags around the matching query terms.

Returns:

the highlight

spellingSuggestions

public java.lang.Boolean spellingSuggestions()

Gets the spellingSuggestions.

When `true` and the **natural_language_query** parameter is used, the **natural_language_query** parameter is spell checked. The most likely correction is returned in the **suggested_query** field of the response (if one exists).

Returns:

the spellingSuggestions

tableResults

public QueryLargeTableResults tableResults()

Gets the tableResults.

Configuration for table retrieval.

Returns:

the tableResults

suggestedRefinements

public QueryLargeSuggestedRefinements suggestedRefinements()

Gets the suggestedRefinements.

Configuration for suggested refinements.

Returns:

the suggestedRefinements

passages

public QueryLargePassages passages()

Gets the passages.

Configuration for passage retrieval.

Returns:

the passages