Documentation - v20.0.0-dev
    Preparing search index...

    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

    Properties

    name: string

    Display name of the plugin

    Its settings: those saved in the local storage set, then config.

    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)[]

    • Whether the plugin has at least one setting an interface shows (not hidden).

      Returns boolean

    • Called when the plugin is registered in the viewer.

      Returns void

    • Called when the plugin is unregistred from the viewer.

      Returns void

    • A base class for a plugin of this name, its settings an instance of SettingsClass (EmptySettings for none): class MyPlugin extends ViewerPlugin.Create('MyPlugin', MySettings) {}.

      Type Parameters

      Parameters

      • name: string
      • SettingsClass: new () => S

      Returns typeof PluginClass