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

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

@@ -0,0 +1,80 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantAnimationDef](./ai-assistant.aiassistantanimationdef.md)
+
+## AiAssistantAnimationDef interface
+
+> 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.
+> 
+
+Metadata describing a UI animation in the assistant.
+
+**Signature:**
+
+```typescript
+export interface AiAssistantAnimationDef 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[label](./ai-assistant.aiassistantanimationdef.label.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** Display label shown in the settings multiselect.
+
+
+</td></tr>
+<tr><td>
+
+[tooltip](./ai-assistant.aiassistantanimationdef.tooltip.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** Short description shown as a tooltip on the option.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/ai-assistant.aiassistantanimationdef.tooltip.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantAnimationDef](./ai-assistant.aiassistantanimationdef.md) &gt; [tooltip](./ai-assistant.aiassistantanimationdef.tooltip.md)
+
+## AiAssistantAnimationDef.tooltip property
+
+> 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.
+> 
+
+Short description shown as a tooltip on the option.
+
+**Signature:**
+
+```typescript
+tooltip: string;
+```

package/docs/api/ai-assistant.aiassistantconfig.chatconfig.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantConfig](./ai-assistant.aiassistantconfig.md) &gt; [chatConfig](./ai-assistant.aiassistantconfig.chatconfig.md)
+
+## AiAssistantConfig.chatConfig property
+
+> 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.
+> 
+
+Chat display and behaviour configuration.
+
+**Signature:**
+
+```typescript
+chatConfig: ChatConfig;
+```

package/docs/api/ai-assistant.aiassistantconfig.debugstatefactory.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantConfig](./ai-assistant.aiassistantconfig.md) &gt; [debugStateFactory](./ai-assistant.aiassistantconfig.debugstatefactory.md)
+
+## AiAssistantConfig.debugStateFactory property
+
+> 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.
+> 
+
+Optional factory called at download time to include extra app-specific debug state alongside the message history. Only used when `chatConfig.allowDebugDownload` is `true`<!-- -->.
+
+**Signature:**
+
+```typescript
+debugStateFactory?: () => unknown;
+```

package/docs/api/ai-assistant.aiassistantconfig.headertitle.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantConfig](./ai-assistant.aiassistantconfig.md) &gt; [headerTitle](./ai-assistant.aiassistantconfig.headertitle.md)
+
+## AiAssistantConfig.headerTitle property
+
+> 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.
+> 
+
+Display title shown in the chat header (e.g. 'Trades Assistant').
+
+**Signature:**
+
+```typescript
+headerTitle?: string;
+```

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

@@ -0,0 +1,157 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantConfig](./ai-assistant.aiassistantconfig.md)
+
+## AiAssistantConfig interface
+
+> 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.
+> 
+
+AiAssistantConfig DI interface.
+
+**Signature:**
+
+```typescript
+export interface AiAssistantConfig extends PartialGenesisElementDefinition 
+```
+**Extends:** PartialGenesisElementDefinition
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[chatConfig](./ai-assistant.aiassistantconfig.chatconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ChatConfig
+
+
+</td><td>
+
+**_(BETA)_** Chat display and behaviour configuration.
+
+
+</td></tr>
+<tr><td>
+
+[debugStateFactory?](./ai-assistant.aiassistantconfig.debugstatefactory.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; unknown
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Optional factory called at download time to include extra app-specific debug state alongside the message history. Only used when `chatConfig.allowDebugDownload` is `true`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[headerTitle?](./ai-assistant.aiassistantconfig.headertitle.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Display title shown in the chat header (e.g. 'Trades Assistant').
+
+
+</td></tr>
+<tr><td>
+
+[systemPrompt?](./ai-assistant.aiassistantconfig.systemprompt.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ System prompt injected into every conversation.
+
+
+</td></tr>
+<tr><td>
+
+[toolDefinitions?](./ai-assistant.aiassistantconfig.tooldefinitions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ChatToolDefinition\[\]
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Tool definitions (JSON Schema) passed to the AI provider.
+
+
+</td></tr>
+<tr><td>
+
+[toolHandlers?](./ai-assistant.aiassistantconfig.toolhandlers.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ChatToolHandlers
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Tool handlers injected per-app at configure() time.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/ai-assistant.aiassistantconfig.systemprompt.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantConfig](./ai-assistant.aiassistantconfig.md) &gt; [systemPrompt](./ai-assistant.aiassistantconfig.systemprompt.md)
+
+## AiAssistantConfig.systemPrompt property
+
+> 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.
+> 
+
+System prompt injected into every conversation.
+
+**Signature:**
+
+```typescript
+systemPrompt?: string;
+```

package/docs/api/ai-assistant.aiassistantconfig.tooldefinitions.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantConfig](./ai-assistant.aiassistantconfig.md) &gt; [toolDefinitions](./ai-assistant.aiassistantconfig.tooldefinitions.md)
+
+## AiAssistantConfig.toolDefinitions property
+
+> 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.
+> 
+
+Tool definitions (JSON Schema) passed to the AI provider.
+
+**Signature:**
+
+```typescript
+toolDefinitions?: ChatToolDefinition[];
+```

package/docs/api/ai-assistant.aiassistantconfig.toolhandlers.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantConfig](./ai-assistant.aiassistantconfig.md) &gt; [toolHandlers](./ai-assistant.aiassistantconfig.toolhandlers.md)
+
+## AiAssistantConfig.toolHandlers property
+
+> 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.
+> 
+
+Tool handlers injected per-app at configure() time.
+
+**Signature:**
+
+```typescript
+toolHandlers?: ChatToolHandlers;
+```

package/docs/api/ai-assistant.aiassistantserializedstate.enabledanimations.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantSerializedState](./ai-assistant.aiassistantserializedstate.md) &gt; [enabledAnimations](./ai-assistant.aiassistantserializedstate.enabledanimations.md)
+
+## AiAssistantSerializedState.enabledAnimations property
+
+> 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.
+> 
+
+**Signature:**
+
+```typescript
+enabledAnimations: AiAssistantAnimation[];
+```

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

@@ -0,0 +1,118 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantSerializedState](./ai-assistant.aiassistantserializedstate.md)
+
+## AiAssistantSerializedState interface
+
+> 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.
+> 
+
+Serialized state of a `FoundationAiAssistant` instance. All fields are JSON-serializable and round-trip through BroadcastChannel structured-clone.
+
+**Signature:**
+
+```typescript
+export interface AiAssistantSerializedState 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[enabledAnimations](./ai-assistant.aiassistantserializedstate.enabledanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[AiAssistantAnimation](./ai-assistant.aiassistantanimation.md)<!-- -->\[\]
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[messages](./ai-assistant.aiassistantserializedstate.messages.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ChatMessage\[\]
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[showThinkingSteps](./ai-assistant.aiassistantserializedstate.showthinkingsteps.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[showToolCalls](./ai-assistant.aiassistantserializedstate.showtoolcalls.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/ai-assistant.aiassistantserializedstate.messages.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantSerializedState](./ai-assistant.aiassistantserializedstate.md) &gt; [messages](./ai-assistant.aiassistantserializedstate.messages.md)
+
+## AiAssistantSerializedState.messages property
+
+> 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.
+> 
+
+**Signature:**
+
+```typescript
+messages: ChatMessage[];
+```

package/docs/api/ai-assistant.aiassistantserializedstate.showthinkingsteps.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantSerializedState](./ai-assistant.aiassistantserializedstate.md) &gt; [showThinkingSteps](./ai-assistant.aiassistantserializedstate.showthinkingsteps.md)
+
+## AiAssistantSerializedState.showThinkingSteps property
+
+> 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.
+> 
+
+**Signature:**
+
+```typescript
+showThinkingSteps: boolean;
+```

package/docs/api/ai-assistant.aiassistantserializedstate.showtoolcalls.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantSerializedState](./ai-assistant.aiassistantserializedstate.md) &gt; [showToolCalls](./ai-assistant.aiassistantserializedstate.showtoolcalls.md)
+
+## AiAssistantSerializedState.showToolCalls property
+
+> 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.
+> 
+
+**Signature:**
+
+```typescript
+showToolCalls: boolean;
+```

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

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiAssistantState](./ai-assistant.aiassistantstate.md)
+
+## AiAssistantState type
+
+> 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.
+> 
+
+State of the AI assistant component.
+
+**Signature:**
+
+```typescript
+export type AiAssistantState = 'idle' | 'loading' | 'error';
+```

package/docs/api/ai-assistant.aichatbubble.bubbleleft.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiChatBubble](./ai-assistant.aichatbubble.md) &gt; [bubbleLeft](./ai-assistant.aichatbubble.bubbleleft.md)
+
+## AiChatBubble.bubbleLeft property
+
+**Signature:**
+
+```typescript
+bubbleLeft: number;
+```

package/docs/api/ai-assistant.aichatbubble.bubbletop.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiChatBubble](./ai-assistant.aichatbubble.md) &gt; [bubbleTop](./ai-assistant.aichatbubble.bubbletop.md)
+
+## AiChatBubble.bubbleTop property
+
+**Signature:**
+
+```typescript
+bubbleTop: number;
+```

package/docs/api/ai-assistant.aichatbubble.channelname.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiChatBubble](./ai-assistant.aichatbubble.md) &gt; [channelName](./ai-assistant.aichatbubble.channelname.md)
+
+## AiChatBubble.channelName property
+
+**Signature:**
+
+```typescript
+channelName: string;
+```

package/docs/api/ai-assistant.aichatbubble.connectedcallback.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiChatBubble](./ai-assistant.aichatbubble.md) &gt; [connectedCallback](./ai-assistant.aichatbubble.connectedcallback.md)
+
+## AiChatBubble.connectedCallback() method
+
+**Signature:**
+
+```typescript
+connectedCallback(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/ai-assistant.aichatbubble.designsystemprefix.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiChatBubble](./ai-assistant.aichatbubble.md) &gt; [designSystemPrefix](./ai-assistant.aichatbubble.designsystemprefix.md)
+
+## AiChatBubble.designSystemPrefix property
+
+**Signature:**
+
+```typescript
+designSystemPrefix: string;
+```

package/docs/api/ai-assistant.aichatbubble.dialogcontent.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/ai-assistant](./ai-assistant.md) &gt; [AiChatBubble](./ai-assistant.aichatbubble.md) &gt; [dialogContent](./ai-assistant.aichatbubble.dialogcontent.md)
+
+## AiChatBubble.dialogContent property
+
+**Signature:**
+
+```typescript
+dialogContent: HTMLElement[];
+```