@breadstone/archipel-mcp 0.0.51 → 0.0.53

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 (98) hide show
  1. package/data/guides/ai-realtime-voice.md +506 -0
  2. package/data/guides/ai-text-generation.md +5 -0
  3. package/data/guides/health-indicators.md +12 -3
  4. package/data/guides/index.md +5 -4
  5. package/data/packages/platform-health/index.md +1 -1
  6. package/data/packages/platform-intelligence/api/Class.IntelligenceAgentFactory.md +5 -5
  7. package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +3 -3
  8. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +6 -5
  9. package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +5 -5
  10. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  11. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAssetUploader.md +7 -5
  12. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +110 -0
  13. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +47 -0
  14. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +129 -0
  15. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +308 -0
  16. package/data/packages/platform-intelligence/api/Class.IntelligenceStructuredGenerator.md +5 -5
  17. package/data/packages/platform-intelligence/api/Class.IntelligenceTelemetryRegistry.md +4 -4
  18. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +8 -8
  19. package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +3 -3
  20. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +3 -3
  21. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +3 -3
  22. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +3 -3
  23. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +3 -3
  24. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +3 -3
  25. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +3 -3
  26. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +3 -3
  27. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +3 -3
  28. package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +3 -3
  29. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +3 -3
  30. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +3 -3
  31. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +3 -3
  32. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +3 -3
  33. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +3 -3
  34. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +3 -3
  35. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +3 -3
  36. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +3 -3
  37. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +3 -3
  38. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +3 -3
  39. package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +3 -3
  40. package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +3 -3
  41. package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +3 -3
  42. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +3 -3
  43. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +3 -3
  44. package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +3 -3
  45. package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +3 -3
  46. package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +3 -3
  47. package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +3 -3
  48. package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +3 -3
  49. package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +3 -3
  50. package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +3 -3
  51. package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +3 -3
  52. package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +3 -3
  53. package/data/packages/platform-intelligence/api/Function.createMimoCustomTool.md +3 -3
  54. package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +3 -3
  55. package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +3 -3
  56. package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +3 -3
  57. package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +3 -3
  58. package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +3 -3
  59. package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +3 -3
  60. package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +3 -3
  61. package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +3 -3
  62. package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +3 -3
  63. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +3 -3
  64. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +3 -3
  65. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +2 -2
  66. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +2 -2
  67. package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +25 -0
  68. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +2 -2
  69. package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +25 -0
  70. package/data/packages/platform-intelligence/api/Function.loadMimoLanguageModel.md +3 -3
  71. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +2 -2
  72. package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +25 -0
  73. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +20 -7
  74. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeAudioFormat.md +34 -0
  75. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeCloseEvent.md +40 -0
  76. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +120 -0
  77. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionConfiguration.md +135 -0
  78. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +148 -0
  79. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeToolDefinition.md +58 -0
  80. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTranscriptionConfiguration.md +46 -0
  81. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTurnDetectionConfiguration.md +58 -0
  82. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +103 -0
  83. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +2 -2
  84. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md +64 -0
  85. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md +14 -0
  86. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +44 -0
  87. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +25 -0
  88. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +14 -0
  89. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeServerEvent.md +159 -0
  90. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeStatus.md +14 -0
  91. package/data/packages/platform-intelligence/api/Variable.MIMO_API_KEY.md +1 -1
  92. package/data/packages/platform-intelligence/api/Variable.MIMO_BASE_URL.md +1 -1
  93. package/data/packages/platform-intelligence/api/Variable.MIMO_CONFIG_ENTRIES.md +1 -1
  94. package/data/packages/platform-intelligence/api/index.md +23 -0
  95. package/data/packages/platform-intelligence/index.md +133 -7
  96. package/data/patterns/index.md +1 -0
  97. package/data/patterns/realtime-session-pattern.md +309 -0
  98. package/package.json +1 -1
@@ -0,0 +1,308 @@
1
+ ---
2
+ title: 'Abstract Class: IntelligenceRealtimeSessionPort'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Abstract Class: IntelligenceRealtimeSessionPort
7
+
8
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:14
9
+
10
+ Provider-neutral control surface for one realtime model connection.
11
+
12
+ ## Constructors
13
+
14
+ ### Constructor
15
+
16
+ ```ts
17
+ new IntelligenceRealtimeSessionPort(): IntelligenceRealtimeSessionPort;
18
+ ```
19
+
20
+ #### Returns
21
+
22
+ `IntelligenceRealtimeSessionPort`
23
+
24
+ ## Accessors
25
+
26
+ ### connectionId
27
+
28
+ #### Get Signature
29
+
30
+ ```ts
31
+ get abstract connectionId(): string;
32
+ ```
33
+
34
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:18
35
+
36
+ ##### Returns
37
+
38
+ `string`
39
+
40
+ ***
41
+
42
+ ### model
43
+
44
+ #### Get Signature
45
+
46
+ ```ts
47
+ get abstract model(): string;
48
+ ```
49
+
50
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:20
51
+
52
+ ##### Returns
53
+
54
+ `string`
55
+
56
+ ***
57
+
58
+ ### provider
59
+
60
+ #### Get Signature
61
+
62
+ ```ts
63
+ get abstract provider(): IntelligenceProviderName;
64
+ ```
65
+
66
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:19
67
+
68
+ ##### Returns
69
+
70
+ [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName)
71
+
72
+ ***
73
+
74
+ ### sessionId
75
+
76
+ #### Get Signature
77
+
78
+ ```ts
79
+ get abstract sessionId(): string;
80
+ ```
81
+
82
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:17
83
+
84
+ ##### Returns
85
+
86
+ `string`
87
+
88
+ ***
89
+
90
+ ### status
91
+
92
+ #### Get Signature
93
+
94
+ ```ts
95
+ get abstract status(): IntelligenceRealtimeStatus;
96
+ ```
97
+
98
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:21
99
+
100
+ ##### Returns
101
+
102
+ [`IntelligenceRealtimeStatus`](TypeAlias.IntelligenceRealtimeStatus)
103
+
104
+ ## Methods
105
+
106
+ ### addToolOutput()
107
+
108
+ ```ts
109
+ abstract addToolOutput(
110
+ callId,
111
+ output,
112
+ name?): Promise<void>;
113
+ ```
114
+
115
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:56
116
+
117
+ Returns a completed function result to the model.
118
+
119
+ #### Parameters
120
+
121
+ | Parameter | Type |
122
+ | ------ | ------ |
123
+ | `callId` | `string` |
124
+ | `output` | `unknown` |
125
+ | `name?` | `string` |
126
+
127
+ #### Returns
128
+
129
+ `Promise`\<`void`\>
130
+
131
+ ***
132
+
133
+ ### appendAudio()
134
+
135
+ ```ts
136
+ abstract appendAudio(audio): Promise<void>;
137
+ ```
138
+
139
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:34
140
+
141
+ Appends a base64-encoded audio fragment to the upstream input buffer.
142
+
143
+ #### Parameters
144
+
145
+ | Parameter | Type |
146
+ | ------ | ------ |
147
+ | `audio` | `string` |
148
+
149
+ #### Returns
150
+
151
+ `Promise`\<`void`\>
152
+
153
+ ***
154
+
155
+ ### cancelResponse()
156
+
157
+ ```ts
158
+ abstract cancelResponse(): Promise<void>;
159
+ ```
160
+
161
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:53
162
+
163
+ Cancels the active model response.
164
+
165
+ #### Returns
166
+
167
+ `Promise`\<`void`\>
168
+
169
+ ***
170
+
171
+ ### clearAudio()
172
+
173
+ ```ts
174
+ abstract clearAudio(): Promise<void>;
175
+ ```
176
+
177
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:40
178
+
179
+ Clears the provider input audio buffer.
180
+
181
+ #### Returns
182
+
183
+ `Promise`\<`void`\>
184
+
185
+ ***
186
+
187
+ ### close()
188
+
189
+ ```ts
190
+ abstract close(code?, reason?): Promise<void>;
191
+ ```
192
+
193
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:59
194
+
195
+ Gracefully closes the upstream connection and flushes metering events.
196
+
197
+ #### Parameters
198
+
199
+ | Parameter | Type |
200
+ | ------ | ------ |
201
+ | `code?` | `number` |
202
+ | `reason?` | `string` |
203
+
204
+ #### Returns
205
+
206
+ `Promise`\<`void`\>
207
+
208
+ ***
209
+
210
+ ### commitAudio()
211
+
212
+ ```ts
213
+ abstract commitAudio(): Promise<void>;
214
+ ```
215
+
216
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:37
217
+
218
+ Commits the provider input audio buffer.
219
+
220
+ #### Returns
221
+
222
+ `Promise`\<`void`\>
223
+
224
+ ***
225
+
226
+ ### connect()
227
+
228
+ ```ts
229
+ abstract connect(): Promise<void>;
230
+ ```
231
+
232
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:28
233
+
234
+ Opens the upstream provider WebSocket and applies the session configuration.
235
+
236
+ #### Returns
237
+
238
+ `Promise`\<`void`\>
239
+
240
+ ***
241
+
242
+ ### requestResponse()
243
+
244
+ ```ts
245
+ abstract requestResponse(options?): Promise<void>;
246
+ ```
247
+
248
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:46
249
+
250
+ Requests a new model response.
251
+
252
+ #### Parameters
253
+
254
+ | Parameter | Type |
255
+ | ------ | ------ |
256
+ | `options?` | \{ `instructions?`: `string`; `metadata?`: `Readonly`\<`Record`\<`string`, `unknown`\>\>; `modalities?`: readonly `string`[]; \} |
257
+ | `options.instructions?` | `string` |
258
+ | `options.metadata?` | `Readonly`\<`Record`\<`string`, `unknown`\>\> |
259
+ | `options.modalities?` | readonly `string`[] |
260
+
261
+ #### Returns
262
+
263
+ `Promise`\<`void`\>
264
+
265
+ ***
266
+
267
+ ### send()
268
+
269
+ ```ts
270
+ abstract send(event): Promise<void>;
271
+ ```
272
+
273
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:31
274
+
275
+ Sends any provider-neutral client event.
276
+
277
+ #### Parameters
278
+
279
+ | Parameter | Type |
280
+ | ------ | ------ |
281
+ | `event` | [`IntelligenceRealtimeClientEvent`](TypeAlias.IntelligenceRealtimeClientEvent) |
282
+
283
+ #### Returns
284
+
285
+ `Promise`\<`void`\>
286
+
287
+ ***
288
+
289
+ ### sendText()
290
+
291
+ ```ts
292
+ abstract sendText(text, requestResponse?): Promise<void>;
293
+ ```
294
+
295
+ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:43
296
+
297
+ Sends a text turn and optionally asks the model to respond.
298
+
299
+ #### Parameters
300
+
301
+ | Parameter | Type |
302
+ | ------ | ------ |
303
+ | `text` | `string` |
304
+ | `requestResponse?` | `boolean` |
305
+
306
+ #### Returns
307
+
308
+ `Promise`\<`void`\>
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceStructuredGenerator
7
7
 
8
- Defined in: IntelligenceStructuredGenerator.ts:14
8
+ Defined in: [IntelligenceStructuredGenerator.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceStructuredGenerator.ts#L20)
9
9
 
10
10
  Executes AI SDK structured-output generation.
11
11
 
@@ -29,7 +29,7 @@ new IntelligenceStructuredGenerator(): IntelligenceStructuredGenerator;
29
29
  generateObject(options): Promise<GenerateObjectResult<unknown>>;
30
30
  ```
31
31
 
32
- Defined in: IntelligenceStructuredGenerator.ts:36
32
+ Defined in: [IntelligenceStructuredGenerator.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceStructuredGenerator.ts#L42)
33
33
 
34
34
  Generates a structured object using the native AI SDK object API.
35
35
 
@@ -50,10 +50,10 @@ The native AI SDK object-generation result.
50
50
  ### streamObject()
51
51
 
52
52
  ```ts
53
- streamObject(options): StreamObjectResult<unknown>;
53
+ streamObject(options): Promise<StreamObjectResult<unknown, unknown, never>>;
54
54
  ```
55
55
 
56
- Defined in: IntelligenceStructuredGenerator.ts:47
56
+ Defined in: [IntelligenceStructuredGenerator.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceStructuredGenerator.ts#L55)
57
57
 
58
58
  Streams a structured object using the native AI SDK object API.
59
59
 
@@ -65,6 +65,6 @@ Streams a structured object using the native AI SDK object API.
65
65
 
66
66
  #### Returns
67
67
 
68
- `StreamObjectResult`\<`unknown`\>
68
+ `Promise`\<`StreamObjectResult`\<`unknown`, `unknown`, `never`\>\>
69
69
 
70
70
  The native AI SDK streaming object result.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceTelemetryRegistry
7
7
 
8
- Defined in: IntelligenceTelemetryRegistry.ts:14
8
+ Defined in: [IntelligenceTelemetryRegistry.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTelemetryRegistry.ts#L15)
9
9
 
10
10
  Registers AI SDK telemetry integrations for the current process.
11
11
 
@@ -26,10 +26,10 @@ new IntelligenceTelemetryRegistry(): IntelligenceTelemetryRegistry;
26
26
  ### register()
27
27
 
28
28
  ```ts
29
- register(...integrations): void;
29
+ register(...integrations): Promise<void>;
30
30
  ```
31
31
 
32
- Defined in: IntelligenceTelemetryRegistry.ts:35
32
+ Defined in: [IntelligenceTelemetryRegistry.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTelemetryRegistry.ts#L36)
33
33
 
34
34
  Registers one or more native AI SDK telemetry integrations.
35
35
 
@@ -41,4 +41,4 @@ Registers one or more native AI SDK telemetry integrations.
41
41
 
42
42
  #### Returns
43
43
 
44
- `void`
44
+ `Promise`\<`void`\>
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceTextGenerator
7
7
 
8
- Defined in: [IntelligenceTextGenerator.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L56)
8
+ Defined in: [IntelligenceTextGenerator.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L34)
9
9
 
10
10
  Executes text completions using the configured intelligence provider.
11
11
 
@@ -26,7 +26,7 @@ new IntelligenceTextGenerator(
26
26
  validateOnModuleInit?): IntelligenceTextGenerator;
27
27
  ```
28
28
 
29
- Defined in: [IntelligenceTextGenerator.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L71)
29
+ Defined in: [IntelligenceTextGenerator.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L49)
30
30
 
31
31
  #### Parameters
32
32
 
@@ -49,7 +49,7 @@ Defined in: [IntelligenceTextGenerator.ts:71](https://github.com/RueDeRennes/arc
49
49
  generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
50
50
  ```
51
51
 
52
- Defined in: [IntelligenceTextGenerator.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L112)
52
+ Defined in: [IntelligenceTextGenerator.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L90)
53
53
 
54
54
  Generates a completion using the configured provider.
55
55
 
@@ -76,7 +76,7 @@ Generates a completion using the configured provider.
76
76
  getConfiguration(): IIntelligenceProviderConfiguration;
77
77
  ```
78
78
 
79
- Defined in: [IntelligenceTextGenerator.ts:286](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L286)
79
+ Defined in: [IntelligenceTextGenerator.ts:267](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L267)
80
80
 
81
81
  Returns the resolved provider configuration with the API key redacted.
82
82
 
@@ -93,16 +93,16 @@ Returns the resolved provider configuration with the API key redacted.
93
93
  ### onModuleInit()
94
94
 
95
95
  ```ts
96
- onModuleInit(): void;
96
+ onModuleInit(): Promise<void>;
97
97
  ```
98
98
 
99
- Defined in: [IntelligenceTextGenerator.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L96)
99
+ Defined in: [IntelligenceTextGenerator.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L74)
100
100
 
101
101
  Eagerly resolves configuration at startup to fail fast on missing keys.
102
102
 
103
103
  #### Returns
104
104
 
105
- `void`
105
+ `Promise`\<`void`\>
106
106
 
107
107
  #### Implementation of
108
108
 
@@ -118,7 +118,7 @@ OnModuleInit.onModuleInit
118
118
  streamText(prompt, options?): Promise<StreamTextResult<ToolSet, Context, Output<string, string, never>>>;
119
119
  ```
120
120
 
121
- Defined in: [IntelligenceTextGenerator.ts:213](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L213)
121
+ Defined in: [IntelligenceTextGenerator.ts:192](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L192)
122
122
 
123
123
  Streams a completion using the configured provider.
124
124
 
@@ -6,10 +6,10 @@ editUrl: false
6
6
  # Function: createAnthropicAdvisor20260301Tool()
7
7
 
8
8
  ```ts
9
- function createAnthropicAdvisor20260301Tool(options): IIntelligenceTool;
9
+ function createAnthropicAdvisor20260301Tool(options): Promise<IIntelligenceTool>;
10
10
  ```
11
11
 
12
- Defined in: [providers/anthropic/tools/createAnthropicAdvisor20260301Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicAdvisor20260301Tool.ts#L18)
12
+ Defined in: [providers/anthropic/tools/createAnthropicAdvisor20260301Tool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicAdvisor20260301Tool.ts#L19)
13
13
 
14
14
  Creates an Anthropic advisor tool registration.
15
15
 
@@ -21,6 +21,6 @@ Creates an Anthropic advisor tool registration.
21
21
 
22
22
  ## Returns
23
23
 
24
- [`IIntelligenceTool`](Interface.IIntelligenceTool)
24
+ `Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
25
25
 
26
26
  Tool registration compatible with the intelligence tool registry.
@@ -6,10 +6,10 @@ editUrl: false
6
6
  # Function: createAnthropicBash20241022Tool()
7
7
 
8
8
  ```ts
9
- function createAnthropicBash20241022Tool(options?): IIntelligenceTool;
9
+ function createAnthropicBash20241022Tool(options?): Promise<IIntelligenceTool>;
10
10
  ```
11
11
 
12
- Defined in: [providers/anthropic/tools/createAnthropicBash20241022Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicBash20241022Tool.ts#L18)
12
+ Defined in: [providers/anthropic/tools/createAnthropicBash20241022Tool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicBash20241022Tool.ts#L19)
13
13
 
14
14
  Creates an Anthropic bash tool registration for the 2024-10-22 version.
15
15
 
@@ -21,6 +21,6 @@ Creates an Anthropic bash tool registration for the 2024-10-22 version.
21
21
 
22
22
  ## Returns
23
23
 
24
- [`IIntelligenceTool`](Interface.IIntelligenceTool)
24
+ `Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
25
25
 
26
26
  Tool registration compatible with the intelligence tool registry.
@@ -6,10 +6,10 @@ editUrl: false
6
6
  # Function: createAnthropicBash20250124Tool()
7
7
 
8
8
  ```ts
9
- function createAnthropicBash20250124Tool(options?): IIntelligenceTool;
9
+ function createAnthropicBash20250124Tool(options?): Promise<IIntelligenceTool>;
10
10
  ```
11
11
 
12
- Defined in: [providers/anthropic/tools/createAnthropicBash20250124Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicBash20250124Tool.ts#L18)
12
+ Defined in: [providers/anthropic/tools/createAnthropicBash20250124Tool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicBash20250124Tool.ts#L19)
13
13
 
14
14
  Creates an Anthropic bash tool registration for the 2025-01-24 version.
15
15
 
@@ -21,6 +21,6 @@ Creates an Anthropic bash tool registration for the 2025-01-24 version.
21
21
 
22
22
  ## Returns
23
23
 
24
- [`IIntelligenceTool`](Interface.IIntelligenceTool)
24
+ `Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
25
25
 
26
26
  Tool registration compatible with the intelligence tool registry.
@@ -6,10 +6,10 @@ editUrl: false
6
6
  # Function: createAnthropicCodeExecution20250522Tool()
7
7
 
8
8
  ```ts
9
- function createAnthropicCodeExecution20250522Tool(options?): IIntelligenceTool;
9
+ function createAnthropicCodeExecution20250522Tool(options?): Promise<IIntelligenceTool>;
10
10
  ```
11
11
 
12
- Defined in: [providers/anthropic/tools/createAnthropicCodeExecution20250522Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicCodeExecution20250522Tool.ts#L18)
12
+ Defined in: [providers/anthropic/tools/createAnthropicCodeExecution20250522Tool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicCodeExecution20250522Tool.ts#L19)
13
13
 
14
14
  Creates an Anthropic code-execution tool registration for the 2025-05-22 version.
15
15
 
@@ -21,6 +21,6 @@ Creates an Anthropic code-execution tool registration for the 2025-05-22 version
21
21
 
22
22
  ## Returns
23
23
 
24
- [`IIntelligenceTool`](Interface.IIntelligenceTool)
24
+ `Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
25
25
 
26
26
  Tool registration compatible with the intelligence tool registry.
@@ -6,10 +6,10 @@ editUrl: false
6
6
  # Function: createAnthropicCodeExecution20250825Tool()
7
7
 
8
8
  ```ts
9
- function createAnthropicCodeExecution20250825Tool(options?): IIntelligenceTool;
9
+ function createAnthropicCodeExecution20250825Tool(options?): Promise<IIntelligenceTool>;
10
10
  ```
11
11
 
12
- Defined in: [providers/anthropic/tools/createAnthropicCodeExecution20250825Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicCodeExecution20250825Tool.ts#L18)
12
+ Defined in: [providers/anthropic/tools/createAnthropicCodeExecution20250825Tool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicCodeExecution20250825Tool.ts#L19)
13
13
 
14
14
  Creates an Anthropic code-execution tool registration for the 2025-08-25 version.
15
15
 
@@ -21,6 +21,6 @@ Creates an Anthropic code-execution tool registration for the 2025-08-25 version
21
21
 
22
22
  ## Returns
23
23
 
24
- [`IIntelligenceTool`](Interface.IIntelligenceTool)
24
+ `Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
25
25
 
26
26
  Tool registration compatible with the intelligence tool registry.
@@ -6,10 +6,10 @@ editUrl: false
6
6
  # Function: createAnthropicCodeExecution20260120Tool()
7
7
 
8
8
  ```ts
9
- function createAnthropicCodeExecution20260120Tool(options?): IIntelligenceTool;
9
+ function createAnthropicCodeExecution20260120Tool(options?): Promise<IIntelligenceTool>;
10
10
  ```
11
11
 
12
- Defined in: [providers/anthropic/tools/createAnthropicCodeExecution20260120Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicCodeExecution20260120Tool.ts#L18)
12
+ Defined in: [providers/anthropic/tools/createAnthropicCodeExecution20260120Tool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicCodeExecution20260120Tool.ts#L19)
13
13
 
14
14
  Creates an Anthropic code-execution tool registration for the 2026-01-20 version.
15
15
 
@@ -21,6 +21,6 @@ Creates an Anthropic code-execution tool registration for the 2026-01-20 version
21
21
 
22
22
  ## Returns
23
23
 
24
- [`IIntelligenceTool`](Interface.IIntelligenceTool)
24
+ `Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
25
25
 
26
26
  Tool registration compatible with the intelligence tool registry.
@@ -6,10 +6,10 @@ editUrl: false
6
6
  # Function: createAnthropicComputer20241022Tool()
7
7
 
8
8
  ```ts
9
- function createAnthropicComputer20241022Tool(options): IIntelligenceTool;
9
+ function createAnthropicComputer20241022Tool(options): Promise<IIntelligenceTool>;
10
10
  ```
11
11
 
12
- Defined in: [providers/anthropic/tools/createAnthropicComputer20241022Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicComputer20241022Tool.ts#L18)
12
+ Defined in: [providers/anthropic/tools/createAnthropicComputer20241022Tool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicComputer20241022Tool.ts#L19)
13
13
 
14
14
  Creates an Anthropic computer-use tool registration for the 2024-10-22 version.
15
15
 
@@ -21,6 +21,6 @@ Creates an Anthropic computer-use tool registration for the 2024-10-22 version.
21
21
 
22
22
  ## Returns
23
23
 
24
- [`IIntelligenceTool`](Interface.IIntelligenceTool)
24
+ `Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
25
25
 
26
26
  Tool registration compatible with the intelligence tool registry.
@@ -6,10 +6,10 @@ editUrl: false
6
6
  # Function: createAnthropicComputer20250124Tool()
7
7
 
8
8
  ```ts
9
- function createAnthropicComputer20250124Tool(options): IIntelligenceTool;
9
+ function createAnthropicComputer20250124Tool(options): Promise<IIntelligenceTool>;
10
10
  ```
11
11
 
12
- Defined in: [providers/anthropic/tools/createAnthropicComputer20250124Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicComputer20250124Tool.ts#L18)
12
+ Defined in: [providers/anthropic/tools/createAnthropicComputer20250124Tool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicComputer20250124Tool.ts#L19)
13
13
 
14
14
  Creates an Anthropic computer-use tool registration for the 2025-01-24 version.
15
15
 
@@ -21,6 +21,6 @@ Creates an Anthropic computer-use tool registration for the 2025-01-24 version.
21
21
 
22
22
  ## Returns
23
23
 
24
- [`IIntelligenceTool`](Interface.IIntelligenceTool)
24
+ `Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
25
25
 
26
26
  Tool registration compatible with the intelligence tool registry.
@@ -6,10 +6,10 @@ editUrl: false
6
6
  # Function: createAnthropicComputer20251124Tool()
7
7
 
8
8
  ```ts
9
- function createAnthropicComputer20251124Tool(options): IIntelligenceTool;
9
+ function createAnthropicComputer20251124Tool(options): Promise<IIntelligenceTool>;
10
10
  ```
11
11
 
12
- Defined in: [providers/anthropic/tools/createAnthropicComputer20251124Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicComputer20251124Tool.ts#L18)
12
+ Defined in: [providers/anthropic/tools/createAnthropicComputer20251124Tool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicComputer20251124Tool.ts#L19)
13
13
 
14
14
  Creates an Anthropic computer-use tool registration for the 2025-11-24 version.
15
15
 
@@ -21,6 +21,6 @@ Creates an Anthropic computer-use tool registration for the 2025-11-24 version.
21
21
 
22
22
  ## Returns
23
23
 
24
- [`IIntelligenceTool`](Interface.IIntelligenceTool)
24
+ `Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
25
25
 
26
26
  Tool registration compatible with the intelligence tool registry.
@@ -6,10 +6,10 @@ editUrl: false
6
6
  # Function: createAnthropicMemory20250818Tool()
7
7
 
8
8
  ```ts
9
- function createAnthropicMemory20250818Tool(options?): IIntelligenceTool;
9
+ function createAnthropicMemory20250818Tool(options?): Promise<IIntelligenceTool>;
10
10
  ```
11
11
 
12
- Defined in: [providers/anthropic/tools/createAnthropicMemory20250818Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicMemory20250818Tool.ts#L18)
12
+ Defined in: [providers/anthropic/tools/createAnthropicMemory20250818Tool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicMemory20250818Tool.ts#L19)
13
13
 
14
14
  Creates an Anthropic memory tool registration.
15
15
 
@@ -21,6 +21,6 @@ Creates an Anthropic memory tool registration.
21
21
 
22
22
  ## Returns
23
23
 
24
- [`IIntelligenceTool`](Interface.IIntelligenceTool)
24
+ `Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
25
25
 
26
26
  Tool registration compatible with the intelligence tool registry.
@@ -6,10 +6,10 @@ editUrl: false
6
6
  # Function: createAnthropicTextEditor20241022Tool()
7
7
 
8
8
  ```ts
9
- function createAnthropicTextEditor20241022Tool(options?): IIntelligenceTool;
9
+ function createAnthropicTextEditor20241022Tool(options?): Promise<IIntelligenceTool>;
10
10
  ```
11
11
 
12
- Defined in: [providers/anthropic/tools/createAnthropicTextEditor20241022Tool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicTextEditor20241022Tool.ts#L18)
12
+ Defined in: [providers/anthropic/tools/createAnthropicTextEditor20241022Tool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/tools/createAnthropicTextEditor20241022Tool.ts#L19)
13
13
 
14
14
  Creates an Anthropic text-editor tool registration for the 2024-10-22 version.
15
15
 
@@ -21,6 +21,6 @@ Creates an Anthropic text-editor tool registration for the 2024-10-22 version.
21
21
 
22
22
  ## Returns
23
23
 
24
- [`IIntelligenceTool`](Interface.IIntelligenceTool)
24
+ `Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
25
25
 
26
26
  Tool registration compatible with the intelligence tool registry.