Interface CarouselItem<TUserDefinedType>

The basic class for items returned from a back-end as part of a message response. These are the items contained in the MessageOutput.generic array.

interface CarouselItem<TUserDefinedType = Record<string, unknown>> {
    agent_message_type?: AgentMessageType;
    items: GenericItem<Record<string, unknown>>[];
    message_options?: GenericItemMessageOptions;
    response_type: MessageResponseTypes;
    streaming_metadata?: ItemStreamingMetadata;
    user_defined?: TUserDefinedType;
}

Type Parameters

  • TUserDefinedType = Record<string, unknown>

Hierarchy (View Summary, Expand)

Properties

agent_message_type? items message_options? response_type streaming_metadata? 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.

items

items: GenericItem<Record<string, unknown>>[]

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.

Optionaluser_defined

user_defined?: TUserDefinedType

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

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR