Optional
element?: HTMLElementThe element to which customers can add the custom code to render for the custom response.
Optional
fullWidth?: booleanAn assignable property that the event listener can assign that will indicate if the response is supposed to be full width.
The individual message item that is being displayed in this custom response.
Optional
agent_message_type?: AgentMessageTypeFor 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.
Optional
message_options?: {Options that control additional features available for a message item.
Optional
chain_of_thought?: {Controls the display of chain of thought component. This API is in beta and is subject to change.
Optional
feedback?: {Controls the display of a feedback options (thumbs up/down) for a message item.
Optional
categories?: string[]An optional set of categories to allow the user to choose from.
Optional
disclaimer?: stringThe legal disclaimer text to show at the bottom of the popup. This text may contain rich markdown content. If this value is not provided, no text will be shown.
Optional
id?: stringA unique identifier for this feedback. This is required for the feedback to be recorded in message history.
Optional
is_on?: booleanIndicates if a request for feedback should be displayed.
Optional
placeholder?: stringThe placeholder to show in the text area. A default value will be used if no value is provided here.
Optional
prompt?: stringThe prompt text to display to the user. A default value will be used if no value is provided here.
Optional
show_negative_details?: booleanIndicates if the user should be asked for additional detailed information when providing negative feedback. This defaults to true.
Optional
show_positive_details?: booleanIndicates if the user should be asked for additional detailed information when providing positive feedback. This defaults to true.
Optional
show_prompt?: booleanIndicates whether the prompt line should be shown. This defaults to true.
Optional
show_text_area?: booleanIndicates whether the text area should be shown. This defaults to true.
Optional
title?: stringThe title to display in the popup. A default value will be used if no value is provided here.
Optional
response_type?: MessageResponseTypesThe response type of this message item.
Optional
streaming_metadata?: { cancellable?: boolean; id?: string; stream_stopped?: boolean }Metadata used identify a generic item within the context of a stream in order to correlate any updates meant for a specific item.
Optional
cancellable?: booleanWhen included on a partial_item, indicates if the stream can be cancelled. If so, a "stop streaming" button will display in the UI.
Optional
id?: stringAn identifier for this item within the full message response. This ID is used to correlate a partial or complete item chunk with other chunks that represent the same item. This ID is only unique for a given message response.
Optional
stream_stopped?: booleanIndicates if the stream has stopped which will trigger the UI to respond with appropriate a11y states and messaging.
Optional
user_defined?: { [key: string]: {} }An optional buckets of additional user defined properties for this item.
Optional
slot?: stringThe slot name for users of the web components cds-aichat-container or cds-aichat-custom-element.
The type of this event.
The full chunk that contained the user defined response.