@genesislcap/ai-assistant 14.403.0-ai-assistant.1

package/docs/api/ai-assistant.foundationaiassistant.md

@@ -0,0 +1,826 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [FoundationAiAssistant](./ai-assistant.foundationaiassistant.md)
+
+## FoundationAiAssistant class
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Foundation AI Assistant component.
+
+**Signature:**
+
+```typescript
+export declare class FoundationAiAssistant extends GenesisElement 
+```
+**Extends:** GenesisElement
+
+## Remarks
+
+Lazy-loaded via `configure()`<!-- -->. Inject an `AIProvider` and `AiAssistantConfig` through the DI container. The component creates a `ChatDriver` to manage the conversation loop.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[aiProvider](./ai-assistant.foundationaiassistant.aiprovider.md)
+
+
+</td><td>
+
+
+</td><td>
+
+AIProvider
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[attachmentErrors](./ai-assistant.foundationaiassistant.attachmenterrors.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[attachments](./ai-assistant.foundationaiassistant.attachments.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ChatAttachment\[\]
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[channelName](./ai-assistant.foundationaiassistant.channelname.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[chatConfig](./ai-assistant.foundationaiassistant.chatconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ChatConfig
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[debugStateFactory?](./ai-assistant.foundationaiassistant.debugstatefactory.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; unknown
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[designSystemPrefix](./ai-assistant.foundationaiassistant.designsystemprefix.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[enabledAnimations](./ai-assistant.foundationaiassistant.enabledanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[AiAssistantAnimation](./ai-assistant.aiassistantanimation.md)<!-- -->\[\]
+
+
+</td><td>
+
+**_(BETA)_** Currently enabled animations.
+
+
+</td></tr>
+<tr><td>
+
+[hasActivePendingInteraction](./ai-assistant.foundationaiassistant.hasactivependinginteraction.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** True when there is a pending (unresolved) interaction — disables the popout button.
+
+
+</td></tr>
+<tr><td>
+
+[headerTitle?](./ai-assistant.foundationaiassistant.headertitle.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[imageSrc?](./ai-assistant.foundationaiassistant.imagesrc.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[inputValue](./ai-assistant.foundationaiassistant.inputvalue.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[messages](./ai-assistant.foundationaiassistant.messages.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ChatMessage\[\]
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[placeholder](./ai-assistant.foundationaiassistant.placeholder.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[popoutMode?](./ai-assistant.foundationaiassistant.popoutmode.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[PopoutMode](./ai-assistant.popoutmode.md)
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Controls the pop-out button shown next to the settings cog. "expand" — in bubble, expands to layout panel (fires chat-popout). "collapse" — in layout panel, collapses back to bubble (fires chat-popin). Absent — no button (default standalone behaviour, no breaking change).
+
+
+</td></tr>
+<tr><td>
+
+[settingsOpen](./ai-assistant.foundationaiassistant.settingsopen.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** Whether the settings panel is open.
+
+
+</td></tr>
+<tr><td>
+
+[showHalo](./ai-assistant.foundationaiassistant.showhalo.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** Whether the halo animation should be shown. True when the AI is actively computing (loading state, no pending interaction).
+
+
+</td></tr>
+<tr><td>
+
+[showLoadingIndicator](./ai-assistant.foundationaiassistant.showloadingindicator.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** Whether the loading spinner is currently visible. Controlled by the loading delay timer.
+
+
+</td></tr>
+<tr><td>
+
+[showThinkingSteps](./ai-assistant.foundationaiassistant.showthinkingsteps.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** Current user-facing toggle state for thinking step visibility.
+
+
+</td></tr>
+<tr><td>
+
+[showToolCalls](./ai-assistant.foundationaiassistant.showtoolcalls.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** Current user-facing toggle state for tool call visibility.
+
+
+</td></tr>
+<tr><td>
+
+[state](./ai-assistant.foundationaiassistant.state.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[AiAssistantState](./ai-assistant.aiassistantstate.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[systemPrompt?](./ai-assistant.foundationaiassistant.systemprompt.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[toolDefinitions?](./ai-assistant.foundationaiassistant.tooldefinitions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ChatToolDefinition\[\]
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[toolHandlers?](./ai-assistant.foundationaiassistant.toolhandlers.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ChatToolHandlers
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[visibleMessages](./ai-assistant.foundationaiassistant.visiblemessages.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+ChatMessage\[\]
+
+
+</td><td>
+
+**_(BETA)_** Messages filtered by the current toggle state. Tool-related messages (those with toolCalls or toolResult) are hidden when `showToolCalls` is false.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[applyState(state)](./ai-assistant.foundationaiassistant.applystate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Applies a serialized state snapshot to this live instance (used on collapse path).
+
+
+</td></tr>
+<tr><td>
+
+[connectedCallback()](./ai-assistant.foundationaiassistant.connectedcallback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[disconnectedCallback()](./ai-assistant.foundationaiassistant.disconnectedcallback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[downloadHistory()](./ai-assistant.foundationaiassistant.downloadhistory.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[handleFileSelect(e)](./ai-assistant.foundationaiassistant.handlefileselect.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[handleInteractionCompleted(e)](./ai-assistant.foundationaiassistant.handleinteractioncompleted.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[handlePopout()](./ai-assistant.foundationaiassistant.handlepopout.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Called when the user clicks the popout button.
+
+
+</td></tr>
+<tr><td>
+
+[handleSendClick()](./ai-assistant.foundationaiassistant.handlesendclick.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[messagesChanged()](./ai-assistant.foundationaiassistant.messageschanged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[onChatHeaderMouseDown(e)](./ai-assistant.foundationaiassistant.onchatheadermousedown.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[removeAttachment(attachment)](./ai-assistant.foundationaiassistant.removeattachment.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[removeAttachmentError(message)](./ai-assistant.foundationaiassistant.removeattachmenterror.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[setEnabledAnimations(animations)](./ai-assistant.foundationaiassistant.setenabledanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[showHaloChanged()](./ai-assistant.foundationaiassistant.showhalochanged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[showLoadingIndicatorChanged()](./ai-assistant.foundationaiassistant.showloadingindicatorchanged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[stateChanged()](./ai-assistant.foundationaiassistant.statechanged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[toggleSettings()](./ai-assistant.foundationaiassistant.togglesettings.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[toggleShowThinkingSteps()](./ai-assistant.foundationaiassistant.toggleshowthinkingsteps.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[toggleShowToolCalls()](./ai-assistant.foundationaiassistant.toggleshowtoolcalls.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[triggerFileInput()](./ai-assistant.foundationaiassistant.triggerfileinput.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>
+