@genesislcap/foundation-ai 14.408.0 → 14.409.0

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

@@ -1,61 +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; [CriteriaInterpretContext](./foundation-ai.criteriainterpretcontext.md)
-
-## CriteriaInterpretContext 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.
-> 
-
-Context passed to criteria interpretation, providing available field metadata.
-
-**Signature:**
-
-```typescript
-export interface CriteriaInterpretContext 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[fields?](./foundation-ai.criteriainterpretcontext.fields.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[FieldLike](./foundation-ai.fieldlike.md)<!-- -->\[\]
-
-
-</td><td>
-
-**_(BETA)_** _(Optional)_
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -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; [FieldLike](./foundation-ai.fieldlike.md)
-
-## FieldLike 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.
-> 
-
-A field descriptor accepted by criteria interpretation utilities. Can be a plain string name or an object with common field metadata properties.
-
-**Signature:**
-
-```typescript
-export type FieldLike = string | {
-    name?: string;
-    field?: string;
-    label?: string;
-    NAME?: string;
-};
-```

package/docs/api/foundation-ai.geminiaiconfig.apikey.md

@@ -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; [GeminiAIConfig](./foundation-ai.geminiaiconfig.md) &gt; [apiKey](./foundation-ai.geminiaiconfig.apikey.md)
-
-## GeminiAIConfig.apiKey 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
-apiKey?: string;
-```

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

@@ -1,123 +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; [GeminiAIConfig](./foundation-ai.geminiaiconfig.md)
-
-## GeminiAIConfig 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.
-> 
-
-Gemini server-proxy AI configuration (client calls your server; server calls Gemini).
-
-**Signature:**
-
-```typescript
-export interface GeminiAIConfig extends AIProviderConfig 
-```
-**Extends:** AIProviderConfig
-
-## Remarks
-
-API key stays on the server. URL defaults to /gwf/ai-service/gemini/chat.
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[apiKey?](./foundation-ai.geminiaiconfig.apikey.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_** _(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[model?](./foundation-ai.geminiaiconfig.model.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_** _(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-[providerType](./foundation-ai.geminiaiconfig.providertype.md)
-
-
-</td><td>
-
-
-</td><td>
-
-'gemini'
-
-
-</td><td>
-
-**_(BETA)_**
-
-
-</td></tr>
-<tr><td>
-
-[serverEndpoint?](./foundation-ai.geminiaiconfig.serverendpoint.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(BETA)_** _(Optional)_
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-ai.geminiaiconfig.model.md

@@ -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; [GeminiAIConfig](./foundation-ai.geminiaiconfig.md) &gt; [model](./foundation-ai.geminiaiconfig.model.md)
-
-## GeminiAIConfig.model 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
-model?: string;
-```

package/docs/api/foundation-ai.geminiaiconfig.providertype.md

@@ -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; [GeminiAIConfig](./foundation-ai.geminiaiconfig.md) &gt; [providerType](./foundation-ai.geminiaiconfig.providertype.md)
-
-## GeminiAIConfig.providerType 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
-providerType: 'gemini';
-```

package/docs/api/foundation-ai.geminiaiconfig.serverendpoint.md

@@ -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; [GeminiAIConfig](./foundation-ai.geminiaiconfig.md) &gt; [serverEndpoint](./foundation-ai.geminiaiconfig.serverendpoint.md)
-
-## GeminiAIConfig.serverEndpoint 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
-serverEndpoint?: string;
-```

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

@@ -1,65 +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; [GeminiProvider](./foundation-ai.geminiprovider.md) &gt; [(constructor)](./foundation-ai.geminiprovider._constructor_.md)
-
-## GeminiProvider.(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 `GeminiProvider` class
-
-**Signature:**
-
-```typescript
-constructor(config: GeminiProviderConfig, transport: GeminiTransport);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-config
-
-
-</td><td>
-
-GeminiProviderConfig
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-transport
-
-
-</td><td>
-
-[GeminiTransport](./foundation-ai.geminitransport.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -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; [GeminiProvider](./foundation-ai.geminiprovider.md) &gt; [chat](./foundation-ai.geminiprovider.chat.md)
-
-## GeminiProvider.chat() 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
-chat(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.geminiprovider.getstatus.md

@@ -1,18 +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; [GeminiProvider](./foundation-ai.geminiprovider.md) &gt; [getStatus](./foundation-ai.geminiprovider.getstatus.md)
-
-## GeminiProvider.getStatus() 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
-getStatus(): Promise<AIStatus>;
-```
-**Returns:**
-
-Promise&lt;[AIStatus](./foundation-ai.aistatus.md)<!-- -->&gt;
-

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

@@ -1,67 +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; [GeminiProvider](./foundation-ai.geminiprovider.md) &gt; [interpretCriteria](./foundation-ai.geminiprovider.interpretcriteria.md)
-
-## GeminiProvider.interpretCriteria() 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
-interpretCriteria(input: string, context: CriteriaInterpretContext): Promise<CriteriaInterpretationResult | null>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-input
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-context
-
-
-</td><td>
-
-[CriteriaInterpretContext](./foundation-ai.criteriainterpretcontext.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;[CriteriaInterpretationResult](./foundation-ai.criteriainterpretationresult.md) \| null&gt;
-

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

@@ -1,128 +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; [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

@@ -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; [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;
-