@breadstone/archipel-mcp 0.0.54 → 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 (216) hide show
  1. package/data/guides/ai-image-generation.md +101 -0
  2. package/data/guides/ai-realtime-voice.md +85 -473
  3. package/data/guides/ai-text-generation.md +98 -635
  4. package/data/guides/health-indicators.md +67 -66
  5. package/data/guides/index.md +2 -1
  6. package/data/guides/intelligence-prompts-warm-up.md +81 -312
  7. package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +122 -0
  8. package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +122 -0
  9. package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +122 -0
  10. package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +122 -0
  11. package/data/packages/platform-intelligence/api/Class.IntelligenceAgent.md +95 -0
  12. package/data/packages/platform-intelligence/api/Class.IntelligenceAgentFactory.md +11 -23
  13. package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +25 -21
  14. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +15 -10
  15. package/data/packages/platform-intelligence/api/Class.IntelligenceImageGenerator.md +117 -0
  16. package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +159 -0
  17. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  18. package/data/packages/platform-intelligence/api/Class.IntelligencePromptExecutor.md +6 -6
  19. package/data/packages/platform-intelligence/api/Class.IntelligencePromptPolicyPort.md +1 -1
  20. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAdapterPort.md +104 -0
  21. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAssetUploader.md +21 -15
  22. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderDiagnostics.md +55 -0
  23. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderError.md +14 -4
  24. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderRegistry.md +68 -0
  25. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +9 -9
  26. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +1 -1
  27. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +8 -8
  28. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +18 -18
  29. package/data/packages/platform-intelligence/api/Class.IntelligenceReranker.md +58 -0
  30. package/data/packages/platform-intelligence/api/Class.IntelligenceSpeechGenerator.md +117 -0
  31. package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +14 -16
  32. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +14 -18
  33. package/data/packages/platform-intelligence/api/Class.IntelligenceTranscriptionGenerator.md +139 -0
  34. package/data/packages/platform-intelligence/api/Class.IntelligenceVideoGenerator.md +117 -0
  35. package/data/packages/platform-intelligence/api/Class.MiMoIntelligenceProviderAdapter.md +122 -0
  36. package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +122 -0
  37. package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +1 -1
  38. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +1 -1
  39. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +1 -1
  40. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +1 -1
  41. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +1 -1
  42. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +1 -1
  43. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +1 -1
  44. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +1 -1
  45. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +1 -1
  46. package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +1 -1
  47. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +1 -1
  48. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +1 -1
  49. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +1 -1
  50. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +1 -1
  51. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +1 -1
  52. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +1 -1
  53. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +1 -1
  54. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +1 -1
  55. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +1 -1
  56. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +1 -1
  57. package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +1 -1
  58. package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +1 -1
  59. package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +1 -1
  60. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +1 -1
  61. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +1 -1
  62. package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +1 -1
  63. package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +1 -1
  64. package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +1 -1
  65. package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +1 -1
  66. package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +1 -1
  67. package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +1 -1
  68. package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +1 -1
  69. package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +1 -1
  70. package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +1 -1
  71. package/data/packages/platform-intelligence/api/Function.createIntelligenceJsonSchema.md +31 -0
  72. package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +2 -2
  73. package/data/packages/platform-intelligence/api/Function.createMimoCustomTool.md +5 -5
  74. package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +1 -1
  75. package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +1 -1
  76. package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +1 -1
  77. package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +1 -1
  78. package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +1 -1
  79. package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +1 -1
  80. package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +1 -1
  81. package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +1 -1
  82. package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +1 -1
  83. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +1 -1
  84. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +1 -1
  85. package/data/packages/platform-intelligence/api/Function.defineIntelligenceTool.md +31 -0
  86. package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md +70 -0
  87. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md +140 -0
  88. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +70 -0
  89. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +130 -0
  90. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +70 -0
  91. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +118 -0
  92. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadResult.md +60 -0
  93. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGeneratedFile.md +40 -0
  94. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGenerationStepStartEvent.md +50 -0
  95. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationOptions.md +186 -0
  96. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationResult.md +60 -0
  97. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageCompletion.md +141 -0
  98. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md +250 -0
  99. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageStream.md +50 -0
  100. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelReference.md +34 -0
  101. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelRequestOptions.md +72 -0
  102. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +30 -0
  103. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +54 -26
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceObjectStream.md +56 -0
  105. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +50 -0
  106. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptDefinition.md +14 -14
  107. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md +1 -1
  108. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md +1 -1
  109. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md +15 -27
  110. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +10 -10
  111. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +54 -0
  112. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md +70 -0
  113. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +9 -21
  114. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +23 -11
  115. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +174 -10
  116. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +114 -0
  117. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +156 -0
  118. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +50 -0
  119. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +110 -0
  120. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +80 -0
  121. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +180 -0
  122. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +50 -0
  123. package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +155 -0
  124. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +7 -10
  125. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolCall.md +40 -0
  126. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolDefinition.md +91 -0
  127. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionEndEvent.md +50 -0
  128. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionStartEvent.md +30 -0
  129. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +4 -4
  130. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionOptions.md +130 -0
  131. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionResult.md +84 -0
  132. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionStream.md +97 -0
  133. package/data/packages/platform-intelligence/api/Interface.IIntelligenceUsage.md +197 -0
  134. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +245 -0
  135. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationResult.md +50 -0
  136. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceModelMessage.md +43 -0
  137. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligencePromptModelRequirement.md +2 -2
  138. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceSchema.md +70 -0
  139. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceCapability.md +14 -0
  140. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceDefaultModels.md +14 -0
  141. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceJsonValue.md +22 -0
  142. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptDefinitionConfiguration.md +2 -2
  143. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md +1 -1
  144. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
  145. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderOptions.md +14 -0
  146. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderProbeStatus.md +14 -0
  147. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderToolOptions.md +17 -0
  148. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +1 -1
  149. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRequestTimeouts.md +14 -0
  150. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolChoice.md +21 -0
  151. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolOutput.md +22 -0
  152. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolSet.md +14 -0
  153. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md +46 -0
  154. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_API_KEY.md +14 -0
  155. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_BASE_URL.md +14 -0
  156. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_CONFIG_ENTRIES.md +14 -0
  157. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  158. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  159. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  160. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  161. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +2 -2
  162. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  163. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  164. package/data/packages/platform-intelligence/api/Variable.IntelligenceCapabilityNames.md +40 -0
  165. package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +2 -0
  166. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +2 -2
  167. package/data/packages/platform-intelligence/api/index.md +83 -32
  168. package/data/packages/platform-intelligence/index.md +81 -622
  169. package/package.json +1 -1
  170. package/data/packages/index.md +0 -8
  171. package/data/packages/platform-analytics/index.md +0 -209
  172. package/data/packages/platform-authentication/index.md +0 -725
  173. package/data/packages/platform-blob-storage/index.md +0 -416
  174. package/data/packages/platform-bootstrap/index.md +0 -162
  175. package/data/packages/platform-caching/index.md +0 -167
  176. package/data/packages/platform-configuration/index.md +0 -226
  177. package/data/packages/platform-core/index.md +0 -504
  178. package/data/packages/platform-cryptography/index.md +0 -142
  179. package/data/packages/platform-database/index.md +0 -337
  180. package/data/packages/platform-documents/index.md +0 -255
  181. package/data/packages/platform-esigning/index.md +0 -710
  182. package/data/packages/platform-feature-flags/index.md +0 -103
  183. package/data/packages/platform-health/index.md +0 -141
  184. package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +0 -118
  185. package/data/packages/platform-intelligence/api/Class.IntelligenceStructuredGenerator.md +0 -70
  186. package/data/packages/platform-intelligence/api/Class.IntelligenceTelemetryRegistry.md +0 -44
  187. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +0 -138
  188. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +0 -39
  189. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +0 -26
  190. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +0 -26
  191. package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +0 -25
  192. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +0 -26
  193. package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +0 -25
  194. package/data/packages/platform-intelligence/api/Function.loadMimoLanguageModel.md +0 -26
  195. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +0 -26
  196. package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +0 -25
  197. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +0 -46
  198. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +0 -180
  199. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +0 -144
  200. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +0 -78
  201. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +0 -170
  202. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +0 -24
  203. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +0 -14
  204. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +0 -25
  205. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +0 -14
  206. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +0 -14
  207. package/data/packages/platform-logging/index.md +0 -150
  208. package/data/packages/platform-mailing/index.md +0 -470
  209. package/data/packages/platform-mapping/index.md +0 -123
  210. package/data/packages/platform-mcp/index.md +0 -335
  211. package/data/packages/platform-openapi/index.md +0 -207
  212. package/data/packages/platform-payments/index.md +0 -610
  213. package/data/packages/platform-queue/index.md +0 -192
  214. package/data/packages/platform-reporting/index.md +0 -233
  215. package/data/packages/platform-resources/index.md +0 -137
  216. package/data/packages/platform-telemetry/index.md +0 -262
@@ -0,0 +1,46 @@
1
+ ---
2
+ title: 'Type Alias: IntelligenceTranscriptionStreamPart'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligenceTranscriptionStreamPart
7
+
8
+ ```ts
9
+ type IntelligenceTranscriptionStreamPart =
10
+ | {
11
+ delta: string;
12
+ id?: string;
13
+ providerMetadata?: IntelligenceProviderOptions;
14
+ type: "transcript-delta";
15
+ }
16
+ | {
17
+ channelIndex?: number;
18
+ durationInSeconds?: number;
19
+ id?: string;
20
+ providerMetadata?: IntelligenceProviderOptions;
21
+ startSecond?: number;
22
+ text: string;
23
+ type: "transcript-partial";
24
+ }
25
+ | {
26
+ channelIndex?: number;
27
+ endSecond?: number;
28
+ id?: string;
29
+ providerMetadata?: IntelligenceProviderOptions;
30
+ startSecond?: number;
31
+ text: string;
32
+ type: "transcript-final";
33
+ }
34
+ | {
35
+ rawValue: unknown;
36
+ type: "raw";
37
+ }
38
+ | {
39
+ error: unknown;
40
+ type: "error";
41
+ };
42
+ ```
43
+
44
+ Defined in: [contracts/IntelligenceTranscriptionStreamPart.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceTranscriptionStreamPart.ts#L12)
45
+
46
+ Provider-neutral live transcription event.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AI\_GATEWAY\_API\_KEY'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AI\_GATEWAY\_API\_KEY
7
+
8
+ ```ts
9
+ const AI_GATEWAY_API_KEY: IConfigKey<string>;
10
+ ```
11
+
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
+
14
+ Vercel AI Gateway API key.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AI\_GATEWAY\_BASE\_URL'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AI\_GATEWAY\_BASE\_URL
7
+
8
+ ```ts
9
+ const AI_GATEWAY_BASE_URL: IConfigKey<string>;
10
+ ```
11
+
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
+
14
+ Vercel AI Gateway base URL.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: AI\_GATEWAY\_CONFIG\_ENTRIES'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: AI\_GATEWAY\_CONFIG\_ENTRIES
7
+
8
+ ```ts
9
+ const AI_GATEWAY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ ```
11
+
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
+
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:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L42)
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.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const INTELLIGENCE_BASE_URL: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [env.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L45)
12
+ Defined in: [env.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L30)
13
13
 
14
14
  Global base URL override for the intelligence provider.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const INTELLIGENCE_MAX_OUTPUT_TOKENS: IConfigKey<number>;
10
10
  ```
11
11
 
12
- Defined in: [env.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L36)
12
+ Defined in: [env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L21)
13
13
 
14
14
  Maximum number of output tokens for the AI model.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const INTELLIGENCE_MODEL: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [env.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L27)
12
+ Defined in: [env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L12)
13
13
 
14
14
  AI model identifier to use for text generation.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const INTELLIGENCE_PROVIDER: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [env.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L39)
12
+ Defined in: [env.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L24)
13
13
 
14
- Intelligence provider name (e.g. openai, anthropic, google, grok, mimo).
14
+ Intelligence provider name (e.g. openai, anthropic, google, grok, mimo, gateway).
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const INTELLIGENCE_TEMPERATURE: IConfigKey<number>;
10
10
  ```
11
11
 
12
- Defined in: [env.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L30)
12
+ Defined in: [env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L15)
13
13
 
14
14
  Sampling temperature for the AI model.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const INTELLIGENCE_TOP_P: IConfigKey<number>;
10
10
  ```
11
11
 
12
- Defined in: [env.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L33)
12
+ Defined in: [env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L18)
13
13
 
14
14
  Top-p (nucleus sampling) for the AI model.
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: 'Variable: IntelligenceCapabilityNames'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: IntelligenceCapabilityNames
7
+
8
+ ```ts
9
+ const IntelligenceCapabilityNames: {
10
+ Embedding: "embedding";
11
+ Files: "files";
12
+ Image: "image";
13
+ Language: "language";
14
+ Realtime: "realtime";
15
+ Reranking: "reranking";
16
+ Skills: "skills";
17
+ Speech: "speech";
18
+ Transcription: "transcription";
19
+ Video: "video";
20
+ };
21
+ ```
22
+
23
+ Defined in: [contracts/IntelligenceCapabilityNames.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapabilityNames.ts#L6)
24
+
25
+ Capability identifiers understood by the intelligence provider registry.
26
+
27
+ ## Type Declaration
28
+
29
+ | Name | Type | Default value | Defined in |
30
+ | ------ | ------ | ------ | ------ |
31
+ | <a id="property-embedding"></a> `Embedding` | `"embedding"` | `'embedding'` | [contracts/IntelligenceCapabilityNames.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapabilityNames.ts#L8) |
32
+ | <a id="property-files"></a> `Files` | `"files"` | `'files'` | [contracts/IntelligenceCapabilityNames.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapabilityNames.ts#L15) |
33
+ | <a id="property-image"></a> `Image` | `"image"` | `'image'` | [contracts/IntelligenceCapabilityNames.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapabilityNames.ts#L9) |
34
+ | <a id="property-language"></a> `Language` | `"language"` | `'language'` | [contracts/IntelligenceCapabilityNames.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapabilityNames.ts#L7) |
35
+ | <a id="property-realtime"></a> `Realtime` | `"realtime"` | `'realtime'` | [contracts/IntelligenceCapabilityNames.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapabilityNames.ts#L14) |
36
+ | <a id="property-reranking"></a> `Reranking` | `"reranking"` | `'reranking'` | [contracts/IntelligenceCapabilityNames.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapabilityNames.ts#L13) |
37
+ | <a id="property-skills"></a> `Skills` | `"skills"` | `'skills'` | [contracts/IntelligenceCapabilityNames.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapabilityNames.ts#L16) |
38
+ | <a id="property-speech"></a> `Speech` | `"speech"` | `'speech'` | [contracts/IntelligenceCapabilityNames.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapabilityNames.ts#L10) |
39
+ | <a id="property-transcription"></a> `Transcription` | `"transcription"` | `'transcription'` | [contracts/IntelligenceCapabilityNames.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapabilityNames.ts#L11) |
40
+ | <a id="property-video"></a> `Video` | `"video"` | `'video'` | [contracts/IntelligenceCapabilityNames.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceCapabilityNames.ts#L12) |
@@ -8,6 +8,7 @@ editUrl: false
8
8
  ```ts
9
9
  const IntelligenceProviderNames: {
10
10
  Anthropic: "anthropic";
11
+ Gateway: "gateway";
11
12
  Google: "google";
12
13
  Grok: "grok";
13
14
  MiMo: "mimo";
@@ -24,6 +25,7 @@ Enumerates the supported model providers powering the intelligence pipeline.
24
25
  | Name | Type | Default value | Defined in |
25
26
  | ------ | ------ | ------ | ------ |
26
27
  | <a id="property-anthropic"></a> `Anthropic` | `"anthropic"` | `'anthropic'` | [contracts/IntelligenceProviderNames.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L8) |
28
+ | <a id="property-gateway"></a> `Gateway` | `"gateway"` | `'gateway'` | [contracts/IntelligenceProviderNames.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L12) |
27
29
  | <a id="property-google"></a> `Google` | `"google"` | `'google'` | [contracts/IntelligenceProviderNames.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L9) |
28
30
  | <a id="property-grok"></a> `Grok` | `"grok"` | `'grok'` | [contracts/IntelligenceProviderNames.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L10) |
29
31
  | <a id="property-mimo"></a> `MiMo` | `"mimo"` | `'mimo'` | [contracts/IntelligenceProviderNames.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L11) |
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const PLATFORM_INTELLIGENCE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
10
  ```
11
11
 
12
- Defined in: [env.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L52)
12
+ Defined in: [env.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L37)
13
13
 
14
- All configuration entries required by `platform-intelligence`.
14
+ Provider-neutral configuration entries required by `platform-intelligence`.
@@ -9,34 +9,64 @@ editUrl: false
9
9
 
10
10
  | Class | Description |
11
11
  | ------ | ------ |
12
+ | [AnthropicIntelligenceProviderAdapter](Class.AnthropicIntelligenceProviderAdapter) | Anthropic adapter for language, files, and skills. |
12
13
  | [DefaultIntelligencePromptPolicyAdapter](Class.DefaultIntelligencePromptPolicyAdapter) | Default prompt policy that supports native settings and automatic model selection. |
13
- | [IntelligenceAgentFactory](Class.IntelligenceAgentFactory) | Creates AI SDK 7 tool-loop agents with platform-registered tools merged in. |
14
+ | [GatewayIntelligenceProviderAdapter](Class.GatewayIntelligenceProviderAdapter) | Vercel AI Gateway adapter spanning all standardized model capabilities. |
15
+ | [GoogleIntelligenceProviderAdapter](Class.GoogleIntelligenceProviderAdapter) | Google adapter for language, embeddings, images, speech, video, realtime, and files. |
16
+ | [GrokIntelligenceProviderAdapter](Class.GrokIntelligenceProviderAdapter) | xAI Grok adapter for language, image, speech, transcription, video, realtime, and files. |
17
+ | [IntelligenceAgent](Class.IntelligenceAgent) | Reusable provider-neutral agent backed by the language capability. |
18
+ | [IntelligenceAgentFactory](Class.IntelligenceAgentFactory) | Creates reusable provider-neutral tool-loop agents. |
14
19
  | [IntelligenceConfigurationError](Class.IntelligenceConfigurationError) | Error thrown when an intelligence provider configuration is invalid or missing. |
15
- | [IntelligenceEmbeddingGenerator](Class.IntelligenceEmbeddingGenerator) | Executes AI SDK embedding operations. |
16
- | [IntelligenceHealthIndicator](Class.IntelligenceHealthIndicator) | Health indicator for the intelligence infrastructure. Verifies that the intelligence provider configuration can be resolved. |
17
- | [IntelligenceMediaGenerator](Class.IntelligenceMediaGenerator) | Executes AI SDK media generation and understanding operations. |
20
+ | [IntelligenceEmbeddingGenerator](Class.IntelligenceEmbeddingGenerator) | Provider-neutral single and batch embedding facade. |
21
+ | [IntelligenceHealthIndicator](Class.IntelligenceHealthIndicator) | Health indicator for the intelligence infrastructure. Performs a bounded remote readiness probe for the default language model and reports the locally registered capability topology. |
22
+ | [IntelligenceImageGenerator](Class.IntelligenceImageGenerator) | Provider-neutral image generation facade. |
23
+ | [IntelligenceLanguageGenerator](Class.IntelligenceLanguageGenerator) | Provider-neutral language generation, structured output, and streaming facade. |
18
24
  | [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure. |
19
25
  | [IntelligencePromptExecutor](Class.IntelligencePromptExecutor) | Validates and executes reusable intelligence prompt invocations. |
20
26
  | [IntelligencePromptPolicyPort](Class.IntelligencePromptPolicyPort) | Resolves provider-neutral prompt requirements into effective generation settings. |
21
- | [IntelligenceProviderAssetUploader](Class.IntelligenceProviderAssetUploader) | Uploads provider-managed files and skills for reuse in AI SDK calls. |
27
+ | [IntelligenceProviderAdapterPort](Class.IntelligenceProviderAdapterPort) | Port implemented by every intelligence provider adapter. |
28
+ | [IntelligenceProviderAssetUploader](Class.IntelligenceProviderAssetUploader) | Uploads provider-managed files and skills behind provider-neutral contracts. |
29
+ | [IntelligenceProviderDiagnostics](Class.IntelligenceProviderDiagnostics) | Performs bounded, provider-neutral provider availability diagnostics. |
22
30
  | [IntelligenceProviderError](Class.IntelligenceProviderError) | Error thrown when an intelligence provider call fails. |
31
+ | [IntelligenceProviderRegistry](Class.IntelligenceProviderRegistry) | Immutable registry of provider adapters and their supported capabilities. |
23
32
  | [IntelligenceRealtimeError](Class.IntelligenceRealtimeError) | Error raised by a realtime session, transport, or metering adapter. |
24
33
  | [IntelligenceRealtimeMeteringPort](Class.IntelligenceRealtimeMeteringPort) | Application port for idempotently persisting realtime billing and audit events. |
25
34
  | [IntelligenceRealtimeSessionFactory](Class.IntelligenceRealtimeSessionFactory) | Creates and owns server-side, provider-neutral realtime AI sessions. |
26
35
  | [IntelligenceRealtimeSessionPort](Class.IntelligenceRealtimeSessionPort) | Provider-neutral control surface for one realtime model connection. |
27
- | [IntelligenceStructuredGenerator](Class.IntelligenceStructuredGenerator) | Executes AI SDK structured-output generation. |
28
- | [IntelligenceTelemetryRegistry](Class.IntelligenceTelemetryRegistry) | Registers AI SDK telemetry integrations for the current process. |
29
- | [IntelligenceTextGenerator](Class.IntelligenceTextGenerator) | Executes text completions using the configured intelligence provider. |
30
- | [IntelligenceToolBase](Class.IntelligenceToolBase) | Base class for class-based AI SDK tools. |
36
+ | [IntelligenceReranker](Class.IntelligenceReranker) | Provider-neutral semantic reranking facade. |
37
+ | [IntelligenceSpeechGenerator](Class.IntelligenceSpeechGenerator) | Provider-neutral speech generation facade. |
38
+ | [IntelligenceToolBase](Class.IntelligenceToolBase) | Base class for class-based intelligence tools. |
31
39
  | [IntelligenceToolRegistry](Class.IntelligenceToolRegistry) | Registry for class-based intelligence tools. |
40
+ | [IntelligenceTranscriptionGenerator](Class.IntelligenceTranscriptionGenerator) | Provider-neutral bounded and streaming transcription facade. |
32
41
  | [IntelligenceValidationError](Class.IntelligenceValidationError) | Error thrown when an intelligence input validation fails. |
42
+ | [IntelligenceVideoGenerator](Class.IntelligenceVideoGenerator) | Provider-neutral video generation facade. |
43
+ | [MiMoIntelligenceProviderAdapter](Class.MiMoIntelligenceProviderAdapter) | Xiaomi MiMo OpenAI-compatible language adapter. |
44
+ | [OpenAIIntelligenceProviderAdapter](Class.OpenAIIntelligenceProviderAdapter) | OpenAI adapter for language, embeddings, images, audio, video, realtime, files, and skills. |
33
45
 
34
46
  ## Interfaces
35
47
 
36
48
  | Interface | Description |
37
49
  | ------ | ------ |
38
- | [IIntelligenceCompletionUsage](Interface.IIntelligenceCompletionUsage) | Captures usage telemetry returned by the intelligence provider. |
50
+ | [IIntelligenceAgentConfiguration](Interface.IIntelligenceAgentConfiguration) | Reusable provider-neutral tool-loop agent configuration. |
51
+ | [IIntelligenceEmbeddingBatchOptions](Interface.IIntelligenceEmbeddingBatchOptions) | Provider-neutral batch embedding options. |
52
+ | [IIntelligenceEmbeddingBatchResult](Interface.IIntelligenceEmbeddingBatchResult) | Provider-neutral batch embedding result. |
53
+ | [IIntelligenceEmbeddingOptions](Interface.IIntelligenceEmbeddingOptions) | Provider-neutral single-value embedding options. |
54
+ | [IIntelligenceEmbeddingResult](Interface.IIntelligenceEmbeddingResult) | Provider-neutral embedding result. |
55
+ | [IIntelligenceFileUploadOptions](Interface.IIntelligenceFileUploadOptions) | Provider-neutral file upload options. |
56
+ | [IIntelligenceFileUploadResult](Interface.IIntelligenceFileUploadResult) | Normalized provider-managed file upload result. |
57
+ | [IIntelligenceGeneratedFile](Interface.IIntelligenceGeneratedFile) | Binary content generated by an intelligence capability. |
58
+ | [IIntelligenceGenerationStepStartEvent](Interface.IIntelligenceGenerationStepStartEvent) | Language generation step metadata. |
59
+ | [IIntelligenceImageGenerationOptions](Interface.IIntelligenceImageGenerationOptions) | Provider-neutral image generation options. |
60
+ | [IIntelligenceImageGenerationResult](Interface.IIntelligenceImageGenerationResult) | Provider-neutral image generation result. |
61
+ | [IIntelligenceLanguageCompletion](Interface.IIntelligenceLanguageCompletion) | Normalized language generation result. |
62
+ | [IIntelligenceLanguageGenerationOptions](Interface.IIntelligenceLanguageGenerationOptions) | Provider-neutral language generation controls. |
63
+ | [IIntelligenceLanguageStream](Interface.IIntelligenceLanguageStream) | Provider-neutral text stream. |
64
+ | [IIntelligenceModelReference](Interface.IIntelligenceModelReference) | Selects a provider-owned model without exposing a provider SDK model object. |
65
+ | [IIntelligenceModelRequestOptions](Interface.IIntelligenceModelRequestOptions) | Shared provider/model controls for intelligence operations. |
66
+ | [IIntelligenceModelStatus](Interface.IIntelligenceModelStatus) | Safe resolved model status that never includes credentials. |
39
67
  | [IIntelligenceModuleOptions](Interface.IIntelligenceModuleOptions) | Options for configuring the intelligence module. |
68
+ | [IIntelligenceObjectStream](Interface.IIntelligenceObjectStream) | Provider-neutral structured-output stream. |
69
+ | [IIntelligencePrompt](Interface.IIntelligencePrompt) | Provider-neutral language-model prompt. |
40
70
  | [IIntelligencePromptDefinition](Interface.IIntelligencePromptDefinition) | Reusable, immutable definition of an intelligence prompt. |
41
71
  | [IIntelligencePromptEffectivePolicy](Interface.IIntelligencePromptEffectivePolicy) | Effective settings resolved for one prompt execution. |
42
72
  | [IIntelligencePromptExecutionContext](Interface.IIntelligencePromptExecutionContext) | Application context made available to prompt policy adapters. |
@@ -46,6 +76,8 @@ editUrl: false
46
76
  | [IIntelligencePromptPolicyRequest](Interface.IIntelligencePromptPolicyRequest) | Policy resolution request for one prompt invocation. |
47
77
  | [IIntelligencePromptRenderContext](Interface.IIntelligencePromptRenderContext) | Input exposed to pure prompt rendering functions. |
48
78
  | [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration) | Describes the resolved configuration for the intelligence provider. |
79
+ | [IIntelligenceProviderLoadRequest](Interface.IIntelligenceProviderLoadRequest) | Internal model/API load request passed to a provider adapter. |
80
+ | [IIntelligenceProviderProbeResult](Interface.IIntelligenceProviderProbeResult) | Provider-neutral result of a bounded provider availability probe. |
49
81
  | [IIntelligenceRealtimeAudioFormat](Interface.IIntelligenceRealtimeAudioFormat) | Provider-neutral audio format configuration. |
50
82
  | [IIntelligenceRealtimeCloseEvent](Interface.IIntelligenceRealtimeCloseEvent) | Describes why an upstream realtime connection closed. |
51
83
  | [IIntelligenceRealtimeModuleOptions](Interface.IIntelligenceRealtimeModuleOptions) | Module-level resilience and resource limits for realtime intelligence. |
@@ -55,20 +87,37 @@ editUrl: false
55
87
  | [IIntelligenceRealtimeTranscriptionConfiguration](Interface.IIntelligenceRealtimeTranscriptionConfiguration) | Provider-neutral transcription configuration. |
56
88
  | [IIntelligenceRealtimeTurnDetectionConfiguration](Interface.IIntelligenceRealtimeTurnDetectionConfiguration) | Provider-neutral voice activity detection configuration. |
57
89
  | [IIntelligenceRealtimeUsage](Interface.IIntelligenceRealtimeUsage) | Normalized token usage reported by a realtime provider. |
58
- | [IIntelligenceTextCompletion](Interface.IIntelligenceTextCompletion) | Represents the normalized completion result produced by the intelligence provider. |
59
- | [IIntelligenceTextGenerationOptions](Interface.IIntelligenceTextGenerationOptions) | Options that can be supplied when generating text with the intelligence provider. |
60
- | [IIntelligenceTextGenerator](Interface.IIntelligenceTextGenerator) | Abstraction responsible for executing text completions using the configured provider. |
61
- | [IIntelligenceTextStreamingOptions](Interface.IIntelligenceTextStreamingOptions) | Options that can be supplied when streaming text with the intelligence provider. |
90
+ | [IIntelligenceRequestOptions](Interface.IIntelligenceRequestOptions) | Shared execution controls for bounded intelligence requests. |
91
+ | [IIntelligenceRerankingOptions](Interface.IIntelligenceRerankingOptions) | Provider-neutral reranking options. |
92
+ | [IIntelligenceRerankingResult](Interface.IIntelligenceRerankingResult) | Provider-neutral reranking result. |
93
+ | [IIntelligenceSkillUploadOptions](Interface.IIntelligenceSkillUploadOptions) | Provider-neutral skill bundle upload options. |
94
+ | [IIntelligenceSkillUploadResult](Interface.IIntelligenceSkillUploadResult) | Normalized provider-managed skill upload result. |
95
+ | [IIntelligenceSpeechGenerationOptions](Interface.IIntelligenceSpeechGenerationOptions) | Provider-neutral speech generation options. |
96
+ | [IIntelligenceSpeechGenerationResult](Interface.IIntelligenceSpeechGenerationResult) | Provider-neutral speech generation result. |
97
+ | [IIntelligenceStreamingTranscriptionOptions](Interface.IIntelligenceStreamingTranscriptionOptions) | Provider-neutral live transcription options. |
62
98
  | [IIntelligenceTool](Interface.IIntelligenceTool) | Minimal shape required by the intelligence tool registry. |
99
+ | [IIntelligenceToolCall](Interface.IIntelligenceToolCall) | Tool call selected by a language model. |
100
+ | [IIntelligenceToolDefinition](Interface.IIntelligenceToolDefinition) | Provider-neutral application tool definition. |
101
+ | [IIntelligenceToolExecutionEndEvent](Interface.IIntelligenceToolExecutionEndEvent) | Tool execution completion event. |
102
+ | [IIntelligenceToolExecutionStartEvent](Interface.IIntelligenceToolExecutionStartEvent) | Tool execution start event. |
63
103
  | [IIntelligenceToolRegistry](Interface.IIntelligenceToolRegistry) | Contract for the intelligence tool registry. |
104
+ | [IIntelligenceTranscriptionOptions](Interface.IIntelligenceTranscriptionOptions) | Provider-neutral transcription options. |
105
+ | [IIntelligenceTranscriptionResult](Interface.IIntelligenceTranscriptionResult) | Provider-neutral transcription result. |
106
+ | [IIntelligenceTranscriptionStream](Interface.IIntelligenceTranscriptionStream) | Provider-neutral live transcription result. |
107
+ | [IIntelligenceUsage](Interface.IIntelligenceUsage) | Provider-neutral usage counters. |
108
+ | [IIntelligenceVideoGenerationOptions](Interface.IIntelligenceVideoGenerationOptions) | Provider-neutral video generation options. |
109
+ | [IIntelligenceVideoGenerationResult](Interface.IIntelligenceVideoGenerationResult) | Provider-neutral video generation result. |
64
110
 
65
111
  ## Type Aliases
66
112
 
67
113
  | Type Alias | Description |
68
114
  | ------ | ------ |
115
+ | [IIntelligenceModelMessage](TypeAlias.IIntelligenceModelMessage) | Provider-neutral conversation message. |
69
116
  | [IIntelligencePromptModelRequirement](TypeAlias.IIntelligencePromptModelRequirement) | Model selection requested by a reusable intelligence prompt. |
70
- | [IntelligenceLanguageModelLoader](TypeAlias.IntelligenceLanguageModelLoader) | Represents a factory responsible for creating a configured language model instance. |
71
- | [IntelligenceLanguageModelLoaders](TypeAlias.IntelligenceLanguageModelLoaders) | Maps configured intelligence providers to their tree-shakable model loader. |
117
+ | [IIntelligenceSchema](TypeAlias.IIntelligenceSchema) | Provider-neutral schema accepted by prompts, structured outputs, and tools. |
118
+ | [IntelligenceCapability](TypeAlias.IntelligenceCapability) | Intelligence capability identifier. |
119
+ | [IntelligenceDefaultModels](TypeAlias.IntelligenceDefaultModels) | Capability-specific default provider and model references. |
120
+ | [IntelligenceJsonValue](TypeAlias.IntelligenceJsonValue) | JSON-compatible value used by provider-neutral intelligence contracts. |
72
121
  | [IntelligencePromptCapability](TypeAlias.IntelligencePromptCapability) | Provider-neutral capability required by an intelligence prompt. |
73
122
  | [IntelligencePromptDefinitionConfiguration](TypeAlias.IntelligencePromptDefinitionConfiguration) | Configuration accepted by [intelligencePrompt](Function.intelligencePrompt). |
74
123
  | [IntelligencePromptGenerationOptions](TypeAlias.IntelligencePromptGenerationOptions) | Native generation settings that can be stored on a prompt definition. |
@@ -77,19 +126,27 @@ editUrl: false
77
126
  | [IntelligencePromptQuality](TypeAlias.IntelligencePromptQuality) | Provider-neutral model quality requested by an intelligence prompt. |
78
127
  | [IntelligencePromptReasoning](TypeAlias.IntelligencePromptReasoning) | Provider-neutral reasoning effort requested by an intelligence prompt. |
79
128
  | [IntelligenceProviderName](TypeAlias.IntelligenceProviderName) | Represents the union of supported intelligence provider identifiers. |
129
+ | [IntelligenceProviderOptions](TypeAlias.IntelligenceProviderOptions) | Provider-specific request options kept behind an explicit escape hatch. |
130
+ | [IntelligenceProviderProbeStatus](TypeAlias.IntelligenceProviderProbeStatus) | Normalized provider availability state. |
131
+ | [IntelligenceProviderToolOptions](TypeAlias.IntelligenceProviderToolOptions) | Opaque provider-tool configuration accepted only by provider-specific subpaths. |
80
132
  | [IntelligenceRealtimeClientEvent](TypeAlias.IntelligenceRealtimeClientEvent) | Provider-neutral event sent from an application to a realtime model. |
81
133
  | [IntelligenceRealtimeMetadataValue](TypeAlias.IntelligenceRealtimeMetadataValue) | Serializable metadata copied into realtime metering events. |
82
134
  | [IntelligenceRealtimeMeteringEvent](TypeAlias.IntelligenceRealtimeMeteringEvent) | Durable metering event emitted by an Archipel realtime session. |
83
- | [IntelligenceRealtimeModelLoader](TypeAlias.IntelligenceRealtimeModelLoader) | Creates a configured Vercel AI SDK realtime model behind the Archipel facade. |
84
- | [IntelligenceRealtimeModelLoaders](TypeAlias.IntelligenceRealtimeModelLoaders) | Maps configured intelligence providers to tree-shakable realtime model loaders. |
85
135
  | [IntelligenceRealtimeServerEvent](TypeAlias.IntelligenceRealtimeServerEvent) | Provider-neutral event emitted by a realtime model. |
86
136
  | [IntelligenceRealtimeStatus](TypeAlias.IntelligenceRealtimeStatus) | Describes the lifecycle state of an upstream realtime model connection. |
87
- | [IntelligenceTextStream](TypeAlias.IntelligenceTextStream) | Native AI SDK streaming result returned by the intelligence text generator. |
137
+ | [IntelligenceRequestTimeouts](TypeAlias.IntelligenceRequestTimeouts) | Capability-specific total request timeouts in milliseconds. |
138
+ | [IntelligenceToolChoice](TypeAlias.IntelligenceToolChoice) | Provider-neutral tool-selection policy. |
139
+ | [IntelligenceToolOutput](TypeAlias.IntelligenceToolOutput) | Provider-neutral tool result. |
140
+ | [IntelligenceToolSet](TypeAlias.IntelligenceToolSet) | Provider-neutral named tool collection. |
141
+ | [IntelligenceTranscriptionStreamPart](TypeAlias.IntelligenceTranscriptionStreamPart) | Provider-neutral live transcription event. |
88
142
 
89
143
  ## Variables
90
144
 
91
145
  | Variable | Description |
92
146
  | ------ | ------ |
147
+ | [AI\_GATEWAY\_API\_KEY](Variable.AI_GATEWAY_API_KEY) | Vercel AI Gateway API key. |
148
+ | [AI\_GATEWAY\_BASE\_URL](Variable.AI_GATEWAY_BASE_URL) | Vercel AI Gateway base URL. |
149
+ | [AI\_GATEWAY\_CONFIG\_ENTRIES](Variable.AI_GATEWAY_CONFIG_ENTRIES) | Configuration entries used by the Vercel AI Gateway provider. |
93
150
  | [ANTHROPIC\_API\_KEY](Variable.ANTHROPIC_API_KEY) | Anthropic-specific API key. |
94
151
  | [ANTHROPIC\_BASE\_URL](Variable.ANTHROPIC_BASE_URL) | Anthropic-specific base URL. |
95
152
  | [ANTHROPIC\_CONFIG\_ENTRIES](Variable.ANTHROPIC_CONFIG_ENTRIES) | Configuration entries used by the Anthropic intelligence provider. |
@@ -107,9 +164,10 @@ editUrl: false
107
164
  | [INTELLIGENCE\_BASE\_URL](Variable.INTELLIGENCE_BASE_URL) | Global base URL override for the intelligence provider. |
108
165
  | [INTELLIGENCE\_MAX\_OUTPUT\_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model. |
109
166
  | [INTELLIGENCE\_MODEL](Variable.INTELLIGENCE_MODEL) | AI model identifier to use for text generation. |
110
- | [INTELLIGENCE\_PROVIDER](Variable.INTELLIGENCE_PROVIDER) | Intelligence provider name (e.g. openai, anthropic, google, grok, mimo). |
167
+ | [INTELLIGENCE\_PROVIDER](Variable.INTELLIGENCE_PROVIDER) | Intelligence provider name (e.g. openai, anthropic, google, grok, mimo, gateway). |
111
168
  | [INTELLIGENCE\_TEMPERATURE](Variable.INTELLIGENCE_TEMPERATURE) | Sampling temperature for the AI model. |
112
169
  | [INTELLIGENCE\_TOP\_P](Variable.INTELLIGENCE_TOP_P) | Top-p (nucleus sampling) for the AI model. |
170
+ | [IntelligenceCapabilityNames](Variable.IntelligenceCapabilityNames) | Capability identifiers understood by the intelligence provider registry. |
113
171
  | [IntelligenceProviderNames](Variable.IntelligenceProviderNames) | Enumerates the supported model providers powering the intelligence pipeline. |
114
172
  | [MIMO\_API\_KEY](Variable.MIMO_API_KEY) | MiMo-specific API key. |
115
173
  | [MIMO\_BASE\_URL](Variable.MIMO_BASE_URL) | MiMo-specific base URL. |
@@ -118,7 +176,7 @@ editUrl: false
118
176
  | [OPENAI\_BASE\_URL](Variable.OPENAI_BASE_URL) | OpenAI-specific base URL. |
119
177
  | [OPENAI\_CONFIG\_ENTRIES](Variable.OPENAI_CONFIG_ENTRIES) | Configuration entries used by the OpenAI intelligence provider. |
120
178
  | [OpenAIIntelligenceToolNames](Variable.OpenAIIntelligenceToolNames) | OpenAI provider-defined tool names exposed through Archipel. |
121
- | [PLATFORM\_INTELLIGENCE\_CONFIG\_ENTRIES](Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES) | All configuration entries required by `platform-intelligence`. |
179
+ | [PLATFORM\_INTELLIGENCE\_CONFIG\_ENTRIES](Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES) | Provider-neutral configuration entries required by `platform-intelligence`. |
122
180
  | [XAI\_API\_KEY](Variable.XAI_API_KEY) | xAI-specific API key alias for Grok. |
123
181
  | [XAI\_BASE\_URL](Variable.XAI_BASE_URL) | xAI-specific base URL alias for Grok. |
124
182
 
@@ -160,8 +218,9 @@ editUrl: false
160
218
  | [createGrokViewXVideoTool](Function.createGrokViewXVideoTool) | Creates a Grok X-video understanding tool registration. |
161
219
  | [createGrokWebSearchTool](Function.createGrokWebSearchTool) | Creates a Grok web-search tool registration. |
162
220
  | [createGrokXSearchTool](Function.createGrokXSearchTool) | Creates a Grok X-search tool registration. |
163
- | [createIntelligenceTool](Function.createIntelligenceTool) | Adapts a native AI SDK tool to the Archipel intelligence tool schema. |
164
- | [createMimoCustomTool](Function.createMimoCustomTool) | Creates a MiMo function tool registration. |
221
+ | [createIntelligenceJsonSchema](Function.createIntelligenceJsonSchema) | Creates a provider-neutral JSON Schema wrapper. |
222
+ | [createIntelligenceTool](Function.createIntelligenceTool) | Creates an Archipel intelligence tool registration. |
223
+ | [createMimoCustomTool](Function.createMimoCustomTool) | Creates a provider-neutral function tool for MiMo. |
165
224
  | [createOpenAIApplyPatchTool](Function.createOpenAIApplyPatchTool) | Creates an OpenAI apply-patch tool registration. |
166
225
  | [createOpenAICodeInterpreterTool](Function.createOpenAICodeInterpreterTool) | Creates an OpenAI code-interpreter tool registration. |
167
226
  | [createOpenAICustomTool](Function.createOpenAICustomTool) | Creates an OpenAI custom provider-defined tool registration. |
@@ -173,13 +232,5 @@ editUrl: false
173
232
  | [createOpenAIToolSearchTool](Function.createOpenAIToolSearchTool) | Creates an OpenAI tool-search tool registration. |
174
233
  | [createOpenAIWebSearchPreviewTool](Function.createOpenAIWebSearchPreviewTool) | Creates an OpenAI web-search-preview tool registration. |
175
234
  | [createOpenAIWebSearchTool](Function.createOpenAIWebSearchTool) | Creates an OpenAI web-search tool registration. |
176
- | [createProviderOptions](Function.createProviderOptions) | Creates the provider options object consumed by the AI SDK model factories. |
235
+ | [defineIntelligenceTool](Function.defineIntelligenceTool) | Defines a provider-neutral intelligence tool while preserving its input and output types. |
177
236
  | [intelligencePrompt](Function.intelligencePrompt) | Creates a reusable intelligence prompt definition. |
178
- | [loadAnthropicLanguageModel](Function.loadAnthropicLanguageModel) | Creates the Anthropic language model from the resolved provider configuration. |
179
- | [loadGoogleLanguageModel](Function.loadGoogleLanguageModel) | Creates the Google Gemini language model from the resolved provider configuration. |
180
- | [loadGoogleRealtimeModel](Function.loadGoogleRealtimeModel) | Creates a Google Gemini Live model exclusively through the Vercel AI SDK provider. |
181
- | [loadGrokLanguageModel](Function.loadGrokLanguageModel) | Creates the Grok language model through the native xAI provider. |
182
- | [loadGrokRealtimeModel](Function.loadGrokRealtimeModel) | Creates an xAI Grok voice model exclusively through the Vercel AI SDK provider. |
183
- | [loadMimoLanguageModel](Function.loadMimoLanguageModel) | Creates the Xiaomi MiMo language model from the resolved provider configuration. |
184
- | [loadOpenAILanguageModel](Function.loadOpenAILanguageModel) | Creates the OpenAI language model from the resolved provider configuration. |
185
- | [loadOpenAIRealtimeModel](Function.loadOpenAIRealtimeModel) | Creates an OpenAI realtime model exclusively through the Vercel AI SDK provider. |