IOpenAiAssistantHostUiNotification

Home > @gooddata/sdk-pluggable-application-model > IOpenAiAssistantHostUiNotification

IOpenAiAssistantHostUiNotification interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Notification requesting the host UI to open its AI assistant chat.

Signature:

export interface IOpenAiAssistantHostUiNotification

Remarks

Emitted when the active pluggable application requests the assistant (see IOpenAiAssistantRequestedEvent). The host UI owns the single chat instance on hosted-application routes and opens it, optionally seeded with a question and user context.

Properties

Property

Modifiers

Type

Description

question?

string

(ALPHA) (Optional) Question to seed the chat with. When omitted, the chat just opens.

type

"openAiAssistant"

(ALPHA)

userContext?

IGenAIUserContext

(ALPHA) (Optional) Context of the user's current location (e.g. the active dashboard), passed to the assistant alongside the seeded question.

← INewDeploymentAvailableHostUiNotificationIOpenAiAssistantRequestedEvent →