com.ibm.watson.discovery.v2.model

Class Expansions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.Expansions

All Implemented Interfaces:

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

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

The query expansion definitions for the specified collection.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
List<Expansion>	expansions() Gets the expansions.
Expansions.Builder	newBuilder() New builder.

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 Expansions.Builder newBuilder()

New builder.

Returns:

a Expansions builder

expansions

public List<Expansion> expansions()

Gets the expansions.

An array of query expansion definitions.

Each object in the **expansions** array represents a term or set of terms that will be expanded into other terms. Each expansion object can be configured as `bidirectional` or `unidirectional`.

* **Bidirectional**: Each entry in the `expanded_terms` list expands to include all expanded terms. For example, a query for `ibm` expands to `ibm OR international business machines OR big blue`.

* **Unidirectional**: The terms in `input_terms` in the query are replaced by the terms in `expanded_terms`. For example, a query for the often misused term `on premise` is converted to `on premises OR on-premises` and does not contain the original term. If you want an input term to be included in the query, then repeat the input term in the expanded terms list.

Returns:

the expansions