OutputData

public struct OutputData : Codable, Equatable

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

  • An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.

    Declaration

    Swift

    public var nodesVisited: [String]?

  • An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.

    Declaration

    Swift

    public var nodesVisitedDetails: [DialogNodeVisitedDetails]?

  • An array of up to 50 messages logged with the request.

    Declaration

    Swift

    public var logMessages: [LogMessage]

  • An array of responses to the user.

    Declaration

    Swift

    public var text: [String]

  • Output intended for any channel. It is the responsibility of the client application to implement the supported response types.

    Declaration

    Swift

    public var generic: [RuntimeResponseGeneric]?

  • Additional properties associated with this model.

    Declaration

    Swift

    public var additionalProperties: [String : JSON]

  • Initialize a OutputData with member variables.

    Declaration

    Swift

    public init(
    logMessages: [LogMessage],
    text: [String],
    nodesVisited: [String]? = nil,
    nodesVisitedDetails: [DialogNodeVisitedDetails]? = nil,
    generic: [RuntimeResponseGeneric]? = nil,
    additionalProperties: [String: JSON] = [:]
)

    Parameters

    logMessages

    An array of up to 50 messages logged with the request.
    text

    An array of responses to the user.
    nodesVisited

    An array of the nodes that were triggered to create the response, in the order in which they were visited. This information is useful for debugging and for tracing the path taken through the node tree.
    nodesVisitedDetails

    An array of objects containing detailed diagnostic information about the nodes that were triggered during processing of the input message. Included only if nodes_visited_details is set to true in the message request.
    generic

    Output intended for any channel. It is the responsibility of the client application to implement the supported response types.

    Return Value

    An initialized OutputData.

  • Declaration

    Swift

    public init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws