public class DialogNodeOutputGeneric
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Classes which extend this class: - DialogNodeOutputGenericDialogNodeOutputResponseTypeText - DialogNodeOutputGenericDialogNodeOutputResponseTypePause - DialogNodeOutputGenericDialogNodeOutputResponseTypeImage - DialogNodeOutputGenericDialogNodeOutputResponseTypeOption - DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent - DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill
Modifier and Type | Class and Description |
---|---|
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.
|
Modifier and Type | Field and Description |
---|---|
protected AgentAvailabilityMessage |
agentAvailable |
protected AgentAvailabilityMessage |
agentUnavailable |
protected java.lang.String |
delimiter |
protected java.lang.String |
description |
protected java.lang.String |
discoveryVersion |
protected static java.util.Map<java.lang.String,java.lang.Class<?>> |
discriminatorMapping |
protected static java.lang.String |
discriminatorPropertyName |
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 DialogNodeOutputConnectToAgentTransferInfo |
transferInfo |
protected java.lang.Boolean |
typing |
protected java.util.List<DialogNodeOutputTextValuesElement> |
values |
Modifier | Constructor and Description |
---|---|
protected |
DialogNodeOutputGeneric() |
Modifier and Type | Method and Description |
---|---|
AgentAvailabilityMessage |
agentAvailable()
Gets the agentAvailable.
|
AgentAvailabilityMessage |
agentUnavailable()
Gets the agentUnavailable.
|
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.
|
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.
|
DialogNodeOutputConnectToAgentTransferInfo |
transferInfo()
Gets the transferInfo.
|
java.lang.Boolean |
typing()
Gets the typing.
|
java.util.List<DialogNodeOutputTextValuesElement> |
values()
Gets the values.
|
protected static java.lang.String discriminatorPropertyName
protected static java.util.Map<java.lang.String,java.lang.Class<?>> discriminatorMapping
@SerializedName(value="response_type") protected java.lang.String responseType
protected java.util.List<DialogNodeOutputTextValuesElement> values
@SerializedName(value="selection_policy") protected java.lang.String selectionPolicy
protected java.lang.String delimiter
protected java.lang.Long time
protected java.lang.Boolean typing
protected java.lang.String source
protected java.lang.String title
protected java.lang.String description
protected java.lang.String preference
protected java.util.List<DialogNodeOutputOptionsElement> options
@SerializedName(value="message_to_human_agent") protected java.lang.String messageToHumanAgent
@SerializedName(value="agent_available") protected AgentAvailabilityMessage agentAvailable
@SerializedName(value="agent_unavailable") protected AgentAvailabilityMessage agentUnavailable
@SerializedName(value="transfer_info") protected DialogNodeOutputConnectToAgentTransferInfo transferInfo
protected java.lang.String query
@SerializedName(value="query_type") protected java.lang.String queryType
protected java.lang.String filter
@SerializedName(value="discovery_version") protected java.lang.String discoveryVersion
public java.lang.String responseType()
The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
public java.util.List<DialogNodeOutputTextValuesElement> values()
A list of one or more objects defining text responses.
public java.lang.String selectionPolicy()
How a response is selected from the list, if more than one response is specified.
public java.lang.String delimiter()
The delimiter to use as a separator between responses when `selection_policy`=`multiline`.
public java.lang.Long time()
How long to pause, in milliseconds. The valid values are from 0 to 10000.
public java.lang.Boolean typing()
Whether to send a "user is typing" event during the pause. Ignored if the channel does not support this event.
public java.lang.String source()
The URL of the image.
public java.lang.String title()
An optional title to show before the response.
public java.lang.String description()
An optional description to show with the response.
public java.lang.String preference()
The preferred type of control to display, if supported by the channel.
public java.util.List<DialogNodeOutputOptionsElement> options()
An array of objects describing the options from which the user can choose. You can include up to 20 options.
public java.lang.String messageToHumanAgent()
An optional message to be sent to the human agent who will be taking over the conversation.
public AgentAvailabilityMessage agentAvailable()
An optional message to be displayed to the user to indicate that the conversation will be transferred to the next available agent.
public AgentAvailabilityMessage agentUnavailable()
An optional message to be displayed to the user to indicate that no online agent is available to take over the conversation.
public DialogNodeOutputConnectToAgentTransferInfo transferInfo()
Routing or other contextual information to be used by target service desk systems.
public java.lang.String 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).
public java.lang.String queryType()
The type of the search query.
public java.lang.String 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).
public java.lang.String discoveryVersion()
The version of the Discovery service API to use for the query.