MessageInputOptions

public struct MessageInputOptions : Codable, Equatable

Optional properties that control how the assistant responds.

  • Whether to restart dialog processing at the root of the dialog, regardless of any previously visited nodes. Note: This does not affect turn_count or any other context variables.

    Declaration

    Swift

    public var restart: Bool?

  • Whether to return more than one intent. Set to true to return all matching intents.

    Declaration

    Swift

    public var alternateIntents: Bool?

  • Spelling correction options for the message. Any options specified on an individual message override the settings configured for the skill.

    Declaration

    Swift

    public var spelling: MessageInputOptionsSpelling?

  • Whether to return additional diagnostic information. Set to true to return additional information in the output.debug property. If you also specify return_context=true, the returned skill context includes the system.state property.

    Declaration

    Swift

    public var debug: Bool?

  • Whether to return session context with the response. If you specify true, the response includes the context property. If you also specify debug=true, the returned skill context includes the system.state property.

    Declaration

    Swift

    public var returnContext: Bool?

  • Whether to return session context, including full conversation state. If you specify true, the response includes the context property, and the skill context includes the system.state property. Note: If export=true, the context is returned regardless of the value of return_context.

    Declaration

    Swift

    public var export: Bool?

  • Initialize a MessageInputOptions with member variables.

    Declaration

    Swift

    public init(
    restart: Bool? = nil,
    alternateIntents: Bool? = nil,
    spelling: MessageInputOptionsSpelling? = nil,
    debug: Bool? = nil,
    returnContext: Bool? = nil,
    export: Bool? = nil
)

    Parameters

    restart

    Whether to restart dialog processing at the root of the dialog, regardless of any previously visited nodes. Note: This does not affect turn_count or any other context variables.
    alternateIntents

    Whether to return more than one intent. Set to true to return all matching intents.
    spelling

    Spelling correction options for the message. Any options specified on an individual message override the settings configured for the skill.
    debug

    Whether to return additional diagnostic information. Set to true to return additional information in the output.debug property. If you also specify return_context=true, the returned skill context includes the system.state property.
    returnContext

    Whether to return session context with the response. If you specify true, the response includes the context property. If you also specify debug=true, the returned skill context includes the system.state property.
    export

    Whether to return session context, including full conversation state. If you specify true, the response includes the context property, and the skill context includes the system.state property. Note: If export=true, the context is returned regardless of the value of return_context.

    Return Value

    An initialized MessageInputOptions.