Overview of sdk-ui-gen-ai

Home > @gooddata/sdk-ui-gen-ai

sdk-ui-gen-ai package

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

Interfaces

Interface	Description
ChatEventHandler	An event handler for the Chat component.
GenAIChatProps	Properties for the GenAIChat component.

Variables

Variable	Description
GenAIChat	UI component that renders the Gen AI chat.
isChatAssistantMessageEvent	Type guard for the ChatAssistantMessageEvent.
isChatClosedEvent	Type guard for the ChatClosedEvent.
isChatFeedbackEvent	Type guard for the ChatFeedbackEvent.
isChatOpenedEvent	Type guard for the ChatOpenedEvent.
isChatResetEvent	Type guard for the ChatResetEvent.
isChatSaveVisualizationErrorEvent	Type guard for the ChatVisualizationErrorEvent.
isChatSaveVisualizationSuccessEvent	Type guard for the isChatSaveVisualizationSuccessEvent.
isChatUserMessageEvent	Type guard for the ChatUserMessageEvent.
isChatVisualizationErrorEvent	Type guard for the ChatVisualizationErrorEvent.

Type Aliases

Type Alias	Description
AssistantMessage
BaseEvent	A common event definition for the Chat component.
BaseMessage
ChatAssistantMessageEvent	A chat assistant message event.
ChatClosedEvent	A chat window closed event.
ChatEvent	A union type for all chat events.
ChatFeedbackEvent	A chat feedback event.
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.
ChatUserMessageEvent	A chat user message event.
ChatVisualizationErrorEvent	A chat visualization error event.
Contents
ErrorContents
LinkHandlerEvent
Message	All messages that can be stored in history.
RoutingContents
SearchContents
TextContents
UserMessage
VisualizationContents