@breadstone/archipel-mcp 0.0.55 → 0.0.56

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 (104) hide show
  1. package/data/guides/ai-image-generation.md +52 -47
  2. package/data/guides/ai-realtime-voice.md +48 -41
  3. package/data/guides/ai-text-generation.md +54 -60
  4. package/data/guides/health-indicators.md +67 -66
  5. package/data/guides/intelligence-prompts-warm-up.md +52 -63
  6. package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +57 -13
  7. package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +57 -13
  8. package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +57 -13
  9. package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +57 -13
  10. package/data/packages/platform-intelligence/api/Class.IntelligenceAgent.md +5 -5
  11. package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +4 -4
  12. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +10 -9
  13. package/data/packages/platform-intelligence/api/Class.IntelligenceImageGenerator.md +117 -0
  14. package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +7 -7
  15. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  16. package/data/packages/platform-intelligence/api/Class.IntelligencePromptPolicyPort.md +1 -1
  17. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAdapterPort.md +104 -0
  18. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderDiagnostics.md +3 -3
  19. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderRegistry.md +5 -5
  20. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +1 -1
  21. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +5 -5
  22. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +15 -15
  23. package/data/packages/platform-intelligence/api/Class.IntelligenceReranker.md +3 -3
  24. package/data/packages/platform-intelligence/api/Class.IntelligenceSpeechGenerator.md +117 -0
  25. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +5 -5
  26. package/data/packages/platform-intelligence/api/Class.IntelligenceTranscriptionGenerator.md +139 -0
  27. package/data/packages/platform-intelligence/api/Class.IntelligenceVideoGenerator.md +117 -0
  28. package/data/packages/platform-intelligence/api/Class.MiMoIntelligenceProviderAdapter.md +57 -13
  29. package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +38 -18
  30. package/data/packages/platform-intelligence/api/Function.createIntelligenceJsonSchema.md +1 -1
  31. package/data/packages/platform-intelligence/api/Function.defineIntelligenceTool.md +1 -1
  32. package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md +7 -7
  33. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md +25 -9
  34. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +7 -7
  35. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +24 -8
  36. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +7 -7
  37. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +23 -7
  38. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadResult.md +6 -6
  39. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGeneratedFile.md +4 -4
  40. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGenerationStepStartEvent.md +5 -5
  41. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationOptions.md +29 -13
  42. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationResult.md +6 -6
  43. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageCompletion.md +13 -13
  44. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md +33 -17
  45. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageStream.md +5 -5
  46. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelReference.md +3 -3
  47. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelRequestOptions.md +24 -4
  48. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +3 -3
  49. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +30 -8
  50. package/data/packages/platform-intelligence/api/Interface.IIntelligenceObjectStream.md +5 -5
  51. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +5 -5
  52. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +20 -6
  53. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md +7 -7
  54. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +21 -9
  55. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +174 -10
  56. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +22 -6
  57. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +26 -10
  58. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +4 -4
  59. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +22 -6
  60. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +8 -8
  61. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +29 -13
  62. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +5 -5
  63. package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +25 -9
  64. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolCall.md +4 -4
  65. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolDefinition.md +7 -7
  66. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionEndEvent.md +5 -5
  67. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionStartEvent.md +3 -3
  68. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionOptions.md +24 -8
  69. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionResult.md +8 -8
  70. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionStream.md +9 -9
  71. package/data/packages/platform-intelligence/api/Interface.IIntelligenceUsage.md +161 -4
  72. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +34 -18
  73. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationResult.md +5 -5
  74. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceModelMessage.md +1 -1
  75. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceSchema.md +1 -1
  76. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceCapability.md +1 -1
  77. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceDefaultModels.md +1 -1
  78. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceJsonValue.md +1 -1
  79. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
  80. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderOptions.md +1 -1
  81. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderProbeStatus.md +1 -1
  82. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderToolOptions.md +1 -1
  83. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRequestTimeouts.md +1 -1
  84. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolChoice.md +1 -1
  85. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolOutput.md +1 -1
  86. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolSet.md +1 -1
  87. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md +1 -1
  88. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_API_KEY.md +1 -1
  89. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_BASE_URL.md +1 -1
  90. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_CONFIG_ENTRIES.md +1 -1
  91. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  92. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  93. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  94. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  95. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +1 -1
  96. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  97. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  98. package/data/packages/platform-intelligence/api/Variable.IntelligenceCapabilityNames.md +11 -11
  99. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +2 -2
  100. package/data/packages/platform-intelligence/api/index.md +8 -5
  101. package/data/packages/platform-intelligence/index.md +86 -0
  102. package/package.json +1 -1
  103. package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +0 -140
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderAdapter.md +0 -73
@@ -31,7 +31,7 @@ new IntelligenceRealtimeSessionPort(): IntelligenceRealtimeSessionPort;
31
31
  get abstract connectionId(): string;
32
32
  ```
33
33
 
34
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L17)
34
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L25)
35
35
 
36
36
  ##### Returns
37
37
 
@@ -47,7 +47,7 @@ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:17](https://githu
47
47
  get abstract model(): string;
48
48
  ```
49
49
 
50
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L19)
50
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L27)
51
51
 
52
52
  ##### Returns
53
53
 
@@ -63,7 +63,7 @@ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:19](https://githu
63
63
  get abstract provider(): string;
64
64
  ```
65
65
 
66
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L18)
66
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L26)
67
67
 
68
68
  ##### Returns
69
69
 
@@ -79,7 +79,7 @@ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:18](https://githu
79
79
  get abstract sessionId(): string;
80
80
  ```
81
81
 
82
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L16)
82
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L24)
83
83
 
84
84
  ##### Returns
85
85
 
@@ -95,7 +95,7 @@ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:16](https://githu
95
95
  get abstract status(): IntelligenceRealtimeStatus;
96
96
  ```
97
97
 
98
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L20)
98
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L28)
99
99
 
100
100
  ##### Returns
101
101
 
@@ -112,7 +112,7 @@ abstract addToolOutput(
112
112
  name?): Promise<void>;
113
113
  ```
114
114
 
115
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L55)
115
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L63)
116
116
 
117
117
  Returns a completed function result to the model.
118
118
 
@@ -136,7 +136,7 @@ Returns a completed function result to the model.
136
136
  abstract appendAudio(audio): Promise<void>;
137
137
  ```
138
138
 
139
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L33)
139
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L41)
140
140
 
141
141
  Appends a base64-encoded audio fragment to the upstream input buffer.
142
142
 
@@ -158,7 +158,7 @@ Appends a base64-encoded audio fragment to the upstream input buffer.
158
158
  abstract cancelResponse(): Promise<void>;
159
159
  ```
160
160
 
161
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L52)
161
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L60)
162
162
 
163
163
  Cancels the active model response.
164
164
 
@@ -174,7 +174,7 @@ Cancels the active model response.
174
174
  abstract clearAudio(): Promise<void>;
175
175
  ```
176
176
 
177
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L39)
177
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L47)
178
178
 
179
179
  Clears the provider input audio buffer.
180
180
 
@@ -190,7 +190,7 @@ Clears the provider input audio buffer.
190
190
  abstract close(code?, reason?): Promise<void>;
191
191
  ```
192
192
 
193
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L58)
193
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L66)
194
194
 
195
195
  Gracefully closes the upstream connection and flushes metering events.
196
196
 
@@ -213,7 +213,7 @@ Gracefully closes the upstream connection and flushes metering events.
213
213
  abstract commitAudio(): Promise<void>;
214
214
  ```
215
215
 
216
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L36)
216
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L44)
217
217
 
218
218
  Commits the provider input audio buffer.
219
219
 
@@ -229,7 +229,7 @@ Commits the provider input audio buffer.
229
229
  abstract connect(): Promise<void>;
230
230
  ```
231
231
 
232
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L27)
232
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L35)
233
233
 
234
234
  Opens the upstream provider WebSocket and applies the session configuration.
235
235
 
@@ -245,7 +245,7 @@ Opens the upstream provider WebSocket and applies the session configuration.
245
245
  abstract requestResponse(options?): Promise<void>;
246
246
  ```
247
247
 
248
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L45)
248
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L53)
249
249
 
250
250
  Requests a new model response.
251
251
 
@@ -270,7 +270,7 @@ Requests a new model response.
270
270
  abstract send(event): Promise<void>;
271
271
  ```
272
272
 
273
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L30)
273
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L38)
274
274
 
275
275
  Sends any provider-neutral client event.
276
276
 
@@ -292,7 +292,7 @@ Sends any provider-neutral client event.
292
292
  abstract sendText(text, requestResponse?): Promise<void>;
293
293
  ```
294
294
 
295
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L42)
295
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L50)
296
296
 
297
297
  Sends a text turn and optionally asks the model to respond.
298
298
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceReranker
7
7
 
8
- Defined in: IntelligenceReranker.ts:24
8
+ Defined in: [IntelligenceReranker.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceReranker.ts#L24)
9
9
 
10
10
  Provider-neutral semantic reranking facade.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral semantic reranking facade.
17
17
  new IntelligenceReranker(modelResolver): IntelligenceReranker;
18
18
  ```
19
19
 
20
- Defined in: IntelligenceReranker.ts:33
20
+ Defined in: [IntelligenceReranker.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceReranker.ts#L33)
21
21
 
22
22
  #### Parameters
23
23
 
@@ -37,7 +37,7 @@ Defined in: IntelligenceReranker.ts:33
37
37
  rerank<TDocument>(options): Promise<IIntelligenceRerankingResult<TDocument>>;
38
38
  ```
39
39
 
40
- Defined in: IntelligenceReranker.ts:50
40
+ Defined in: [IntelligenceReranker.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceReranker.ts#L50)
41
41
 
42
42
  Reranks documents by relevance to a query.
43
43
 
@@ -0,0 +1,117 @@
1
+ ---
2
+ title: 'Class: IntelligenceSpeechGenerator'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceSpeechGenerator
7
+
8
+ Defined in: [generators/IntelligenceSpeechGenerator.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceSpeechGenerator.ts#L24)
9
+
10
+ Provider-neutral speech generation facade.
11
+
12
+ ## Extends
13
+
14
+ - `IntelligenceGeneratorBase`
15
+
16
+ ## Constructors
17
+
18
+ ### Constructor
19
+
20
+ ```ts
21
+ new IntelligenceSpeechGenerator(modelResolver): IntelligenceSpeechGenerator;
22
+ ```
23
+
24
+ Defined in: [generators/IntelligenceSpeechGenerator.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceSpeechGenerator.ts#L31)
25
+
26
+ #### Parameters
27
+
28
+ | Parameter | Type |
29
+ | ------ | ------ |
30
+ | `modelResolver` | `IntelligenceModelResolver` |
31
+
32
+ #### Returns
33
+
34
+ `IntelligenceSpeechGenerator`
35
+
36
+ #### Overrides
37
+
38
+ ```ts
39
+ IntelligenceGeneratorBase.constructor
40
+ ```
41
+
42
+ ## Properties
43
+
44
+ ### modelResolver
45
+
46
+ ```ts
47
+ protected readonly modelResolver: IntelligenceModelResolver;
48
+ ```
49
+
50
+ Defined in: [generators/abstracts/IntelligenceGeneratorBase.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/abstracts/IntelligenceGeneratorBase.ts#L19)
51
+
52
+ #### Inherited from
53
+
54
+ ```ts
55
+ IntelligenceGeneratorBase.modelResolver
56
+ ```
57
+
58
+ ## Methods
59
+
60
+ ### createProviderError()
61
+
62
+ ```ts
63
+ protected createProviderError(
64
+ error,
65
+ provider,
66
+ model,
67
+ capability,
68
+ operation,
69
+ requestId,
70
+ startedAt): IntelligenceProviderError;
71
+ ```
72
+
73
+ Defined in: [generators/abstracts/IntelligenceGeneratorBase.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/abstracts/IntelligenceGeneratorBase.ts#L40)
74
+
75
+ #### Parameters
76
+
77
+ | Parameter | Type |
78
+ | ------ | ------ |
79
+ | `error` | `unknown` |
80
+ | `provider` | `string` |
81
+ | `model` | `string` |
82
+ | `capability` | [`IntelligenceCapability`](TypeAlias.IntelligenceCapability) |
83
+ | `operation` | `string` |
84
+ | `requestId` | `string` \| `undefined` |
85
+ | `startedAt` | `number` |
86
+
87
+ #### Returns
88
+
89
+ [`IntelligenceProviderError`](Class.IntelligenceProviderError)
90
+
91
+ #### Inherited from
92
+
93
+ ```ts
94
+ IntelligenceGeneratorBase.createProviderError
95
+ ```
96
+
97
+ ***
98
+
99
+ ### generate()
100
+
101
+ ```ts
102
+ generate(options): Promise<IIntelligenceSpeechGenerationResult>;
103
+ ```
104
+
105
+ Defined in: [generators/IntelligenceSpeechGenerator.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceSpeechGenerator.ts#L48)
106
+
107
+ Generates spoken audio from text.
108
+
109
+ #### Parameters
110
+
111
+ | Parameter | Type |
112
+ | ------ | ------ |
113
+ | `options` | [`IIntelligenceSpeechGenerationOptions`](Interface.IIntelligenceSpeechGenerationOptions) |
114
+
115
+ #### Returns
116
+
117
+ `Promise`\<[`IIntelligenceSpeechGenerationResult`](Interface.IIntelligenceSpeechGenerationResult)\>
@@ -60,7 +60,7 @@ Gets the number of registered tools.
60
60
  get(name): IIntelligenceTool | undefined;
61
61
  ```
62
62
 
63
- Defined in: [IntelligenceToolRegistry.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L85)
63
+ Defined in: [IntelligenceToolRegistry.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L102)
64
64
 
65
65
  Gets a tool by name.
66
66
 
@@ -88,7 +88,7 @@ The tool instance, or `undefined` if not found.
88
88
  has(name): boolean;
89
89
  ```
90
90
 
91
- Defined in: [IntelligenceToolRegistry.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L97)
91
+ Defined in: [IntelligenceToolRegistry.ts:114](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L114)
92
92
 
93
93
  Checks whether a tool with the given name is registered.
94
94
 
@@ -116,7 +116,7 @@ Checks whether a tool with the given name is registered.
116
116
  list(): readonly IIntelligenceTool[];
117
117
  ```
118
118
 
119
- Defined in: [IntelligenceToolRegistry.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L107)
119
+ Defined in: [IntelligenceToolRegistry.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L124)
120
120
 
121
121
  Returns all registered tools as a readonly array.
122
122
 
@@ -138,7 +138,7 @@ Array of all registered tool instances.
138
138
  listNames(): readonly string[];
139
139
  ```
140
140
 
141
- Defined in: [IntelligenceToolRegistry.ts:117](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L117)
141
+ Defined in: [IntelligenceToolRegistry.ts:134](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L134)
142
142
 
143
143
  Returns all registered tool names.
144
144
 
@@ -188,7 +188,7 @@ Tools with duplicate names replace the existing registration.
188
188
  toToolSet(): IntelligenceToolSet;
189
189
  ```
190
190
 
191
- Defined in: [IntelligenceToolRegistry.ts:136](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L136)
191
+ Defined in: [IntelligenceToolRegistry.ts:153](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L153)
192
192
 
193
193
  Converts all registered application tools to an Archipel tool set.
194
194
 
@@ -0,0 +1,139 @@
1
+ ---
2
+ title: 'Class: IntelligenceTranscriptionGenerator'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceTranscriptionGenerator
7
+
8
+ Defined in: [generators/IntelligenceTranscriptionGenerator.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceTranscriptionGenerator.ts#L40)
9
+
10
+ Provider-neutral bounded and streaming transcription facade.
11
+
12
+ ## Extends
13
+
14
+ - `IntelligenceGeneratorBase`
15
+
16
+ ## Constructors
17
+
18
+ ### Constructor
19
+
20
+ ```ts
21
+ new IntelligenceTranscriptionGenerator(modelResolver): IntelligenceTranscriptionGenerator;
22
+ ```
23
+
24
+ Defined in: [generators/IntelligenceTranscriptionGenerator.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceTranscriptionGenerator.ts#L47)
25
+
26
+ #### Parameters
27
+
28
+ | Parameter | Type |
29
+ | ------ | ------ |
30
+ | `modelResolver` | `IntelligenceModelResolver` |
31
+
32
+ #### Returns
33
+
34
+ `IntelligenceTranscriptionGenerator`
35
+
36
+ #### Overrides
37
+
38
+ ```ts
39
+ IntelligenceGeneratorBase.constructor
40
+ ```
41
+
42
+ ## Properties
43
+
44
+ ### modelResolver
45
+
46
+ ```ts
47
+ protected readonly modelResolver: IntelligenceModelResolver;
48
+ ```
49
+
50
+ Defined in: [generators/abstracts/IntelligenceGeneratorBase.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/abstracts/IntelligenceGeneratorBase.ts#L19)
51
+
52
+ #### Inherited from
53
+
54
+ ```ts
55
+ IntelligenceGeneratorBase.modelResolver
56
+ ```
57
+
58
+ ## Methods
59
+
60
+ ### createProviderError()
61
+
62
+ ```ts
63
+ protected createProviderError(
64
+ error,
65
+ provider,
66
+ model,
67
+ capability,
68
+ operation,
69
+ requestId,
70
+ startedAt): IntelligenceProviderError;
71
+ ```
72
+
73
+ Defined in: [generators/abstracts/IntelligenceGeneratorBase.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/abstracts/IntelligenceGeneratorBase.ts#L40)
74
+
75
+ #### Parameters
76
+
77
+ | Parameter | Type |
78
+ | ------ | ------ |
79
+ | `error` | `unknown` |
80
+ | `provider` | `string` |
81
+ | `model` | `string` |
82
+ | `capability` | [`IntelligenceCapability`](TypeAlias.IntelligenceCapability) |
83
+ | `operation` | `string` |
84
+ | `requestId` | `string` \| `undefined` |
85
+ | `startedAt` | `number` |
86
+
87
+ #### Returns
88
+
89
+ [`IntelligenceProviderError`](Class.IntelligenceProviderError)
90
+
91
+ #### Inherited from
92
+
93
+ ```ts
94
+ IntelligenceGeneratorBase.createProviderError
95
+ ```
96
+
97
+ ***
98
+
99
+ ### stream()
100
+
101
+ ```ts
102
+ stream(options): Promise<IIntelligenceTranscriptionStream>;
103
+ ```
104
+
105
+ Defined in: [generators/IntelligenceTranscriptionGenerator.ts:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceTranscriptionGenerator.ts#L106)
106
+
107
+ Streams incremental and final transcripts from live raw audio.
108
+
109
+ #### Parameters
110
+
111
+ | Parameter | Type |
112
+ | ------ | ------ |
113
+ | `options` | [`IIntelligenceStreamingTranscriptionOptions`](Interface.IIntelligenceStreamingTranscriptionOptions) |
114
+
115
+ #### Returns
116
+
117
+ `Promise`\<[`IIntelligenceTranscriptionStream`](Interface.IIntelligenceTranscriptionStream)\>
118
+
119
+ ***
120
+
121
+ ### transcribe()
122
+
123
+ ```ts
124
+ transcribe(options): Promise<IIntelligenceTranscriptionResult>;
125
+ ```
126
+
127
+ Defined in: [generators/IntelligenceTranscriptionGenerator.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceTranscriptionGenerator.ts#L64)
128
+
129
+ Transcribes bounded audio input.
130
+
131
+ #### Parameters
132
+
133
+ | Parameter | Type |
134
+ | ------ | ------ |
135
+ | `options` | [`IIntelligenceTranscriptionOptions`](Interface.IIntelligenceTranscriptionOptions) |
136
+
137
+ #### Returns
138
+
139
+ `Promise`\<[`IIntelligenceTranscriptionResult`](Interface.IIntelligenceTranscriptionResult)\>
@@ -0,0 +1,117 @@
1
+ ---
2
+ title: 'Class: IntelligenceVideoGenerator'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceVideoGenerator
7
+
8
+ Defined in: [generators/IntelligenceVideoGenerator.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceVideoGenerator.ts#L24)
9
+
10
+ Provider-neutral video generation facade.
11
+
12
+ ## Extends
13
+
14
+ - `IntelligenceGeneratorBase`
15
+
16
+ ## Constructors
17
+
18
+ ### Constructor
19
+
20
+ ```ts
21
+ new IntelligenceVideoGenerator(modelResolver): IntelligenceVideoGenerator;
22
+ ```
23
+
24
+ Defined in: [generators/IntelligenceVideoGenerator.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceVideoGenerator.ts#L31)
25
+
26
+ #### Parameters
27
+
28
+ | Parameter | Type |
29
+ | ------ | ------ |
30
+ | `modelResolver` | `IntelligenceModelResolver` |
31
+
32
+ #### Returns
33
+
34
+ `IntelligenceVideoGenerator`
35
+
36
+ #### Overrides
37
+
38
+ ```ts
39
+ IntelligenceGeneratorBase.constructor
40
+ ```
41
+
42
+ ## Properties
43
+
44
+ ### modelResolver
45
+
46
+ ```ts
47
+ protected readonly modelResolver: IntelligenceModelResolver;
48
+ ```
49
+
50
+ Defined in: [generators/abstracts/IntelligenceGeneratorBase.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/abstracts/IntelligenceGeneratorBase.ts#L19)
51
+
52
+ #### Inherited from
53
+
54
+ ```ts
55
+ IntelligenceGeneratorBase.modelResolver
56
+ ```
57
+
58
+ ## Methods
59
+
60
+ ### createProviderError()
61
+
62
+ ```ts
63
+ protected createProviderError(
64
+ error,
65
+ provider,
66
+ model,
67
+ capability,
68
+ operation,
69
+ requestId,
70
+ startedAt): IntelligenceProviderError;
71
+ ```
72
+
73
+ Defined in: [generators/abstracts/IntelligenceGeneratorBase.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/abstracts/IntelligenceGeneratorBase.ts#L40)
74
+
75
+ #### Parameters
76
+
77
+ | Parameter | Type |
78
+ | ------ | ------ |
79
+ | `error` | `unknown` |
80
+ | `provider` | `string` |
81
+ | `model` | `string` |
82
+ | `capability` | [`IntelligenceCapability`](TypeAlias.IntelligenceCapability) |
83
+ | `operation` | `string` |
84
+ | `requestId` | `string` \| `undefined` |
85
+ | `startedAt` | `number` |
86
+
87
+ #### Returns
88
+
89
+ [`IntelligenceProviderError`](Class.IntelligenceProviderError)
90
+
91
+ #### Inherited from
92
+
93
+ ```ts
94
+ IntelligenceGeneratorBase.createProviderError
95
+ ```
96
+
97
+ ***
98
+
99
+ ### generate()
100
+
101
+ ```ts
102
+ generate(options): Promise<IIntelligenceVideoGenerationResult>;
103
+ ```
104
+
105
+ Defined in: [generators/IntelligenceVideoGenerator.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceVideoGenerator.ts#L48)
106
+
107
+ Generates one or more videos.
108
+
109
+ #### Parameters
110
+
111
+ | Parameter | Type |
112
+ | ------ | ------ |
113
+ | `options` | [`IIntelligenceVideoGenerationOptions`](Interface.IIntelligenceVideoGenerationOptions) |
114
+
115
+ #### Returns
116
+
117
+ `Promise`\<[`IIntelligenceVideoGenerationResult`](Interface.IIntelligenceVideoGenerationResult)\>