com.ibm.watson.assistant.v1.model

Class DialogNodeOutputGeneric

java.lang.Object

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

com.ibm.watson.assistant.v1.model.DialogNodeOutputGeneric

All Implemented Interfaces:

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

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

DialogNodeOutputGeneric.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DialogNodeOutputGeneric.Builder Builder.
static interface	DialogNodeOutputGeneric.Preference The preferred type of control to display, if supported by the channel.
static interface	DialogNodeOutputGeneric.QueryType The type of the search query.
static interface	DialogNodeOutputGeneric.ResponseType The type of response returned by the dialog node.
static interface	DialogNodeOutputGeneric.SelectionPolicy How a response is selected from the list, if more than one response is specified.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	delimiter
protected java.lang.String	description
protected java.lang.String	discoveryVersion
protected java.lang.String	filter
protected java.lang.String	messageToHumanAgent
protected java.util.List<DialogNodeOutputOptionsElement>	options
protected java.lang.String	preference
protected java.lang.String	query
protected java.lang.String	queryType
protected java.lang.String	responseType
protected java.lang.String	selectionPolicy
protected java.lang.String	source
protected java.lang.Long	time
protected java.lang.String	title
protected java.lang.Boolean	typing
protected java.util.List<DialogNodeOutputTextValuesElement>	values

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	delimiter() Gets the delimiter.
java.lang.String	description() Gets the description.
java.lang.String	discoveryVersion() Gets the discoveryVersion.
java.lang.String	filter() Gets the filter.
java.lang.String	messageToHumanAgent() Gets the messageToHumanAgent.
DialogNodeOutputGeneric.Builder	newBuilder() New builder.
java.util.List<DialogNodeOutputOptionsElement>	options() Gets the options.
java.lang.String	preference() Gets the preference.
java.lang.String	query() Gets the query.
java.lang.String	queryType() Gets the queryType.
java.lang.String	responseType() Gets the responseType.
java.lang.String	selectionPolicy() Gets the selectionPolicy.
java.lang.String	source() Gets the source.
java.lang.Long	time() Gets the time.
java.lang.String	title() Gets the title.
java.lang.Boolean	typing() Gets the typing.
java.util.List<DialogNodeOutputTextValuesElement>	values() Gets the values.

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

responseType

@SerializedName(value="response_type")
protected java.lang.String responseType

values

protected java.util.List<DialogNodeOutputTextValuesElement> values

selectionPolicy

@SerializedName(value="selection_policy")
protected java.lang.String selectionPolicy

delimiter

protected java.lang.String delimiter

time

protected java.lang.Long time

typing

protected java.lang.Boolean typing

source

protected java.lang.String source

title

protected java.lang.String title

description

protected java.lang.String description

preference

protected java.lang.String preference

options

protected java.util.List<DialogNodeOutputOptionsElement> options

messageToHumanAgent

@SerializedName(value="message_to_human_agent")
protected java.lang.String messageToHumanAgent

query

protected java.lang.String query

queryType

@SerializedName(value="query_type")
protected java.lang.String queryType

filter

protected java.lang.String filter

discoveryVersion

@SerializedName(value="discovery_version")
protected java.lang.String discoveryVersion

Constructor Detail

DialogNodeOutputGeneric

protected DialogNodeOutputGeneric(DialogNodeOutputGeneric.Builder builder)

Method Detail

newBuilder

public DialogNodeOutputGeneric.Builder newBuilder()

New builder.

Returns:

a DialogNodeOutputGeneric builder

responseType

public java.lang.String responseType()

Gets the responseType.

The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.

**Note:** The **search_skill** response type is used only by the v2 runtime API.

Returns:

the responseType

values

public java.util.List<DialogNodeOutputTextValuesElement> values()

Gets the values.

A list of one or more objects defining text responses. Required when **response_type**=`text`.

Returns:

the values

selectionPolicy

public java.lang.String selectionPolicy()

Gets the selectionPolicy.

How a response is selected from the list, if more than one response is specified. Valid only when **response_type**=`text`.

Returns:

the selectionPolicy

delimiter

public java.lang.String delimiter()

Gets the delimiter.

The delimiter to use as a separator between responses when `selection_policy`=`multiline`.

Returns:

the delimiter

time

public java.lang.Long time()

Gets the time.

How long to pause, in milliseconds. The valid values are from 0 to 10000. Valid only when **response_type**=`pause`.

Returns:

the time

typing

public java.lang.Boolean typing()

Gets the typing.

Whether to send a "user is typing" event during the pause. Ignored if the channel does not support this event. Valid only when **response_type**=`pause`.

Returns:

the typing

source

public java.lang.String source()

Gets the source.

The URL of the image. Required when **response_type**=`image`.

Returns:

the source

title

public java.lang.String title()

Gets the title.

An optional title to show before the response. Valid only when **response_type**=`image` or `option`.

Returns:

the title

description

public java.lang.String description()

Gets the description.

An optional description to show with the response. Valid only when **response_type**=`image` or `option`.

Returns:

the description

preference

public java.lang.String preference()

Gets the preference.

The preferred type of control to display, if supported by the channel. Valid only when **response_type**=`option`.

Returns:

the preference

options

public java.util.List<DialogNodeOutputOptionsElement> options()

Gets the options.

An array of objects describing the options from which the user can choose. You can include up to 20 options. Required when **response_type**=`option`.

Returns:

the options

messageToHumanAgent

public java.lang.String messageToHumanAgent()

Gets the messageToHumanAgent.

An optional message to be sent to the human agent who will be taking over the conversation. Valid only when **reponse_type**=`connect_to_agent`.

Returns:

the messageToHumanAgent

query

public java.lang.String query()

Gets the query.

The text of the search query. This can be either a natural-language query or a query that uses the Discovery query language syntax, depending on the value of the **query_type** property. For more information, see the [Discovery service documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-operators#query-operators). Required when **response_type**=`search_skill`.

Returns:

the query

queryType

public java.lang.String queryType()

Gets the queryType.

The type of the search query. Required when **response_type**=`search_skill`.

Returns:

the queryType

filter

public java.lang.String filter()

Gets the filter.

An optional filter that narrows the set of documents to be searched. For more information, see the [Discovery service documentation]([Discovery service documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-query-parameters#filter).

Returns:

the filter

discoveryVersion

public java.lang.String discoveryVersion()

Gets the discoveryVersion.

The version of the Discovery service API to use for the query.

Returns:

the discoveryVersion