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.

Functions

Function	Description
GenAIAssistant(props)	UI component that renders the Gen AI assistant.
isChatAssistantMessageEvent(event)	Type guard for the ChatAssistantMessageEvent.
isChatClosedEvent(event)	Type guard for the ChatClosedEvent.
isChatCopyToClipboardEvent(event)	Type guard for the ChatCopyToClipboardEvent.
isChatFeedbackEvent(event)	Type guard for the ChatFeedbackEvent.
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.
isChatUserMessageEvent(event)	Type guard for the ChatUserMessageEvent.
isChatVisualizationErrorEvent(event)	Type guard for the ChatVisualizationErrorEvent.
makeTextContents(text, objects)
makeUserMessage(content)

Interfaces

Interface	Description
ChatEventHandler	An event handler for the Chat component.
GenAIAssistantProps	Properties for the GenAIAssistant component.

Variables

Variable	Description
clearThreadAction
GenAIChat	UI component that renders the Gen AI chat.
newMessageAction

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.
ChatCopyToClipboardEvent	A chat copy to clipboard 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
GenAIChatProps	Properties for the GenAIChat component.
LinkHandlerEvent
Message	All messages that can be stored in history.
RoutingContents
SearchContents
TextContentObject
TextContents
UserMessage
VisualizationContents