@breadstone/archipel-mcp 0.0.54 → 0.0.55

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 (208) hide show
  1. package/data/guides/ai-image-generation.md +96 -0
  2. package/data/guides/ai-realtime-voice.md +69 -464
  3. package/data/guides/ai-text-generation.md +95 -626
  4. package/data/guides/index.md +2 -1
  5. package/data/guides/intelligence-prompts-warm-up.md +63 -283
  6. package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +78 -0
  7. package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +78 -0
  8. package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +78 -0
  9. package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +78 -0
  10. package/data/packages/platform-intelligence/api/Class.IntelligenceAgent.md +95 -0
  11. package/data/packages/platform-intelligence/api/Class.IntelligenceAgentFactory.md +11 -23
  12. package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +25 -21
  13. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +11 -7
  14. package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +159 -0
  15. package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +60 -38
  16. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  17. package/data/packages/platform-intelligence/api/Class.IntelligencePromptExecutor.md +6 -6
  18. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAssetUploader.md +21 -15
  19. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderDiagnostics.md +55 -0
  20. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderError.md +14 -4
  21. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderRegistry.md +68 -0
  22. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +9 -9
  23. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +12 -12
  24. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +18 -18
  25. package/data/packages/platform-intelligence/api/Class.IntelligenceReranker.md +58 -0
  26. package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +14 -16
  27. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +10 -14
  28. package/data/packages/platform-intelligence/api/Class.MiMoIntelligenceProviderAdapter.md +78 -0
  29. package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +102 -0
  30. package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +1 -1
  31. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +1 -1
  32. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +1 -1
  33. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +1 -1
  34. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +1 -1
  35. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +1 -1
  36. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +1 -1
  37. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +1 -1
  38. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +1 -1
  39. package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +1 -1
  40. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +1 -1
  41. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +1 -1
  42. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +1 -1
  43. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +1 -1
  44. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +1 -1
  45. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +1 -1
  46. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +1 -1
  47. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +1 -1
  48. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +1 -1
  49. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +1 -1
  50. package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +1 -1
  51. package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +1 -1
  52. package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +1 -1
  53. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +1 -1
  54. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +1 -1
  55. package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +1 -1
  56. package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +1 -1
  57. package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +1 -1
  58. package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +1 -1
  59. package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +1 -1
  60. package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +1 -1
  61. package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +1 -1
  62. package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +1 -1
  63. package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +1 -1
  64. package/data/packages/platform-intelligence/api/Function.createIntelligenceJsonSchema.md +31 -0
  65. package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +2 -2
  66. package/data/packages/platform-intelligence/api/Function.createMimoCustomTool.md +5 -5
  67. package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +1 -1
  68. package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +1 -1
  69. package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +1 -1
  70. package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +1 -1
  71. package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +1 -1
  72. package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +1 -1
  73. package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +1 -1
  74. package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +1 -1
  75. package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +1 -1
  76. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +1 -1
  77. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +1 -1
  78. package/data/packages/platform-intelligence/api/Function.defineIntelligenceTool.md +31 -0
  79. package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md +70 -0
  80. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md +124 -0
  81. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +70 -0
  82. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +114 -0
  83. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +70 -0
  84. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +102 -0
  85. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadResult.md +60 -0
  86. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGeneratedFile.md +40 -0
  87. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGenerationStepStartEvent.md +50 -0
  88. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationOptions.md +170 -0
  89. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationResult.md +60 -0
  90. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageCompletion.md +141 -0
  91. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md +234 -0
  92. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageStream.md +50 -0
  93. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelReference.md +34 -0
  94. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelRequestOptions.md +52 -0
  95. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +30 -0
  96. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +33 -27
  97. package/data/packages/platform-intelligence/api/Interface.IIntelligenceObjectStream.md +56 -0
  98. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +50 -0
  99. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptDefinition.md +14 -14
  100. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md +1 -1
  101. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md +1 -1
  102. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md +15 -27
  103. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderAdapter.md +73 -0
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +10 -10
  105. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +40 -0
  106. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md +70 -0
  107. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +9 -21
  108. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +11 -11
  109. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +98 -0
  110. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +140 -0
  111. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +50 -0
  112. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +94 -0
  113. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +80 -0
  114. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +164 -0
  115. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +50 -0
  116. package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +139 -0
  117. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +7 -10
  118. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolCall.md +40 -0
  119. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolDefinition.md +91 -0
  120. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionEndEvent.md +50 -0
  121. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionStartEvent.md +30 -0
  122. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +4 -4
  123. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionOptions.md +114 -0
  124. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionResult.md +84 -0
  125. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionStream.md +97 -0
  126. package/data/packages/platform-intelligence/api/Interface.IIntelligenceUsage.md +40 -0
  127. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +229 -0
  128. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationResult.md +50 -0
  129. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceModelMessage.md +43 -0
  130. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligencePromptModelRequirement.md +2 -2
  131. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceSchema.md +70 -0
  132. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceCapability.md +14 -0
  133. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceDefaultModels.md +14 -0
  134. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceJsonValue.md +22 -0
  135. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptDefinitionConfiguration.md +2 -2
  136. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md +1 -1
  137. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
  138. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderOptions.md +14 -0
  139. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderProbeStatus.md +14 -0
  140. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderToolOptions.md +17 -0
  141. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +1 -1
  142. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRequestTimeouts.md +14 -0
  143. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolChoice.md +21 -0
  144. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolOutput.md +22 -0
  145. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolSet.md +14 -0
  146. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md +46 -0
  147. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_API_KEY.md +14 -0
  148. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_BASE_URL.md +14 -0
  149. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_CONFIG_ENTRIES.md +14 -0
  150. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  151. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  152. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  153. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  154. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +2 -2
  155. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  156. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  157. package/data/packages/platform-intelligence/api/Variable.IntelligenceCapabilityNames.md +40 -0
  158. package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +2 -0
  159. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +1 -1
  160. package/data/packages/platform-intelligence/api/index.md +78 -30
  161. package/package.json +1 -1
  162. package/data/packages/index.md +0 -8
  163. package/data/packages/platform-analytics/index.md +0 -209
  164. package/data/packages/platform-authentication/index.md +0 -725
  165. package/data/packages/platform-blob-storage/index.md +0 -416
  166. package/data/packages/platform-bootstrap/index.md +0 -162
  167. package/data/packages/platform-caching/index.md +0 -167
  168. package/data/packages/platform-configuration/index.md +0 -226
  169. package/data/packages/platform-core/index.md +0 -504
  170. package/data/packages/platform-cryptography/index.md +0 -142
  171. package/data/packages/platform-database/index.md +0 -337
  172. package/data/packages/platform-documents/index.md +0 -255
  173. package/data/packages/platform-esigning/index.md +0 -710
  174. package/data/packages/platform-feature-flags/index.md +0 -103
  175. package/data/packages/platform-health/index.md +0 -141
  176. package/data/packages/platform-intelligence/api/Class.IntelligenceStructuredGenerator.md +0 -70
  177. package/data/packages/platform-intelligence/api/Class.IntelligenceTelemetryRegistry.md +0 -44
  178. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +0 -138
  179. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +0 -39
  180. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +0 -26
  181. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +0 -26
  182. package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +0 -25
  183. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +0 -26
  184. package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +0 -25
  185. package/data/packages/platform-intelligence/api/Function.loadMimoLanguageModel.md +0 -26
  186. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +0 -26
  187. package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +0 -25
  188. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +0 -46
  189. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +0 -180
  190. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +0 -144
  191. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +0 -78
  192. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +0 -170
  193. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +0 -24
  194. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +0 -14
  195. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +0 -25
  196. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +0 -14
  197. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +0 -14
  198. package/data/packages/platform-intelligence/index.md +0 -627
  199. package/data/packages/platform-logging/index.md +0 -150
  200. package/data/packages/platform-mailing/index.md +0 -470
  201. package/data/packages/platform-mapping/index.md +0 -123
  202. package/data/packages/platform-mcp/index.md +0 -335
  203. package/data/packages/platform-openapi/index.md +0 -207
  204. package/data/packages/platform-payments/index.md +0 -610
  205. package/data/packages/platform-queue/index.md +0 -192
  206. package/data/packages/platform-reporting/index.md +0 -233
  207. package/data/packages/platform-resources/index.md +0 -137
  208. package/data/packages/platform-telemetry/index.md +0 -262
@@ -0,0 +1,78 @@
1
+ ---
2
+ title: 'Class: GrokIntelligenceProviderAdapter'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: GrokIntelligenceProviderAdapter
7
+
8
+ Defined in: providers/grok/GrokIntelligenceProviderAdapter.ts:19
9
+
10
+ xAI Grok adapter for language, image, speech, transcription, video, realtime, and files.
11
+
12
+ ## Implements
13
+
14
+ - [`IIntelligenceProviderAdapter`](Interface.IIntelligenceProviderAdapter)
15
+
16
+ ## Constructors
17
+
18
+ ### Constructor
19
+
20
+ ```ts
21
+ new GrokIntelligenceProviderAdapter(): GrokIntelligenceProviderAdapter;
22
+ ```
23
+
24
+ #### Returns
25
+
26
+ `GrokIntelligenceProviderAdapter`
27
+
28
+ ## Properties
29
+
30
+ ### capabilities
31
+
32
+ ```ts
33
+ readonly capabilities: readonly ["language", "image", "speech", "transcription", "video", "realtime", "files"];
34
+ ```
35
+
36
+ Defined in: providers/grok/GrokIntelligenceProviderAdapter.ts:31
37
+
38
+ #### Implementation of
39
+
40
+ [`IIntelligenceProviderAdapter`](Interface.IIntelligenceProviderAdapter).[`capabilities`](Interface.IIntelligenceProviderAdapter#capabilities)
41
+
42
+ ***
43
+
44
+ ### provider
45
+
46
+ ```ts
47
+ readonly provider: "grok" = IntelligenceProviderNames.Grok;
48
+ ```
49
+
50
+ Defined in: providers/grok/GrokIntelligenceProviderAdapter.ts:30
51
+
52
+ #### Implementation of
53
+
54
+ [`IIntelligenceProviderAdapter`](Interface.IIntelligenceProviderAdapter).[`provider`](Interface.IIntelligenceProviderAdapter#provider)
55
+
56
+ ## Methods
57
+
58
+ ### load()
59
+
60
+ ```ts
61
+ load(request): Promise<unknown>;
62
+ ```
63
+
64
+ Defined in: providers/grok/GrokIntelligenceProviderAdapter.ts:45
65
+
66
+ #### Parameters
67
+
68
+ | Parameter | Type |
69
+ | ------ | ------ |
70
+ | `request` | [`IIntelligenceProviderLoadRequest`](Interface.IIntelligenceProviderLoadRequest) |
71
+
72
+ #### Returns
73
+
74
+ `Promise`\<`unknown`\>
75
+
76
+ #### Implementation of
77
+
78
+ [`IIntelligenceProviderAdapter`](Interface.IIntelligenceProviderAdapter).[`load`](Interface.IIntelligenceProviderAdapter#load)
@@ -0,0 +1,95 @@
1
+ ---
2
+ title: 'Class: IntelligenceAgent'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceAgent
7
+
8
+ Defined in: IntelligenceAgent.ts:17
9
+
10
+ Reusable provider-neutral agent backed by the language capability.
11
+
12
+ ## Constructors
13
+
14
+ ### Constructor
15
+
16
+ ```ts
17
+ new IntelligenceAgent(configuration, languageGenerator): IntelligenceAgent;
18
+ ```
19
+
20
+ Defined in: IntelligenceAgent.ts:27
21
+
22
+ #### Parameters
23
+
24
+ | Parameter | Type |
25
+ | ------ | ------ |
26
+ | `configuration` | [`IIntelligenceAgentConfiguration`](Interface.IIntelligenceAgentConfiguration) |
27
+ | `languageGenerator` | [`IntelligenceLanguageGenerator`](Class.IntelligenceLanguageGenerator) |
28
+
29
+ #### Returns
30
+
31
+ `IntelligenceAgent`
32
+
33
+ ## Accessors
34
+
35
+ ### name
36
+
37
+ #### Get Signature
38
+
39
+ ```ts
40
+ get name(): string | undefined;
41
+ ```
42
+
43
+ Defined in: IntelligenceAgent.ts:37
44
+
45
+ Optional stable agent name used by application observability.
46
+
47
+ ##### Returns
48
+
49
+ `string` \| `undefined`
50
+
51
+ ## Methods
52
+
53
+ ### generate()
54
+
55
+ ```ts
56
+ generate(prompt, options?): Promise<IIntelligenceLanguageCompletion<string>>;
57
+ ```
58
+
59
+ Defined in: IntelligenceAgent.ts:46
60
+
61
+ Executes one bounded agent run.
62
+
63
+ #### Parameters
64
+
65
+ | Parameter | Type |
66
+ | ------ | ------ |
67
+ | `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
68
+ | `options` | [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions) |
69
+
70
+ #### Returns
71
+
72
+ `Promise`\<[`IIntelligenceLanguageCompletion`](Interface.IIntelligenceLanguageCompletion)\<`string`\>\>
73
+
74
+ ***
75
+
76
+ ### stream()
77
+
78
+ ```ts
79
+ stream(prompt, options?): Promise<IIntelligenceLanguageStream>;
80
+ ```
81
+
82
+ Defined in: IntelligenceAgent.ts:51
83
+
84
+ Streams one agent run.
85
+
86
+ #### Parameters
87
+
88
+ | Parameter | Type |
89
+ | ------ | ------ |
90
+ | `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
91
+ | `options` | [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions) |
92
+
93
+ #### Returns
94
+
95
+ `Promise`\<[`IIntelligenceLanguageStream`](Interface.IIntelligenceLanguageStream)\>
@@ -7,14 +7,14 @@ editUrl: false
7
7
 
8
8
  Defined in: [IntelligenceAgentFactory.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceAgentFactory.ts#L16)
9
9
 
10
- Creates AI SDK 7 tool-loop agents with platform-registered tools merged in.
10
+ Creates reusable provider-neutral tool-loop agents.
11
11
 
12
12
  ## Constructors
13
13
 
14
14
  ### Constructor
15
15
 
16
16
  ```ts
17
- new IntelligenceAgentFactory(toolRegistry): IntelligenceAgentFactory;
17
+ new IntelligenceAgentFactory(languageGenerator): IntelligenceAgentFactory;
18
18
  ```
19
19
 
20
20
  Defined in: [IntelligenceAgentFactory.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceAgentFactory.ts#L25)
@@ -23,7 +23,7 @@ Defined in: [IntelligenceAgentFactory.ts:25](https://github.com/RueDeRennes/arch
23
23
 
24
24
  | Parameter | Type |
25
25
  | ------ | ------ |
26
- | `toolRegistry` | [`IntelligenceToolRegistry`](Class.IntelligenceToolRegistry) |
26
+ | `languageGenerator` | [`IntelligenceLanguageGenerator`](Class.IntelligenceLanguageGenerator) |
27
27
 
28
28
  #### Returns
29
29
 
@@ -31,34 +31,22 @@ Defined in: [IntelligenceAgentFactory.ts:25](https://github.com/RueDeRennes/arch
31
31
 
32
32
  ## Methods
33
33
 
34
- ### createToolLoopAgent()
34
+ ### create()
35
35
 
36
36
  ```ts
37
- createToolLoopAgent<TOOLS, RUNTIME_CONTEXT>(settings): Promise<ToolLoopAgent<never, TOOLS, RUNTIME_CONTEXT, never>>;
37
+ create(configuration): IntelligenceAgent;
38
38
  ```
39
39
 
40
- Defined in: [IntelligenceAgentFactory.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceAgentFactory.ts#L47)
40
+ Defined in: [IntelligenceAgentFactory.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceAgentFactory.ts#L38)
41
41
 
42
- Creates a native AI SDK `ToolLoopAgent`.
43
-
44
- Registered platform tools are merged before request-specific tools, so
45
- request-specific tools can intentionally override a platform tool name.
46
-
47
- #### Type Parameters
48
-
49
- | Type Parameter | Default type |
50
- | ------ | ------ |
51
- | `TOOLS` *extends* `ToolSet` | `ToolSet` |
52
- | `RUNTIME_CONTEXT` *extends* `Record`\<`string`, `unknown`\> | `Record`\<`string`, `unknown`\> |
42
+ Creates a reusable agent that resolves its provider model only when run.
53
43
 
54
44
  #### Parameters
55
45
 
56
- | Parameter | Type | Description |
57
- | ------ | ------ | ------ |
58
- | `settings` | `ToolLoopAgentSettings`\<`never`, `TOOLS`, `RUNTIME_CONTEXT`, `never`\> | Native AI SDK tool-loop agent settings. |
46
+ | Parameter | Type |
47
+ | ------ | ------ |
48
+ | `configuration` | [`IIntelligenceAgentConfiguration`](Interface.IIntelligenceAgentConfiguration) |
59
49
 
60
50
  #### Returns
61
51
 
62
- `Promise`\<`ToolLoopAgent`\<`never`, `TOOLS`, `RUNTIME_CONTEXT`, `never`\>\>
63
-
64
- A configured AI SDK tool-loop agent.
52
+ [`IntelligenceAgent`](Class.IntelligenceAgent)
@@ -5,18 +5,26 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceEmbeddingGenerator
7
7
 
8
- Defined in: [IntelligenceEmbeddingGenerator.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceEmbeddingGenerator.ts#L20)
8
+ Defined in: [IntelligenceEmbeddingGenerator.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceEmbeddingGenerator.ts#L27)
9
9
 
10
- Executes AI SDK embedding operations.
10
+ Provider-neutral single and batch embedding facade.
11
11
 
12
12
  ## Constructors
13
13
 
14
14
  ### Constructor
15
15
 
16
16
  ```ts
17
- new IntelligenceEmbeddingGenerator(): IntelligenceEmbeddingGenerator;
17
+ new IntelligenceEmbeddingGenerator(modelResolver): IntelligenceEmbeddingGenerator;
18
18
  ```
19
19
 
20
+ Defined in: [IntelligenceEmbeddingGenerator.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceEmbeddingGenerator.ts#L36)
21
+
22
+ #### Parameters
23
+
24
+ | Parameter | Type |
25
+ | ------ | ------ |
26
+ | `modelResolver` | `IntelligenceModelResolver` |
27
+
20
28
  #### Returns
21
29
 
22
30
  `IntelligenceEmbeddingGenerator`
@@ -26,45 +34,41 @@ new IntelligenceEmbeddingGenerator(): IntelligenceEmbeddingGenerator;
26
34
  ### embed()
27
35
 
28
36
  ```ts
29
- embed(options): Promise<EmbedResult>;
37
+ embed(options): Promise<IIntelligenceEmbeddingResult>;
30
38
  ```
31
39
 
32
- Defined in: [IntelligenceEmbeddingGenerator.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceEmbeddingGenerator.ts#L42)
40
+ Defined in: [IntelligenceEmbeddingGenerator.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceEmbeddingGenerator.ts#L53)
33
41
 
34
- Embeds a single value.
42
+ Embeds one text value.
35
43
 
36
44
  #### Parameters
37
45
 
38
- | Parameter | Type | Description |
39
- | ------ | ------ | ------ |
40
- | `options` | \{ \} | Native AI SDK `embed()` options. |
46
+ | Parameter | Type |
47
+ | ------ | ------ |
48
+ | `options` | [`IIntelligenceEmbeddingOptions`](Interface.IIntelligenceEmbeddingOptions) |
41
49
 
42
50
  #### Returns
43
51
 
44
- `Promise`\<`EmbedResult`\>
45
-
46
- The native AI SDK embedding result.
52
+ `Promise`\<[`IIntelligenceEmbeddingResult`](Interface.IIntelligenceEmbeddingResult)\>
47
53
 
48
54
  ***
49
55
 
50
56
  ### embedMany()
51
57
 
52
58
  ```ts
53
- embedMany(options): Promise<EmbedManyResult>;
59
+ embedMany(options): Promise<IIntelligenceEmbeddingBatchResult>;
54
60
  ```
55
61
 
56
- Defined in: [IntelligenceEmbeddingGenerator.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceEmbeddingGenerator.ts#L55)
62
+ Defined in: [IntelligenceEmbeddingGenerator.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceEmbeddingGenerator.ts#L85)
57
63
 
58
- Embeds multiple values.
64
+ Embeds multiple values with bounded provider parallelism.
59
65
 
60
66
  #### Parameters
61
67
 
62
- | Parameter | Type | Description |
63
- | ------ | ------ | ------ |
64
- | `options` | \{ \} | Native AI SDK `embedMany()` options. |
68
+ | Parameter | Type |
69
+ | ------ | ------ |
70
+ | `options` | [`IIntelligenceEmbeddingBatchOptions`](Interface.IIntelligenceEmbeddingBatchOptions) |
65
71
 
66
72
  #### Returns
67
73
 
68
- `Promise`\<`EmbedManyResult`\>
69
-
70
- The native AI SDK embedding result.
74
+ `Promise`\<[`IIntelligenceEmbeddingBatchResult`](Interface.IIntelligenceEmbeddingBatchResult)\>
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceHealthIndicator
7
7
 
8
- Defined in: [health/IntelligenceHealthIndicator.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L18)
8
+ Defined in: [health/IntelligenceHealthIndicator.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L20)
9
9
 
10
10
  Health indicator for the intelligence infrastructure.
11
11
  Verifies that the intelligence provider configuration can be resolved.
@@ -19,16 +19,20 @@ Verifies that the intelligence provider configuration can be resolved.
19
19
  ### Constructor
20
20
 
21
21
  ```ts
22
- new IntelligenceHealthIndicator(textGenerator?, realtimeSessionFactory?): IntelligenceHealthIndicator;
22
+ new IntelligenceHealthIndicator(
23
+ providerRegistry?,
24
+ languageGenerator?,
25
+ realtimeSessionFactory?): IntelligenceHealthIndicator;
23
26
  ```
24
27
 
25
- Defined in: [health/IntelligenceHealthIndicator.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L28)
28
+ Defined in: [health/IntelligenceHealthIndicator.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L31)
26
29
 
27
30
  #### Parameters
28
31
 
29
32
  | Parameter | Type |
30
33
  | ------ | ------ |
31
- | `textGenerator?` | [`IntelligenceTextGenerator`](Class.IntelligenceTextGenerator) |
34
+ | `providerRegistry?` | [`IntelligenceProviderRegistry`](Class.IntelligenceProviderRegistry) |
35
+ | `languageGenerator?` | [`IntelligenceLanguageGenerator`](Class.IntelligenceLanguageGenerator) |
32
36
  | `realtimeSessionFactory?` | [`IntelligenceRealtimeSessionFactory`](Class.IntelligenceRealtimeSessionFactory) |
33
37
 
34
38
  #### Returns
@@ -43,7 +47,7 @@ Defined in: [health/IntelligenceHealthIndicator.ts:28](https://github.com/RueDeR
43
47
  readonly key: string = 'intelligence';
44
48
  ```
45
49
 
46
- Defined in: [health/IntelligenceHealthIndicator.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L37)
50
+ Defined in: [health/IntelligenceHealthIndicator.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L45)
47
51
 
48
52
  Unique key identifying the indicator
49
53
 
@@ -61,10 +65,10 @@ IHealthIndicator.key
61
65
  check(): HealthIndicatorResult<string>;
62
66
  ```
63
67
 
64
- Defined in: [health/IntelligenceHealthIndicator.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L50)
68
+ Defined in: [health/IntelligenceHealthIndicator.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L58)
65
69
 
66
70
  Verifies that the provider configuration can be resolved.
67
- Returns disabled status when no text generator is configured.
71
+ Returns disabled status when no intelligence generator is configured.
68
72
 
69
73
  #### Returns
70
74
 
@@ -0,0 +1,159 @@
1
+ ---
2
+ title: 'Class: IntelligenceLanguageGenerator'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceLanguageGenerator
7
+
8
+ Defined in: IntelligenceLanguageGenerator.ts:80
9
+
10
+ Provider-neutral language generation, structured output, and streaming facade.
11
+
12
+ ## Constructors
13
+
14
+ ### Constructor
15
+
16
+ ```ts
17
+ new IntelligenceLanguageGenerator(modelResolver, toolRegistry): IntelligenceLanguageGenerator;
18
+ ```
19
+
20
+ Defined in: IntelligenceLanguageGenerator.ts:91
21
+
22
+ #### Parameters
23
+
24
+ | Parameter | Type |
25
+ | ------ | ------ |
26
+ | `modelResolver` | `IntelligenceModelResolver` |
27
+ | `toolRegistry` | [`IntelligenceToolRegistry`](Class.IntelligenceToolRegistry) |
28
+
29
+ #### Returns
30
+
31
+ `IntelligenceLanguageGenerator`
32
+
33
+ ## Methods
34
+
35
+ ### generateObject()
36
+
37
+ ```ts
38
+ generateObject<T>(
39
+ prompt,
40
+ schema,
41
+ options?): Promise<IIntelligenceLanguageCompletion<T>>;
42
+ ```
43
+
44
+ Defined in: IntelligenceLanguageGenerator.ts:121
45
+
46
+ Generates a schema-constrained object through the language capability.
47
+
48
+ #### Type Parameters
49
+
50
+ | Type Parameter |
51
+ | ------ |
52
+ | `T` |
53
+
54
+ #### Parameters
55
+
56
+ | Parameter | Type |
57
+ | ------ | ------ |
58
+ | `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
59
+ | `schema` | [`IIntelligenceSchema`](TypeAlias.IIntelligenceSchema)\<`T`\> |
60
+ | `options` | [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions) |
61
+
62
+ #### Returns
63
+
64
+ `Promise`\<[`IIntelligenceLanguageCompletion`](Interface.IIntelligenceLanguageCompletion)\<`T`\>\>
65
+
66
+ ***
67
+
68
+ ### generateText()
69
+
70
+ ```ts
71
+ generateText(prompt, options?): Promise<IIntelligenceLanguageCompletion<string>>;
72
+ ```
73
+
74
+ Defined in: IntelligenceLanguageGenerator.ts:109
75
+
76
+ Generates plain text and normalized tool metadata.
77
+
78
+ #### Parameters
79
+
80
+ | Parameter | Type |
81
+ | ------ | ------ |
82
+ | `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
83
+ | `options` | [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions) |
84
+
85
+ #### Returns
86
+
87
+ `Promise`\<[`IIntelligenceLanguageCompletion`](Interface.IIntelligenceLanguageCompletion)\<`string`\>\>
88
+
89
+ ***
90
+
91
+ ### getDefaultModel()
92
+
93
+ ```ts
94
+ getDefaultModel(): IIntelligenceModelStatus;
95
+ ```
96
+
97
+ Defined in: IntelligenceLanguageGenerator.ts:201
98
+
99
+ Returns the default language model without exposing credentials.
100
+
101
+ #### Returns
102
+
103
+ [`IIntelligenceModelStatus`](Interface.IIntelligenceModelStatus)
104
+
105
+ ***
106
+
107
+ ### streamObject()
108
+
109
+ ```ts
110
+ streamObject<T>(
111
+ prompt,
112
+ schema,
113
+ options?): Promise<IIntelligenceObjectStream<T>>;
114
+ ```
115
+
116
+ Defined in: IntelligenceLanguageGenerator.ts:166
117
+
118
+ Streams partial structured output through the language capability.
119
+
120
+ #### Type Parameters
121
+
122
+ | Type Parameter |
123
+ | ------ |
124
+ | `T` |
125
+
126
+ #### Parameters
127
+
128
+ | Parameter | Type |
129
+ | ------ | ------ |
130
+ | `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
131
+ | `schema` | [`IIntelligenceSchema`](TypeAlias.IIntelligenceSchema)\<`T`\> |
132
+ | `options` | [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions) |
133
+
134
+ #### Returns
135
+
136
+ `Promise`\<[`IIntelligenceObjectStream`](Interface.IIntelligenceObjectStream)\<`T`\>\>
137
+
138
+ ***
139
+
140
+ ### streamText()
141
+
142
+ ```ts
143
+ streamText(prompt, options?): Promise<IIntelligenceLanguageStream>;
144
+ ```
145
+
146
+ Defined in: IntelligenceLanguageGenerator.ts:139
147
+
148
+ Streams text without exposing the native AI SDK stream object.
149
+
150
+ #### Parameters
151
+
152
+ | Parameter | Type |
153
+ | ------ | ------ |
154
+ | `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
155
+ | `options` | [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions) |
156
+
157
+ #### Returns
158
+
159
+ `Promise`\<[`IIntelligenceLanguageStream`](Interface.IIntelligenceLanguageStream)\>