public class DialogNodeOutputGeneric
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Classes which extend this class: - DialogNodeOutputGenericDialogNodeOutputResponseTypeText - DialogNodeOutputGenericDialogNodeOutputResponseTypePause - DialogNodeOutputGenericDialogNodeOutputResponseTypeImage - DialogNodeOutputGenericDialogNodeOutputResponseTypeOption - DialogNodeOutputGenericDialogNodeOutputResponseTypeConnectToAgent - DialogNodeOutputGenericDialogNodeOutputResponseTypeSearchSkill - DialogNodeOutputGenericDialogNodeOutputResponseTypeChannelTransfer - DialogNodeOutputGenericDialogNodeOutputResponseTypeUserDefined - DialogNodeOutputGenericDialogNodeOutputResponseTypeVideo - DialogNodeOutputGenericDialogNodeOutputResponseTypeAudio - DialogNodeOutputGenericDialogNodeOutputResponseTypeIframe
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.SelectionPolicy
How a response is selected from the list, if more than one response is specified.
|
Modifier and Type | Method and Description |
---|---|
AgentAvailabilityMessage |
agentAvailable()
Gets the agentAvailable.
|
AgentAvailabilityMessage |
agentUnavailable()
Gets the agentUnavailable.
|
String |
altText()
Gets the altText.
|
Map<String,Object> |
channelOptions()
Gets the channelOptions.
|
List<ResponseGenericChannel> |
channels()
Gets the channels.
|
String |
delimiter()
Gets the delimiter.
|
String |
description()
Gets the description.
|
String |
discoveryVersion()
Gets the discoveryVersion.
|
String |
filter()
Gets the filter.
|
String |
imageUrl()
Gets the imageUrl.
|
String |
messageToHumanAgent()
Gets the messageToHumanAgent.
|
String |
messageToUser()
Gets the messageToUser.
|
List<DialogNodeOutputOptionsElement> |
options()
Gets the options.
|
String |
preference()
Gets the preference.
|
String |
query()
Gets the query.
|
String |
queryType()
Gets the queryType.
|
String |
responseType()
Gets the responseType.
|
String |
selectionPolicy()
Gets the selectionPolicy.
|
String |
source()
Gets the source.
|
Long |
time()
Gets the time.
|
String |
title()
Gets the title.
|
Boolean |
typing()
Gets the typing.
|
Map<String,Object> |
userDefined()
Gets the userDefined.
|
List<DialogNodeOutputTextValuesElement> |
values()
Gets the values.
|
public 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 List<DialogNodeOutputTextValuesElement> values()
A list of one or more objects defining text responses.
public String selectionPolicy()
How a response is selected from the list, if more than one response is specified.
public String delimiter()
The delimiter to use as a separator between responses when `selection_policy`=`multiline`.
public List<ResponseGenericChannel> channels()
An array of objects specifying channels for which the response is intended.
public Long time()
How long to pause, in milliseconds. The valid values are from 0 to 10000.
public Boolean typing()
Whether to send a "user is typing" event during the pause. Ignored if the channel does not support this event.
public String source()
The `https:` URL of the image.
public String title()
An optional title to show before the response.
public String description()
An optional description to show with the response.
public String altText()
Descriptive text that can be used for screen readers or other situations where the image cannot be seen.
public String preference()
The preferred type of control to display, if supported by the channel.
public List<DialogNodeOutputOptionsElement> options()
An array of objects describing the options from which the user can choose. You can include up to 20 options.
public 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 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 String queryType()
The type of the search query.
public 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 String discoveryVersion()
The version of the Discovery service API to use for the query.
public String messageToUser()
The message to display to the user when initiating a channel transfer.
public Map<String,Object> userDefined()
An object containing any properties for the user-defined response type. The total size of this object cannot exceed 5000 bytes.
public Map<String,Object> channelOptions()
For internal use only.
public String imageUrl()
The URL of an image that shows a preview of the embedded content.
Copyright © 2022 IBM Cloud. All rights reserved.