com.ibm.watson.developer_cloud.discovery.v1.model

Class QueryOptions

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.discovery.v1.model.QueryOptions

All Implemented Interfaces:

ObjectModel

public class QueryOptions
extends 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
java.lang.String	aggregation() Gets the aggregation.
java.lang.String	collectionId() Gets the collectionId.
java.lang.Long	count() Gets the count.
java.lang.Boolean	deduplicate() Gets the deduplicate.
java.lang.String	deduplicateField() Gets the deduplicateField.
java.lang.String	environmentId() Gets the environmentId.
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.
java.lang.Boolean	passages() Gets the passages.
java.lang.Long	passagesCharacters() Gets the passagesCharacters.
java.lang.Long	passagesCount() Gets the passagesCount.
java.util.List<java.lang.String>	passagesFields() Gets the passagesFields.
java.lang.String	query() Gets the query.
java.util.List<java.lang.String>	returnFields() Gets the returnFields.
java.util.List<java.lang.String>	sort() Gets the sort.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public QueryOptions.Builder newBuilder()

New builder.

Returns:

a QueryOptions builder

environmentId

public java.lang.String environmentId()

Gets the environmentId. the ID of your environment.

Returns:

the environmentId

collectionId

public java.lang.String collectionId()

Gets the collectionId. the ID of your collection.

Returns:

the collectionId

filter

public java.lang.String filter()

Gets the filter. A cacheable query that limits the documents returned to exclude any documents that don't mention the query content. Filter searches are better for metadata type searches and when you are trying to get a sense of 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. You cannot use `natural_language_query` and `query` at the same time.

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. You cannot use `natural_language_query` and `query` at the same time.

Returns:

the naturalLanguageQuery

passages

public java.lang.Boolean passages()

Gets the passages. A passages query that returns the most relevant passages from the results.

Returns:

the passages

aggregation

public java.lang.String aggregation()

Gets the aggregation. An aggregation search uses combinations of filters and query search to return an exact answer. Aggregations are useful for building applications, because you can use them to build lists, tables, and time series. For a full list of possible aggregrations, see the Query reference.

Returns:

the aggregation

count

public java.lang.Long count()

Gets the count. Number of documents to return.

Returns:

the count

returnFields

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

Gets the returnFields. A comma separated list of the portion of the document hierarchy to return.

Returns:

the returnFields

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.util.List<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.

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 that match the query with `` tags around the matching query terms. Defaults to false.

Returns:

the highlight

passagesFields

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

Gets the passagesFields. A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all top-level fields are included.

Returns:

the passagesFields

passagesCount

public java.lang.Long passagesCount()

Gets the passagesCount. The maximum number of passages to return. The search returns fewer passages if the requested total is not found. The default is 10. The maximum is 100.

Returns:

the passagesCount

passagesCharacters

public java.lang.Long passagesCharacters()

Gets the passagesCharacters. The approximate number of characters that any one passage will have. The default is 400. The minimum is 50. The maximum is 2000.

Returns:

the passagesCharacters

deduplicate

public java.lang.Boolean deduplicate()

Gets the deduplicate. When true and used with a Watson Discovery News collection, duplicate results (based on the contents of the title field) are removed. Duplicate comparison is limited to the current query only, offset is not considered. Defaults to false. This parameter is currently Beta functionality.

Returns:

the deduplicate

deduplicateField

public java.lang.String deduplicateField()

Gets the deduplicateField. When specified, duplicate results based on the field specified are removed from the returned results. Duplicate comparison is limited to the current query only, offset is not considered. This parameter is currently Beta functionality.

Returns:

the deduplicateField