@gooddata/sdk-ui-gen-ai

This package provides React components for GoodData’s GenAI features.

Functions

Function	Description
DefaultAgentChooser(props)	*(ALPHA)* Default implementation of the AgentChooser slot.
DefaultAgentItem(props)	*(ALPHA)* Default implementation of the AgentItem slot.
DefaultAssistantMessage(props)	*(ALPHA)* Default implementation of the AssistantMessage slot.
DefaultConversationDateGrouping(props)	*(ALPHA)* Default implementation of the ConversationDateGrouping slot.
DefaultConversationDrawerHeader(props)	*(ALPHA)* Default implementation of the ConversationDrawerHeader slot.
DefaultConversationFooter(_)	*(ALPHA)* Default implementation of the ConversationFooter slot.
DefaultConversationHeader(_)	*(ALPHA)* Default implementation of the ConversationHeader slot.
DefaultConversationItem(props)	*(ALPHA)* Default implementation of the ConversationItem slot.
DefaultConversationKdaContent(props)	*(ALPHA)* Default implementation of the ConversationKdaContent slot.
DefaultConversationVisualizationContent(props)	*(ALPHA)* Default implementation of the ConversationVisualizationContent slot.
DefaultDisclaimer(_props)	*(ALPHA)* Default implementation of the Disclaimer slot.
DefaultFeedback(props)	*(ALPHA)* Default implementation of the Feedback slot.
DefaultFollowUpButtons(props)	*(ALPHA)* Default implementation of the FollowUpButtons slot.
DefaultFollowUpQuestion(props)	*(ALPHA)* Default implementation of the FollowUpQuestion slot.
DefaultLandingContainer({ children, isBigScreen, isSmallScreen, isFullscreen, }, input)	*(ALPHA)* Default implementation of the LandingContainer slot.
DefaultLandingQuestion({ icon, question, answer, title }, input)	*(ALPHA)* Default implementation of the LandingQuestion slot.
DefaultLandingQuestions({ children, isFullscreen, isBigScreen, isSmallScreen, }, input)	*(ALPHA)* Default implementation of the LandingQuestions slot.
DefaultLandingScreen({ LandingScreen, isBigScreen, isSmallScreen, isFullscreen, }, input)	*(ALPHA)* Default implementation of the LandingScreen slot.
DefaultLandingTitle({ children }, input)	*(ALPHA)* Default implementation of the LandingTitle slot.
DefaultLandingTitleAscent({ children }, input)	*(ALPHA)* Default implementation of the LandingTitleAscent slot.
DefaultMessageErrorContent(props)	*(ALPHA)* Default implementation of the MessageErrorContent slot.
DefaultMessageMultipartContent(props)	*(ALPHA)* Default implementation of the MessageMultipartContent slot.
DefaultMessageReasoningContent(props)	*(ALPHA)* Default implementation of the MessageReasoningContent slot.
DefaultMessageTextContent(props)	*(ALPHA)* Default implementation of the MessageTextContent slot.
DefaultUserMessage(props)	*(ALPHA)* Default implementation of the UserMessage slot.
GenAIAssistant(props)	UI component that renders the Gen AI assistant.
GenAIConversations(props)	UI component that renders the Gen AI assistant.
GenAiInteractionIntelligence({ responseId, onClose, initialMode, initialCategory, }, input)	The Interaction Intelligence panel: a single timeline of the processing steps behind one assistant response, with a list view and a per-category detail view. Loads its own data on mount and owns which view/category is currently shown.
GenAiKeyDriverAnalysis({ locale }, input)	UI component that renders the Key Driver Analysis dialog when requested in the GenAI store.
GenAiStore(props)	Provides the Gen AI store to the application.
isChatAgentChangeEvent(event)	Type guard for the ChatAgentChangeEvent.
isChatAssistantMessageEvent(event)	Type guard for the ChatAssistantMessageEvent.
isChatClarificationQuestionsEvent(event)	Type guard for the ChatClarificationQuestionsEvent.
isChatClosedEvent(event)	Type guard for the ChatClosedEvent.
isChatContextChangeEvent(event)	Type guard for the ChatContextChangeEvent.
isChatConversationChangedEvent(event)	Type guard for the ChatCopyToClipboardEvent.
isChatConversationDeletedErrorEvent(event)	Type guard for the ChatConversationDeletedEvent.
isChatConversationDeletedSuccessEvent(event)	Type guard for the ChatConversationDeletedEvent.
isChatConversationDeleteEvent(event)	Type guard for the ChatConversationDeletedEvent.
isChatConversationPinErrorEvent(event)	Type guard for the ChatConversationPinnedEvent.
isChatConversationPinnedEvent(event)	Type guard for the ChatConversationPinnedEvent.
isChatConversationRenamedErrorEvent(event)	Type guard for the ChatConversationRenamedErrorEvent.
isChatConversationRenamedSuccessEvent(event)	Type guard for the ChatConversationRenamedSuccessEvent.
isChatConversationRenameEvent(event)	Type guard for the ChatConversationRenameEvent.
isChatCopyToClipboardEvent(event)	Type guard for the ChatCopyToClipboardEvent.
isChatDefinitionReceivedEvent(event)	Type guard for the ChatDefinitionReceivedEvent.
isChatFeedbackErrorEvent(event)	Type guard for the ChatFeedbackErrorEvent.
isChatFeedbackEvent(event)	Type guard for the ChatFeedbackEvent.
isChatModeChangeEvent(event)	Type guard for the ChatModeChangeEvent.
isChatOpenedEvent(event)	Type guard for the ChatOpenedEvent.
isChatResetEvent(event)	Type guard for the ChatResetEvent.
isChatSaveVisualizationErrorEvent(event)	Type guard for the ChatVisualizationErrorEvent.
isChatSaveVisualizationSuccessEvent(event)	Type guard for the ChatSaveVisualizationSuccessEvent.
isChatUserAnswersEvent(event)	Type guard for the ChatUserAnswersEvent.
isChatUserMessageEvent(event)	Type guard for the ChatUserMessageEvent.
isChatVisualizationErrorEvent(event)	Type guard for the ChatVisualizationErrorEvent.
makeAssistantItem(content, id, complete)	Make a new assistant message item.
makeUserItem(content, id)	Make a new user message item.
useGenAiConversations()	*(ALPHA)* Hook to retrieve the list of all conversations.
useGenAiConversationsLoaded()	*(ALPHA)* Hook to retrieve whether the conversations have been loaded.
useGenAiCurrentConversation()	*(ALPHA)* Hook to retrieve the current active conversation.
useGenAiDispatcher()	Hook to retrieve the GenAI dispatcher.

Interfaces

Interface	Description
IChatMessagesGroup
IGenAIAssistantSlots	Customizations for the Gen AI assistant.
IGenAiInteractionIntelligenceProps	Props for the GenAiInteractionIntelligence() component.
ILandingContentProps	*(BETA)*
ILandingQuestionProps	*(ALPHA)* Default implementation of the LandingQuestion slot.
ILandingTitleProps	*(ALPHA)*
IWhatIfRenderableScenario	*(ALPHA)* A renderable what-if scenario with optional execution config overrides.

Variables

Variable	Description
clearThreadAction
dashboardSavedAction	*(ALPHA)*
deleteConversationAction
GenAIChat	UI component that renders the Gen AI chat.
newMessageAction
pinConversationAction
publisherDocumentSavedAction	*(ALPHA)*
renameConversationAction
setAmbientUserContextAction
setCurrentConversationAction
setFullscreenAction	Switches the assistant between the docked and the fullscreen layout.
setSelectedAgentAction
setUserContextAction
startNewConversationAction

Type Aliases

Type Alias	Description
BaseEvent	A common event definition for the Chat component.
ChatAgentChangeEvent	A chat agent changed
ChatAssistantMessageEvent	A chat assistant message event.
ChatClarificationAnswer	An answer submitted for a clarification question.
ChatClarificationQuestion	A clarification question presented by the chat assistant.
ChatClarificationQuestionsEvent	An event emitted when clarification questions are presented, answered, or cancelled.
ChatClosedEvent	A chat window closed event.
ChatContextChangeEvent	A chat context change event.
ChatConversationChangedEvent	A chat copy to clipboard event.
ChatConversationDeletedErrorEvent	A chat conversation deleted error event.
ChatConversationDeletedSuccessEvent	A chat conversation deleted success event.
ChatConversationDeleteEvent	A chat conversation deleted event.
ChatConversationPinErrorEvent	A chat conversation pinned state change error event.
ChatConversationPinnedEvent	A chat conversation pinned state change event.
ChatConversationRenamedErrorEvent	A chat conversation renamed error event.
ChatConversationRenamedSuccessEvent	A chat conversation renamed success event.
ChatConversationRenameEvent	A chat conversation rename event.
ChatCopyToClipboardEvent	A chat copy to clipboard event.
ChatDefinitionReceivedEvent	A chat definition received event.
ChatEvent	A union type for all chat events.
ChatEventHandler	An event handler for the Chat component.
ChatFeedbackErrorEvent	A chat feedback error event.
ChatFeedbackEvent	A chat feedback event.
ChatModeChangeEvent	A chat mode changed
ChatOpenedEvent	A chat window opened event.
ChatResetEvent	A chat conversation clearing event.
ChatSaveVisualizationErrorEvent	A chat save visualization error event.
ChatSaveVisualizationSuccessEvent	A chat save visualization success event.
ChatUserAnswersEvent	A chat user answers event.
ChatUserMessageEvent	A chat user message event.
ChatVisualizationErrorEvent	A chat visualization error event.
GenAIAgent	Describes an AI assistant agent.
GenAIAssistantDisplayMode	Display mode of the Gen AI assistant.
GenAIAssistantMode	Mode of the Gen AI assistant.
GenAIAssistantProps	Properties for the GenAIAssistant component.
GenAIChatProps	Properties for the GenAIChat component.
GenAIConversationsProps	Properties for the GenAIConversations component.
GenAiKeyDriverAnalysisProps
GenAiStoreProps	Props for the GenAiStore component.
IChatConversationErrorContent	Chat conversation error content
IChatConversationLocal	Represents a local chat conversation that extends the base `IChatConversation` type. Includes additional optional properties specific to the local context.
IChatConversationLocalContent	Chat local conversation content
IChatConversationLocalItem	Chat conversation item with local ID.
IChatConversationMultipartLocalPart	Chat local conversation multipart local part
IChatConversationSystemContent	Local-only content type for system-role items (e.g. agent-switch events). Meaningful data lives in top-level item fields; content is structurally required but unused.
IGenAIAssistantAgentChooserProps	*(ALPHA)* Properties for the AgentChooser slot.
IGenAIAssistantAgentItemProps	Properties for the AgentItem slot.
IGenAIAssistantAssistantMessageProps	*(ALPHA)* Properties for the AssistantMessage slot.
IGenAIAssistantConversationDateGroupingProps	*(ALPHA)* Properties for the ConversationDateGrouping slot.
IGenAIAssistantConversationDrawerHeaderProps	*(ALPHA)* Properties for the ConversationDrawerHeader slot.
IGenAIAssistantConversationFooterProps	*(ALPHA)* Properties for the ConversationFooter slot.
IGenAIAssistantConversationHeaderProps	*(ALPHA)* Properties for the ConversationHeader slot.
IGenAIAssistantConversationItemProps	*(ALPHA)* Properties for the ConversationItem slot.
IGenAIAssistantConversationKdaContentProps	*(ALPHA)* Properties for the ConversationKdaContent slot.
IGenAIAssistantConversationVisualizationContentProps	*(ALPHA)* Properties for the ConversationVisualizationContent slot.
IGenAIAssistantDisclaimerProps	Properties for the Disclaimer slot.
IGenAIAssistantFeedbackProps	*(ALPHA)* Properties for the Feedback slot.
IGenAIAssistantFollowUpButtonsProps	*(ALPHA)* Properties for the FollowUpButtons slot.
IGenAIAssistantFollowUpQuestionProps	*(ALPHA)* Properties for the FollowUpQuestion slot.
IGenAIAssistantLandingScreenProps	Properties for the LandingScreen slot.
IGenAIAssistantMessageErrorContentProps	*(ALPHA)* Properties for the MessageErrorContent slot.
IGenAIAssistantMessageMultipartContentProps	*(ALPHA)* Properties for the MessageMultipartContent slot.
IGenAIAssistantMessageReasoningContentProps	*(ALPHA)* Properties for the MessageReasoningContent slot.
IGenAIAssistantMessageTextContentProps	*(ALPHA)* Properties for the MessageTextContent slot.
IGenAIAssistantUserMessageProps	*(ALPHA)* Properties for the UserMessage slot.
InteractionIntelligenceMode	The modes the panel can render: the full list/timeline view or a single category’s detail view.
LandingScreenProps	*(ALPHA)*
LinkHandlerEvent
TextContentObject