@gooddata/sdk-ui-gen-ai
This package provides React components for GoodData’s GenAI features.
Classes
Class | Description |
|---|---|
(ALPHA) Isolated headless workflow owner backed by pure transitions and immutable snapshots. |
Enumerations
Enumeration | Description |
|---|---|
(ALPHA) Built-in copilot workflows. Applications may supply their own string enum. |
Functions
Function | Description |
|---|---|
(ALPHA) Wrap content with a composing animation and optional reasoning or reply banner. | |
CopilotInteractionComposingWithHandler({ copilot, scope, onReplyInChat, …props }, input) | (ALPHA) Subscribe to a copilot instance without introducing another workflow state owner. |
(ALPHA) Create an independent, empty workflow state. | |
(ALPHA) Default implementation of the AgentChooser slot. | |
(ALPHA) Default implementation of the AgentItem slot. | |
(ALPHA) Default implementation of the AssistantMessage slot. | |
(ALPHA) Default implementation of the ConversationDateGrouping slot. | |
(ALPHA) Default implementation of the ConversationDrawerHeader slot. | |
(ALPHA) Default implementation of the ConversationFooter slot. | |
(ALPHA) Default implementation of the ConversationHeader slot. | |
(ALPHA) Default implementation of the ConversationItem slot. | |
(ALPHA) Default implementation of the ConversationKdaContent slot. | |
(ALPHA) Default implementation of the ConversationVisualizationContent slot. | |
(ALPHA) Default implementation of the Disclaimer slot. | |
(ALPHA) Default implementation of the Feedback slot. | |
(ALPHA) Default implementation of the FollowUpButtons slot. | |
(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. |
(ALPHA) Default implementation of the LandingTitle slot. | |
(ALPHA) Default implementation of the LandingTitleAscent slot. | |
(ALPHA) Default implementation of the MessageErrorContent slot. | |
(ALPHA) Default implementation of the MessageMultipartContent slot. | |
(ALPHA) Default implementation of the MessageReasoningContent slot. | |
(ALPHA) Default implementation of the MessageTextContent slot. | |
(ALPHA) Default implementation of the UserMessage slot. | |
DefaultVisualizationMenu({ items, isDisabled, ariaDescribedBy, }, input) | (ALPHA) Default implementation of the VisualizationMenu slot. |
UI component that renders the Gen AI assistant. | |
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. |
UI component that renders the Key Driver Analysis dialog when requested in the GenAI store. | |
Provides the Gen AI store to the application. | |
Type guard for the ChatAgentChangeEvent. | |
Type guard for the ChatAssistantMessageEvent. | |
Type guard for the ChatClarificationQuestionsEvent. | |
Type guard for the ChatClosedEvent. | |
Type guard for the ChatContextChangeEvent. | |
Type guard for the ChatCopyToClipboardEvent. | |
Type guard for the ChatConversationDeletedEvent. | |
Type guard for the ChatConversationDeletedEvent. | |
Type guard for the ChatConversationDeletedEvent. | |
Type guard for the ChatConversationPinnedEvent. | |
Type guard for the ChatConversationPinnedEvent. | |
Type guard for the ChatConversationRenamedErrorEvent. | |
Type guard for the ChatConversationRenamedSuccessEvent. | |
Type guard for the ChatConversationRenameEvent. | |
Type guard for the ChatCopyToClipboardEvent. | |
Type guard for the ChatDefinitionReceivedEvent. | |
Type guard for the ChatFeedbackErrorEvent. | |
Type guard for the ChatFeedbackEvent. | |
Type guard for the ChatModeChangeEvent. | |
Type guard for the ChatOpenedEvent. | |
Type guard for the ChatReasoningEvent. | |
Type guard for the ChatResetEvent. | |
Type guard for the ChatVisualizationErrorEvent. | |
Type guard for the ChatSaveVisualizationSuccessEvent. | |
Type guard for the ChatUserAnswersEvent. | |
Type guard for the ChatUserMessageEvent. | |
Type guard for the ChatVisualizationErrorEvent. | |
Make a new assistant message item. | |
Make a new user message item. | |
(ALPHA) Whether creation is pending, including an activated creation build. | |
(ALPHA) Query foreground reasoning, optionally restricted to the owning workflow. | |
(ALPHA) Query the originating conversation of an applied object. | |
(ALPHA) Calculate progress without host presentation rules or side effects. | |
(ALPHA) Deterministic immutable transition; never allocates IDs, invokes effects, or performs I/O. | |
(ALPHA) Subscribes a React component to a copilot handler’s snapshot. | |
(ALPHA) Hook to retrieve the list of all conversations. | |
(ALPHA) Hook to retrieve whether the conversations have been loaded. | |
(ALPHA) Hook to retrieve the current active conversation. | |
Hook to retrieve the GenAI dispatcher. |
Interfaces
Interface | Description |
|---|---|
(ALPHA) An application awaiting an explicit host acknowledgement. | |
(ALPHA) Origin and intended target of a host definition application. | |
(ALPHA) Configuration of an isolated copilot instance. | |
(ALPHA) Host facts used to resolve events, never application services. | |
(ALPHA) Foreground interaction; background requests are tracked independently. | |
(ALPHA) Configuration of the workflow-independent composing presentation. | |
(ALPHA) Composing presentation driven directly by an existing copilot instance. | |
(ALPHA) Pure matching policy and host effect for one workflow. | |
(ALPHA) A potentially editing response, including provisional requests without a skill. | |
(ALPHA) Scope of a progress query. | |
(ALPHA) Read-only workflow state shared by headless and React consumers. | |
(ALPHA) Conversation that supplied an applied definition. | |
(ALPHA) An object managed by a registered workflow. | |
Customizations for the Gen AI assistant. | |
Props for the GenAiInteractionIntelligence() component. | |
(BETA) | |
(ALPHA) Default implementation of the LandingQuestion slot. | |
(ALPHA) | |
(ALPHA) A renderable what-if scenario with optional execution config overrides. |
Variables
Variable | Description |
|---|---|
(ALPHA) | |
UI component that renders the Gen AI chat. | |
(ALPHA) | |
Switches the assistant between the docked and the fullscreen layout. | |
Type Aliases
Type Alias | Description |
|---|---|
A common event definition for the Chat component. | |
A chat agent changed | |
A chat assistant message event. | |
An answer submitted for a clarification question. | |
A clarification question presented by the chat assistant. | |
An event emitted when clarification questions are presented, answered, or cancelled. | |
A chat window closed event. | |
A chat context change event. | |
A chat copy to clipboard event. | |
A chat conversation deleted error event. | |
A chat conversation deleted success event. | |
A chat conversation deleted event. | |
A chat conversation pinned state change error event. | |
A chat conversation pinned state change event. | |
A chat conversation renamed error event. | |
A chat conversation renamed success event. | |
A chat conversation rename event. | |
A chat copy to clipboard event. | |
An event emitted when a definition is received in a live assistant response or replayed from chat history. | |
A union type for all chat events. | |
An event handler for the Chat component. | |
A chat feedback error event. | |
A chat feedback event. | |
A chat mode changed | |
A chat window opened event. | |
An update to the current reasoning display title during a streamed response. | |
A chat conversation clearing event. | |
A chat save visualization error event. | |
A chat save visualization success event. | |
A chat user answers event. | |
A chat user message event. | |
A chat visualization error event. | |
(ALPHA) Explicit, deterministic input to the workflow engine. | |
(ALPHA) Derived workflow progress, independent of host presentation. | |
Describes an AI assistant agent. | |
Display mode of the Gen AI assistant. | |
Mode of the Gen AI assistant. | |
Properties for the GenAIAssistant component. | |
Properties for the GenAIChat component. | |
Properties for the GenAIConversations component. | |
Props for the GenAiStore component. | |
Chat conversation error content | |
Represents a local chat conversation that extends the base | |
Chat local conversation content | |
Chat conversation item with local ID. | |
Chat local conversation multipart local part | |
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. | |
(ALPHA) Properties for the AgentChooser slot. | |
Properties for the AgentItem slot. | |
(ALPHA) Properties for the AssistantMessage slot. | |
(ALPHA) Properties for the ConversationDateGrouping slot. | |
(ALPHA) Properties for the ConversationDrawerHeader slot. | |
(ALPHA) Properties for the ConversationFooter slot. | |
(ALPHA) Properties for the ConversationHeader slot. | |
(ALPHA) Properties for the ConversationItem slot. | |
(ALPHA) Properties for the ConversationKdaContent slot. | |
(ALPHA) Properties for the ConversationVisualizationContent slot. | |
Properties for the Disclaimer slot. | |
(ALPHA) Properties for the Feedback slot. | |
(ALPHA) Properties for the FollowUpButtons slot. | |
(ALPHA) Properties for the FollowUpQuestion slot. | |
Properties for the LandingScreen slot. | |
(ALPHA) Properties for the MessageErrorContent slot. | |
(ALPHA) Properties for the MessageMultipartContent slot. | |
(ALPHA) Properties for the MessageReasoningContent slot. | |
(ALPHA) Properties for the MessageTextContent slot. | |
(ALPHA) Properties for the UserMessage slot. | |
(ALPHA) Item of the visualization menu. | |
(ALPHA) Properties for the VisualizationMenu slot. | |
The modes the panel can render: the full list/timeline view or a single category’s detail view. | |
(ALPHA) | |