@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,170 +0,0 @@
1
- ---
2
- title: 'Interface: IIntelligenceTextStreamingOptions'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Interface: IIntelligenceTextStreamingOptions
7
-
8
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L34)
9
-
10
- Options that can be supplied when streaming text with the intelligence provider.
11
-
12
- ## Extends
13
-
14
- - `IntelligenceStreamTextPassthroughOptions`
15
-
16
- ## Properties
17
-
18
- ### activeTools?
19
-
20
- ```ts
21
- readonly optional activeTools?: string[];
22
- ```
23
-
24
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L98)
25
-
26
- Optional list of tool names available to the model for this request.
27
-
28
- ***
29
-
30
- ### maxOutputTokens?
31
-
32
- ```ts
33
- readonly optional maxOutputTokens?: number;
34
- ```
35
-
36
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L63)
37
-
38
- Optional maximum output tokens override.
39
-
40
- ***
41
-
42
- ### model?
43
-
44
- ```ts
45
- readonly optional model?: LanguageModel;
46
- ```
47
-
48
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L42)
49
-
50
- Optional per-request AI SDK model override.
51
-
52
- ***
53
-
54
- ### onChunk?
55
-
56
- ```ts
57
- readonly optional onChunk?: StreamTextOnChunkCallback<ToolSet>;
58
- ```
59
-
60
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L105)
61
-
62
- Optional callback invoked for every emitted stream chunk.
63
-
64
- ***
65
-
66
- ### onEnd?
67
-
68
- ```ts
69
- readonly optional onEnd?: GenerateTextOnEndCallback<NoInfer<ToolSet>, NoInfer<Context>>;
70
- ```
71
-
72
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:119](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L119)
73
-
74
- Optional callback invoked when the full stream finishes.
75
-
76
- ***
77
-
78
- ### onError?
79
-
80
- ```ts
81
- readonly optional onError?: StreamTextOnErrorCallback;
82
- ```
83
-
84
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L126)
85
-
86
- Optional callback invoked when streaming fails.
87
-
88
- ***
89
-
90
- ### onStepEnd?
91
-
92
- ```ts
93
- readonly optional onStepEnd?: GenerateTextOnStepEndCallback<NoInfer<ToolSet>, NoInfer<Context>>;
94
- ```
95
-
96
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L112)
97
-
98
- Optional callback invoked when a stream step completes.
99
-
100
- ***
101
-
102
- ### stopWhen?
103
-
104
- ```ts
105
- readonly optional stopWhen?: StopCondition<ToolSet> | StopCondition<ToolSet>[];
106
- ```
107
-
108
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L91)
109
-
110
- Optional AI SDK stop condition for multi-step tool execution.
111
-
112
- ***
113
-
114
- ### temperature?
115
-
116
- ```ts
117
- readonly optional temperature?: number;
118
- ```
119
-
120
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L49)
121
-
122
- Optional sampling temperature override.
123
-
124
- ***
125
-
126
- ### timeout?
127
-
128
- ```ts
129
- readonly optional timeout?: TimeoutConfiguration<ToolSet>;
130
- ```
131
-
132
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L70)
133
-
134
- Native AI SDK timeout configuration.
135
-
136
- ***
137
-
138
- ### toolChoice?
139
-
140
- ```ts
141
- readonly optional toolChoice?: ToolChoice<ToolSet>;
142
- ```
143
-
144
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L84)
145
-
146
- Optional AI SDK tool choice strategy.
147
-
148
- ***
149
-
150
- ### tools?
151
-
152
- ```ts
153
- readonly optional tools?: ToolSet;
154
- ```
155
-
156
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L77)
157
-
158
- Optional AI SDK tools available for this streaming request.
159
-
160
- ***
161
-
162
- ### topP?
163
-
164
- ```ts
165
- readonly optional topP?: number;
166
- ```
167
-
168
- Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L56)
169
-
170
- Optional top-p (nucleus) sampling override.
@@ -1,24 +0,0 @@
1
- ---
2
- title: 'Type Alias: IntelligenceLanguageModelLoader'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Type Alias: IntelligenceLanguageModelLoader
7
-
8
- ```ts
9
- type IntelligenceLanguageModelLoader = (configuration) => Promise<LanguageModelV4>;
10
- ```
11
-
12
- Defined in: [providers/IntelligenceLanguageModelLoader.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceLanguageModelLoader.ts#L13)
13
-
14
- Represents a factory responsible for creating a configured language model instance.
15
-
16
- ## Parameters
17
-
18
- | Parameter | Type |
19
- | ------ | ------ |
20
- | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
21
-
22
- ## Returns
23
-
24
- `Promise`\<`LanguageModelV4`\>
@@ -1,14 +0,0 @@
1
- ---
2
- title: 'Type Alias: IntelligenceLanguageModelLoaders'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Type Alias: IntelligenceLanguageModelLoaders
7
-
8
- ```ts
9
- type IntelligenceLanguageModelLoaders = Partial<Record<IntelligenceProviderName, IntelligenceLanguageModelLoader>>;
10
- ```
11
-
12
- Defined in: [providers/IntelligenceLanguageModelLoaders.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceLanguageModelLoaders.ts#L13)
13
-
14
- Maps configured intelligence providers to their tree-shakable model loader.
@@ -1,25 +0,0 @@
1
- ---
2
- title: 'Type Alias: IntelligenceRealtimeModelLoader'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Type Alias: IntelligenceRealtimeModelLoader
7
-
8
- ```ts
9
- type IntelligenceRealtimeModelLoader = (configuration, options) => Promise<RealtimeModelV4>;
10
- ```
11
-
12
- Defined in: [providers/IntelligenceRealtimeModelLoader.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceRealtimeModelLoader.ts#L14)
13
-
14
- Creates a configured Vercel AI SDK realtime model behind the Archipel facade.
15
-
16
- ## Parameters
17
-
18
- | Parameter | Type |
19
- | ------ | ------ |
20
- | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
21
- | `options` | `IIntelligenceRealtimeModelLoaderOptions` |
22
-
23
- ## Returns
24
-
25
- `Promise`\<`RealtimeModelV4`\>
@@ -1,14 +0,0 @@
1
- ---
2
- title: 'Type Alias: IntelligenceRealtimeModelLoaders'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Type Alias: IntelligenceRealtimeModelLoaders
7
-
8
- ```ts
9
- type IntelligenceRealtimeModelLoaders = Partial<Record<IntelligenceProviderName, IntelligenceRealtimeModelLoader>>;
10
- ```
11
-
12
- Defined in: [providers/IntelligenceRealtimeModelLoaders.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceRealtimeModelLoaders.ts#L13)
13
-
14
- Maps configured intelligence providers to tree-shakable realtime model loaders.
@@ -1,14 +0,0 @@
1
- ---
2
- title: 'Type Alias: IntelligenceTextStream'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Type Alias: IntelligenceTextStream
7
-
8
- ```ts
9
- type IntelligenceTextStream = ReturnType<typeof streamText>;
10
- ```
11
-
12
- Defined in: [contracts/IntelligenceTextStream.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceTextStream.ts#L12)
13
-
14
- Native AI SDK streaming result returned by the intelligence text generator.
@@ -1,150 +0,0 @@
1
- ---
2
- title: platform-logging
3
- description: Configurable logging module for NestJS with log-level management, request context propagation, and structured logging.
4
- order: 6
5
- tags: [logging, log-level, nestjs, request-context, structured-logging, correlation-id]
6
- package: '@breadstone/archipel-platform-logging'
7
- ---
8
-
9
- # platform-logging
10
-
11
- Configurable logging module for NestJS applications with application-wide log-level management, request-scoped context propagation, and structured logging. Wraps the built-in NestJS `Logger` and configures it via the central `ConfigModule`.
12
-
13
- **Package:** `@breadstone/archipel-platform-logging`
14
-
15
- <InstallTabs />
16
-
17
- ## Quick Start
18
-
19
- ```typescript
20
- import { Module } from '@nestjs/common';
21
- import { LoggerModule } from '@breadstone/archipel-platform-logging';
22
-
23
- @Module({
24
- imports: [LoggerModule],
25
- })
26
- export class AppModule {}
27
- ```
28
-
29
- The module is `@Global()` — once imported, `Logger` is available for injection across the entire application.
30
-
31
- ---
32
-
33
- ## Using the Logger
34
-
35
- Inject the standard NestJS `Logger` provided by `LoggerModule`:
36
-
37
- ```typescript
38
- import { Injectable, Logger } from '@nestjs/common';
39
-
40
- @Injectable()
41
- export class PaymentService {
42
- constructor(private readonly _logger: Logger) {}
43
-
44
- public async processPayment(orderId: string): Promise<void> {
45
- this._logger.log(`Processing payment for order ${orderId}`);
46
- // ...
47
- }
48
- }
49
- ```
50
-
51
- ---
52
-
53
- ## Request Context Propagation
54
-
55
- ### RequestIdMiddleware
56
-
57
- Extracts or generates a unique `x-request-id` per request and stores it in `AsyncLocalStorage` via `RequestContextStore`. Apply it globally:
58
-
59
- ```typescript
60
- import { RequestIdMiddleware } from '@breadstone/archipel-platform-logging';
61
-
62
- export class AppModule implements NestModule {
63
- public configure(consumer: MiddlewareConsumer): void {
64
- consumer.apply(RequestIdMiddleware).forRoutes('*');
65
- }
66
- }
67
- ```
68
-
69
- The middleware:
70
-
71
- 1. Reads the `x-request-id` header from the incoming request (if present from an API gateway or load balancer)
72
- 2. Generates a UUID v4 if no header is found
73
- 3. Sets the `x-request-id` header on the response
74
- 4. Wraps the request execution in `RequestContextStore.run()` so the ID is available anywhere in the call stack
75
-
76
- ### RequestContextStore
77
-
78
- `AsyncLocalStorage`-based per-request context store. Access the current request context from anywhere without passing parameters:
79
-
80
- ```typescript
81
- import { RequestContextStore, type IRequestContext } from '@breadstone/archipel-platform-logging';
82
-
83
- // Get current context
84
- const context: IRequestContext | undefined = RequestContextStore.get();
85
- const requestId: string | undefined = RequestContextStore.getRequestId();
86
-
87
- // Run a callback within a context (used internally by middleware)
88
- RequestContextStore.run({ requestId: 'abc-123', userId: 'user-1' }, () => {
89
- // context is available in all nested calls
90
- });
91
- ```
92
-
93
- #### IRequestContext
94
-
95
- | Field | Type | Description |
96
- | ----------- | -------- | --------------------------------- |
97
- | `requestId` | `string` | Unique request correlation ID |
98
- | `userId` | `string?`| Optional authenticated user ID |
99
-
100
- ### ContextLogger
101
-
102
- Structured logger that automatically enriches every log entry with the current request context:
103
-
104
- ```typescript
105
- import { ContextLogger } from '@breadstone/archipel-platform-logging';
106
-
107
- @Injectable()
108
- export class OrderService {
109
- private readonly _logger = new ContextLogger(OrderService.name);
110
-
111
- public async placeOrder(dto: CreateOrderDto): Promise<void> {
112
- this._logger.log('Placing order', { orderId: dto.orderId });
113
- // Output: { requestId: "abc-123", userId: "user-1", orderId: "...", message: "Placing order" }
114
- }
115
- }
116
- ```
117
-
118
- Methods: `log()`, `warn()`, `error()`, `debug()`, `verbose()` — all accept an optional `data` record that is merged with the request context.
119
-
120
- ---
121
-
122
- ## Environment Variables
123
-
124
- | Variable | Description | Required | Default |
125
- | --------------- | -------------------------------------------------------------- | -------- | ------- |
126
- | `APP_LOG_LEVEL` | Application log level (`'debug'`, `'info'`, `'warn'`, `'error'`) | No | `warn` |
127
-
128
- > **Startup validation:** The module validates `APP_LOG_LEVEL` at initialization. An unrecognized value triggers a warning and falls back to `warn`.
129
-
130
- ---
131
-
132
- ## Peer Dependencies
133
-
134
- | Package | Required | Notes |
135
- | --------- | -------- | ---------------------------------------------- |
136
- | `express` | Yes | Required for `RequestIdMiddleware` types (`Request`, `Response`) |
137
-
138
- ---
139
-
140
- ## Exports Summary
141
-
142
- | Export | Type | Description |
143
- | ----------------------- | ------------- | ------------------------------------------------------------------ |
144
- | `LoggerModule` | NestJS Module | Global logging module with log-level control |
145
- | `Logger` | Provider | NestJS Logger configured with `APP_LOG_LEVEL` |
146
- | `ContextLogger` | Class | Structured logger enriched with request context |
147
- | `RequestContextStore` | Class | AsyncLocalStorage-based per-request context (requestId, userId) |
148
- | `RequestIdMiddleware` | Middleware | Extracts/generates `x-request-id` and wraps in context store |
149
- | `IRequestContext` | Interface | Shape of the per-request context |
150
- | `REQUEST_ID_HEADER` | Constant | Header name (`'x-request-id'`) |