Package com.ibm.watson.assistant.v2.model

Class RuntimeResponseGeneric

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.assistant.v2.model.RuntimeResponseGeneric
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
Direct Known Subclasses:
RuntimeResponseGenericRuntimeResponseTypeChannelTransfer, RuntimeResponseGenericRuntimeResponseTypeConnectToAgent, RuntimeResponseGenericRuntimeResponseTypeImage, RuntimeResponseGenericRuntimeResponseTypeOption, RuntimeResponseGenericRuntimeResponseTypePause, RuntimeResponseGenericRuntimeResponseTypeSearch, RuntimeResponseGenericRuntimeResponseTypeSuggestion, RuntimeResponseGenericRuntimeResponseTypeText, RuntimeResponseGenericRuntimeResponseTypeUserDefined
public class RuntimeResponseGeneric
extends com.ibm.cloud.sdk.core.service.model.GenericModel
RuntimeResponseGeneric.

Classes which extend this class: - RuntimeResponseGenericRuntimeResponseTypeText - RuntimeResponseGenericRuntimeResponseTypePause - RuntimeResponseGenericRuntimeResponseTypeImage - RuntimeResponseGenericRuntimeResponseTypeOption - RuntimeResponseGenericRuntimeResponseTypeConnectToAgent - RuntimeResponseGenericRuntimeResponseTypeSuggestion - RuntimeResponseGenericRuntimeResponseTypeChannelTransfer - RuntimeResponseGenericRuntimeResponseTypeSearch - RuntimeResponseGenericRuntimeResponseTypeUserDefined

  • Method Details

    • responseType

      public 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.

      Returns:
      the responseType

    • text

      public String text()
      Gets the text.

      The text of the response.

      Returns:
      the text

    • channels

      public List<ResponseGenericChannel> channels()
      Gets the channels.

      An array of objects specifying channels for which the response is intended. If **channels** is present, the response is intended for a built-in integration and should not be handled by an API client.

      Returns:
      the channels

    • time

      public Long time()
      Gets the time.

      How long to pause, in milliseconds.

      Returns:
      the time

    • typing

      public Boolean typing()
      Gets the typing.

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

      Returns:
      the typing

    • source

      public String source()
      Gets the source.

      The `https:` URL of the image.

      Returns:
      the source

    • title

      public String title()
      Gets the title.

      The title to show before the response.

      Returns:
      the title

    • description

      public String description()
      Gets the description.

      The description to show with the the response.

      Returns:
      the description

    • altText

      public String altText()
      Gets the altText.

      Descriptive text that can be used for screen readers or other situations where the image cannot be seen.

      Returns:
      the altText

    • preference

      public String preference()
      Gets the preference.

      The preferred type of control to display.

      Returns:
      the preference

    • options

      public List<DialogNodeOutputOptionsElement> options()
      Gets the options.

      An array of objects describing the options from which the user can choose.

      Returns:
      the options

    • messageToHumanAgent

      public String messageToHumanAgent()
      Gets the messageToHumanAgent.

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

      Returns:
      the messageToHumanAgent

    • agentAvailable

      public AgentAvailabilityMessage agentAvailable()
      Gets the agentAvailable.

      An optional message to be displayed to the user to indicate that the conversation will be transferred to the next available agent.

      Returns:
      the agentAvailable

    • agentUnavailable

      public AgentAvailabilityMessage agentUnavailable()
      Gets the agentUnavailable.

      An optional message to be displayed to the user to indicate that no online agent is available to take over the conversation.

      Returns:
      the agentUnavailable

    • topic

      public String topic()
      Gets the 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.

      Returns:
      the topic

    • suggestions

      public List<DialogSuggestion> suggestions()
      Gets the suggestions.

      An array of objects describing the possible matching dialog nodes from which the user can choose.

      Returns:
      the suggestions

    • messageToUser

      public String messageToUser()
      Gets the messageToUser.

      The message to display to the user when initiating a channel transfer.

      Returns:
      the messageToUser

    • header

      public String header()
      Gets the header.

      The title or introductory text to show before the response. This text is defined in the search skill configuration.

      Returns:
      the header

    • primaryResults

      public List<SearchResult> primaryResults()
      Gets the primaryResults.

      An array of objects that contains the search results to be displayed in the initial response to the user.

      Returns:
      the primaryResults

    • additionalResults

      public List<SearchResult> additionalResults()
      Gets the additionalResults.

      An array of objects that contains additional search results that can be displayed to the user upon request.

      Returns:
      the additionalResults

    • userDefined

      public Map<String,​Object> userDefined()
      Gets the userDefined.

      An object containing any properties for the user-defined response type.

      Returns:
      the userDefined