npm - @genesislcap/foundation-ai - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-ai 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (120) hide show

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

@@ -1,53 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,21 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,116 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,83 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- 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.getaiprovider.md DELETED Viewed

@@ -1,35 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [getAIProvider](./foundation-ai.getaiprovider.md)
-## getAIProvider() function
-> 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.
->
-Gets AIProvider from the DI container. When the AI feature flag is disabled (?feature.ai), returns DefaultAIProvider (no-op).
-**Signature:**
-```typescript
-export declare function getAIProvider(): AIProvider;
-```
-**Returns:**
-[AIProvider](./foundation-ai.aiprovider.md)
-## Remarks
-A utility method for host applications that are not using decorators or the DI container.
-## Example
-```ts
-import { getAIProvider } from '@genesislcap/foundation-ai';
-...
-private aiProvider = getAIProvider();
-...
-const result = await this.aiProvider.interpretCriteria?.(input, context);
-```

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

@@ -1,20 +0,0 @@
-<!-- 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.isaifeatureenabled.md DELETED Viewed

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [isAIFeatureEnabled](./foundation-ai.isaifeatureenabled.md)
-## isAIFeatureEnabled() function
-Returns true when AI features (beta) are enabled. Requires ?feature.ai in URL.
-**Signature:**
-```typescript
-isAIFeatureEnabled: () => boolean
-```
-**Returns:**
-boolean

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

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [isSpeechRecognitionAvailable](./foundation-ai.isspeechrecognitionavailable.md)
-## isSpeechRecognitionAvailable() function
-> 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.
->
-Returns true if the Web Speech API is available in the current environment.
-**Signature:**
-```typescript
-export declare function isSpeechRecognitionAvailable(): boolean;
-```
-**Returns:**
-boolean

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

@@ -1,53 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- 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;
-```

package/docs/api/foundation-ai.malformedfunctioncallerror.md DELETED Viewed

@@ -1,98 +0,0 @@
-<!-- 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)
-## MalformedFunctionCallError 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.
->
-Thrown when Gemini returns a `MALFORMED_FUNCTION_CALL` finish reason, typically because the model tried to batch multiple tool calls using Python-style syntax instead of the proper API format.
-**Signature:**
-```typescript
-export declare class MalformedFunctionCallError extends Error
-```
-**Extends:** Error
-## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)(finishMessage)](./foundation-ai.malformedfunctioncallerror._constructor_.md)
-</td><td>
-</td><td>
-**_(BETA)_** Constructs a new instance of the `MalformedFunctionCallError` class
-</td></tr>
-</tbody></table>
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[finishMessage?](./foundation-ai.malformedfunctioncallerror.finishmessage.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-**_(BETA)_** _(Optional)_
-</td></tr>
-</tbody></table>