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.

Method Summary

Modifier and Type	Method and Description
String	aggregation() Gets the aggregation.
List<String>	collectionIds() Gets the collectionIds.
Long	count() Gets the count.
String	filter() Gets the filter.
Boolean	highlight() Gets the highlight.
String	naturalLanguageQuery() Gets the naturalLanguageQuery.
QueryOptions.Builder	newBuilder() New builder.
Long	offset() Gets the offset.
QueryLargePassages	passages() Gets the passages.
String	projectId() Gets the projectId.
String	query() Gets the query.
QueryLargeSimilar	similar() Gets the similar.
String	sort() Gets the sort.
Boolean	spellingSuggestions() Gets the spellingSuggestions.
QueryLargeSuggestedRefinements	suggestedRefinements() Gets the suggestedRefinements.
QueryLargeTableResults	tableResults() Gets the tableResults.
List<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

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public QueryOptions.Builder newBuilder()

New builder.

Returns:

a QueryOptions builder

projectId

public String projectId()

Gets the projectId.

The ID of the project. This information can be found from the *Integrate and Deploy* page in Discovery.

Returns:

the projectId

collectionIds

public List<String> collectionIds()

Gets the collectionIds.

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

Returns:

the collectionIds

filter

public String filter()

Gets the filter.

Searches for documents that match the Discovery Query Language criteria that is specified as input. Filter calls are cached and are faster than query calls because the results are not ordered by relevance. When used with the **aggregation**, **query**, or **natural_language_query** parameters, the **filter** parameter runs first. This parameter is useful for limiting results to those that contain specific metadata values.

Returns:

the filter

query

public String query()

Gets the query.

A query search that is written in the Discovery Query Language and returns all matching documents in your data set with full enrichments and full text, and with the most relevant documents listed first. Use a query search when you want to find the most relevant search results. You can use this parameter or the **natural_language_query** parameter to specify the query input, but not both.

Returns:

the query

naturalLanguageQuery

public String naturalLanguageQuery()

Gets the naturalLanguageQuery.

A natural language query that returns relevant documents by using training data and natural language understanding. You can use this parameter or the **query** parameter to specify the query input, but not both. To filter the results based on criteria you specify, include the **filter** parameter in the request.

Returns:

the naturalLanguageQuery

aggregation

public 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 more information about the supported types of aggregations, see the [Discovery documentation](/docs/discovery-data?topic=discovery-data-query-aggregations).

Returns:

the aggregation

count

public Long count()

Gets the count.

Number of results to return.

Returns:

the count

xReturn

public List<String> xReturn()

Gets the xReturn.

A list of the fields in the document hierarchy to return. You can specify both root-level (`text`) and nested (`extracted_metadata.filename`) fields. If this parameter is an empty list, then all fields are returned.

Returns:

the xReturn

offset

public 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 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.

Returns:

the sort

highlight

public Boolean highlight()

Gets the highlight.

When `true`, a highlight field is returned for each result that contains fields that match the query. The matching query terms are emphasized with surrounding `<em></em>` tags. This parameter is ignored if **passages.enabled** and **passages.per_document** are `true`, in which case passages are returned for each document instead of highlights.

Returns:

the highlight

spellingSuggestions

public 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.

**Note**: The **suggested_refinements** parameter that identified dynamic facets from the data is deprecated.

Returns:

the suggestedRefinements

passages

public QueryLargePassages passages()

Gets the passages.

Configuration for passage retrieval.

Returns:

the passages

similar

public QueryLargeSimilar similar()

Gets the similar.

Finds results from documents that are similar to documents of interest. Use this parameter to add a *More like these* function to your search. You can include this parameter with or without a **query**, **filter** or **natural_language_query** parameter.

Returns:

the similar