MessageResponse

public struct MessageResponse : Codable, Equatable

The response sent by the workspace, including the output text, detected intents and entities, and context.

  • An input object that includes the input text.

    Declaration

    Swift

    public var input: MessageInput
  • An array of intents recognized in the user input, sorted in descending order of confidence.

    Declaration

    Swift

    public var intents: [RuntimeIntent]
  • An array of entities identified in the user input.

    Declaration

    Swift

    public var entities: [RuntimeEntity]
  • Whether to return more than one intent. A value of true indicates that all matching intents are returned.

    Declaration

    Swift

    public var alternateIntents: Bool?
  • State information for the conversation. To maintain state, include the context from the previous response.

    Declaration

    Swift

    public var context: Context
  • An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the log.

    Declaration

    Swift

    public var output: OutputData
  • An array of objects describing any actions requested by the dialog node.

    Declaration

    Swift

    public var actions: [DialogNodeAction]?
  • A string value that identifies the user who is interacting with the workspace. The client must provide a unique identifier for each individual end user who accesses the application. For user-based plans, this user ID is used to identify unique users for billing purposes. This string cannot contain carriage return, newline, or tab characters. If no value is specified in the input, user_id is automatically set to the value of context.conversation_id. Note: This property is the same as the user_id property in the context metadata. If user_id is specified in both locations in a message request, the value specified at the root is used.

    Declaration

    Swift

    public var userID: String