@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
@@ -1,26 +0,0 @@
1
- ---
2
- title: 'Function: loadGoogleLanguageModel()'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Function: loadGoogleLanguageModel()
7
-
8
- ```ts
9
- function loadGoogleLanguageModel(configuration): Promise<LanguageModelV4>;
10
- ```
11
-
12
- Defined in: [providers/google/loadGoogleLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/loadGoogleLanguageModel.ts#L17)
13
-
14
- Creates the Google Gemini language model from the resolved provider configuration.
15
-
16
- ## Parameters
17
-
18
- | Parameter | Type | Description |
19
- | ------ | ------ | ------ |
20
- | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
21
-
22
- ## Returns
23
-
24
- `Promise`\<`LanguageModelV4`\>
25
-
26
- The configured language model instance.
@@ -1,25 +0,0 @@
1
- ---
2
- title: 'Function: loadGoogleRealtimeModel()'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Function: loadGoogleRealtimeModel()
7
-
8
- ```ts
9
- function loadGoogleRealtimeModel(configuration, options): Promise<RealtimeModelV4>;
10
- ```
11
-
12
- Defined in: [providers/google/loadGoogleRealtimeModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/loadGoogleRealtimeModel.ts#L17)
13
-
14
- Creates a Google Gemini Live model exclusively through the Vercel AI SDK provider.
15
-
16
- ## Parameters
17
-
18
- | Parameter | Type |
19
- | ------ | ------ |
20
- | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
21
- | `options` | `IIntelligenceRealtimeModelLoaderOptions` |
22
-
23
- ## Returns
24
-
25
- `Promise`\<`RealtimeModelV4`\>
@@ -1,26 +0,0 @@
1
- ---
2
- title: 'Function: loadGrokLanguageModel()'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Function: loadGrokLanguageModel()
7
-
8
- ```ts
9
- function loadGrokLanguageModel(configuration): Promise<LanguageModelV4>;
10
- ```
11
-
12
- Defined in: [providers/grok/loadGrokLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/loadGrokLanguageModel.ts#L17)
13
-
14
- Creates the Grok language model through the native xAI provider.
15
-
16
- ## Parameters
17
-
18
- | Parameter | Type | Description |
19
- | ------ | ------ | ------ |
20
- | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
21
-
22
- ## Returns
23
-
24
- `Promise`\<`LanguageModelV4`\>
25
-
26
- The configured language model instance.
@@ -1,25 +0,0 @@
1
- ---
2
- title: 'Function: loadGrokRealtimeModel()'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Function: loadGrokRealtimeModel()
7
-
8
- ```ts
9
- function loadGrokRealtimeModel(configuration, options): Promise<RealtimeModelV4>;
10
- ```
11
-
12
- Defined in: [providers/grok/loadGrokRealtimeModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/loadGrokRealtimeModel.ts#L17)
13
-
14
- Creates an xAI Grok voice model exclusively through the Vercel AI SDK provider.
15
-
16
- ## Parameters
17
-
18
- | Parameter | Type |
19
- | ------ | ------ |
20
- | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
21
- | `options` | `IIntelligenceRealtimeModelLoaderOptions` |
22
-
23
- ## Returns
24
-
25
- `Promise`\<`RealtimeModelV4`\>
@@ -1,26 +0,0 @@
1
- ---
2
- title: 'Function: loadMimoLanguageModel()'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Function: loadMimoLanguageModel()
7
-
8
- ```ts
9
- function loadMimoLanguageModel(configuration): Promise<LanguageModelV4>;
10
- ```
11
-
12
- Defined in: [providers/mimo/loadMimoLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/mimo/loadMimoLanguageModel.ts#L17)
13
-
14
- Creates the Xiaomi MiMo language model from the resolved provider configuration.
15
-
16
- ## Parameters
17
-
18
- | Parameter | Type | Description |
19
- | ------ | ------ | ------ |
20
- | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
21
-
22
- ## Returns
23
-
24
- `Promise`\<`LanguageModelV4`\>
25
-
26
- The configured language model instance.
@@ -1,26 +0,0 @@
1
- ---
2
- title: 'Function: loadOpenAILanguageModel()'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Function: loadOpenAILanguageModel()
7
-
8
- ```ts
9
- function loadOpenAILanguageModel(configuration): Promise<LanguageModelV4>;
10
- ```
11
-
12
- Defined in: [providers/openai/loadOpenAILanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/loadOpenAILanguageModel.ts#L17)
13
-
14
- Creates the OpenAI language model from the resolved provider configuration.
15
-
16
- ## Parameters
17
-
18
- | Parameter | Type | Description |
19
- | ------ | ------ | ------ |
20
- | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
21
-
22
- ## Returns
23
-
24
- `Promise`\<`LanguageModelV4`\>
25
-
26
- The configured language model instance.
@@ -1,25 +0,0 @@
1
- ---
2
- title: 'Function: loadOpenAIRealtimeModel()'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Function: loadOpenAIRealtimeModel()
7
-
8
- ```ts
9
- function loadOpenAIRealtimeModel(configuration, options): Promise<RealtimeModelV4>;
10
- ```
11
-
12
- Defined in: [providers/openai/loadOpenAIRealtimeModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/loadOpenAIRealtimeModel.ts#L17)
13
-
14
- Creates an OpenAI realtime model exclusively through the Vercel AI SDK provider.
15
-
16
- ## Parameters
17
-
18
- | Parameter | Type |
19
- | ------ | ------ |
20
- | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
21
- | `options` | `IIntelligenceRealtimeModelLoaderOptions` |
22
-
23
- ## Returns
24
-
25
- `Promise`\<`RealtimeModelV4`\>
@@ -1,46 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceCompletionUsage'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceCompletionUsage
7
-
8
- Defined in: [contracts/IIntelligenceCompletionUsage.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L6)
9
-
10
- Captures usage telemetry returned by the intelligence provider.
11
-
12
- ## Properties
13
-
14
- ### inputTokens
15
-
16
- ```ts
17
- readonly inputTokens: number | null;
18
- ```
19
-
20
- Defined in: [contracts/IIntelligenceCompletionUsage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L14)
21
-
22
- The number of input tokens consumed by the prompt.
23
-
24
- ***
25
-
26
- ### outputTokens
27
-
28
- ```ts
29
- readonly outputTokens: number | null;
30
- ```
31
-
32
- Defined in: [contracts/IIntelligenceCompletionUsage.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L21)
33
-
34
- The number of output tokens generated in the completion.
35
-
36
- ***
37
-
38
- ### totalTokens
39
-
40
- ```ts
41
- readonly totalTokens: number | null;
42
- ```
43
-
44
- Defined in: [contracts/IIntelligenceCompletionUsage.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L28)
45
-
46
- The total number of tokens reported by the provider.
@@ -1,180 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceTextCompletion'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceTextCompletion
7
-
8
- Defined in: [contracts/IIntelligenceTextCompletion.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L20)
9
-
10
- Represents the normalized completion result produced by the intelligence provider.
11
-
12
- ## Properties
13
-
14
- ### files
15
-
16
- ```ts
17
- readonly files: readonly GeneratedFile[];
18
- ```
19
-
20
- Defined in: [contracts/IIntelligenceTextCompletion.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L63)
21
-
22
- Files generated by provider-native tools such as image generation or code interpreter.
23
-
24
- ***
25
-
26
- ### finalStep?
27
-
28
- ```ts
29
- readonly optional finalStep?: StepResult<ToolSet, Record<string, unknown>>;
30
- ```
31
-
32
- Defined in: [contracts/IIntelligenceTextCompletion.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L91)
33
-
34
- Final AI SDK generation step.
35
-
36
- ***
37
-
38
- ### model
39
-
40
- ```ts
41
- readonly model: string;
42
- ```
43
-
44
- Defined in: [contracts/IIntelligenceTextCompletion.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L49)
45
-
46
- The model identifier used for the completion.
47
-
48
- ***
49
-
50
- ### output?
51
-
52
- ```ts
53
- readonly optional output?: unknown;
54
- ```
55
-
56
- Defined in: [contracts/IIntelligenceTextCompletion.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L35)
57
-
58
- Generated output parsed according to the supplied AI SDK output specification.
59
-
60
- ***
61
-
62
- ### provider
63
-
64
- ```ts
65
- readonly provider: string;
66
- ```
67
-
68
- Defined in: [contracts/IIntelligenceTextCompletion.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L42)
69
-
70
- The provider that produced the completion.
71
-
72
- ***
73
-
74
- ### reasoning?
75
-
76
- ```ts
77
- readonly optional reasoning?: (ReasoningOutput | ReasoningFileOutput)[];
78
- ```
79
-
80
- Defined in: [contracts/IIntelligenceTextCompletion.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L70)
81
-
82
- Reasoning parts reported by AI SDK 7 compatible models.
83
-
84
- ***
85
-
86
- ### reasoningText?
87
-
88
- ```ts
89
- readonly optional reasoningText?: string;
90
- ```
91
-
92
- Defined in: [contracts/IIntelligenceTextCompletion.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L77)
93
-
94
- Concatenated reasoning text reported by the final generation step.
95
-
96
- ***
97
-
98
- ### sources
99
-
100
- ```ts
101
- readonly sources: readonly LanguageModelV4Source[];
102
- ```
103
-
104
- Defined in: [contracts/IIntelligenceTextCompletion.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L56)
105
-
106
- Sources reported by provider-native tools such as web search.
107
-
108
- ***
109
-
110
- ### steps?
111
-
112
- ```ts
113
- readonly optional steps?: StepResult<ToolSet, Record<string, unknown>>[];
114
- ```
115
-
116
- Defined in: [contracts/IIntelligenceTextCompletion.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L84)
117
-
118
- All AI SDK generation steps.
119
-
120
- ***
121
-
122
- ### text
123
-
124
- ```ts
125
- readonly text: string;
126
- ```
127
-
128
- Defined in: [contracts/IIntelligenceTextCompletion.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L28)
129
-
130
- The generated text content.
131
-
132
- ***
133
-
134
- ### toolCalls?
135
-
136
- ```ts
137
- readonly optional toolCalls?: TypedToolCall<ToolSet>[];
138
- ```
139
-
140
- Defined in: [contracts/IIntelligenceTextCompletion.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L98)
141
-
142
- Tool calls produced across the generation.
143
-
144
- ***
145
-
146
- ### toolResults?
147
-
148
- ```ts
149
- readonly optional toolResults?: TypedToolResult<ToolSet>[];
150
- ```
151
-
152
- Defined in: [contracts/IIntelligenceTextCompletion.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L105)
153
-
154
- Tool results produced across the generation.
155
-
156
- ***
157
-
158
- ### usage
159
-
160
- ```ts
161
- readonly usage:
162
- | IIntelligenceCompletionUsage
163
- | null;
164
- ```
165
-
166
- Defined in: [contracts/IIntelligenceTextCompletion.ts:119](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L119)
167
-
168
- Token usage telemetry, or `null` when the provider does not report usage.
169
-
170
- ***
171
-
172
- ### warnings?
173
-
174
- ```ts
175
- readonly optional warnings?: SharedV4Warning[];
176
- ```
177
-
178
- Defined in: [contracts/IIntelligenceTextCompletion.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L112)
179
-
180
- Provider or model warnings reported by the AI SDK.
@@ -1,144 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceTextGenerationOptions'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceTextGenerationOptions
7
-
8
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L31)
9
-
10
- Options that can be supplied when generating text with the intelligence provider.
11
-
12
- ## Extends
13
-
14
- - `IntelligenceGenerateTextPassthroughOptions`
15
-
16
- ## Properties
17
-
18
- ### abortSignal?
19
-
20
- ```ts
21
- readonly optional abortSignal?: AbortSignal;
22
- ```
23
-
24
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L81)
25
-
26
- Optional AI SDK abort signal for this generation request.
27
-
28
- The signal is linked with the platform timeout so either cancellation
29
- source can stop the request.
30
-
31
- ***
32
-
33
- ### activeTools?
34
-
35
- ```ts
36
- readonly optional activeTools?: string[];
37
- ```
38
-
39
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L112)
40
-
41
- Optional list of tool names available to the model for this request.
42
-
43
- ***
44
-
45
- ### maxOutputTokens?
46
-
47
- ```ts
48
- readonly optional maxOutputTokens?: number;
49
- ```
50
-
51
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L64)
52
-
53
- Optional maximum output tokens override.
54
-
55
- ***
56
-
57
- ### model?
58
-
59
- ```ts
60
- readonly optional model?: LanguageModel;
61
- ```
62
-
63
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L43)
64
-
65
- Optional per-request AI SDK model override.
66
-
67
- Use this escape hatch when a use case needs a provider-specific model
68
- factory, wrapped model, middleware, or gateway model that should bypass
69
- the configured platform model for this call.
70
-
71
- ***
72
-
73
- ### stopWhen?
74
-
75
- ```ts
76
- readonly optional stopWhen?: StopCondition<ToolSet> | StopCondition<ToolSet>[];
77
- ```
78
-
79
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L105)
80
-
81
- Optional AI SDK stop condition for multi-step tool execution.
82
-
83
- ***
84
-
85
- ### temperature?
86
-
87
- ```ts
88
- readonly optional temperature?: number;
89
- ```
90
-
91
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L50)
92
-
93
- Optional sampling temperature override.
94
-
95
- ***
96
-
97
- ### timeout?
98
-
99
- ```ts
100
- readonly optional timeout?: TimeoutConfiguration<ToolSet>;
101
- ```
102
-
103
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L71)
104
-
105
- Native AI SDK timeout configuration.
106
-
107
- ***
108
-
109
- ### toolChoice?
110
-
111
- ```ts
112
- readonly optional toolChoice?: ToolChoice<ToolSet>;
113
- ```
114
-
115
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L98)
116
-
117
- Optional AI SDK tool choice strategy.
118
-
119
- ***
120
-
121
- ### tools?
122
-
123
- ```ts
124
- readonly optional tools?: ToolSet;
125
- ```
126
-
127
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L91)
128
-
129
- Optional AI SDK tools available for this generation request.
130
-
131
- Tools registered in the intelligence tool registry are merged with these
132
- request-specific tools before calling the AI SDK.
133
-
134
- ***
135
-
136
- ### topP?
137
-
138
- ```ts
139
- readonly optional topP?: number;
140
- ```
141
-
142
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L57)
143
-
144
- Optional top-p (nucleus) sampling override.
@@ -1,78 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceTextGenerator'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceTextGenerator
7
-
8
- Defined in: [interfaces/IIntelligenceTextGenerator.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L17)
9
-
10
- Abstraction responsible for executing text completions using the configured provider.
11
-
12
- ## Methods
13
-
14
- ### generateText()
15
-
16
- ```ts
17
- generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
18
- ```
19
-
20
- Defined in: [interfaces/IIntelligenceTextGenerator.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L28)
21
-
22
- Generates a text completion using the configured intelligence provider.
23
-
24
- #### Parameters
25
-
26
- | Parameter | Type | Description |
27
- | ------ | ------ | ------ |
28
- | `prompt` | `Prompt` | The assembled prompt payload. |
29
- | `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) | Optional overrides for the text generation request. |
30
-
31
- #### Returns
32
-
33
- `Promise`\<[`IIntelligenceTextCompletion`](Interface.IIntelligenceTextCompletion)\>
34
-
35
- The normalized text completion result.
36
-
37
- ***
38
-
39
- ### getConfiguration()
40
-
41
- ```ts
42
- getConfiguration(): IIntelligenceProviderConfiguration;
43
- ```
44
-
45
- Defined in: [interfaces/IIntelligenceTextGenerator.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L46)
46
-
47
- Returns the currently resolved provider configuration.
48
-
49
- #### Returns
50
-
51
- [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration)
52
-
53
- The active provider configuration.
54
-
55
- ***
56
-
57
- ### streamText()
58
-
59
- ```ts
60
- streamText(prompt, options?): Promise<StreamTextResult<ToolSet, Context, Output<string, string, never>>>;
61
- ```
62
-
63
- Defined in: [interfaces/IIntelligenceTextGenerator.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L38)
64
-
65
- Streams a text completion using the configured intelligence provider.
66
-
67
- #### Parameters
68
-
69
- | Parameter | Type | Description |
70
- | ------ | ------ | ------ |
71
- | `prompt` | `Prompt` | The assembled prompt payload. |
72
- | `options?` | [`IIntelligenceTextStreamingOptions`](Interface.IIntelligenceTextStreamingOptions) | Optional overrides for the streaming request. |
73
-
74
- #### Returns
75
-
76
- `Promise`\<`StreamTextResult`\<`ToolSet`, `Context`, `Output`\<`string`, `string`, `never`\>\>\>
77
-
78
- The native AI SDK streaming result.