com.ibm.watson.discovery.v1.model

Class FederatedQueryOptions

java.lang.Object

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

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

All Implemented Interfaces:

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

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

The federatedQuery options.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	aggregation
protected java.lang.String	bias
protected java.lang.String	collectionIds
protected java.lang.Long	count
protected java.lang.Boolean	deduplicate
protected java.lang.String	deduplicateField
protected java.lang.String	environmentId
protected java.lang.String	filter
protected java.lang.Boolean	highlight
protected java.lang.String	naturalLanguageQuery
protected java.lang.Long	offset
protected java.lang.Boolean	passages
protected java.lang.Long	passagesCharacters
protected java.lang.Long	passagesCount
protected java.lang.String	passagesFields
protected java.lang.String	query
protected java.lang.Boolean	similar
protected java.lang.String	similarDocumentIds
protected java.lang.String	similarFields
protected java.lang.String	sort
protected java.lang.String	xReturn
protected java.lang.Boolean	xWatsonLoggingOptOut

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	aggregation() Gets the aggregation.
java.lang.String	bias() Gets the bias.
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.Boolean	passages() Gets the passages.
java.lang.Long	passagesCharacters() Gets the passagesCharacters.
java.lang.Long	passagesCount() Gets the passagesCount.
java.lang.String	passagesFields() Gets the passagesFields.
java.lang.String	query() Gets the query.
java.lang.Boolean	similar() Gets the similar.
java.lang.String	similarDocumentIds() Gets the similarDocumentIds.
java.lang.String	similarFields() Gets the similarFields.
java.lang.String	sort() Gets the sort.
java.lang.String	xReturn() Gets the xReturn.
java.lang.Boolean	xWatsonLoggingOptOut() Gets the xWatsonLoggingOptOut.

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

environmentId

protected java.lang.String environmentId

collectionIds

protected java.lang.String collectionIds

filter

protected java.lang.String filter

query

protected java.lang.String query

naturalLanguageQuery

protected java.lang.String naturalLanguageQuery

passages

protected java.lang.Boolean passages

aggregation

protected java.lang.String aggregation

count

protected java.lang.Long count

xReturn

protected java.lang.String xReturn

offset

protected java.lang.Long offset

sort

protected java.lang.String sort

highlight

protected java.lang.Boolean highlight

passagesFields

protected java.lang.String passagesFields

passagesCount

protected java.lang.Long passagesCount

passagesCharacters

protected java.lang.Long passagesCharacters

deduplicate

protected java.lang.Boolean deduplicate

deduplicateField

protected java.lang.String deduplicateField

similar

protected java.lang.Boolean similar

similarDocumentIds

protected java.lang.String similarDocumentIds

similarFields

protected java.lang.String similarFields

bias

protected java.lang.String bias

xWatsonLoggingOptOut

protected java.lang.Boolean xWatsonLoggingOptOut

Constructor Detail

FederatedQueryOptions

protected FederatedQueryOptions(FederatedQueryOptions.Builder builder)

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

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 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.lang.String xReturn()

Gets the xReturn.

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

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

passagesFields

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

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

Returns:

the similar

similarDocumentIds

public java.lang.String similarDocumentIds()

Gets the similarDocumentIds.

A comma-separated list of document IDs to find similar documents.

**Tip:** Include the **natural_language_query** parameter to expand the scope of the document similarity search with the natural language query. Other query parameters, such as **filter** and **query**, are subsequently applied and reduce the scope.

Returns:

the similarDocumentIds

similarFields

public java.lang.String similarFields()

Gets the similarFields.

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

Returns:

the similarFields

bias

public java.lang.String bias()

Gets the bias.

Field which the returned results will be biased against. The specified field must be either a **date** or **number** format. When a **date** type field is specified returned results are biased towards field values closer to the current date. When a **number** type field is specified, returned results are biased towards higher field values. This parameter cannot be used in the same query as the **sort** parameter.

Returns:

the bias

xWatsonLoggingOptOut

public java.lang.Boolean xWatsonLoggingOptOut()

Gets the xWatsonLoggingOptOut.

If `true`, queries are not stored in the Discovery **Logs** endpoint.

Returns:

the xWatsonLoggingOptOut