com.ibm.watson.discovery.v2.model

Class CreateExpansionsOptions

java.lang.Object

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

com.ibm.watson.discovery.v2.model.CreateExpansionsOptions

All Implemented Interfaces:

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

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

The createExpansions options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	collectionId() Gets the collectionId.
List<Expansion>	expansions() Gets the expansions.
CreateExpansionsOptions.Builder	newBuilder() New builder.
String	projectId() Gets the projectId.

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

New builder.

Returns:

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

collectionId

public String collectionId()

Gets the collectionId.

The ID of the collection.

Returns:

the collectionId

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