@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
  1. package/package.json +11 -11
  2. package/docs/api/foundation-ai.ai_feature_flag.md +0 -13
  3. package/docs/api/foundation-ai.aiconfig.md +0 -18
  4. package/docs/api/foundation-ai.aiprovider.chat.md +0 -85
  5. package/docs/api/foundation-ai.aiprovider.getstatus.md +0 -20
  6. package/docs/api/foundation-ai.aiprovider.interpretcriteria.md +0 -67
  7. package/docs/api/foundation-ai.aiprovider.md +0 -91
  8. package/docs/api/foundation-ai.aiprovider.streamchat.md +0 -85
  9. package/docs/api/foundation-ai.aiprovider.triggerdownload.md +0 -20
  10. package/docs/api/foundation-ai.aiprovidertype.md +0 -16
  11. package/docs/api/foundation-ai.aistatus.chromeavailability.md +0 -14
  12. package/docs/api/foundation-ai.aistatus.md +0 -99
  13. package/docs/api/foundation-ai.aistatus.model.md +0 -14
  14. package/docs/api/foundation-ai.aistatus.provider.md +0 -14
  15. package/docs/api/foundation-ai.chatanimationsconfig.enabled.md +0 -16
  16. package/docs/api/foundation-ai.chatanimationsconfig.md +0 -80
  17. package/docs/api/foundation-ai.chatanimationsconfig.userconfigurable.md +0 -16
  18. package/docs/api/foundation-ai.chatattachment.content.md +0 -14
  19. package/docs/api/foundation-ai.chatattachment.md +0 -99
  20. package/docs/api/foundation-ai.chatattachment.mimetype.md +0 -14
  21. package/docs/api/foundation-ai.chatattachment.name.md +0 -14
  22. package/docs/api/foundation-ai.chatconfig.acceptedfiles.md +0 -16
  23. package/docs/api/foundation-ai.chatconfig.allowdebugdownload.md +0 -16
  24. package/docs/api/foundation-ai.chatconfig.animations.md +0 -16
  25. package/docs/api/foundation-ai.chatconfig.loadingdelay.md +0 -16
  26. package/docs/api/foundation-ai.chatconfig.maxtooliterations.md +0 -16
  27. package/docs/api/foundation-ai.chatconfig.md +0 -177
  28. package/docs/api/foundation-ai.chatconfig.showthinkingsteps.md +0 -16
  29. package/docs/api/foundation-ai.chatconfig.showtoolcalls.md +0 -16
  30. package/docs/api/foundation-ai.chatinteraction.componentname.md +0 -14
  31. package/docs/api/foundation-ai.chatinteraction.data.md +0 -14
  32. package/docs/api/foundation-ai.chatinteraction.interactionid.md +0 -14
  33. package/docs/api/foundation-ai.chatinteraction.md +0 -118
  34. package/docs/api/foundation-ai.chatinteraction.resolved.md +0 -16
  35. package/docs/api/foundation-ai.chatmessage.attachments.md +0 -14
  36. package/docs/api/foundation-ai.chatmessage.content.md +0 -14
  37. package/docs/api/foundation-ai.chatmessage.interaction.md +0 -14
  38. package/docs/api/foundation-ai.chatmessage.md +0 -175
  39. package/docs/api/foundation-ai.chatmessage.role.md +0 -14
  40. package/docs/api/foundation-ai.chatmessage.thinking.md +0 -14
  41. package/docs/api/foundation-ai.chatmessage.toolcalls.md +0 -14
  42. package/docs/api/foundation-ai.chatmessage.toolresult.md +0 -14
  43. package/docs/api/foundation-ai.chatrequestoptions.attachments.md +0 -14
  44. package/docs/api/foundation-ai.chatrequestoptions.md +0 -118
  45. package/docs/api/foundation-ai.chatrequestoptions.signal.md +0 -14
  46. package/docs/api/foundation-ai.chatrequestoptions.systemprompt.md +0 -14
  47. package/docs/api/foundation-ai.chatrequestoptions.tools.md +0 -14
  48. package/docs/api/foundation-ai.chatrole.md +0 -16
  49. package/docs/api/foundation-ai.chatstreamchunk.delta.md +0 -14
  50. package/docs/api/foundation-ai.chatstreamchunk.done.md +0 -14
  51. package/docs/api/foundation-ai.chatstreamchunk.md +0 -99
  52. package/docs/api/foundation-ai.chatstreamchunk.toolcalls.md +0 -14
  53. package/docs/api/foundation-ai.chattoolcall.args.md +0 -14
  54. package/docs/api/foundation-ai.chattoolcall.id.md +0 -14
  55. package/docs/api/foundation-ai.chattoolcall.md +0 -99
  56. package/docs/api/foundation-ai.chattoolcall.name.md +0 -14
  57. package/docs/api/foundation-ai.chattooldefinition.description.md +0 -14
  58. package/docs/api/foundation-ai.chattooldefinition.md +0 -99
  59. package/docs/api/foundation-ai.chattooldefinition.name.md +0 -14
  60. package/docs/api/foundation-ai.chattooldefinition.parameters.md +0 -14
  61. package/docs/api/foundation-ai.chattoolhandlers.md +0 -18
  62. package/docs/api/foundation-ai.chattoolresult.content.md +0 -14
  63. package/docs/api/foundation-ai.chattoolresult.md +0 -80
  64. package/docs/api/foundation-ai.chattoolresult.toolcallid.md +0 -14
  65. package/docs/api/foundation-ai.chattransport.md +0 -58
  66. package/docs/api/foundation-ai.chattransport.sendchatmessage.md +0 -83
  67. package/docs/api/foundation-ai.chattransport.streamchatmessage.md +0 -83
  68. package/docs/api/foundation-ai.chromeaiconfig.md +0 -104
  69. package/docs/api/foundation-ai.chromeaiconfig.providertype.md +0 -14
  70. package/docs/api/foundation-ai.chromeaiconfig.temperature.md +0 -14
  71. package/docs/api/foundation-ai.chromeaiconfig.topk.md +0 -14
  72. package/docs/api/foundation-ai.chromeavailability.md +0 -16
  73. package/docs/api/foundation-ai.createaiprovider.md +0 -57
  74. package/docs/api/foundation-ai.criteriaclauseresult.field.md +0 -14
  75. package/docs/api/foundation-ai.criteriaclauseresult.md +0 -99
  76. package/docs/api/foundation-ai.criteriaclauseresult.operator.md +0 -14
  77. package/docs/api/foundation-ai.criteriaclauseresult.value.md +0 -14
  78. package/docs/api/foundation-ai.criteriagroupresult.clauses.md +0 -14
  79. package/docs/api/foundation-ai.criteriagroupresult.logic.md +0 -14
  80. package/docs/api/foundation-ai.criteriagroupresult.md +0 -99
  81. package/docs/api/foundation-ai.criteriagroupresult.negated.md +0 -14
  82. package/docs/api/foundation-ai.criteriainterpretationresult.groups.md +0 -14
  83. package/docs/api/foundation-ai.criteriainterpretationresult.md +0 -61
  84. package/docs/api/foundation-ai.criteriainterpretcontext.fields.md +0 -14
  85. package/docs/api/foundation-ai.criteriainterpretcontext.md +0 -61
  86. package/docs/api/foundation-ai.fieldlike.md +0 -21
  87. package/docs/api/foundation-ai.geminiaiconfig.apikey.md +0 -14
  88. package/docs/api/foundation-ai.geminiaiconfig.md +0 -123
  89. package/docs/api/foundation-ai.geminiaiconfig.model.md +0 -14
  90. package/docs/api/foundation-ai.geminiaiconfig.providertype.md +0 -14
  91. package/docs/api/foundation-ai.geminiaiconfig.serverendpoint.md +0 -14
  92. package/docs/api/foundation-ai.geminiprovider._constructor_.md +0 -65
  93. package/docs/api/foundation-ai.geminiprovider.chat.md +0 -83
  94. package/docs/api/foundation-ai.geminiprovider.getstatus.md +0 -18
  95. package/docs/api/foundation-ai.geminiprovider.interpretcriteria.md +0 -67
  96. package/docs/api/foundation-ai.geminiprovider.md +0 -128
  97. package/docs/api/foundation-ai.geminiprovider.streamchat.md +0 -83
  98. package/docs/api/foundation-ai.geminitransport._constructor_.md +0 -53
  99. package/docs/api/foundation-ai.geminitransport.getconfig.md +0 -21
  100. package/docs/api/foundation-ai.geminitransport.md +0 -116
  101. package/docs/api/foundation-ai.geminitransport.sendchatmessage.md +0 -83
  102. package/docs/api/foundation-ai.geminitransport.sendstructuredprompt.md +0 -53
  103. package/docs/api/foundation-ai.getaiprovider.md +0 -35
  104. package/docs/api/foundation-ai.interactionresult.md +0 -20
  105. package/docs/api/foundation-ai.isaifeatureenabled.md +0 -17
  106. package/docs/api/foundation-ai.isspeechrecognitionavailable.md +0 -20
  107. package/docs/api/foundation-ai.malformedfunctioncallerror._constructor_.md +0 -53
  108. package/docs/api/foundation-ai.malformedfunctioncallerror.finishmessage.md +0 -14
  109. package/docs/api/foundation-ai.malformedfunctioncallerror.md +0 -98
  110. package/docs/api/foundation-ai.md +0 -503
  111. package/docs/api/foundation-ai.resolveaiconfig.md +0 -57
  112. package/docs/api/foundation-ai.resolveaiconfigoptions.md +0 -99
  113. package/docs/api/foundation-ai.resolveaiconfigoptions.model.md +0 -16
  114. package/docs/api/foundation-ai.resolveaiconfigoptions.preferchrome.md +0 -16
  115. package/docs/api/foundation-ai.resolveaiconfigoptions.provider.md +0 -16
  116. package/docs/api/foundation-ai.serveraiconfig.md +0 -66
  117. package/docs/api/foundation-ai.serveraiconfig.provider.md +0 -14
  118. package/docs/api/foundation-ai.startspeechrecognition.md +0 -71
  119. package/docs/api/index.md +0 -30
  120. package/docs/api-report.md.api.md +0 -317
@@ -1,83 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChatTransport](./foundation-ai.chattransport.md) &gt; [streamChatMessage](./foundation-ai.chattransport.streamchatmessage.md)
4
-
5
- ## ChatTransport.streamChatMessage() 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
- streamChatMessage?(history: ChatMessage[], userMessage: string, options?: ChatRequestOptions): AsyncIterable<ChatStreamChunk>;
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
- history
37
-
38
-
39
- </td><td>
40
-
41
- [ChatMessage](./foundation-ai.chatmessage.md)<!-- -->\[\]
42
-
43
-
44
- </td><td>
45
-
46
-
47
- </td></tr>
48
- <tr><td>
49
-
50
- userMessage
51
-
52
-
53
- </td><td>
54
-
55
- string
56
-
57
-
58
- </td><td>
59
-
60
-
61
- </td></tr>
62
- <tr><td>
63
-
64
- options
65
-
66
-
67
- </td><td>
68
-
69
- [ChatRequestOptions](./foundation-ai.chatrequestoptions.md)
70
-
71
-
72
- </td><td>
73
-
74
- _(Optional)_
75
-
76
-
77
- </td></tr>
78
- </tbody></table>
79
-
80
- **Returns:**
81
-
82
- AsyncIterable&lt;[ChatStreamChunk](./foundation-ai.chatstreamchunk.md)<!-- -->&gt;
83
-
@@ -1,104 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChromeAIConfig](./foundation-ai.chromeaiconfig.md)
4
-
5
- ## ChromeAIConfig 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
- Chrome built-in AI (Prompt API / Gemini Nano) configuration.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export interface ChromeAIConfig extends AIProviderConfig
16
- ```
17
- **Extends:** AIProviderConfig
18
-
19
- ## Remarks
20
-
21
- No apiKey required. Uses on-device model. Optional temperature/topK for extensions.
22
-
23
- ## Properties
24
-
25
- <table><thead><tr><th>
26
-
27
- Property
28
-
29
-
30
- </th><th>
31
-
32
- Modifiers
33
-
34
-
35
- </th><th>
36
-
37
- Type
38
-
39
-
40
- </th><th>
41
-
42
- Description
43
-
44
-
45
- </th></tr></thead>
46
- <tbody><tr><td>
47
-
48
- [providerType?](./foundation-ai.chromeaiconfig.providertype.md)
49
-
50
-
51
- </td><td>
52
-
53
-
54
- </td><td>
55
-
56
- 'chrome'
57
-
58
-
59
- </td><td>
60
-
61
- **_(BETA)_** _(Optional)_
62
-
63
-
64
- </td></tr>
65
- <tr><td>
66
-
67
- [temperature?](./foundation-ai.chromeaiconfig.temperature.md)
68
-
69
-
70
- </td><td>
71
-
72
-
73
- </td><td>
74
-
75
- number
76
-
77
-
78
- </td><td>
79
-
80
- **_(BETA)_** _(Optional)_
81
-
82
-
83
- </td></tr>
84
- <tr><td>
85
-
86
- [topK?](./foundation-ai.chromeaiconfig.topk.md)
87
-
88
-
89
- </td><td>
90
-
91
-
92
- </td><td>
93
-
94
- number
95
-
96
-
97
- </td><td>
98
-
99
- **_(BETA)_** _(Optional)_
100
-
101
-
102
- </td></tr>
103
- </tbody></table>
104
-
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChromeAIConfig](./foundation-ai.chromeaiconfig.md) &gt; [providerType](./foundation-ai.chromeaiconfig.providertype.md)
4
-
5
- ## ChromeAIConfig.providerType 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
- providerType?: 'chrome';
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChromeAIConfig](./foundation-ai.chromeaiconfig.md) &gt; [temperature](./foundation-ai.chromeaiconfig.temperature.md)
4
-
5
- ## ChromeAIConfig.temperature 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
- temperature?: number;
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChromeAIConfig](./foundation-ai.chromeaiconfig.md) &gt; [topK](./foundation-ai.chromeaiconfig.topk.md)
4
-
5
- ## ChromeAIConfig.topK 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
- topK?: number;
14
- ```
@@ -1,16 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [ChromeAvailability](./foundation-ai.chromeavailability.md)
4
-
5
- ## ChromeAvailability 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
- Chrome Prompt API availability states.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export type ChromeAvailability = 'available' | 'downloading' | 'downloadable' | 'unavailable';
16
- ```
@@ -1,57 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [createAIProvider](./foundation-ai.createaiprovider.md)
4
-
5
- ## createAIProvider() function
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
- Creates an AIProvider from config. Uses ChromeProvider when providerType is 'chrome'. Uses OpenAIProvider with ServerOpenAITransport when provider is set (server-only). Otherwise returns DefaultAIProvider. When the AI feature flag is disabled (?feature.ai), always returns DefaultAIProvider.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export declare function createAIProvider(config?: AIConfig | null): AIProvider;
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
- config
39
-
40
-
41
- </td><td>
42
-
43
- [AIConfig](./foundation-ai.aiconfig.md) \| null
44
-
45
-
46
- </td><td>
47
-
48
- _(Optional)_
49
-
50
-
51
- </td></tr>
52
- </tbody></table>
53
-
54
- **Returns:**
55
-
56
- [AIProvider](./foundation-ai.aiprovider.md)
57
-
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [CriteriaClauseResult](./foundation-ai.criteriaclauseresult.md) &gt; [field](./foundation-ai.criteriaclauseresult.field.md)
4
-
5
- ## CriteriaClauseResult.field 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
- field: string;
14
- ```
@@ -1,99 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [CriteriaClauseResult](./foundation-ai.criteriaclauseresult.md)
4
-
5
- ## CriteriaClauseResult 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
- Minimal types for AI criteria interpretation results. Providers return these; consumers (e.g. ai-criteria-search) validate and cast.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export interface CriteriaClauseResult
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
- [field](./foundation-ai.criteriaclauseresult.field.md)
44
-
45
-
46
- </td><td>
47
-
48
-
49
- </td><td>
50
-
51
- string
52
-
53
-
54
- </td><td>
55
-
56
- **_(BETA)_**
57
-
58
-
59
- </td></tr>
60
- <tr><td>
61
-
62
- [operator](./foundation-ai.criteriaclauseresult.operator.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
- [value](./foundation-ai.criteriaclauseresult.value.md)
82
-
83
-
84
- </td><td>
85
-
86
-
87
- </td><td>
88
-
89
- string \| number \| boolean \| null
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) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [CriteriaClauseResult](./foundation-ai.criteriaclauseresult.md) &gt; [operator](./foundation-ai.criteriaclauseresult.operator.md)
4
-
5
- ## CriteriaClauseResult.operator 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
- operator: string;
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [CriteriaClauseResult](./foundation-ai.criteriaclauseresult.md) &gt; [value](./foundation-ai.criteriaclauseresult.value.md)
4
-
5
- ## CriteriaClauseResult.value 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
- value: string | number | boolean | null;
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [CriteriaGroupResult](./foundation-ai.criteriagroupresult.md) &gt; [clauses](./foundation-ai.criteriagroupresult.clauses.md)
4
-
5
- ## CriteriaGroupResult.clauses 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
- clauses: CriteriaClauseResult[];
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [CriteriaGroupResult](./foundation-ai.criteriagroupresult.md) &gt; [logic](./foundation-ai.criteriagroupresult.logic.md)
4
-
5
- ## CriteriaGroupResult.logic 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
- logic: 'and' | 'or';
14
- ```
@@ -1,99 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [CriteriaGroupResult](./foundation-ai.criteriagroupresult.md)
4
-
5
- ## CriteriaGroupResult 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
- A group of criteria clauses combined by a logical operator.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export interface CriteriaGroupResult
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
- [clauses](./foundation-ai.criteriagroupresult.clauses.md)
44
-
45
-
46
- </td><td>
47
-
48
-
49
- </td><td>
50
-
51
- [CriteriaClauseResult](./foundation-ai.criteriaclauseresult.md)<!-- -->\[\]
52
-
53
-
54
- </td><td>
55
-
56
- **_(BETA)_**
57
-
58
-
59
- </td></tr>
60
- <tr><td>
61
-
62
- [logic](./foundation-ai.criteriagroupresult.logic.md)
63
-
64
-
65
- </td><td>
66
-
67
-
68
- </td><td>
69
-
70
- 'and' \| 'or'
71
-
72
-
73
- </td><td>
74
-
75
- **_(BETA)_**
76
-
77
-
78
- </td></tr>
79
- <tr><td>
80
-
81
- [negated?](./foundation-ai.criteriagroupresult.negated.md)
82
-
83
-
84
- </td><td>
85
-
86
-
87
- </td><td>
88
-
89
- boolean
90
-
91
-
92
- </td><td>
93
-
94
- **_(BETA)_** _(Optional)_
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) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [CriteriaGroupResult](./foundation-ai.criteriagroupresult.md) &gt; [negated](./foundation-ai.criteriagroupresult.negated.md)
4
-
5
- ## CriteriaGroupResult.negated 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
- negated?: boolean;
14
- ```
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [CriteriaInterpretationResult](./foundation-ai.criteriainterpretationresult.md) &gt; [groups](./foundation-ai.criteriainterpretationresult.groups.md)
4
-
5
- ## CriteriaInterpretationResult.groups 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
- groups: CriteriaGroupResult[];
14
- ```
@@ -1,61 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [CriteriaInterpretationResult](./foundation-ai.criteriainterpretationresult.md)
4
-
5
- ## CriteriaInterpretationResult 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
- Top-level result returned by criteria interpretation.
11
-
12
- **Signature:**
13
-
14
- ```typescript
15
- export interface CriteriaInterpretationResult
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
- [groups](./foundation-ai.criteriainterpretationresult.groups.md)
44
-
45
-
46
- </td><td>
47
-
48
-
49
- </td><td>
50
-
51
- [CriteriaGroupResult](./foundation-ai.criteriagroupresult.md)<!-- -->\[\]
52
-
53
-
54
- </td><td>
55
-
56
- **_(BETA)_**
57
-
58
-
59
- </td></tr>
60
- </tbody></table>
61
-
@@ -1,14 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/foundation-ai](./foundation-ai.md) &gt; [CriteriaInterpretContext](./foundation-ai.criteriainterpretcontext.md) &gt; [fields](./foundation-ai.criteriainterpretcontext.fields.md)
4
-
5
- ## CriteriaInterpretContext.fields 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
- fields?: FieldLike[];
14
- ```