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

Class FederatedQueryOptions

java.lang.Object

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

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

All Implemented Interfaces:

ObjectModel

public class FederatedQueryOptions
extends GenericModel

The federatedQuery options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FederatedQueryOptions.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.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.
FederatedQueryOptions.Builder	newBuilder() New builder.
java.lang.Long	offset() Gets the offset.
java.lang.String	query() Gets the query.
java.util.List<java.lang.String>	returnFields() Gets the returnFields.
java.lang.Boolean	similar() Gets the similar.
java.util.List<java.lang.String>	similarDocumentIds() Gets the similarDocumentIds.
java.util.List<java.lang.String>	similarFields() Gets the similarFields.
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 FederatedQueryOptions.Builder newBuilder()

New builder.

Returns:

a FederatedQueryOptions builder

environmentId

public java.lang.String environmentId()

Gets the environmentId. The ID of the environment.

Returns:

the environmentId

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

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

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

similar

public java.lang.Boolean similar()

Gets the similar. When `true`, results are returned based on their similarity to the document IDs specified in the `similar.document_ids` parameter. The default is `false`.

Returns:

the similar

similarDocumentIds

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

Gets the similarDocumentIds. A comma-separated list of document IDs that will be used to find similar documents. **Note:** If the `natural_language_query` parameter is also specified, it will be used to expand the scope of the document similarity search to include the natural language query. Other query parameters, such as `filter` and `query` are subsequently applied and reduce the query scope.

Returns:

the similarDocumentIds

similarFields

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

Gets the similarFields. A comma-separated list of field names that will be used as a basis for comparison to identify similar documents. If not specified, the entire document is used for comparison.

Returns:

the similarFields