@breadstone/archipel-mcp 0.0.55 → 0.0.57

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 +92 -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
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceLanguageGenerationOptions
7
7
 
8
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:17
8
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L17)
9
9
 
10
10
  Provider-neutral language generation controls.
11
11
 
@@ -21,7 +21,7 @@ Provider-neutral language generation controls.
21
21
  readonly optional abortSignal?: AbortSignal;
22
22
  ```
23
23
 
24
- Defined in: contracts/IIntelligenceRequestOptions.ts:16
24
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L16)
25
25
 
26
26
  Caller-driven cancellation signal.
27
27
 
@@ -37,7 +37,7 @@ Caller-driven cancellation signal.
37
37
  readonly optional activeToolNames?: readonly string[];
38
38
  ```
39
39
 
40
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:26
40
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L26)
41
41
 
42
42
  ***
43
43
 
@@ -47,7 +47,7 @@ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:26
47
47
  readonly optional headers?: Readonly<Record<string, string>>;
48
48
  ```
49
49
 
50
- Defined in: contracts/IIntelligenceRequestOptions.ts:19
50
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L19)
51
51
 
52
52
  Additional outbound request headers.
53
53
 
@@ -63,7 +63,7 @@ Additional outbound request headers.
63
63
  readonly optional maxOutputTokens?: number;
64
64
  ```
65
65
 
66
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:22
66
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L22)
67
67
 
68
68
  ***
69
69
 
@@ -73,7 +73,7 @@ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:22
73
73
  readonly optional maxRetries?: number;
74
74
  ```
75
75
 
76
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:23
76
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L23)
77
77
 
78
78
  ***
79
79
 
@@ -83,7 +83,7 @@ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:23
83
83
  readonly optional maxSteps?: number;
84
84
  ```
85
85
 
86
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:27
86
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L27)
87
87
 
88
88
  ***
89
89
 
@@ -93,7 +93,7 @@ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:27
93
93
  readonly optional model?: IIntelligenceModelReference;
94
94
  ```
95
95
 
96
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
96
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
97
97
 
98
98
  Optional provider/model override.
99
99
 
@@ -109,7 +109,7 @@ Optional provider/model override.
109
109
  readonly optional onStepStart?: (event) => void | Promise<void>;
110
110
  ```
111
111
 
112
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:28
112
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L28)
113
113
 
114
114
  #### Parameters
115
115
 
@@ -129,7 +129,7 @@ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:28
129
129
  readonly optional onToolExecutionEnd?: (event) => void | Promise<void>;
130
130
  ```
131
131
 
132
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:30
132
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L30)
133
133
 
134
134
  #### Parameters
135
135
 
@@ -149,7 +149,7 @@ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:30
149
149
  readonly optional onToolExecutionStart?: (event) => void | Promise<void>;
150
150
  ```
151
151
 
152
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:29
152
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L29)
153
153
 
154
154
  #### Parameters
155
155
 
@@ -169,7 +169,7 @@ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:29
169
169
  readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
170
170
  ```
171
171
 
172
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
172
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
173
173
 
174
174
  Optional provider-specific settings.
175
175
 
@@ -179,13 +179,29 @@ Optional provider-specific settings.
179
179
 
180
180
  ***
181
181
 
182
+ ### requestId?
183
+
184
+ ```ts
185
+ readonly optional requestId?: string;
186
+ ```
187
+
188
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
189
+
190
+ Correlation identifier included in structured Archipel logs.
191
+
192
+ #### Inherited from
193
+
194
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`requestId`](Interface.IIntelligenceRequestOptions#requestid)
195
+
196
+ ***
197
+
182
198
  ### temperature?
183
199
 
184
200
  ```ts
185
201
  readonly optional temperature?: number;
186
202
  ```
187
203
 
188
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:20
204
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L20)
189
205
 
190
206
  ***
191
207
 
@@ -195,7 +211,7 @@ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:20
195
211
  readonly optional timeoutMs?: number;
196
212
  ```
197
213
 
198
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
214
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
199
215
 
200
216
  Total provider-operation timeout in milliseconds.
201
217
 
@@ -211,7 +227,7 @@ Total provider-operation timeout in milliseconds.
211
227
  readonly optional toolChoice?: IntelligenceToolChoice;
212
228
  ```
213
229
 
214
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:25
230
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L25)
215
231
 
216
232
  ***
217
233
 
@@ -221,7 +237,7 @@ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:25
221
237
  readonly optional tools?: Readonly<Record<string, IIntelligenceToolDefinition<unknown, unknown>>>;
222
238
  ```
223
239
 
224
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:24
240
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L24)
225
241
 
226
242
  ***
227
243
 
@@ -231,4 +247,4 @@ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:24
231
247
  readonly optional topP?: number;
232
248
  ```
233
249
 
234
- Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:21
250
+ Defined in: [contracts/IIntelligenceLanguageGenerationOptions.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageGenerationOptions.ts#L21)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceLanguageStream
7
7
 
8
- Defined in: contracts/IIntelligenceLanguageStream.ts:12
8
+ Defined in: [contracts/IIntelligenceLanguageStream.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageStream.ts#L12)
9
9
 
10
10
  Provider-neutral text stream.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral text stream.
17
17
  readonly finishReason: PromiseLike<string>;
18
18
  ```
19
19
 
20
- Defined in: contracts/IIntelligenceLanguageStream.ts:17
20
+ Defined in: [contracts/IIntelligenceLanguageStream.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageStream.ts#L17)
21
21
 
22
22
  ***
23
23
 
@@ -27,7 +27,7 @@ Defined in: contracts/IIntelligenceLanguageStream.ts:17
27
27
  readonly text: PromiseLike<string>;
28
28
  ```
29
29
 
30
- Defined in: contracts/IIntelligenceLanguageStream.ts:16
30
+ Defined in: [contracts/IIntelligenceLanguageStream.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageStream.ts#L16)
31
31
 
32
32
  ***
33
33
 
@@ -37,7 +37,7 @@ Defined in: contracts/IIntelligenceLanguageStream.ts:16
37
37
  readonly textStream: AsyncIterable<string>;
38
38
  ```
39
39
 
40
- Defined in: contracts/IIntelligenceLanguageStream.ts:15
40
+ Defined in: [contracts/IIntelligenceLanguageStream.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageStream.ts#L15)
41
41
 
42
42
  ***
43
43
 
@@ -47,4 +47,4 @@ Defined in: contracts/IIntelligenceLanguageStream.ts:15
47
47
  readonly usage: PromiseLike<IIntelligenceUsage | null>;
48
48
  ```
49
49
 
50
- Defined in: contracts/IIntelligenceLanguageStream.ts:18
50
+ Defined in: [contracts/IIntelligenceLanguageStream.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceLanguageStream.ts#L18)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceModelReference
7
7
 
8
- Defined in: contracts/IIntelligenceModelReference.ts:6
8
+ Defined in: [contracts/IIntelligenceModelReference.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelReference.ts#L6)
9
9
 
10
10
  Selects a provider-owned model without exposing a provider SDK model object.
11
11
 
@@ -17,7 +17,7 @@ Selects a provider-owned model without exposing a provider SDK model object.
17
17
  readonly optional model?: string;
18
18
  ```
19
19
 
20
- Defined in: contracts/IIntelligenceModelReference.ts:13
20
+ Defined in: [contracts/IIntelligenceModelReference.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelReference.ts#L13)
21
21
 
22
22
  Provider model identifier.
23
23
 
@@ -29,6 +29,6 @@ Provider model identifier.
29
29
  readonly optional provider?: string;
30
30
  ```
31
31
 
32
- Defined in: contracts/IIntelligenceModelReference.ts:10
32
+ Defined in: [contracts/IIntelligenceModelReference.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelReference.ts#L10)
33
33
 
34
34
  Provider registered with [IntelligenceModule](Class.IntelligenceModule).
@@ -5,10 +5,18 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceModelRequestOptions
7
7
 
8
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:13
8
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L20)
9
9
 
10
10
  Shared provider/model controls for intelligence operations.
11
11
 
12
+ ## Remarks
13
+
14
+ Provider APIs do not expose one portable idempotency-key contract across all
15
+ capabilities. A provider operation can therefore be billed or materialize an
16
+ asset more than once after ambiguous transport failure. Consumers must
17
+ deduplicate the owning business operation and persist usage or generated
18
+ assets idempotently.
19
+
12
20
  ## Extended by
13
21
 
14
22
  - [`IIntelligenceFileUploadOptions`](Interface.IIntelligenceFileUploadOptions)
@@ -23,7 +31,7 @@ Shared provider/model controls for intelligence operations.
23
31
  readonly optional model?: IIntelligenceModelReference;
24
32
  ```
25
33
 
26
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
34
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
27
35
 
28
36
  Optional provider/model override.
29
37
 
@@ -35,18 +43,30 @@ Optional provider/model override.
35
43
  readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
36
44
  ```
37
45
 
38
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
46
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
39
47
 
40
48
  Optional provider-specific settings.
41
49
 
42
50
  ***
43
51
 
52
+ ### requestId?
53
+
54
+ ```ts
55
+ readonly optional requestId?: string;
56
+ ```
57
+
58
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
59
+
60
+ Correlation identifier included in structured Archipel logs.
61
+
62
+ ***
63
+
44
64
  ### timeoutMs?
45
65
 
46
66
  ```ts
47
67
  readonly optional timeoutMs?: number;
48
68
  ```
49
69
 
50
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
70
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
51
71
 
52
72
  Total provider-operation timeout in milliseconds.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceModelStatus
7
7
 
8
- Defined in: contracts/IIntelligenceModelStatus.ts:6
8
+ Defined in: [contracts/IIntelligenceModelStatus.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelStatus.ts#L6)
9
9
 
10
10
  Safe resolved model status that never includes credentials.
11
11
 
@@ -17,7 +17,7 @@ Safe resolved model status that never includes credentials.
17
17
  readonly model: string;
18
18
  ```
19
19
 
20
- Defined in: contracts/IIntelligenceModelStatus.ts:10
20
+ Defined in: [contracts/IIntelligenceModelStatus.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelStatus.ts#L10)
21
21
 
22
22
  ***
23
23
 
@@ -27,4 +27,4 @@ Defined in: contracts/IIntelligenceModelStatus.ts:10
27
27
  readonly provider: string;
28
28
  ```
29
29
 
30
- Defined in: contracts/IIntelligenceModelStatus.ts:9
30
+ Defined in: [contracts/IIntelligenceModelStatus.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelStatus.ts#L9)
@@ -29,7 +29,7 @@ Provider-specific configuration entries to register with the config module.
29
29
  readonly optional defaultModels?: Readonly<Partial<Record<IntelligenceCapability, IIntelligenceModelReference>>>;
30
30
  ```
31
31
 
32
- Defined in: [interfaces/IIntelligenceModuleOptions.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L40)
32
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L44)
33
33
 
34
34
  Capability-specific default provider and model references.
35
35
 
@@ -41,7 +41,7 @@ Capability-specific default provider and model references.
41
41
  readonly optional isGlobal?: boolean;
42
42
  ```
43
43
 
44
- Defined in: [interfaces/IIntelligenceModuleOptions.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L64)
44
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L79)
45
45
 
46
46
  When `true` the module is registered globally.
47
47
 
@@ -53,7 +53,7 @@ When `true` the module is registered globally.
53
53
  readonly optional promptPolicyAdapter?: Type<IntelligencePromptPolicyPort>;
54
54
  ```
55
55
 
56
- Defined in: [interfaces/IIntelligenceModuleOptions.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L57)
56
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L72)
57
57
 
58
58
  Optional application policy adapter for provider-neutral prompt requirements.
59
59
 
@@ -62,12 +62,34 @@ Optional application policy adapter for provider-neutral prompt requirements.
62
62
  ### providerAdapters?
63
63
 
64
64
  ```ts
65
- readonly optional providerAdapters?: readonly IIntelligenceProviderAdapter[];
65
+ readonly optional providerAdapters?: readonly Type<IntelligenceProviderAdapterPort>[];
66
66
  ```
67
67
 
68
- Defined in: [interfaces/IIntelligenceModuleOptions.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L37)
68
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L41)
69
69
 
70
- Provider adapters imported from tree-shakable provider subpaths.
70
+ Injectable provider adapter classes imported from tree-shakable provider subpaths.
71
+
72
+ ***
73
+
74
+ ### providerRequestTimeoutMs?
75
+
76
+ ```ts
77
+ readonly optional providerRequestTimeoutMs?: number;
78
+ ```
79
+
80
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L58)
81
+
82
+ Maximum duration of one outbound provider request.
83
+
84
+ Long-running operations such as video generation use multiple bounded
85
+ provider requests under their capability-specific total timeout.
86
+
87
+ #### Default Value
88
+
89
+ ```ts
90
+ 5000
91
+ @public
92
+ ```
71
93
 
72
94
  ***
73
95
 
@@ -77,7 +99,7 @@ Provider adapters imported from tree-shakable provider subpaths.
77
99
  readonly optional realtime?: IIntelligenceRealtimeModuleOptions;
78
100
  ```
79
101
 
80
- Defined in: [interfaces/IIntelligenceModuleOptions.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L50)
102
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L65)
81
103
 
82
104
  Server-owned realtime model sessions, resilience limits, and metering.
83
105
 
@@ -89,7 +111,7 @@ Server-owned realtime model sessions, resilience limits, and metering.
89
111
  readonly optional requestTimeouts?: Readonly<Partial<Record<IntelligenceCapability, number>>>;
90
112
  ```
91
113
 
92
- Defined in: [interfaces/IIntelligenceModuleOptions.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L43)
114
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L47)
93
115
 
94
116
  Capability-specific total request timeout overrides.
95
117
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceObjectStream\<T\>
7
7
 
8
- Defined in: contracts/IIntelligenceObjectStream.ts:12
8
+ Defined in: [contracts/IIntelligenceObjectStream.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceObjectStream.ts#L12)
9
9
 
10
10
  Provider-neutral structured-output stream.
11
11
 
@@ -23,7 +23,7 @@ Provider-neutral structured-output stream.
23
23
  readonly finishReason: PromiseLike<string>;
24
24
  ```
25
25
 
26
- Defined in: contracts/IIntelligenceObjectStream.ts:17
26
+ Defined in: [contracts/IIntelligenceObjectStream.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceObjectStream.ts#L17)
27
27
 
28
28
  ***
29
29
 
@@ -33,7 +33,7 @@ Defined in: contracts/IIntelligenceObjectStream.ts:17
33
33
  readonly output: PromiseLike<T>;
34
34
  ```
35
35
 
36
- Defined in: contracts/IIntelligenceObjectStream.ts:16
36
+ Defined in: [contracts/IIntelligenceObjectStream.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceObjectStream.ts#L16)
37
37
 
38
38
  ***
39
39
 
@@ -43,7 +43,7 @@ Defined in: contracts/IIntelligenceObjectStream.ts:16
43
43
  readonly partialOutputStream: AsyncIterable<Partial<T>>;
44
44
  ```
45
45
 
46
- Defined in: contracts/IIntelligenceObjectStream.ts:15
46
+ Defined in: [contracts/IIntelligenceObjectStream.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceObjectStream.ts#L15)
47
47
 
48
48
  ***
49
49
 
@@ -53,4 +53,4 @@ Defined in: contracts/IIntelligenceObjectStream.ts:15
53
53
  readonly usage: PromiseLike<IIntelligenceUsage | null>;
54
54
  ```
55
55
 
56
- Defined in: contracts/IIntelligenceObjectStream.ts:18
56
+ Defined in: [contracts/IIntelligenceObjectStream.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceObjectStream.ts#L18)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligencePrompt
7
7
 
8
- Defined in: contracts/IIntelligencePrompt.ts:12
8
+ Defined in: [contracts/IIntelligencePrompt.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L12)
9
9
 
10
10
  Provider-neutral language-model prompt.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral language-model prompt.
17
17
  readonly optional instructions?: string;
18
18
  ```
19
19
 
20
- Defined in: contracts/IIntelligencePrompt.ts:15
20
+ Defined in: [contracts/IIntelligencePrompt.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L15)
21
21
 
22
22
  ***
23
23
 
@@ -27,7 +27,7 @@ Defined in: contracts/IIntelligencePrompt.ts:15
27
27
  readonly optional messages?: readonly IIntelligenceModelMessage[];
28
28
  ```
29
29
 
30
- Defined in: contracts/IIntelligencePrompt.ts:18
30
+ Defined in: [contracts/IIntelligencePrompt.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L18)
31
31
 
32
32
  ***
33
33
 
@@ -37,7 +37,7 @@ Defined in: contracts/IIntelligencePrompt.ts:18
37
37
  readonly optional prompt?: string;
38
38
  ```
39
39
 
40
- Defined in: contracts/IIntelligencePrompt.ts:17
40
+ Defined in: [contracts/IIntelligencePrompt.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L17)
41
41
 
42
42
  ***
43
43
 
@@ -47,4 +47,4 @@ Defined in: contracts/IIntelligencePrompt.ts:17
47
47
  readonly optional system?: string;
48
48
  ```
49
49
 
50
- Defined in: contracts/IIntelligencePrompt.ts:16
50
+ Defined in: [contracts/IIntelligencePrompt.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L16)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceProviderLoadRequest
7
7
 
8
- Defined in: providers/IIntelligenceProviderLoadRequest.ts:13
8
+ Defined in: [providers/IIntelligenceProviderLoadRequest.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IIntelligenceProviderLoadRequest.ts#L13)
9
9
 
10
10
  Internal model/API load request passed to a provider adapter.
11
11
 
@@ -17,7 +17,7 @@ Internal model/API load request passed to a provider adapter.
17
17
  readonly capability: IntelligenceCapability;
18
18
  ```
19
19
 
20
- Defined in: providers/IIntelligenceProviderLoadRequest.ts:16
20
+ Defined in: [providers/IIntelligenceProviderLoadRequest.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IIntelligenceProviderLoadRequest.ts#L16)
21
21
 
22
22
  ***
23
23
 
@@ -27,14 +27,28 @@ Defined in: providers/IIntelligenceProviderLoadRequest.ts:16
27
27
  readonly configuration: IIntelligenceProviderConfiguration;
28
28
  ```
29
29
 
30
- Defined in: providers/IIntelligenceProviderLoadRequest.ts:17
30
+ Defined in: [providers/IIntelligenceProviderLoadRequest.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IIntelligenceProviderLoadRequest.ts#L17)
31
31
 
32
32
  ***
33
33
 
34
- ### requestTimeoutMs
34
+ ### operationTimeoutMs
35
35
 
36
36
  ```ts
37
- readonly requestTimeoutMs: number;
37
+ readonly operationTimeoutMs: number;
38
38
  ```
39
39
 
40
- Defined in: providers/IIntelligenceProviderLoadRequest.ts:18
40
+ Defined in: [providers/IIntelligenceProviderLoadRequest.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IIntelligenceProviderLoadRequest.ts#L19)
41
+
42
+ Total timeout for the complete capability operation, including retries and polling.
43
+
44
+ ***
45
+
46
+ ### providerRequestTimeoutMs
47
+
48
+ ```ts
49
+ readonly providerRequestTimeoutMs: number;
50
+ ```
51
+
52
+ Defined in: [providers/IIntelligenceProviderLoadRequest.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IIntelligenceProviderLoadRequest.ts#L22)
53
+
54
+ Timeout for one outbound provider request.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceProviderProbeResult
7
7
 
8
- Defined in: contracts/IIntelligenceProviderProbeResult.ts:13
8
+ Defined in: [contracts/IIntelligenceProviderProbeResult.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderProbeResult.ts#L13)
9
9
 
10
10
  Provider-neutral result of a bounded provider availability probe.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral result of a bounded provider availability probe.
17
17
  readonly capability: IntelligenceCapability;
18
18
  ```
19
19
 
20
- Defined in: contracts/IIntelligenceProviderProbeResult.ts:19
20
+ Defined in: [contracts/IIntelligenceProviderProbeResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderProbeResult.ts#L19)
21
21
 
22
22
  ***
23
23
 
@@ -27,7 +27,7 @@ Defined in: contracts/IIntelligenceProviderProbeResult.ts:19
27
27
  readonly checkedAt: Date;
28
28
  ```
29
29
 
30
- Defined in: contracts/IIntelligenceProviderProbeResult.ts:20
30
+ Defined in: [contracts/IIntelligenceProviderProbeResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderProbeResult.ts#L20)
31
31
 
32
32
  ***
33
33
 
@@ -37,7 +37,7 @@ Defined in: contracts/IIntelligenceProviderProbeResult.ts:20
37
37
  readonly failureCode: string | null;
38
38
  ```
39
39
 
40
- Defined in: contracts/IIntelligenceProviderProbeResult.ts:21
40
+ Defined in: [contracts/IIntelligenceProviderProbeResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderProbeResult.ts#L21)
41
41
 
42
42
  ***
43
43
 
@@ -47,7 +47,7 @@ Defined in: contracts/IIntelligenceProviderProbeResult.ts:21
47
47
  readonly model: string;
48
48
  ```
49
49
 
50
- Defined in: contracts/IIntelligenceProviderProbeResult.ts:18
50
+ Defined in: [contracts/IIntelligenceProviderProbeResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderProbeResult.ts#L18)
51
51
 
52
52
  ***
53
53
 
@@ -57,7 +57,7 @@ Defined in: contracts/IIntelligenceProviderProbeResult.ts:18
57
57
  readonly provider: string;
58
58
  ```
59
59
 
60
- Defined in: contracts/IIntelligenceProviderProbeResult.ts:17
60
+ Defined in: [contracts/IIntelligenceProviderProbeResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderProbeResult.ts#L17)
61
61
 
62
62
  ***
63
63
 
@@ -67,4 +67,4 @@ Defined in: contracts/IIntelligenceProviderProbeResult.ts:17
67
67
  readonly status: IntelligenceProviderProbeStatus;
68
68
  ```
69
69
 
70
- Defined in: contracts/IIntelligenceProviderProbeResult.ts:16
70
+ Defined in: [contracts/IIntelligenceProviderProbeResult.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderProbeResult.ts#L16)