com.ibm.watson.assistant.v1.model

Class DialogSuggestionResponseGeneric

java.lang.Object

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

com.ibm.watson.assistant.v1.model.DialogSuggestionResponseGeneric

All Implemented Interfaces:

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

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

DialogSuggestionResponseGeneric.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DialogSuggestionResponseGeneric.Builder Builder.
static interface	DialogSuggestionResponseGeneric.Preference The preferred type of control to display.
static interface	DialogSuggestionResponseGeneric.ResponseType The type of response returned by the dialog node.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	description
protected java.lang.String	dialogNode
protected java.lang.String	messageToHumanAgent
protected java.util.List<DialogNodeOutputOptionsElement>	options
protected java.lang.String	preference
protected java.lang.String	responseType
protected java.lang.String	source
protected java.lang.String	text
protected java.lang.Long	time
protected java.lang.String	title
protected java.lang.String	topic
protected java.lang.Boolean	typing

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	description() Gets the description.
java.lang.String	dialogNode() Gets the dialogNode.
java.lang.String	messageToHumanAgent() Gets the messageToHumanAgent.
DialogSuggestionResponseGeneric.Builder	newBuilder() New builder.
java.util.List<DialogNodeOutputOptionsElement>	options() Gets the options.
java.lang.String	preference() Gets the preference.
java.lang.String	responseType() Gets the responseType.
java.lang.String	source() Gets the source.
java.lang.String	text() Gets the text.
java.lang.Long	time() Gets the time.
java.lang.String	title() Gets the title.
java.lang.String	topic() Gets the topic.
java.lang.Boolean	typing() Gets the typing.

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

text

protected java.lang.String text

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

topic

protected java.lang.String topic

dialogNode

@SerializedName(value="dialog_node")
protected java.lang.String dialogNode

Constructor Detail

DialogSuggestionResponseGeneric

protected DialogSuggestionResponseGeneric(DialogSuggestionResponseGeneric.Builder builder)

Method Detail

newBuilder

public DialogSuggestionResponseGeneric.Builder newBuilder()

New builder.

Returns:

a DialogSuggestionResponseGeneric 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 **suggestion** response type is part of the disambiguation feature, which is only available for Plus and Premium users. The **search_skill** response type is available only for Plus and Premium users, and is used only by the v2 runtime API.

Returns:

the responseType

text

public java.lang.String text()

Gets the text.

The text of the response.

Returns:

the text

time

public java.lang.Long time()

Gets the time.

How long to pause, in milliseconds.

Returns:

the time

typing

public java.lang.Boolean typing()

Gets the typing.

Whether to send a "user is typing" event during the pause.

Returns:

the typing

source

public java.lang.String source()

Gets the source.

The URL of the image.

Returns:

the source

title

public java.lang.String title()

Gets the title.

The title or introductory text to show before the response.

Returns:

the title

description

public java.lang.String description()

Gets the description.

The description to show with the the response.

Returns:

the description

preference

public java.lang.String preference()

Gets the preference.

The preferred type of control to display.

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.

Returns:

the options

messageToHumanAgent

public java.lang.String messageToHumanAgent()

Gets the messageToHumanAgent.

A message to be sent to the human agent who will be taking over the conversation.

Returns:

the messageToHumanAgent

topic

public java.lang.String topic()

Gets the topic.

A label identifying the topic of the conversation, derived from the **title** property of the relevant node.

Returns:

the topic

dialogNode

public java.lang.String dialogNode()

Gets the dialogNode.

The ID of the dialog node that the **topic** property is taken from. The **topic** property is populated using the value of the dialog node's **title** property.

Returns:

the dialogNode