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

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

@@ -0,0 +1,128 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [GeminiProvider](./foundation-ai.geminiprovider.md)
+
+## GeminiProvider 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.
+> 
+
+Gemini AI provider. Uses [GeminiTransport](./foundation-ai.geminitransport.md) to handle requests. Implements criteria interpretation and multi-turn chat.
+
+**Signature:**
+
+```typescript
+export declare class GeminiProvider implements AIProvider 
+```
+**Implements:** [AIProvider](./foundation-ai.aiprovider.md)
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(config, transport)](./foundation-ai.geminiprovider._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Constructs a new instance of the `GeminiProvider` class
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[chat(history, userMessage, options)](./foundation-ai.geminiprovider.chat.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[getStatus()](./foundation-ai.geminiprovider.getstatus.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[interpretCriteria(input, context)](./foundation-ai.geminiprovider.interpretcriteria.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[streamChat(history, userMessage, options)](./foundation-ai.geminiprovider.streamchat.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.geminiprovider.streamchat.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; [GeminiProvider](./foundation-ai.geminiprovider.md) &gt; [streamChat](./foundation-ai.geminiprovider.streamchat.md)
+
+## GeminiProvider.streamChat() 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
+streamChat(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): AsyncIterable<ChatStreamChunk>;
+```
+
+## 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:**
+
+AsyncIterable&lt;[ChatStreamChunk](./foundation-ai.chatstreamchunk.md)<!-- -->&gt;
+

package/docs/api/foundation-ai.geminitransport._constructor_.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [GeminiTransport](./foundation-ai.geminitransport.md) &gt; [(constructor)](./foundation-ai.geminitransport._constructor_.md)
+
+## GeminiTransport.(constructor)
+
+> 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.
+> 
+
+Constructs a new instance of the `GeminiTransport` class
+
+**Signature:**
+
+```typescript
+constructor(config?: GeminiTransportConfig);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+config
+
+
+</td><td>
+
+GeminiTransportConfig
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.geminitransport.getconfig.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [GeminiTransport](./foundation-ai.geminitransport.md) &gt; [getConfig](./foundation-ai.geminitransport.getconfig.md)
+
+## GeminiTransport.getConfig() 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
+getConfig(): {
+        provider: 'gemini';
+        model: string;
+    };
+```
+**Returns:**
+
+{ provider: 'gemini'; model: string; }
+

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

@@ -0,0 +1,116 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [GeminiTransport](./foundation-ai.geminitransport.md)
+
+## GeminiTransport 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.
+> 
+
+Transport for Gemini. Calls the Gemini REST API directly when `apiKey` is provided, otherwise falls back to a server-proxy endpoint (if `serverEndpoint` is configured).
+
+Implements `AITransport` (structured prompt) and `ChatTransport` (multi-turn chat).
+
+**Signature:**
+
+```typescript
+export declare class GeminiTransport implements AITransport, ChatTransport 
+```
+**Implements:** AITransport, [ChatTransport](./foundation-ai.chattransport.md)
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(config)](./foundation-ai.geminitransport._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_** Constructs a new instance of the `GeminiTransport` class
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getConfig()](./foundation-ai.geminitransport.getconfig.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[sendChatMessage(history, userMessage, options)](./foundation-ai.geminitransport.sendchatmessage.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+<tr><td>
+
+[sendStructuredPrompt(options)](./foundation-ai.geminitransport.sendstructuredprompt.md)
+
+
+</td><td>
+
+
+</td><td>
+
+**_(BETA)_**
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.geminitransport.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; [GeminiTransport](./foundation-ai.geminitransport.md) &gt; [sendChatMessage](./foundation-ai.geminitransport.sendchatmessage.md)
+
+## GeminiTransport.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;
+

package/docs/api/foundation-ai.geminitransport.sendstructuredprompt.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [GeminiTransport](./foundation-ai.geminitransport.md) &gt; [sendStructuredPrompt](./foundation-ai.geminitransport.sendstructuredprompt.md)
+
+## GeminiTransport.sendStructuredPrompt() 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
+sendStructuredPrompt(options: StructuredPromptOptions): Promise<string>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+StructuredPromptOptions
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;string&gt;
+

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

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [InteractionResult](./foundation-ai.interactionresult.md)
+
+## InteractionResult 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.
+> 
+
+The result of a user interaction component.
+
+**Signature:**
+
+```typescript
+export type InteractionResult<T = unknown> = {
+    status: 'approved' | 'rejected';
+    payload?: T;
+    message?: string;
+};
+```

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

@@ -7,7 +7,7 @@
 > 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.
 > 
 
-Speech-to-text using Web Speech API. Gracefully degrades when SpeechRecognition is unavailable.
+Returns true if the Web Speech API is available in the current environment.
 
 **Signature:**
 

package/docs/api/foundation-ai.malformedfunctioncallerror._constructor_.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [MalformedFunctionCallError](./foundation-ai.malformedfunctioncallerror.md) &gt; [(constructor)](./foundation-ai.malformedfunctioncallerror._constructor_.md)
+
+## MalformedFunctionCallError.(constructor)
+
+> 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.
+> 
+
+Constructs a new instance of the `MalformedFunctionCallError` class
+
+**Signature:**
+
+```typescript
+constructor(finishMessage?: string);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+finishMessage
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-ai.malformedfunctioncallerror.finishmessage.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; [MalformedFunctionCallError](./foundation-ai.malformedfunctioncallerror.md) &gt; [finishMessage](./foundation-ai.malformedfunctioncallerror.finishmessage.md)
+
+## MalformedFunctionCallError.finishMessage 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
+readonly finishMessage?: string;
+```