Interface InlineErrorItem<TUserDefinedType>

An inline error response generated by a conversational skill provider with a user-friendly text and developer debug info.

interface InlineErrorItem<TUserDefinedType = Record<string, unknown>> {
    agent_message_type?: AgentMessageType;
    debug?: {
        info?: Record<string, unknown>;
        statusCode?: number;
        text?: string;
    };
    message_options?: GenericItemMessageOptions;
    response_type: MessageResponseTypes;
    streaming_metadata?: ItemStreamingMetadata;
    text?: string;
    user_defined?: TUserDefinedType;
}

Type Parameters

  • TUserDefinedType = Record<string, unknown>

Hierarchy (View Summary, Expand)

Properties

agent_message_type? debug? message_options? response_type streaming_metadata? text? user_defined?

Properties

Optionalagent_message_type

agent_message_type?: AgentMessageType

For messages that are sent between the user and a human agent, we assign an agent type to the message to distinguish what type it is.

Optionaldebug

debug?: { info?: Record<string, unknown>; statusCode?: number; text?: string }

Relevant debug info intended to be passed on to developers.

This information should not include anything sensitive that might reveal details about our back-end environment that should not be public.

Type declaration

  • Optionalinfo?: Record<string, unknown>

    Any additional key-value pairs for debugging.

  • OptionalstatusCode?: number

    The error code of any underlying error, despite the service returning 200.

  • Optionaltext?: string

    Developer-friendly error text.

Optionalmessage_options

message_options?: GenericItemMessageOptions

Options that control additional features available for a message item.

response_type

response_type: MessageResponseTypes

The response type of this message item.

Optionalstreaming_metadata

streaming_metadata?: ItemStreamingMetadata

Metadata used identify a generic item within the context of a stream in order to correlate any updates meant for a specific item.

Optionaltext

text?: string

Some end user friendly text describing the error and what they should do next.

If no specific text is passed, the client is responsible for fallback generic error message text.

Optionaluser_defined

user_defined?: TUserDefinedType

An optional buckets of additional user defined properties for this item.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR