@genesislcap/foundation-ai 14.407.0-workspaces.4 → 14.408.0

package/docs/api/foundation-ai.chatinteraction.md

@@ -0,0 +1,118 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatInteraction](./foundation-ai.chatinteraction.md)
+
+## ChatInteraction 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.
+> 
+
+A user interaction component request.
+
+**Signature:**
+
+```typescript
+export interface ChatInteraction 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[componentName](./foundation-ai.chatinteraction.componentname.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[data](./foundation-ai.chatinteraction.data.md)
+
+
+</td><td>
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[interactionId](./foundation-ai.chatinteraction.interactionid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[resolved?](./foundation-ai.chatinteraction.resolved.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ Set to true once the interaction has been resolved. Used to render a read-only state on re-render.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.chatinteraction.resolved.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatInteraction](./foundation-ai.chatinteraction.md) &gt; [resolved](./foundation-ai.chatinteraction.resolved.md)
+
+## ChatInteraction.resolved 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.
+> 
+
+Set to true once the interaction has been resolved. Used to render a read-only state on re-render.
+
+**Signature:**
+
+```typescript
+resolved?: boolean;
+```

package/docs/api/foundation-ai.chatmessage.attachments.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatMessage](./foundation-ai.chatmessage.md) &gt; [attachments](./foundation-ai.chatmessage.attachments.md)
+
+## ChatMessage.attachments 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
+attachments?: ChatAttachment[];
+```

package/docs/api/foundation-ai.chatmessage.content.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatMessage](./foundation-ai.chatmessage.md) &gt; [content](./foundation-ai.chatmessage.content.md)
+
+## ChatMessage.content 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
+content: string;
+```

package/docs/api/foundation-ai.chatmessage.interaction.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatMessage](./foundation-ai.chatmessage.md) &gt; [interaction](./foundation-ai.chatmessage.interaction.md)
+
+## ChatMessage.interaction 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
+interaction?: ChatInteraction;
+```

package/docs/api/foundation-ai.chatmessage.md

@@ -0,0 +1,175 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatMessage](./foundation-ai.chatmessage.md)
+
+## ChatMessage 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.
+> 
+
+A single message in a chat conversation.
+
+**Signature:**
+
+```typescript
+export interface ChatMessage 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[attachments?](./foundation-ai.chatmessage.attachments.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ChatAttachment](./foundation-ai.chatattachment.md)<!-- -->\[\]
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[content](./foundation-ai.chatmessage.content.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[interaction?](./foundation-ai.chatmessage.interaction.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ChatInteraction](./foundation-ai.chatinteraction.md)
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[role](./foundation-ai.chatmessage.role.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ChatRole](./foundation-ai.chatrole.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[thinking?](./foundation-ai.chatmessage.thinking.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[toolCalls?](./foundation-ai.chatmessage.toolcalls.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ChatToolCall](./foundation-ai.chattoolcall.md)<!-- -->\[\]
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[toolResult?](./foundation-ai.chatmessage.toolresult.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ChatToolResult](./foundation-ai.chattoolresult.md)
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.chatmessage.role.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatMessage](./foundation-ai.chatmessage.md) &gt; [role](./foundation-ai.chatmessage.role.md)
+
+## ChatMessage.role 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
+role: ChatRole;
+```

package/docs/api/foundation-ai.chatmessage.thinking.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatMessage](./foundation-ai.chatmessage.md) &gt; [thinking](./foundation-ai.chatmessage.thinking.md)
+
+## ChatMessage.thinking 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
+thinking?: boolean;
+```

package/docs/api/foundation-ai.chatmessage.toolcalls.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatMessage](./foundation-ai.chatmessage.md) &gt; [toolCalls](./foundation-ai.chatmessage.toolcalls.md)
+
+## ChatMessage.toolCalls 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
+toolCalls?: ChatToolCall[];
+```

package/docs/api/foundation-ai.chatmessage.toolresult.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatMessage](./foundation-ai.chatmessage.md) &gt; [toolResult](./foundation-ai.chatmessage.toolresult.md)
+
+## ChatMessage.toolResult 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
+toolResult?: ChatToolResult;
+```

package/docs/api/foundation-ai.chatrequestoptions.attachments.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatRequestOptions](./foundation-ai.chatrequestoptions.md) &gt; [attachments](./foundation-ai.chatrequestoptions.attachments.md)
+
+## ChatRequestOptions.attachments 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
+attachments?: ChatAttachment[];
+```

package/docs/api/foundation-ai.chatrequestoptions.md

@@ -0,0 +1,118 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatRequestOptions](./foundation-ai.chatrequestoptions.md)
+
+## ChatRequestOptions 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.
+> 
+
+Options for a chat request.
+
+**Signature:**
+
+```typescript
+export interface ChatRequestOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[attachments?](./foundation-ai.chatrequestoptions.attachments.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ChatAttachment](./foundation-ai.chatattachment.md)<!-- -->\[\]
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[signal?](./foundation-ai.chatrequestoptions.signal.md)
+
+
+</td><td>
+
+
+</td><td>
+
+AbortSignal
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[systemPrompt?](./foundation-ai.chatrequestoptions.systemprompt.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[tools?](./foundation-ai.chatrequestoptions.tools.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ChatToolDefinition](./foundation-ai.chattooldefinition.md)<!-- -->\[\]
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.chatrequestoptions.signal.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatRequestOptions](./foundation-ai.chatrequestoptions.md) &gt; [signal](./foundation-ai.chatrequestoptions.signal.md)
+
+## ChatRequestOptions.signal 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
+signal?: AbortSignal;
+```

package/docs/api/foundation-ai.chatrequestoptions.systemprompt.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatRequestOptions](./foundation-ai.chatrequestoptions.md) &gt; [systemPrompt](./foundation-ai.chatrequestoptions.systemprompt.md)
+
+## ChatRequestOptions.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.
+> 
+
+**Signature:**
+
+```typescript
+systemPrompt?: string;
+```

package/docs/api/foundation-ai.chatrequestoptions.tools.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatRequestOptions](./foundation-ai.chatrequestoptions.md) &gt; [tools](./foundation-ai.chatrequestoptions.tools.md)
+
+## ChatRequestOptions.tools 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
+tools?: ChatToolDefinition[];
+```

package/docs/api/foundation-ai.chatrole.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatRole](./foundation-ai.chatrole.md)
+
+## ChatRole 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.
+> 
+
+Role of a message in a chat conversation.
+
+**Signature:**
+
+```typescript
+export type ChatRole = 'user' | 'assistant' | 'system' | 'tool';
+```

package/docs/api/foundation-ai.chatstreamchunk.delta.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatStreamChunk](./foundation-ai.chatstreamchunk.md) &gt; [delta](./foundation-ai.chatstreamchunk.delta.md)
+
+## ChatStreamChunk.delta 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
+delta: string;
+```

package/docs/api/foundation-ai.chatstreamchunk.done.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatStreamChunk](./foundation-ai.chatstreamchunk.md) &gt; [done](./foundation-ai.chatstreamchunk.done.md)
+
+## ChatStreamChunk.done 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
+done: boolean;
+```