@genesislcap/foundation-ai 14.408.0 → 14.409.0-FUI-2495.1
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.
- package/README.md +7 -1
- package/dist/dts/utils/feature-flags.d.ts +2 -2
- package/dist/dts/utils/feature-flags.d.ts.map +1 -1
- package/dist/esm/utils/feature-flags.js +10 -3
- package/dist/foundation-ai.api.json +2 -2
- package/dist/foundation-ai.d.ts +2 -2
- package/package.json +11 -11
- package/docs/api/foundation-ai.ai_feature_flag.md +0 -13
- package/docs/api/foundation-ai.aiconfig.md +0 -18
- package/docs/api/foundation-ai.aiprovider.chat.md +0 -85
- package/docs/api/foundation-ai.aiprovider.getstatus.md +0 -20
- package/docs/api/foundation-ai.aiprovider.interpretcriteria.md +0 -67
- package/docs/api/foundation-ai.aiprovider.md +0 -91
- package/docs/api/foundation-ai.aiprovider.streamchat.md +0 -85
- package/docs/api/foundation-ai.aiprovider.triggerdownload.md +0 -20
- package/docs/api/foundation-ai.aiprovidertype.md +0 -16
- package/docs/api/foundation-ai.aistatus.chromeavailability.md +0 -14
- package/docs/api/foundation-ai.aistatus.md +0 -99
- package/docs/api/foundation-ai.aistatus.model.md +0 -14
- package/docs/api/foundation-ai.aistatus.provider.md +0 -14
- package/docs/api/foundation-ai.chatanimationsconfig.enabled.md +0 -16
- package/docs/api/foundation-ai.chatanimationsconfig.md +0 -80
- package/docs/api/foundation-ai.chatanimationsconfig.userconfigurable.md +0 -16
- package/docs/api/foundation-ai.chatattachment.content.md +0 -14
- package/docs/api/foundation-ai.chatattachment.md +0 -99
- package/docs/api/foundation-ai.chatattachment.mimetype.md +0 -14
- package/docs/api/foundation-ai.chatattachment.name.md +0 -14
- package/docs/api/foundation-ai.chatconfig.acceptedfiles.md +0 -16
- package/docs/api/foundation-ai.chatconfig.allowdebugdownload.md +0 -16
- package/docs/api/foundation-ai.chatconfig.animations.md +0 -16
- package/docs/api/foundation-ai.chatconfig.loadingdelay.md +0 -16
- package/docs/api/foundation-ai.chatconfig.maxtooliterations.md +0 -16
- package/docs/api/foundation-ai.chatconfig.md +0 -177
- package/docs/api/foundation-ai.chatconfig.showthinkingsteps.md +0 -16
- package/docs/api/foundation-ai.chatconfig.showtoolcalls.md +0 -16
- package/docs/api/foundation-ai.chatinteraction.componentname.md +0 -14
- package/docs/api/foundation-ai.chatinteraction.data.md +0 -14
- package/docs/api/foundation-ai.chatinteraction.interactionid.md +0 -14
- package/docs/api/foundation-ai.chatinteraction.md +0 -118
- package/docs/api/foundation-ai.chatinteraction.resolved.md +0 -16
- package/docs/api/foundation-ai.chatmessage.attachments.md +0 -14
- package/docs/api/foundation-ai.chatmessage.content.md +0 -14
- package/docs/api/foundation-ai.chatmessage.interaction.md +0 -14
- package/docs/api/foundation-ai.chatmessage.md +0 -175
- package/docs/api/foundation-ai.chatmessage.role.md +0 -14
- package/docs/api/foundation-ai.chatmessage.thinking.md +0 -14
- package/docs/api/foundation-ai.chatmessage.toolcalls.md +0 -14
- package/docs/api/foundation-ai.chatmessage.toolresult.md +0 -14
- package/docs/api/foundation-ai.chatrequestoptions.attachments.md +0 -14
- package/docs/api/foundation-ai.chatrequestoptions.md +0 -118
- package/docs/api/foundation-ai.chatrequestoptions.signal.md +0 -14
- package/docs/api/foundation-ai.chatrequestoptions.systemprompt.md +0 -14
- package/docs/api/foundation-ai.chatrequestoptions.tools.md +0 -14
- package/docs/api/foundation-ai.chatrole.md +0 -16
- package/docs/api/foundation-ai.chatstreamchunk.delta.md +0 -14
- package/docs/api/foundation-ai.chatstreamchunk.done.md +0 -14
- package/docs/api/foundation-ai.chatstreamchunk.md +0 -99
- package/docs/api/foundation-ai.chatstreamchunk.toolcalls.md +0 -14
- package/docs/api/foundation-ai.chattoolcall.args.md +0 -14
- package/docs/api/foundation-ai.chattoolcall.id.md +0 -14
- package/docs/api/foundation-ai.chattoolcall.md +0 -99
- package/docs/api/foundation-ai.chattoolcall.name.md +0 -14
- package/docs/api/foundation-ai.chattooldefinition.description.md +0 -14
- package/docs/api/foundation-ai.chattooldefinition.md +0 -99
- package/docs/api/foundation-ai.chattooldefinition.name.md +0 -14
- package/docs/api/foundation-ai.chattooldefinition.parameters.md +0 -14
- package/docs/api/foundation-ai.chattoolhandlers.md +0 -18
- package/docs/api/foundation-ai.chattoolresult.content.md +0 -14
- package/docs/api/foundation-ai.chattoolresult.md +0 -80
- package/docs/api/foundation-ai.chattoolresult.toolcallid.md +0 -14
- package/docs/api/foundation-ai.chattransport.md +0 -58
- package/docs/api/foundation-ai.chattransport.sendchatmessage.md +0 -83
- package/docs/api/foundation-ai.chattransport.streamchatmessage.md +0 -83
- package/docs/api/foundation-ai.chromeaiconfig.md +0 -104
- package/docs/api/foundation-ai.chromeaiconfig.providertype.md +0 -14
- package/docs/api/foundation-ai.chromeaiconfig.temperature.md +0 -14
- package/docs/api/foundation-ai.chromeaiconfig.topk.md +0 -14
- package/docs/api/foundation-ai.chromeavailability.md +0 -16
- package/docs/api/foundation-ai.createaiprovider.md +0 -57
- package/docs/api/foundation-ai.criteriaclauseresult.field.md +0 -14
- package/docs/api/foundation-ai.criteriaclauseresult.md +0 -99
- package/docs/api/foundation-ai.criteriaclauseresult.operator.md +0 -14
- package/docs/api/foundation-ai.criteriaclauseresult.value.md +0 -14
- package/docs/api/foundation-ai.criteriagroupresult.clauses.md +0 -14
- package/docs/api/foundation-ai.criteriagroupresult.logic.md +0 -14
- package/docs/api/foundation-ai.criteriagroupresult.md +0 -99
- package/docs/api/foundation-ai.criteriagroupresult.negated.md +0 -14
- package/docs/api/foundation-ai.criteriainterpretationresult.groups.md +0 -14
- package/docs/api/foundation-ai.criteriainterpretationresult.md +0 -61
- package/docs/api/foundation-ai.criteriainterpretcontext.fields.md +0 -14
- package/docs/api/foundation-ai.criteriainterpretcontext.md +0 -61
- package/docs/api/foundation-ai.fieldlike.md +0 -21
- package/docs/api/foundation-ai.geminiaiconfig.apikey.md +0 -14
- package/docs/api/foundation-ai.geminiaiconfig.md +0 -123
- package/docs/api/foundation-ai.geminiaiconfig.model.md +0 -14
- package/docs/api/foundation-ai.geminiaiconfig.providertype.md +0 -14
- package/docs/api/foundation-ai.geminiaiconfig.serverendpoint.md +0 -14
- package/docs/api/foundation-ai.geminiprovider._constructor_.md +0 -65
- package/docs/api/foundation-ai.geminiprovider.chat.md +0 -83
- package/docs/api/foundation-ai.geminiprovider.getstatus.md +0 -18
- package/docs/api/foundation-ai.geminiprovider.interpretcriteria.md +0 -67
- package/docs/api/foundation-ai.geminiprovider.md +0 -128
- package/docs/api/foundation-ai.geminiprovider.streamchat.md +0 -83
- package/docs/api/foundation-ai.geminitransport._constructor_.md +0 -53
- package/docs/api/foundation-ai.geminitransport.getconfig.md +0 -21
- package/docs/api/foundation-ai.geminitransport.md +0 -116
- package/docs/api/foundation-ai.geminitransport.sendchatmessage.md +0 -83
- package/docs/api/foundation-ai.geminitransport.sendstructuredprompt.md +0 -53
- package/docs/api/foundation-ai.getaiprovider.md +0 -35
- package/docs/api/foundation-ai.interactionresult.md +0 -20
- package/docs/api/foundation-ai.isaifeatureenabled.md +0 -17
- package/docs/api/foundation-ai.isspeechrecognitionavailable.md +0 -20
- package/docs/api/foundation-ai.malformedfunctioncallerror._constructor_.md +0 -53
- package/docs/api/foundation-ai.malformedfunctioncallerror.finishmessage.md +0 -14
- package/docs/api/foundation-ai.malformedfunctioncallerror.md +0 -98
- package/docs/api/foundation-ai.md +0 -503
- package/docs/api/foundation-ai.resolveaiconfig.md +0 -57
- package/docs/api/foundation-ai.resolveaiconfigoptions.md +0 -99
- package/docs/api/foundation-ai.resolveaiconfigoptions.model.md +0 -16
- package/docs/api/foundation-ai.resolveaiconfigoptions.preferchrome.md +0 -16
- package/docs/api/foundation-ai.resolveaiconfigoptions.provider.md +0 -16
- package/docs/api/foundation-ai.serveraiconfig.md +0 -66
- package/docs/api/foundation-ai.serveraiconfig.provider.md +0 -14
- package/docs/api/foundation-ai.startspeechrecognition.md +0 -71
- package/docs/api/index.md +0 -30
- package/docs/api-report.md.api.md +0 -317
package/README.md
CHANGED
|
@@ -21,12 +21,18 @@ Each provider exposes capabilities such as `interpretCriteria` (natural language
|
|
|
21
21
|
|
|
22
22
|
## Feature flag
|
|
23
23
|
|
|
24
|
-
AI features are **disabled by default
|
|
24
|
+
AI features are **disabled by default**. Enable them via URL parameter or environment variable:
|
|
25
25
|
|
|
26
|
+
**URL parameter** — append `?feature.ai` to any URL (useful for testing without rebuilding):
|
|
26
27
|
```
|
|
27
28
|
https://your-app.com/?feature.ai
|
|
28
29
|
```
|
|
29
30
|
|
|
31
|
+
**Environment variable** — set `GENX_ENABLE_AI=true` in your app's `.env` file to enable permanently without a URL parameter:
|
|
32
|
+
```
|
|
33
|
+
GENX_ENABLE_AI=true
|
|
34
|
+
```
|
|
35
|
+
|
|
30
36
|
When the flag is off:
|
|
31
37
|
|
|
32
38
|
- `createAIProvider()` and `getAIProvider()` return a no-op provider
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
/** Feature flag name for AI functionality (beta). Enable via ?feature.ai in URL. */
|
|
1
|
+
/** Feature flag name for AI functionality (beta). Enable via ?feature.ai in URL or GENX_ENABLE_AI env var. */
|
|
2
2
|
export declare const AI_FEATURE_FLAG = "ai";
|
|
3
|
-
/** Returns true when AI features (beta) are enabled
|
|
3
|
+
/** Returns true when AI features (beta) are enabled via ?feature.ai URL param or GENX_ENABLE_AI=true env var. */
|
|
4
4
|
export declare const isAIFeatureEnabled: () => boolean;
|
|
5
5
|
//# sourceMappingURL=feature-flags.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"feature-flags.d.ts","sourceRoot":"","sources":["../../../src/utils/feature-flags.ts"],"names":[],"mappings":"AAEA,
|
|
1
|
+
{"version":3,"file":"feature-flags.d.ts","sourceRoot":"","sources":["../../../src/utils/feature-flags.ts"],"names":[],"mappings":"AAEA,8GAA8G;AAC9G,eAAO,MAAM,eAAe,OAAO,CAAC;AAUpC,iHAAiH;AACjH,eAAO,MAAM,kBAAkB,QAAO,OAA6D,CAAC"}
|
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
import { isFeatureActivated } from '@genesislcap/foundation-utils';
|
|
2
|
-
/** Feature flag name for AI functionality (beta). Enable via ?feature.ai in URL. */
|
|
2
|
+
/** Feature flag name for AI functionality (beta). Enable via ?feature.ai in URL or GENX_ENABLE_AI env var. */
|
|
3
3
|
export const AI_FEATURE_FLAG = 'ai';
|
|
4
|
-
|
|
5
|
-
|
|
4
|
+
let _envEnabled = false;
|
|
5
|
+
try {
|
|
6
|
+
if (typeof GENX_ENABLE_AI !== 'undefined') {
|
|
7
|
+
_envEnabled = GENX_ENABLE_AI === 'true';
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
catch (_a) { }
|
|
11
|
+
/** Returns true when AI features (beta) are enabled via ?feature.ai URL param or GENX_ENABLE_AI=true env var. */
|
|
12
|
+
export const isAIFeatureEnabled = () => _envEnabled || isFeatureActivated(AI_FEATURE_FLAG);
|
|
@@ -175,7 +175,7 @@
|
|
|
175
175
|
{
|
|
176
176
|
"kind": "Variable",
|
|
177
177
|
"canonicalReference": "@genesislcap/foundation-ai!AI_FEATURE_FLAG:var",
|
|
178
|
-
"docComment": "/**\n * Feature flag name for AI functionality (beta). Enable via ?feature.ai in URL.\n */\n",
|
|
178
|
+
"docComment": "/**\n * Feature flag name for AI functionality (beta). Enable via ?feature.ai in URL or GENX_ENABLE_AI env var.\n */\n",
|
|
179
179
|
"excerptTokens": [
|
|
180
180
|
{
|
|
181
181
|
"kind": "Content",
|
|
@@ -3685,7 +3685,7 @@
|
|
|
3685
3685
|
{
|
|
3686
3686
|
"kind": "Function",
|
|
3687
3687
|
"canonicalReference": "@genesislcap/foundation-ai!isAIFeatureEnabled:function(1)",
|
|
3688
|
-
"docComment": "/**\n * Returns true when AI features (beta) are enabled
|
|
3688
|
+
"docComment": "/**\n * Returns true when AI features (beta) are enabled via ?feature.ai URL param or GENX_ENABLE_AI=true env var.\n */\n",
|
|
3689
3689
|
"excerptTokens": [
|
|
3690
3690
|
{
|
|
3691
3691
|
"kind": "Content",
|
package/dist/foundation-ai.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
|
2
2
|
|
|
3
|
-
/** Feature flag name for AI functionality (beta). Enable via ?feature.ai in URL. */
|
|
3
|
+
/** Feature flag name for AI functionality (beta). Enable via ?feature.ai in URL or GENX_ENABLE_AI env var. */
|
|
4
4
|
export declare const AI_FEATURE_FLAG = "ai";
|
|
5
5
|
|
|
6
6
|
/**
|
|
@@ -479,7 +479,7 @@ export declare type InteractionResult<T = unknown> = {
|
|
|
479
479
|
message?: string;
|
|
480
480
|
};
|
|
481
481
|
|
|
482
|
-
/** Returns true when AI features (beta) are enabled
|
|
482
|
+
/** Returns true when AI features (beta) are enabled via ?feature.ai URL param or GENX_ENABLE_AI=true env var. */
|
|
483
483
|
export declare const isAIFeatureEnabled: () => boolean;
|
|
484
484
|
|
|
485
485
|
/**
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-ai",
|
|
3
3
|
"description": "Genesis Foundation AI - Provider-agnostic AI configuration and shared utilities",
|
|
4
|
-
"version": "14.
|
|
4
|
+
"version": "14.409.0-FUI-2495.1",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
|
7
7
|
"main": "dist/esm/index.js",
|
|
@@ -51,17 +51,17 @@
|
|
|
51
51
|
}
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
|
-
"@genesislcap/foundation-testing": "14.
|
|
55
|
-
"@genesislcap/genx": "14.
|
|
56
|
-
"@genesislcap/rollup-builder": "14.
|
|
57
|
-
"@genesislcap/ts-builder": "14.
|
|
58
|
-
"@genesislcap/uvu-playwright-builder": "14.
|
|
59
|
-
"@genesislcap/vite-builder": "14.
|
|
60
|
-
"@genesislcap/webpack-builder": "14.
|
|
54
|
+
"@genesislcap/foundation-testing": "14.409.0-FUI-2495.1",
|
|
55
|
+
"@genesislcap/genx": "14.409.0-FUI-2495.1",
|
|
56
|
+
"@genesislcap/rollup-builder": "14.409.0-FUI-2495.1",
|
|
57
|
+
"@genesislcap/ts-builder": "14.409.0-FUI-2495.1",
|
|
58
|
+
"@genesislcap/uvu-playwright-builder": "14.409.0-FUI-2495.1",
|
|
59
|
+
"@genesislcap/vite-builder": "14.409.0-FUI-2495.1",
|
|
60
|
+
"@genesislcap/webpack-builder": "14.409.0-FUI-2495.1"
|
|
61
61
|
},
|
|
62
62
|
"dependencies": {
|
|
63
|
-
"@genesislcap/foundation-logger": "14.
|
|
64
|
-
"@genesislcap/foundation-utils": "14.
|
|
63
|
+
"@genesislcap/foundation-logger": "14.409.0-FUI-2495.1",
|
|
64
|
+
"@genesislcap/foundation-utils": "14.409.0-FUI-2495.1",
|
|
65
65
|
"@microsoft/fast-foundation": "2.50.0"
|
|
66
66
|
},
|
|
67
67
|
"repository": {
|
|
@@ -72,5 +72,5 @@
|
|
|
72
72
|
"publishConfig": {
|
|
73
73
|
"access": "public"
|
|
74
74
|
},
|
|
75
|
-
"gitHead": "
|
|
75
|
+
"gitHead": "1587391f8f98599f221c4fe75b20868382f73144"
|
|
76
76
|
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AI\_FEATURE\_FLAG](./foundation-ai.ai_feature_flag.md)
|
|
4
|
-
|
|
5
|
-
## AI\_FEATURE\_FLAG variable
|
|
6
|
-
|
|
7
|
-
Feature flag name for AI functionality (beta). Enable via ?feature.ai in URL.
|
|
8
|
-
|
|
9
|
-
**Signature:**
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
AI_FEATURE_FLAG = "ai"
|
|
13
|
-
```
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AIConfig](./foundation-ai.aiconfig.md)
|
|
4
|
-
|
|
5
|
-
## AIConfig type
|
|
6
|
-
|
|
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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
Union type for provider-specific configs. Extend when adding new providers.
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
export type AIConfig = ServerAIConfig | ChromeAIConfig | GeminiAIConfig;
|
|
16
|
-
```
|
|
17
|
-
**References:** [ServerAIConfig](./foundation-ai.serveraiconfig.md)<!-- -->, [ChromeAIConfig](./foundation-ai.chromeaiconfig.md)<!-- -->, [GeminiAIConfig](./foundation-ai.geminiaiconfig.md)
|
|
18
|
-
|
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AIProvider](./foundation-ai.aiprovider.md) > [chat](./foundation-ai.aiprovider.chat.md)
|
|
4
|
-
|
|
5
|
-
## AIProvider.chat() method
|
|
6
|
-
|
|
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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
Multi-turn chat (non-streaming). Returns the assistant's response message. Providers that support chat (Gemini, OpenAI) implement this.
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
chat?(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): Promise<ChatMessage>;
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## Parameters
|
|
19
|
-
|
|
20
|
-
<table><thead><tr><th>
|
|
21
|
-
|
|
22
|
-
Parameter
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
</th><th>
|
|
26
|
-
|
|
27
|
-
Type
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
</th><th>
|
|
31
|
-
|
|
32
|
-
Description
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
</th></tr></thead>
|
|
36
|
-
<tbody><tr><td>
|
|
37
|
-
|
|
38
|
-
history
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
</td><td>
|
|
42
|
-
|
|
43
|
-
[ChatMessage](./foundation-ai.chatmessage.md)<!-- -->\[\]
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
</td><td>
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
</td></tr>
|
|
50
|
-
<tr><td>
|
|
51
|
-
|
|
52
|
-
userMessage
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
</td><td>
|
|
56
|
-
|
|
57
|
-
string
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
</td><td>
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
</td></tr>
|
|
64
|
-
<tr><td>
|
|
65
|
-
|
|
66
|
-
options
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
</td><td>
|
|
70
|
-
|
|
71
|
-
[ChatRequestOptions](./foundation-ai.chatrequestoptions.md)
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
</td><td>
|
|
75
|
-
|
|
76
|
-
_(Optional)_
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
</td></tr>
|
|
80
|
-
</tbody></table>
|
|
81
|
-
|
|
82
|
-
**Returns:**
|
|
83
|
-
|
|
84
|
-
Promise<[ChatMessage](./foundation-ai.chatmessage.md)<!-- -->>
|
|
85
|
-
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AIProvider](./foundation-ai.aiprovider.md) > [getStatus](./foundation-ai.aiprovider.getstatus.md)
|
|
4
|
-
|
|
5
|
-
## AIProvider.getStatus() method
|
|
6
|
-
|
|
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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
Returns current AI status for display (provider, model, Chrome availability).
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
getStatus?(): Promise<AIStatus | null>;
|
|
16
|
-
```
|
|
17
|
-
**Returns:**
|
|
18
|
-
|
|
19
|
-
Promise<[AIStatus](./foundation-ai.aistatus.md) \| null>
|
|
20
|
-
|
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AIProvider](./foundation-ai.aiprovider.md) > [interpretCriteria](./foundation-ai.aiprovider.interpretcriteria.md)
|
|
4
|
-
|
|
5
|
-
## AIProvider.interpretCriteria() method
|
|
6
|
-
|
|
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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
interpretCriteria?(input: string, context: CriteriaInterpretContext): Promise<CriteriaInterpretationResult | null>;
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
<table><thead><tr><th>
|
|
19
|
-
|
|
20
|
-
Parameter
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
</th><th>
|
|
24
|
-
|
|
25
|
-
Type
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
</th><th>
|
|
29
|
-
|
|
30
|
-
Description
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
</th></tr></thead>
|
|
34
|
-
<tbody><tr><td>
|
|
35
|
-
|
|
36
|
-
input
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
</td><td>
|
|
40
|
-
|
|
41
|
-
string
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
</td><td>
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
</td></tr>
|
|
48
|
-
<tr><td>
|
|
49
|
-
|
|
50
|
-
context
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
</td><td>
|
|
54
|
-
|
|
55
|
-
[CriteriaInterpretContext](./foundation-ai.criteriainterpretcontext.md)
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
</td><td>
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
</td></tr>
|
|
62
|
-
</tbody></table>
|
|
63
|
-
|
|
64
|
-
**Returns:**
|
|
65
|
-
|
|
66
|
-
Promise<[CriteriaInterpretationResult](./foundation-ai.criteriainterpretationresult.md) \| null>
|
|
67
|
-
|
|
@@ -1,91 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AIProvider](./foundation-ai.aiprovider.md)
|
|
4
|
-
|
|
5
|
-
## AIProvider interface
|
|
6
|
-
|
|
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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
AI Provider interface for foundation-ai.
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
export interface AIProvider
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## Remarks
|
|
19
|
-
|
|
20
|
-
General providers (OpenAI, Chrome) are configured once and expose multiple capabilities. Components check for optional method support before use.
|
|
21
|
-
|
|
22
|
-
## Methods
|
|
23
|
-
|
|
24
|
-
<table><thead><tr><th>
|
|
25
|
-
|
|
26
|
-
Method
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
</th><th>
|
|
30
|
-
|
|
31
|
-
Description
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
</th></tr></thead>
|
|
35
|
-
<tbody><tr><td>
|
|
36
|
-
|
|
37
|
-
[chat(history, userMessage, options)?](./foundation-ai.aiprovider.chat.md)
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
</td><td>
|
|
41
|
-
|
|
42
|
-
**_(BETA)_** _(Optional)_ Multi-turn chat (non-streaming). Returns the assistant's response message. Providers that support chat (Gemini, OpenAI) implement this.
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
</td></tr>
|
|
46
|
-
<tr><td>
|
|
47
|
-
|
|
48
|
-
[getStatus()?](./foundation-ai.aiprovider.getstatus.md)
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
</td><td>
|
|
52
|
-
|
|
53
|
-
**_(BETA)_** _(Optional)_ Returns current AI status for display (provider, model, Chrome availability).
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
</td></tr>
|
|
57
|
-
<tr><td>
|
|
58
|
-
|
|
59
|
-
[interpretCriteria(input, context)?](./foundation-ai.aiprovider.interpretcriteria.md)
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
</td><td>
|
|
63
|
-
|
|
64
|
-
**_(BETA)_** _(Optional)_
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
</td></tr>
|
|
68
|
-
<tr><td>
|
|
69
|
-
|
|
70
|
-
[streamChat(history, userMessage, options)?](./foundation-ai.aiprovider.streamchat.md)
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
</td><td>
|
|
74
|
-
|
|
75
|
-
**_(BETA)_** _(Optional)_ Multi-turn chat (streaming). Yields chunks as they arrive. Providers that support streaming implement this.
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
</td></tr>
|
|
79
|
-
<tr><td>
|
|
80
|
-
|
|
81
|
-
[triggerDownload()?](./foundation-ai.aiprovider.triggerdownload.md)
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
</td><td>
|
|
85
|
-
|
|
86
|
-
**_(BETA)_** _(Optional)_ Triggers Chrome model download. Only ChromeProvider implements this. Must be called from a user gesture (e.g. click).
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
</td></tr>
|
|
90
|
-
</tbody></table>
|
|
91
|
-
|
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AIProvider](./foundation-ai.aiprovider.md) > [streamChat](./foundation-ai.aiprovider.streamchat.md)
|
|
4
|
-
|
|
5
|
-
## AIProvider.streamChat() method
|
|
6
|
-
|
|
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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
Multi-turn chat (streaming). Yields chunks as they arrive. Providers that support streaming implement this.
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
streamChat?(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): AsyncIterable<ChatStreamChunk>;
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## Parameters
|
|
19
|
-
|
|
20
|
-
<table><thead><tr><th>
|
|
21
|
-
|
|
22
|
-
Parameter
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
</th><th>
|
|
26
|
-
|
|
27
|
-
Type
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
</th><th>
|
|
31
|
-
|
|
32
|
-
Description
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
</th></tr></thead>
|
|
36
|
-
<tbody><tr><td>
|
|
37
|
-
|
|
38
|
-
history
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
</td><td>
|
|
42
|
-
|
|
43
|
-
[ChatMessage](./foundation-ai.chatmessage.md)<!-- -->\[\]
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
</td><td>
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
</td></tr>
|
|
50
|
-
<tr><td>
|
|
51
|
-
|
|
52
|
-
userMessage
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
</td><td>
|
|
56
|
-
|
|
57
|
-
string
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
</td><td>
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
</td></tr>
|
|
64
|
-
<tr><td>
|
|
65
|
-
|
|
66
|
-
options
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
</td><td>
|
|
70
|
-
|
|
71
|
-
[ChatRequestOptions](./foundation-ai.chatrequestoptions.md)
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
</td><td>
|
|
75
|
-
|
|
76
|
-
_(Optional)_
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
</td></tr>
|
|
80
|
-
</tbody></table>
|
|
81
|
-
|
|
82
|
-
**Returns:**
|
|
83
|
-
|
|
84
|
-
AsyncIterable<[ChatStreamChunk](./foundation-ai.chatstreamchunk.md)<!-- -->>
|
|
85
|
-
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AIProvider](./foundation-ai.aiprovider.md) > [triggerDownload](./foundation-ai.aiprovider.triggerdownload.md)
|
|
4
|
-
|
|
5
|
-
## AIProvider.triggerDownload() method
|
|
6
|
-
|
|
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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
Triggers Chrome model download. Only ChromeProvider implements this. Must be called from a user gesture (e.g. click).
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
triggerDownload?(): Promise<void>;
|
|
16
|
-
```
|
|
17
|
-
**Returns:**
|
|
18
|
-
|
|
19
|
-
Promise<void>
|
|
20
|
-
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AIProviderType](./foundation-ai.aiprovidertype.md)
|
|
4
|
-
|
|
5
|
-
## AIProviderType type
|
|
6
|
-
|
|
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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
All AI provider identifiers (server, client, unconfigured).
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
export type AIProviderType = 'openai' | 'chrome' | 'gemini' | 'none';
|
|
16
|
-
```
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AIStatus](./foundation-ai.aistatus.md) > [chromeAvailability](./foundation-ai.aistatus.chromeavailability.md)
|
|
4
|
-
|
|
5
|
-
## AIStatus.chromeAvailability property
|
|
6
|
-
|
|
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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
chromeAvailability?: ChromeAvailability;
|
|
14
|
-
```
|
|
@@ -1,99 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AIStatus](./foundation-ai.aistatus.md)
|
|
4
|
-
|
|
5
|
-
## AIStatus interface
|
|
6
|
-
|
|
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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
AI status for display in the header indicator.
|
|
11
|
-
|
|
12
|
-
**Signature:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
export interface AIStatus
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## Properties
|
|
19
|
-
|
|
20
|
-
<table><thead><tr><th>
|
|
21
|
-
|
|
22
|
-
Property
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
</th><th>
|
|
26
|
-
|
|
27
|
-
Modifiers
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
</th><th>
|
|
31
|
-
|
|
32
|
-
Type
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
</th><th>
|
|
36
|
-
|
|
37
|
-
Description
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
</th></tr></thead>
|
|
41
|
-
<tbody><tr><td>
|
|
42
|
-
|
|
43
|
-
[chromeAvailability?](./foundation-ai.aistatus.chromeavailability.md)
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
</td><td>
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
</td><td>
|
|
50
|
-
|
|
51
|
-
[ChromeAvailability](./foundation-ai.chromeavailability.md)
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
</td><td>
|
|
55
|
-
|
|
56
|
-
**_(BETA)_** _(Optional)_
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
</td></tr>
|
|
60
|
-
<tr><td>
|
|
61
|
-
|
|
62
|
-
[model](./foundation-ai.aistatus.model.md)
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
</td><td>
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
</td><td>
|
|
69
|
-
|
|
70
|
-
string
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
</td><td>
|
|
74
|
-
|
|
75
|
-
**_(BETA)_**
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
</td></tr>
|
|
79
|
-
<tr><td>
|
|
80
|
-
|
|
81
|
-
[provider](./foundation-ai.aistatus.provider.md)
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
</td><td>
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
</td><td>
|
|
88
|
-
|
|
89
|
-
[AIProviderType](./foundation-ai.aiprovidertype.md)
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
</td><td>
|
|
93
|
-
|
|
94
|
-
**_(BETA)_**
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
</td></tr>
|
|
98
|
-
</tbody></table>
|
|
99
|
-
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-ai](./foundation-ai.md) > [AIStatus](./foundation-ai.aistatus.md) > [model](./foundation-ai.aistatus.model.md)
|
|
4
|
-
|
|
5
|
-
## AIStatus.model property
|
|
6
|
-
|
|
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.
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
**Signature:**
|
|
11
|
-
|
|
12
|
-
```typescript
|
|
13
|
-
model: string;
|
|
14
|
-
```
|