@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
@@ -32,7 +32,7 @@ new IntelligenceRealtimeMeteringPort(): IntelligenceRealtimeMeteringPort;
32
32
  abstract report(event): Promise<void>;
33
33
  ```
34
34
 
35
- Defined in: [realtime/ports/IntelligenceRealtimeMeteringPort.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeMeteringPort.ts#L23)
35
+ Defined in: [realtime/ports/IntelligenceRealtimeMeteringPort.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeMeteringPort.ts#L35)
36
36
 
37
37
  Persists one metering event.
38
38
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceRealtimeSessionFactory
7
7
 
8
- Defined in: [IntelligenceRealtimeSessionFactory.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L35)
8
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L34)
9
9
 
10
10
  Creates and owns server-side, provider-neutral realtime AI sessions.
11
11
 
@@ -23,10 +23,10 @@ mappings, token creation, and upstream sockets remain inside Archipel.
23
23
 
24
24
  ```ts
25
25
  new IntelligenceRealtimeSessionFactory(
26
- configService,
26
+ modelResolver,
27
+ providerRegistry,
27
28
  toolRegistry,
28
29
  metering,
29
- providerLoaders,
30
30
  runtime): IntelligenceRealtimeSessionFactory;
31
31
  ```
32
32
 
@@ -36,10 +36,10 @@ Defined in: [IntelligenceRealtimeSessionFactory.ts:55](https://github.com/RueDeR
36
36
 
37
37
  | Parameter | Type |
38
38
  | ------ | ------ |
39
- | `configService` | `ConfigService` |
39
+ | `modelResolver` | `IntelligenceModelResolver` |
40
+ | `providerRegistry` | [`IntelligenceProviderRegistry`](Class.IntelligenceProviderRegistry) |
40
41
  | `toolRegistry` | [`IntelligenceToolRegistry`](Class.IntelligenceToolRegistry) |
41
42
  | `metering` | [`IntelligenceRealtimeMeteringPort`](Class.IntelligenceRealtimeMeteringPort) |
42
- | `providerLoaders` | [`IntelligenceRealtimeModelLoaders`](TypeAlias.IntelligenceRealtimeModelLoaders) |
43
43
  | `runtime` | `IIntelligenceRealtimeRuntimeOptions` |
44
44
 
45
45
  #### Returns
@@ -71,7 +71,7 @@ Number of sessions currently owned by this module instance.
71
71
  #### Get Signature
72
72
 
73
73
  ```ts
74
- get registeredProviders(): readonly IntelligenceProviderName[];
74
+ get registeredProviders(): readonly string[];
75
75
  ```
76
76
 
77
77
  Defined in: [IntelligenceRealtimeSessionFactory.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L79)
@@ -80,7 +80,7 @@ Providers currently registered for server-owned realtime sessions.
80
80
 
81
81
  ##### Returns
82
82
 
83
- readonly [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName)[]
83
+ readonly `string`[]
84
84
 
85
85
  ## Methods
86
86
 
@@ -114,7 +114,7 @@ A provider-neutral session. Call `connect()` to start streaming.
114
114
  onModuleDestroy(): Promise<void>;
115
115
  ```
116
116
 
117
- Defined in: [IntelligenceRealtimeSessionFactory.ts:132](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L132)
117
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:141](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L141)
118
118
 
119
119
  Closes all owned upstream sessions during Nest application shutdown.
120
120
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Abstract Class: IntelligenceRealtimeSessionPort
7
7
 
8
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L14)
8
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L13)
9
9
 
10
10
  Provider-neutral control surface for one realtime model connection.
11
11
 
@@ -31,7 +31,7 @@ new IntelligenceRealtimeSessionPort(): IntelligenceRealtimeSessionPort;
31
31
  get abstract connectionId(): string;
32
32
  ```
33
33
 
34
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L18)
34
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L25)
35
35
 
36
36
  ##### Returns
37
37
 
@@ -47,7 +47,7 @@ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:18](https://githu
47
47
  get abstract model(): string;
48
48
  ```
49
49
 
50
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L20)
50
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L27)
51
51
 
52
52
  ##### Returns
53
53
 
@@ -60,14 +60,14 @@ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:20](https://githu
60
60
  #### Get Signature
61
61
 
62
62
  ```ts
63
- get abstract provider(): IntelligenceProviderName;
63
+ get abstract provider(): string;
64
64
  ```
65
65
 
66
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L19)
66
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L26)
67
67
 
68
68
  ##### Returns
69
69
 
70
- [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName)
70
+ `string`
71
71
 
72
72
  ***
73
73
 
@@ -79,7 +79,7 @@ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:19](https://githu
79
79
  get abstract sessionId(): string;
80
80
  ```
81
81
 
82
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L17)
82
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L24)
83
83
 
84
84
  ##### Returns
85
85
 
@@ -95,7 +95,7 @@ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:17](https://githu
95
95
  get abstract status(): IntelligenceRealtimeStatus;
96
96
  ```
97
97
 
98
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L21)
98
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L28)
99
99
 
100
100
  ##### Returns
101
101
 
@@ -112,7 +112,7 @@ abstract addToolOutput(
112
112
  name?): Promise<void>;
113
113
  ```
114
114
 
115
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L56)
115
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L63)
116
116
 
117
117
  Returns a completed function result to the model.
118
118
 
@@ -136,7 +136,7 @@ Returns a completed function result to the model.
136
136
  abstract appendAudio(audio): Promise<void>;
137
137
  ```
138
138
 
139
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L34)
139
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L41)
140
140
 
141
141
  Appends a base64-encoded audio fragment to the upstream input buffer.
142
142
 
@@ -158,7 +158,7 @@ Appends a base64-encoded audio fragment to the upstream input buffer.
158
158
  abstract cancelResponse(): Promise<void>;
159
159
  ```
160
160
 
161
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L53)
161
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L60)
162
162
 
163
163
  Cancels the active model response.
164
164
 
@@ -174,7 +174,7 @@ Cancels the active model response.
174
174
  abstract clearAudio(): Promise<void>;
175
175
  ```
176
176
 
177
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L40)
177
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L47)
178
178
 
179
179
  Clears the provider input audio buffer.
180
180
 
@@ -190,7 +190,7 @@ Clears the provider input audio buffer.
190
190
  abstract close(code?, reason?): Promise<void>;
191
191
  ```
192
192
 
193
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L59)
193
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L66)
194
194
 
195
195
  Gracefully closes the upstream connection and flushes metering events.
196
196
 
@@ -213,7 +213,7 @@ Gracefully closes the upstream connection and flushes metering events.
213
213
  abstract commitAudio(): Promise<void>;
214
214
  ```
215
215
 
216
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L37)
216
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L44)
217
217
 
218
218
  Commits the provider input audio buffer.
219
219
 
@@ -229,7 +229,7 @@ Commits the provider input audio buffer.
229
229
  abstract connect(): Promise<void>;
230
230
  ```
231
231
 
232
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L28)
232
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L35)
233
233
 
234
234
  Opens the upstream provider WebSocket and applies the session configuration.
235
235
 
@@ -245,7 +245,7 @@ Opens the upstream provider WebSocket and applies the session configuration.
245
245
  abstract requestResponse(options?): Promise<void>;
246
246
  ```
247
247
 
248
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L46)
248
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L53)
249
249
 
250
250
  Requests a new model response.
251
251
 
@@ -270,7 +270,7 @@ Requests a new model response.
270
270
  abstract send(event): Promise<void>;
271
271
  ```
272
272
 
273
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L31)
273
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L38)
274
274
 
275
275
  Sends any provider-neutral client event.
276
276
 
@@ -292,7 +292,7 @@ Sends any provider-neutral client event.
292
292
  abstract sendText(text, requestResponse?): Promise<void>;
293
293
  ```
294
294
 
295
- Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L43)
295
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L50)
296
296
 
297
297
  Sends a text turn and optionally asks the model to respond.
298
298
 
@@ -0,0 +1,58 @@
1
+ ---
2
+ title: 'Class: IntelligenceReranker'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceReranker
7
+
8
+ Defined in: [IntelligenceReranker.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceReranker.ts#L24)
9
+
10
+ Provider-neutral semantic reranking facade.
11
+
12
+ ## Constructors
13
+
14
+ ### Constructor
15
+
16
+ ```ts
17
+ new IntelligenceReranker(modelResolver): IntelligenceReranker;
18
+ ```
19
+
20
+ Defined in: [IntelligenceReranker.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceReranker.ts#L33)
21
+
22
+ #### Parameters
23
+
24
+ | Parameter | Type |
25
+ | ------ | ------ |
26
+ | `modelResolver` | `IntelligenceModelResolver` |
27
+
28
+ #### Returns
29
+
30
+ `IntelligenceReranker`
31
+
32
+ ## Methods
33
+
34
+ ### rerank()
35
+
36
+ ```ts
37
+ rerank<TDocument>(options): Promise<IIntelligenceRerankingResult<TDocument>>;
38
+ ```
39
+
40
+ Defined in: [IntelligenceReranker.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceReranker.ts#L50)
41
+
42
+ Reranks documents by relevance to a query.
43
+
44
+ #### Type Parameters
45
+
46
+ | Type Parameter |
47
+ | ------ |
48
+ | `TDocument` *extends* \| `string` \| `Readonly`\<`Record`\<`string`, [`IntelligenceJsonValue`](TypeAlias.IntelligenceJsonValue)\>\> |
49
+
50
+ #### Parameters
51
+
52
+ | Parameter | Type |
53
+ | ------ | ------ |
54
+ | `options` | [`IIntelligenceRerankingOptions`](Interface.IIntelligenceRerankingOptions)\<`TDocument`\> |
55
+
56
+ #### Returns
57
+
58
+ `Promise`\<[`IIntelligenceRerankingResult`](Interface.IIntelligenceRerankingResult)\<`TDocument`\>\>
@@ -0,0 +1,117 @@
1
+ ---
2
+ title: 'Class: IntelligenceSpeechGenerator'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceSpeechGenerator
7
+
8
+ Defined in: [generators/IntelligenceSpeechGenerator.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceSpeechGenerator.ts#L24)
9
+
10
+ Provider-neutral speech generation facade.
11
+
12
+ ## Extends
13
+
14
+ - `IntelligenceGeneratorBase`
15
+
16
+ ## Constructors
17
+
18
+ ### Constructor
19
+
20
+ ```ts
21
+ new IntelligenceSpeechGenerator(modelResolver): IntelligenceSpeechGenerator;
22
+ ```
23
+
24
+ Defined in: [generators/IntelligenceSpeechGenerator.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceSpeechGenerator.ts#L31)
25
+
26
+ #### Parameters
27
+
28
+ | Parameter | Type |
29
+ | ------ | ------ |
30
+ | `modelResolver` | `IntelligenceModelResolver` |
31
+
32
+ #### Returns
33
+
34
+ `IntelligenceSpeechGenerator`
35
+
36
+ #### Overrides
37
+
38
+ ```ts
39
+ IntelligenceGeneratorBase.constructor
40
+ ```
41
+
42
+ ## Properties
43
+
44
+ ### modelResolver
45
+
46
+ ```ts
47
+ protected readonly modelResolver: IntelligenceModelResolver;
48
+ ```
49
+
50
+ Defined in: [generators/abstracts/IntelligenceGeneratorBase.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/abstracts/IntelligenceGeneratorBase.ts#L19)
51
+
52
+ #### Inherited from
53
+
54
+ ```ts
55
+ IntelligenceGeneratorBase.modelResolver
56
+ ```
57
+
58
+ ## Methods
59
+
60
+ ### createProviderError()
61
+
62
+ ```ts
63
+ protected createProviderError(
64
+ error,
65
+ provider,
66
+ model,
67
+ capability,
68
+ operation,
69
+ requestId,
70
+ startedAt): IntelligenceProviderError;
71
+ ```
72
+
73
+ Defined in: [generators/abstracts/IntelligenceGeneratorBase.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/abstracts/IntelligenceGeneratorBase.ts#L40)
74
+
75
+ #### Parameters
76
+
77
+ | Parameter | Type |
78
+ | ------ | ------ |
79
+ | `error` | `unknown` |
80
+ | `provider` | `string` |
81
+ | `model` | `string` |
82
+ | `capability` | [`IntelligenceCapability`](TypeAlias.IntelligenceCapability) |
83
+ | `operation` | `string` |
84
+ | `requestId` | `string` \| `undefined` |
85
+ | `startedAt` | `number` |
86
+
87
+ #### Returns
88
+
89
+ [`IntelligenceProviderError`](Class.IntelligenceProviderError)
90
+
91
+ #### Inherited from
92
+
93
+ ```ts
94
+ IntelligenceGeneratorBase.createProviderError
95
+ ```
96
+
97
+ ***
98
+
99
+ ### generate()
100
+
101
+ ```ts
102
+ generate(options): Promise<IIntelligenceSpeechGenerationResult>;
103
+ ```
104
+
105
+ Defined in: [generators/IntelligenceSpeechGenerator.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceSpeechGenerator.ts#L48)
106
+
107
+ Generates spoken audio from text.
108
+
109
+ #### Parameters
110
+
111
+ | Parameter | Type |
112
+ | ------ | ------ |
113
+ | `options` | [`IIntelligenceSpeechGenerationOptions`](Interface.IIntelligenceSpeechGenerationOptions) |
114
+
115
+ #### Returns
116
+
117
+ `Promise`\<[`IIntelligenceSpeechGenerationResult`](Interface.IIntelligenceSpeechGenerationResult)\>
@@ -5,14 +5,13 @@ editUrl: false
5
5
  ---
6
6
  # Abstract Class: IntelligenceToolBase\<_TInput, _TOutput\>
7
7
 
8
- Defined in: [abstracts/IntelligenceToolBase.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceToolBase.ts#L39)
8
+ Defined in: [abstracts/IntelligenceToolBase.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceToolBase.ts#L38)
9
9
 
10
- Base class for class-based AI SDK tools.
10
+ Base class for class-based intelligence tools.
11
11
 
12
12
  Archipel keeps tool registration object-oriented while leaving the actual tool
13
- definition fully owned by the AI SDK. Concrete tools expose a stable registry
14
- name and return a native Tool definition, which may be created with
15
- `tool()`, provider-defined tool factories, or any other AI SDK-supported API.
13
+ definition provider-neutral. Concrete tools expose a stable registry name
14
+ and an Archipel-owned definition.
16
15
 
17
16
  ## Example
18
17
 
@@ -22,8 +21,8 @@ export class CustomerSearchTool extends IntelligenceToolBase<ICustomerSearchInpu
22
21
  return 'searchCustomers';
23
22
  }
24
23
 
25
- public override get tool(): Tool<ICustomerSearchInput, ICustomerSearchResult> {
26
- return tool({
24
+ public override get tool(): IIntelligenceToolDefinition<ICustomerSearchInput, ICustomerSearchResult> {
25
+ return defineIntelligenceTool({
27
26
  description: 'Searches customers by name, email, or company.',
28
27
  inputSchema: z.object({
29
28
  query: z.string().describe('Customer search query'),
@@ -38,8 +37,8 @@ export class CustomerSearchTool extends IntelligenceToolBase<ICustomerSearchInpu
38
37
 
39
38
  | Type Parameter | Default type | Description |
40
39
  | ------ | ------ | ------ |
41
- | `_TInput` | `unknown` | The input type accepted by the AI SDK tool. |
42
- | `_TOutput` | `unknown` | The output type produced by the AI SDK tool. |
40
+ | `_TInput` | `unknown` | The input type accepted by the tool. |
41
+ | `_TOutput` | `unknown` | The output type produced by the tool. |
43
42
 
44
43
  ## Constructors
45
44
 
@@ -63,12 +62,11 @@ new IntelligenceToolBase<_TInput, _TOutput>(): IntelligenceToolBase<_TInput, _TO
63
62
  get abstract name(): string;
64
63
  ```
65
64
 
66
- Defined in: [abstracts/IntelligenceToolBase.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceToolBase.ts#L59)
65
+ Defined in: [abstracts/IntelligenceToolBase.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceToolBase.ts#L57)
67
66
 
68
67
  Gets the unique registry name for the tool.
69
68
 
70
- The name becomes the key in the AI SDK tool set passed to `generateText()`
71
- or `streamText()`.
69
+ The name becomes the key in the tool set passed to language generation.
72
70
 
73
71
  ##### Returns
74
72
 
@@ -81,13 +79,13 @@ or `streamText()`.
81
79
  #### Get Signature
82
80
 
83
81
  ```ts
84
- get abstract tool(): Tool<_TInput, _TOutput>;
82
+ get abstract tool(): IIntelligenceToolDefinition<_TInput, _TOutput>;
85
83
  ```
86
84
 
87
- Defined in: [abstracts/IntelligenceToolBase.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceToolBase.ts#L67)
85
+ Defined in: [abstracts/IntelligenceToolBase.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceToolBase.ts#L65)
88
86
 
89
- Gets the native AI SDK tool definition.
87
+ Gets the provider-neutral tool definition.
90
88
 
91
89
  ##### Returns
92
90
 
93
- `Tool`\<`_TInput`, `_TOutput`\>
91
+ [`IIntelligenceToolDefinition`](Interface.IIntelligenceToolDefinition)\<`_TInput`, `_TOutput`\>
@@ -9,8 +9,8 @@ Defined in: [IntelligenceToolRegistry.ts:20](https://github.com/RueDeRennes/arch
9
9
 
10
10
  Registry for class-based intelligence tools.
11
11
 
12
- The registry keeps the Archipel side class-based while exposing tools as a
13
- native AI SDK `ToolSet` for `generateText()` and `streamText()`.
12
+ The registry keeps application tools provider-neutral and supplies them to
13
+ Archipel language generation.
14
14
 
15
15
  ## Implements
16
16
 
@@ -60,7 +60,7 @@ Gets the number of registered tools.
60
60
  get(name): IIntelligenceTool | undefined;
61
61
  ```
62
62
 
63
- Defined in: [IntelligenceToolRegistry.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L85)
63
+ Defined in: [IntelligenceToolRegistry.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L102)
64
64
 
65
65
  Gets a tool by name.
66
66
 
@@ -88,7 +88,7 @@ The tool instance, or `undefined` if not found.
88
88
  has(name): boolean;
89
89
  ```
90
90
 
91
- Defined in: [IntelligenceToolRegistry.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L97)
91
+ Defined in: [IntelligenceToolRegistry.ts:114](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L114)
92
92
 
93
93
  Checks whether a tool with the given name is registered.
94
94
 
@@ -116,7 +116,7 @@ Checks whether a tool with the given name is registered.
116
116
  list(): readonly IIntelligenceTool[];
117
117
  ```
118
118
 
119
- Defined in: [IntelligenceToolRegistry.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L107)
119
+ Defined in: [IntelligenceToolRegistry.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L124)
120
120
 
121
121
  Returns all registered tools as a readonly array.
122
122
 
@@ -138,7 +138,7 @@ Array of all registered tool instances.
138
138
  listNames(): readonly string[];
139
139
  ```
140
140
 
141
- Defined in: [IntelligenceToolRegistry.ts:117](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L117)
141
+ Defined in: [IntelligenceToolRegistry.ts:134](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L134)
142
142
 
143
143
  Returns all registered tool names.
144
144
 
@@ -185,29 +185,25 @@ Tools with duplicate names replace the existing registration.
185
185
  ### toToolSet()
186
186
 
187
187
  ```ts
188
- toToolSet(): ToolSet;
188
+ toToolSet(): IntelligenceToolSet;
189
189
  ```
190
190
 
191
- Defined in: [IntelligenceToolRegistry.ts:140](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L140)
191
+ Defined in: [IntelligenceToolRegistry.ts:153](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceToolRegistry.ts#L153)
192
192
 
193
- Converts all registered tools to the AI SDK's native tool set format.
194
-
195
- This record can be passed directly to `generateText()` or `streamText()`
196
- as the `tools` parameter.
193
+ Converts all registered application tools to an Archipel tool set.
197
194
 
198
195
  #### Returns
199
196
 
200
- `ToolSet`
197
+ [`IntelligenceToolSet`](TypeAlias.IntelligenceToolSet)
201
198
 
202
- A record mapping tool names to Tool definitions.
199
+ A record mapping tool names to provider-neutral definitions.
203
200
 
204
201
  #### Example
205
202
 
206
203
  ```typescript
207
- const tools = registry.toToolSet();
208
- const result = await generateText({
209
- model: openai('gpt-4o'),
210
- tools,
204
+ const result = await languageGenerator.generateText({
205
+ model: { provider: 'openai', model: 'gpt-4o' },
206
+ tools: registry.toToolSet(),
211
207
  prompt: 'Find user John Doe',
212
208
  });
213
209
  ```