MessageRequest

public struct MessageRequest : Codable, Equatable

A request sent to the workspace, including the user input and context.

  • An input object that includes the input text.

    Declaration

    Swift

    public var input: MessageInput?

  • Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.

    Declaration

    Swift

    public var intents: [RuntimeIntent]?

  • Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new 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?

  • Initialize a MessageRequest with member variables.

    Declaration

    Swift

    public init(
    input: MessageInput? = nil,
    intents: [RuntimeIntent]? = nil,
    entities: [RuntimeEntity]? = nil,
    alternateIntents: Bool? = nil,
    context: Context? = nil,
    output: OutputData? = nil,
    userID: String? = nil
)

    Parameters

    input

    An input object that includes the input text.
    intents

    Intents to use when evaluating the user input. Include intents from the previous response to continue using those intents rather than trying to recognize intents in the new input.
    entities

    Entities to use when evaluating the message. Include entities from the previous response to continue using those entities rather than detecting entities in the new input.
    alternateIntents

    Whether to return more than one intent. A value of true indicates that all matching intents are returned.
    context

    State information for the conversation. To maintain state, include the context from the previous response.
    output

    An output object that includes the response to the user, the dialog nodes that were triggered, and messages from the log.
    userID

    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.

    Return Value

    An initialized MessageRequest.