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

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

@@ -0,0 +1,99 @@
+<!-- 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)
+
+## ChatStreamChunk 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 streaming chunk from a chat response.
+
+**Signature:**
+
+```typescript
+export interface ChatStreamChunk 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[delta](./foundation-ai.chatstreamchunk.delta.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[done](./foundation-ai.chatstreamchunk.done.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[toolCalls?](./foundation-ai.chatstreamchunk.toolcalls.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ChatToolCall](./foundation-ai.chattoolcall.md)<!-- -->\[\]
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.chatstreamchunk.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; [ChatStreamChunk](./foundation-ai.chatstreamchunk.md) &gt; [toolCalls](./foundation-ai.chatstreamchunk.toolcalls.md)
+
+## ChatStreamChunk.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.chattoolcall.args.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; [ChatToolCall](./foundation-ai.chattoolcall.md) &gt; [args](./foundation-ai.chattoolcall.args.md)
+
+## ChatToolCall.args 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
+args: Record<string, unknown>;
+```

package/docs/api/foundation-ai.chattoolcall.id.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; [ChatToolCall](./foundation-ai.chattoolcall.md) &gt; [id](./foundation-ai.chattoolcall.id.md)
+
+## ChatToolCall.id 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
+id: string;
+```

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

@@ -0,0 +1,99 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatToolCall](./foundation-ai.chattoolcall.md)
+
+## ChatToolCall 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 tool call requested by the assistant.
+
+**Signature:**
+
+```typescript
+export interface ChatToolCall 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[args](./foundation-ai.chattoolcall.args.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Record&lt;string, unknown&gt;
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[id](./foundation-ai.chattoolcall.id.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[name](./foundation-ai.chattoolcall.name.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.chattoolcall.name.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; [ChatToolCall](./foundation-ai.chattoolcall.md) &gt; [name](./foundation-ai.chattoolcall.name.md)
+
+## ChatToolCall.name 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
+name: string;
+```

package/docs/api/foundation-ai.chattooldefinition.description.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; [ChatToolDefinition](./foundation-ai.chattooldefinition.md) &gt; [description](./foundation-ai.chattooldefinition.description.md)
+
+## ChatToolDefinition.description 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
+description: string;
+```

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

@@ -0,0 +1,99 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatToolDefinition](./foundation-ai.chattooldefinition.md)
+
+## ChatToolDefinition 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.
+> 
+
+JSON Schema-based tool definition for function calling.
+
+**Signature:**
+
+```typescript
+export interface ChatToolDefinition 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[description](./foundation-ai.chattooldefinition.description.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[name](./foundation-ai.chattooldefinition.name.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[parameters](./foundation-ai.chattooldefinition.parameters.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Record&lt;string, unknown&gt;
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.chattooldefinition.name.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; [ChatToolDefinition](./foundation-ai.chattooldefinition.md) &gt; [name](./foundation-ai.chattooldefinition.name.md)
+
+## ChatToolDefinition.name 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
+name: string;
+```

package/docs/api/foundation-ai.chattooldefinition.parameters.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; [ChatToolDefinition](./foundation-ai.chattooldefinition.md) &gt; [parameters](./foundation-ai.chattooldefinition.parameters.md)
+
+## ChatToolDefinition.parameters 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
+parameters: Record<string, unknown>;
+```

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatToolHandlers](./foundation-ai.chattoolhandlers.md)
+
+## ChatToolHandlers 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.
+> 
+
+Map of tool name to async handler function.
+
+**Signature:**
+
+```typescript
+export type ChatToolHandlers = Record<string, (args: Record<string, unknown>, context: {
+    requestInteraction: <T = unknown>(componentName: string, data: any) => Promise<T>;
+}) => Promise<unknown>>;
+```

package/docs/api/foundation-ai.chattoolresult.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; [ChatToolResult](./foundation-ai.chattoolresult.md) &gt; [content](./foundation-ai.chattoolresult.content.md)
+
+## ChatToolResult.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.chattoolresult.md

@@ -0,0 +1,80 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatToolResult](./foundation-ai.chattoolresult.md)
+
+## ChatToolResult 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.
+> 
+
+The result of executing a tool call.
+
+**Signature:**
+
+```typescript
+export interface ChatToolResult 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[content](./foundation-ai.chattoolresult.content.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[toolCallId](./foundation-ai.chattoolresult.toolcallid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.chattoolresult.toolcallid.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; [ChatToolResult](./foundation-ai.chattoolresult.md) &gt; [toolCallId](./foundation-ai.chattoolresult.toolcallid.md)
+
+## ChatToolResult.toolCallId 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
+toolCallId: string;
+```

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

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatTransport](./foundation-ai.chattransport.md)
+
+## ChatTransport 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.
+> 
+
+Transport interface for chat-capable AI providers.
+
+**Signature:**
+
+```typescript
+export interface ChatTransport 
+```
+
+## Remarks
+
+Implement alongside `AITransport` for providers that support multi-turn chat conversations (e.g. Gemini, OpenAI). The `streamChatMessage` method is optional — providers that don't support streaming may omit it.
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[sendChatMessage(history, userMessage, options)](./foundation-ai.chattransport.sendchatmessage.md)
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[streamChatMessage(history, userMessage, options)?](./foundation-ai.chattransport.streamchatmessage.md)
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.chattransport.sendchatmessage.md

@@ -0,0 +1,83 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatTransport](./foundation-ai.chattransport.md) &gt; [sendChatMessage](./foundation-ai.chattransport.sendchatmessage.md)
+
+## ChatTransport.sendChatMessage() method
+
+> 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
+sendChatMessage(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): Promise<ChatMessage>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+history
+
+
+</td><td>
+
+[ChatMessage](./foundation-ai.chatmessage.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+userMessage
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[ChatRequestOptions](./foundation-ai.chatrequestoptions.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[ChatMessage](./foundation-ai.chatmessage.md)<!-- -->&gt;
+