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

package/docs/api/foundation-ai.chattransport.streamchatmessage.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; [streamChatMessage](./foundation-ai.chattransport.streamchatmessage.md)
+
+## ChatTransport.streamChatMessage() 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
+streamChatMessage?(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.criteriagroupresult.clauses.md

@@ -4,6 +4,9 @@
 
 ## CriteriaGroupResult.clauses 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

package/docs/api/foundation-ai.criteriagroupresult.logic.md

@@ -4,6 +4,9 @@
 
 ## CriteriaGroupResult.logic 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

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

@@ -4,6 +4,11 @@
 
 ## CriteriaGroupResult 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 group of criteria clauses combined by a logical operator.
+
 **Signature:**
 
 ```typescript
@@ -48,6 +53,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -65,6 +72,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 <tr><td>
@@ -82,7 +91,7 @@ boolean
 
 </td><td>
 
-_(Optional)_
+**_(BETA)_** _(Optional)_
 
 
 </td></tr>

package/docs/api/foundation-ai.criteriagroupresult.negated.md

@@ -4,6 +4,9 @@
 
 ## CriteriaGroupResult.negated 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

package/docs/api/foundation-ai.criteriainterpretationresult.groups.md

@@ -4,6 +4,9 @@
 
 ## CriteriaInterpretationResult.groups 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

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

@@ -4,6 +4,11 @@
 
 ## CriteriaInterpretationResult 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.
+> 
+
+Top-level result returned by criteria interpretation.
+
 **Signature:**
 
 ```typescript
@@ -48,6 +53,8 @@ Description
 
 </td><td>
 
+**_(BETA)_**
+
 
 </td></tr>
 </tbody></table>

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

@@ -4,6 +4,9 @@
 
 ## CriteriaInterpretContext.fields 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

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

@@ -4,6 +4,11 @@
 
 ## 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
@@ -48,7 +53,7 @@ Description
 
 </td><td>
 
-_(Optional)_
+**_(BETA)_** _(Optional)_
 
 
 </td></tr>

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

@@ -4,6 +4,11 @@
 
 ## 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

package/docs/api/foundation-ai.geminiaiconfig.apikey.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; [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

@@ -0,0 +1,123 @@
+<!-- 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

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

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

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

@@ -0,0 +1,65 @@
+<!-- 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

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

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

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