public class RuntimeResponseGeneric
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Classes which extend this class: - RuntimeResponseGenericRuntimeResponseTypeText - RuntimeResponseGenericRuntimeResponseTypePause - RuntimeResponseGenericRuntimeResponseTypeImage - RuntimeResponseGenericRuntimeResponseTypeOption - RuntimeResponseGenericRuntimeResponseTypeConnectToAgent - RuntimeResponseGenericRuntimeResponseTypeSuggestion - RuntimeResponseGenericRuntimeResponseTypeSearch
Modifier and Type | Class and Description |
---|---|
static interface |
RuntimeResponseGeneric.Preference
The preferred type of control to display.
|
static interface |
RuntimeResponseGeneric.ResponseType
The type of response returned by the dialog node.
|
Modifier and Type | Field and Description |
---|---|
protected java.util.List<SearchResult> |
additionalResults |
protected java.lang.String |
agentAvailable |
protected java.lang.String |
agentUnavailable |
protected java.lang.String |
description |
protected static java.util.Map<java.lang.String,java.lang.Class<?>> |
discriminatorMapping |
protected static java.lang.String |
discriminatorPropertyName |
protected java.lang.String |
header |
protected java.lang.String |
messageToHumanAgent |
protected java.util.List<DialogNodeOutputOptionsElement> |
options |
protected java.lang.String |
preference |
protected java.util.List<SearchResult> |
primaryResults |
protected java.lang.String |
responseType |
protected java.lang.String |
source |
protected java.util.List<DialogSuggestion> |
suggestions |
protected java.lang.String |
text |
protected java.lang.Long |
time |
protected java.lang.String |
title |
protected java.lang.String |
topic |
protected DialogNodeOutputConnectToAgentTransferInfo |
transferInfo |
protected java.lang.Boolean |
typing |
Modifier | Constructor and Description |
---|---|
protected |
RuntimeResponseGeneric() |
Modifier and Type | Method and Description |
---|---|
java.util.List<SearchResult> |
additionalResults()
Gets the additionalResults.
|
java.lang.String |
agentAvailable()
Gets the agentAvailable.
|
java.lang.String |
agentUnavailable()
Gets the agentUnavailable.
|
java.lang.String |
description()
Gets the description.
|
java.lang.String |
header()
Gets the header.
|
java.lang.String |
messageToHumanAgent()
Gets the messageToHumanAgent.
|
java.util.List<DialogNodeOutputOptionsElement> |
options()
Gets the options.
|
java.lang.String |
preference()
Gets the preference.
|
java.util.List<SearchResult> |
primaryResults()
Gets the primaryResults.
|
java.lang.String |
responseType()
Gets the responseType.
|
java.lang.String |
source()
Gets the source.
|
java.util.List<DialogSuggestion> |
suggestions()
Gets the suggestions.
|
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.
|
DialogNodeOutputConnectToAgentTransferInfo |
transferInfo()
Gets the transferInfo.
|
java.lang.Boolean |
typing()
Gets the typing.
|
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.lang.String text
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 java.lang.String agentAvailable
@SerializedName(value="agent_unavailable") protected java.lang.String agentUnavailable
@SerializedName(value="transfer_info") protected DialogNodeOutputConnectToAgentTransferInfo transferInfo
protected java.lang.String topic
protected java.util.List<DialogSuggestion> suggestions
protected java.lang.String header
@SerializedName(value="primary_results") protected java.util.List<SearchResult> primaryResults
@SerializedName(value="additional_results") protected java.util.List<SearchResult> additionalResults
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.lang.String text()
The text of the response.
public java.lang.Long time()
How long to pause, in milliseconds.
public java.lang.Boolean typing()
Whether to send a "user is typing" event during the pause.
public java.lang.String source()
The URL of the image.
public java.lang.String title()
The title to show before the response.
public java.lang.String description()
The description to show with the the response.
public java.lang.String preference()
The preferred type of control to display.
public java.util.List<DialogNodeOutputOptionsElement> options()
An array of objects describing the options from which the user can choose.
public java.lang.String messageToHumanAgent()
A message to be sent to the human agent who will be taking over the conversation.
public java.lang.String agentAvailable()
An optional message to be displayed to the user to indicate that the conversation will be transferred to the next available agent.
public java.lang.String 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 topic()
A label identifying the topic of the conversation, derived from the **title** property of the relevant node or the **topic** property of the dialog node response.
public java.util.List<DialogSuggestion> suggestions()
An array of objects describing the possible matching dialog nodes from which the user can choose.
public java.lang.String header()
The title or introductory text to show before the response. This text is defined in the search skill configuration.
public java.util.List<SearchResult> primaryResults()
An array of objects that contains the search results to be displayed in the initial response to the user.
public java.util.List<SearchResult> additionalResults()
An array of objects that contains additional search results that can be displayed to the user upon request.