@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: IIntelligenceTranscriptionStream
7
7
 
8
- Defined in: contracts/IIntelligenceTranscriptionStream.ts:15
8
+ Defined in: [contracts/IIntelligenceTranscriptionStream.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTranscriptionStream.ts#L15)
9
9
 
10
10
  Provider-neutral live transcription result.
11
11
 
@@ -20,7 +20,7 @@ when both incremental and final output are required.
20
20
  readonly durationInSeconds: PromiseLike<number | undefined>;
21
21
  ```
22
22
 
23
- Defined in: contracts/IIntelligenceTranscriptionStream.ts:30
23
+ Defined in: [contracts/IIntelligenceTranscriptionStream.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTranscriptionStream.ts#L30)
24
24
 
25
25
  ***
26
26
 
@@ -30,7 +30,7 @@ Defined in: contracts/IIntelligenceTranscriptionStream.ts:30
30
30
  readonly fullStream: AsyncIterable<IntelligenceTranscriptionStreamPart>;
31
31
  ```
32
32
 
33
- Defined in: contracts/IIntelligenceTranscriptionStream.ts:20
33
+ Defined in: [contracts/IIntelligenceTranscriptionStream.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTranscriptionStream.ts#L20)
34
34
 
35
35
  ***
36
36
 
@@ -40,7 +40,7 @@ Defined in: contracts/IIntelligenceTranscriptionStream.ts:20
40
40
  readonly language: PromiseLike<string | undefined>;
41
41
  ```
42
42
 
43
- Defined in: contracts/IIntelligenceTranscriptionStream.ts:29
43
+ Defined in: [contracts/IIntelligenceTranscriptionStream.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTranscriptionStream.ts#L29)
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ Defined in: contracts/IIntelligenceTranscriptionStream.ts:29
50
50
  readonly model: string;
51
51
  ```
52
52
 
53
- Defined in: contracts/IIntelligenceTranscriptionStream.ts:19
53
+ Defined in: [contracts/IIntelligenceTranscriptionStream.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTranscriptionStream.ts#L19)
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ Defined in: contracts/IIntelligenceTranscriptionStream.ts:19
60
60
  readonly provider: string;
61
61
  ```
62
62
 
63
- Defined in: contracts/IIntelligenceTranscriptionStream.ts:18
63
+ Defined in: [contracts/IIntelligenceTranscriptionStream.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTranscriptionStream.ts#L18)
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ readonly segments: PromiseLike<readonly {
74
74
  }[]>;
75
75
  ```
76
76
 
77
- Defined in: contracts/IIntelligenceTranscriptionStream.ts:22
77
+ Defined in: [contracts/IIntelligenceTranscriptionStream.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTranscriptionStream.ts#L22)
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ Defined in: contracts/IIntelligenceTranscriptionStream.ts:22
84
84
  readonly text: PromiseLike<string>;
85
85
  ```
86
86
 
87
- Defined in: contracts/IIntelligenceTranscriptionStream.ts:21
87
+ Defined in: [contracts/IIntelligenceTranscriptionStream.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTranscriptionStream.ts#L21)
88
88
 
89
89
  ***
90
90
 
@@ -94,4 +94,4 @@ Defined in: contracts/IIntelligenceTranscriptionStream.ts:21
94
94
  readonly warnings: PromiseLike<readonly string[]>;
95
95
  ```
96
96
 
97
- Defined in: contracts/IIntelligenceTranscriptionStream.ts:31
97
+ Defined in: [contracts/IIntelligenceTranscriptionStream.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTranscriptionStream.ts#L31)
@@ -5,19 +5,160 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceUsage
7
7
 
8
- Defined in: contracts/IIntelligenceUsage.ts:6
8
+ Defined in: [contracts/IIntelligenceUsage.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L9)
9
9
 
10
10
  Provider-neutral usage counters.
11
11
 
12
+ Null values mean that a provider did not report the dimension. Consumers
13
+ must not interpret missing counters as zero usage.
14
+
15
+ ## Extended by
16
+
17
+ - [`IIntelligenceRealtimeUsage`](Interface.IIntelligenceRealtimeUsage)
18
+
12
19
  ## Properties
13
20
 
21
+ ### cachedInputAudioTokens
22
+
23
+ ```ts
24
+ readonly cachedInputAudioTokens: number | null;
25
+ ```
26
+
27
+ Defined in: [contracts/IIntelligenceUsage.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L27)
28
+
29
+ Cached input tokens attributed to audio.
30
+
31
+ ***
32
+
33
+ ### cachedInputImageTokens
34
+
35
+ ```ts
36
+ readonly cachedInputImageTokens: number | null;
37
+ ```
38
+
39
+ Defined in: [contracts/IIntelligenceUsage.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L25)
40
+
41
+ Cached input tokens attributed to images.
42
+
43
+ ***
44
+
45
+ ### cachedInputTextTokens
46
+
47
+ ```ts
48
+ readonly cachedInputTextTokens: number | null;
49
+ ```
50
+
51
+ Defined in: [contracts/IIntelligenceUsage.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L23)
52
+
53
+ Cached input tokens attributed to text.
54
+
55
+ ***
56
+
57
+ ### cachedInputTokens
58
+
59
+ ```ts
60
+ readonly cachedInputTokens: number | null;
61
+ ```
62
+
63
+ Defined in: [contracts/IIntelligenceUsage.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L19)
64
+
65
+ Input tokens read from a provider cache.
66
+
67
+ ***
68
+
69
+ ### cacheWriteInputTokens
70
+
71
+ ```ts
72
+ readonly cacheWriteInputTokens: number | null;
73
+ ```
74
+
75
+ Defined in: [contracts/IIntelligenceUsage.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L21)
76
+
77
+ Input tokens written to a provider cache.
78
+
79
+ ***
80
+
81
+ ### inputAudioTokens
82
+
83
+ ```ts
84
+ readonly inputAudioTokens: number | null;
85
+ ```
86
+
87
+ Defined in: [contracts/IIntelligenceUsage.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L33)
88
+
89
+ Input tokens attributed to audio.
90
+
91
+ ***
92
+
93
+ ### inputImageTokens
94
+
95
+ ```ts
96
+ readonly inputImageTokens: number | null;
97
+ ```
98
+
99
+ Defined in: [contracts/IIntelligenceUsage.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L31)
100
+
101
+ Input tokens attributed to images.
102
+
103
+ ***
104
+
105
+ ### inputTextTokens
106
+
107
+ ```ts
108
+ readonly inputTextTokens: number | null;
109
+ ```
110
+
111
+ Defined in: [contracts/IIntelligenceUsage.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L29)
112
+
113
+ Input tokens attributed to text.
114
+
115
+ ***
116
+
14
117
  ### inputTokens
15
118
 
16
119
  ```ts
17
120
  readonly inputTokens: number | null;
18
121
  ```
19
122
 
20
- Defined in: contracts/IIntelligenceUsage.ts:9
123
+ Defined in: [contracts/IIntelligenceUsage.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L13)
124
+
125
+ All uncached and cached input tokens reported for the operation.
126
+
127
+ ***
128
+
129
+ ### outputAudioTokens
130
+
131
+ ```ts
132
+ readonly outputAudioTokens: number | null;
133
+ ```
134
+
135
+ Defined in: [contracts/IIntelligenceUsage.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L39)
136
+
137
+ Output tokens attributed to generated audio.
138
+
139
+ ***
140
+
141
+ ### outputImageTokens
142
+
143
+ ```ts
144
+ readonly outputImageTokens: number | null;
145
+ ```
146
+
147
+ Defined in: [contracts/IIntelligenceUsage.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L37)
148
+
149
+ Output tokens attributed to generated images.
150
+
151
+ ***
152
+
153
+ ### outputTextTokens
154
+
155
+ ```ts
156
+ readonly outputTextTokens: number | null;
157
+ ```
158
+
159
+ Defined in: [contracts/IIntelligenceUsage.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L35)
160
+
161
+ Output tokens attributed to text, including reasoning when the provider does so.
21
162
 
22
163
  ***
23
164
 
@@ -27,7 +168,21 @@ Defined in: contracts/IIntelligenceUsage.ts:9
27
168
  readonly outputTokens: number | null;
28
169
  ```
29
170
 
30
- Defined in: contracts/IIntelligenceUsage.ts:10
171
+ Defined in: [contracts/IIntelligenceUsage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L15)
172
+
173
+ All output tokens, including any reasoning tokens, reported for the operation.
174
+
175
+ ***
176
+
177
+ ### reasoningTokens
178
+
179
+ ```ts
180
+ readonly reasoningTokens: number | null;
181
+ ```
182
+
183
+ Defined in: [contracts/IIntelligenceUsage.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L41)
184
+
185
+ Reasoning tokens included in the provider's output total.
31
186
 
32
187
  ***
33
188
 
@@ -37,4 +192,6 @@ Defined in: contracts/IIntelligenceUsage.ts:10
37
192
  readonly totalTokens: number | null;
38
193
  ```
39
194
 
40
- Defined in: contracts/IIntelligenceUsage.ts:11
195
+ Defined in: [contracts/IIntelligenceUsage.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L17)
196
+
197
+ Provider-reported total input and output tokens.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceVideoGenerationOptions
7
7
 
8
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:12
8
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L12)
9
9
 
10
10
  Provider-neutral video generation options.
11
11
 
@@ -21,7 +21,7 @@ Provider-neutral video generation options.
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 aspectRatio?: `${number}:${number}`;
38
38
  ```
39
39
 
40
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:24
40
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L24)
41
41
 
42
42
  ***
43
43
 
@@ -47,7 +47,7 @@ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:24
47
47
  readonly optional count?: number;
48
48
  ```
49
49
 
50
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:22
50
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L22)
51
51
 
52
52
  ***
53
53
 
@@ -57,7 +57,7 @@ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:22
57
57
  readonly optional durationSeconds?: number;
58
58
  ```
59
59
 
60
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:26
60
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L26)
61
61
 
62
62
  ***
63
63
 
@@ -70,7 +70,7 @@ readonly optional frameImages?: readonly {
70
70
  }[];
71
71
  ```
72
72
 
73
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:30
73
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L30)
74
74
 
75
75
  ***
76
76
 
@@ -80,7 +80,7 @@ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:30
80
80
  readonly optional framesPerSecond?: number;
81
81
  ```
82
82
 
83
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:27
83
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L27)
84
84
 
85
85
  ***
86
86
 
@@ -90,7 +90,7 @@ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:27
90
90
  readonly optional generateAudio?: boolean;
91
91
  ```
92
92
 
93
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:29
93
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L29)
94
94
 
95
95
  ***
96
96
 
@@ -100,7 +100,7 @@ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:29
100
100
  readonly optional headers?: Readonly<Record<string, string>>;
101
101
  ```
102
102
 
103
- Defined in: contracts/IIntelligenceRequestOptions.ts:19
103
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L19)
104
104
 
105
105
  Additional outbound request headers.
106
106
 
@@ -123,7 +123,7 @@ readonly optional inputReferences?: readonly (
123
123
  })[];
124
124
  ```
125
125
 
126
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:34
126
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L34)
127
127
 
128
128
  ***
129
129
 
@@ -133,7 +133,7 @@ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:34
133
133
  readonly optional maxRetries?: number;
134
134
  ```
135
135
 
136
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:21
136
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L21)
137
137
 
138
138
  ***
139
139
 
@@ -143,7 +143,7 @@ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:21
143
143
  readonly optional maxVideosPerCall?: number;
144
144
  ```
145
145
 
146
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:23
146
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L23)
147
147
 
148
148
  ***
149
149
 
@@ -153,7 +153,7 @@ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:23
153
153
  readonly optional model?: IIntelligenceModelReference;
154
154
  ```
155
155
 
156
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
156
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
157
157
 
158
158
  Optional provider/model override.
159
159
 
@@ -174,7 +174,7 @@ readonly prompt:
174
174
  };
175
175
  ```
176
176
 
177
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:15
177
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L15)
178
178
 
179
179
  ***
180
180
 
@@ -184,7 +184,7 @@ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:15
184
184
  readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
185
185
  ```
186
186
 
187
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
187
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
188
188
 
189
189
  Optional provider-specific settings.
190
190
 
@@ -194,13 +194,29 @@ Optional provider-specific settings.
194
194
 
195
195
  ***
196
196
 
197
+ ### requestId?
198
+
199
+ ```ts
200
+ readonly optional requestId?: string;
201
+ ```
202
+
203
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
204
+
205
+ Correlation identifier included in structured Archipel logs.
206
+
207
+ #### Inherited from
208
+
209
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`requestId`](Interface.IIntelligenceRequestOptions#requestid)
210
+
211
+ ***
212
+
197
213
  ### resolution?
198
214
 
199
215
  ```ts
200
216
  readonly optional resolution?: `${number}x${number}`;
201
217
  ```
202
218
 
203
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:25
219
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L25)
204
220
 
205
221
  ***
206
222
 
@@ -210,7 +226,7 @@ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:25
210
226
  readonly optional seed?: number;
211
227
  ```
212
228
 
213
- Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:28
229
+ Defined in: [contracts/IIntelligenceVideoGenerationOptions.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationOptions.ts#L28)
214
230
 
215
231
  ***
216
232
 
@@ -220,7 +236,7 @@ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:28
220
236
  readonly optional timeoutMs?: number;
221
237
  ```
222
238
 
223
- Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
239
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
224
240
 
225
241
  Total provider-operation timeout in milliseconds.
226
242
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceVideoGenerationResult
7
7
 
8
- Defined in: contracts/IIntelligenceVideoGenerationResult.ts:12
8
+ Defined in: [contracts/IIntelligenceVideoGenerationResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationResult.ts#L12)
9
9
 
10
10
  Provider-neutral video generation result.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral video generation result.
17
17
  readonly model: string;
18
18
  ```
19
19
 
20
- Defined in: contracts/IIntelligenceVideoGenerationResult.ts:17
20
+ Defined in: [contracts/IIntelligenceVideoGenerationResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationResult.ts#L17)
21
21
 
22
22
  ***
23
23
 
@@ -27,7 +27,7 @@ Defined in: contracts/IIntelligenceVideoGenerationResult.ts:17
27
27
  readonly provider: string;
28
28
  ```
29
29
 
30
- Defined in: contracts/IIntelligenceVideoGenerationResult.ts:16
30
+ Defined in: [contracts/IIntelligenceVideoGenerationResult.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationResult.ts#L16)
31
31
 
32
32
  ***
33
33
 
@@ -37,7 +37,7 @@ Defined in: contracts/IIntelligenceVideoGenerationResult.ts:16
37
37
  readonly videos: readonly IIntelligenceGeneratedFile[];
38
38
  ```
39
39
 
40
- Defined in: contracts/IIntelligenceVideoGenerationResult.ts:15
40
+ Defined in: [contracts/IIntelligenceVideoGenerationResult.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationResult.ts#L15)
41
41
 
42
42
  ***
43
43
 
@@ -47,4 +47,4 @@ Defined in: contracts/IIntelligenceVideoGenerationResult.ts:15
47
47
  readonly warnings: readonly string[];
48
48
  ```
49
49
 
50
- Defined in: contracts/IIntelligenceVideoGenerationResult.ts:18
50
+ Defined in: [contracts/IIntelligenceVideoGenerationResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceVideoGenerationResult.ts#L18)
@@ -38,6 +38,6 @@ type IIntelligenceModelMessage =
38
38
  };
39
39
  ```
40
40
 
41
- Defined in: contracts/IIntelligenceModelMessage.ts:12
41
+ Defined in: [contracts/IIntelligenceModelMessage.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelMessage.ts#L12)
42
42
 
43
43
  Provider-neutral conversation message.
@@ -55,7 +55,7 @@ type IIntelligenceSchema<T> =
55
55
  };
56
56
  ```
57
57
 
58
- Defined in: contracts/IIntelligenceSchema.ts:10
58
+ Defined in: [contracts/IIntelligenceSchema.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceSchema.ts#L10)
59
59
 
60
60
  Provider-neutral schema accepted by prompts, structured outputs, and tools.
61
61
 
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type IntelligenceCapability = typeof IntelligenceCapabilityNames[keyof typeof IntelligenceCapabilityNames];
10
10
  ```
11
11
 
12
- Defined in: contracts/IntelligenceCapability.ts:12
12
+ Defined in: [contracts/IntelligenceCapability.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapability.ts#L12)
13
13
 
14
14
  Intelligence capability identifier.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type IntelligenceDefaultModels = Readonly<Partial<Record<IntelligenceCapability, IIntelligenceModelReference>>>;
10
10
  ```
11
11
 
12
- Defined in: contracts/IntelligenceDefaultModels.ts:13
12
+ Defined in: [contracts/IntelligenceDefaultModels.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceDefaultModels.ts#L13)
13
13
 
14
14
  Capability-specific default provider and model references.
@@ -17,6 +17,6 @@ type IntelligenceJsonValue =
17
17
  };
18
18
  ```
19
19
 
20
- Defined in: contracts/IntelligenceJsonValue.ts:6
20
+ Defined in: [contracts/IntelligenceJsonValue.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceJsonValue.ts#L6)
21
21
 
22
22
  JSON-compatible value used by provider-neutral intelligence contracts.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type IntelligenceProviderName = typeof IntelligenceProviderNames[keyof typeof IntelligenceProviderNames];
10
10
  ```
11
11
 
12
- Defined in: contracts/IntelligenceProviderName.ts:12
12
+ Defined in: [contracts/IntelligenceProviderName.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderName.ts#L12)
13
13
 
14
14
  Represents the union of supported intelligence provider identifiers.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type IntelligenceProviderOptions = Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
10
10
  ```
11
11
 
12
- Defined in: contracts/IntelligenceProviderOptions.ts:12
12
+ Defined in: [contracts/IntelligenceProviderOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderOptions.ts#L12)
13
13
 
14
14
  Provider-specific request options kept behind an explicit escape hatch.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type IntelligenceProviderProbeStatus = "operational" | "degraded" | "down";
10
10
  ```
11
11
 
12
- Defined in: contracts/IntelligenceProviderProbeStatus.ts:6
12
+ Defined in: [contracts/IntelligenceProviderProbeStatus.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderProbeStatus.ts#L6)
13
13
 
14
14
  Normalized provider availability state.
@@ -9,7 +9,7 @@ editUrl: false
9
9
  type IntelligenceProviderToolOptions = Readonly<Record<string, unknown>>;
10
10
  ```
11
11
 
12
- Defined in: contracts/IntelligenceProviderToolOptions.ts:9
12
+ Defined in: [contracts/IntelligenceProviderToolOptions.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderToolOptions.ts#L9)
13
13
 
14
14
  Opaque provider-tool configuration accepted only by provider-specific subpaths.
15
15
 
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type IntelligenceRequestTimeouts = Readonly<Partial<Record<IntelligenceCapability, number>>>;
10
10
  ```
11
11
 
12
- Defined in: contracts/IntelligenceRequestTimeouts.ts:12
12
+ Defined in: [contracts/IntelligenceRequestTimeouts.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceRequestTimeouts.ts#L12)
13
13
 
14
14
  Capability-specific total request timeouts in milliseconds.
@@ -16,6 +16,6 @@ type IntelligenceToolChoice =
16
16
  };
17
17
  ```
18
18
 
19
- Defined in: contracts/IntelligenceToolChoice.ts:6
19
+ Defined in: [contracts/IntelligenceToolChoice.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceToolChoice.ts#L6)
20
20
 
21
21
  Provider-neutral tool-selection policy.
@@ -17,6 +17,6 @@ type IntelligenceToolOutput =
17
17
  };
18
18
  ```
19
19
 
20
- Defined in: contracts/IntelligenceToolOutput.ts:6
20
+ Defined in: [contracts/IntelligenceToolOutput.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceToolOutput.ts#L6)
21
21
 
22
22
  Provider-neutral tool result.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type IntelligenceToolSet = Readonly<Record<string, IIntelligenceToolDefinition>>;
10
10
  ```
11
11
 
12
- Defined in: contracts/IntelligenceToolSet.ts:12
12
+ Defined in: [contracts/IntelligenceToolSet.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceToolSet.ts#L12)
13
13
 
14
14
  Provider-neutral named tool collection.
@@ -41,6 +41,6 @@ type IntelligenceTranscriptionStreamPart =
41
41
  };
42
42
  ```
43
43
 
44
- Defined in: contracts/IntelligenceTranscriptionStreamPart.ts:12
44
+ Defined in: [contracts/IntelligenceTranscriptionStreamPart.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceTranscriptionStreamPart.ts#L12)
45
45
 
46
46
  Provider-neutral live transcription event.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const AI_GATEWAY_API_KEY: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: providers/gateway/env.ts:10
12
+ Defined in: [providers/gateway/env.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/gateway/env.ts#L10)
13
13
 
14
14
  Vercel AI Gateway API key.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const AI_GATEWAY_BASE_URL: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: providers/gateway/env.ts:13
12
+ Defined in: [providers/gateway/env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/gateway/env.ts#L13)
13
13
 
14
14
  Vercel AI Gateway base URL.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const AI_GATEWAY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
10
  ```
11
11
 
12
- Defined in: providers/gateway/env.ts:16
12
+ Defined in: [providers/gateway/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/gateway/env.ts#L16)
13
13
 
14
14
  Configuration entries used by the Vercel AI Gateway provider.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const INTELLIGENCE_API_KEY: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [env.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L44)
12
+ Defined in: [env.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L27)
13
13
 
14
14
  Global API key override for the intelligence provider.