Documentation - v19.12.0-dev
    Preparing search index...

    Class ChatBotPlugin

    Plugin registering the ChatBot widget, a conversation with Elliot, the Teia assistant: it answers questions about the loaded Twin, executes viewer commands and previews quantity take-offs. The widget also edits the flows and the aliases of the assistant, and displays the token quota of the instance.

    Requires the Teia and Viewport plugins to be registered: it uses the Tia API client of the Teia plugin. Call setupLegacyPluginsTranslation once i18next is initialized to load its translations.

    Hierarchy

    • PluginBaseClass
      • ChatBotPlugin
    Index

    Constructors

    constructor

    Properties

    name settings viewer ToolbarItems

    Methods

    clear dependencies hasSettings onRegister onUnregister Create

    Constructors

    Properties

    name: string

    Display name of the plugin

    settings: { qtoPreviewSize: NumberController }

    Plugin settings

    Type Declaration

    • qtoPreviewSize: NumberController

      Number of rows of the quantity take-offs previewed in the conversation

      5
    viewer: Viewer
    ToolbarItems: { ShowChatBotWidgetToolbarItem: () => Element } = ...

    Toolbar items provided by the plugin

    Type Declaration

    • ShowChatBotWidgetToolbarItem: () => Element

      Toolbar item opening the ChatBotWidget. Disabled when the loaded source is not a Twin.

    Methods

    • Returns void

    • List of plugins this plugin depends on

      Returns readonly (keyof ViewerPluginRegistry)[]

    • Indicates whether the plugin has settings

      Returns boolean

    • Called when the plugin is registered in the viewer.

      Returns void

    • Called when the plugin is unregistred from the viewer.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods