com.ibm.watson.discovery.v1.model

Class CreateExpansionsOptions

java.lang.Object

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

com.ibm.watson.discovery.v1.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.
String	environmentId() Gets the environmentId.
List<Expansion>	expansions() Gets the expansions.
CreateExpansionsOptions.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 CreateExpansionsOptions.Builder newBuilder()

New builder.

Returns:

a CreateExpansionsOptions builder

environmentId

public String environmentId()

Gets the environmentId.

The ID of the environment.

Returns:

the environmentId

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 means that all terms are expanded to all other terms in the object. Unidirectional means that a set list of terms can be expanded into a second list of terms.

To create a bi-directional expansion specify an **expanded_terms** array. When found in a query, all items in the **expanded_terms** array are then expanded to the other items in the same array.

To create a uni-directional expansion, specify both an array of **input_terms** and an array of **expanded_terms**. When items in the **input_terms** array are present in a query, they are expanded using the items listed in the **expanded_terms** array.

Returns:

the expansions