@breadstone/archipel-mcp 0.0.53 → 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 (232) 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 -622
  4. package/data/guides/index.md +3 -1
  5. package/data/guides/intelligence-prompts-warm-up.md +138 -0
  6. package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +78 -0
  7. package/data/packages/platform-intelligence/api/Class.DefaultIntelligencePromptPolicyAdapter.md +54 -0
  8. package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +78 -0
  9. package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +78 -0
  10. package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +78 -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 +11 -7
  15. package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +159 -0
  16. package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +60 -38
  17. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  18. package/data/packages/platform-intelligence/api/Class.IntelligencePromptExecutor.md +88 -0
  19. package/data/packages/platform-intelligence/api/Class.IntelligencePromptPolicyPort.md +48 -0
  20. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAssetUploader.md +21 -15
  21. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderDiagnostics.md +55 -0
  22. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderError.md +14 -4
  23. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderRegistry.md +68 -0
  24. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +9 -9
  25. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +2 -2
  26. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +12 -12
  27. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +18 -18
  28. package/data/packages/platform-intelligence/api/Class.IntelligenceReranker.md +58 -0
  29. package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +14 -16
  30. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +10 -14
  31. package/data/packages/platform-intelligence/api/Class.MiMoIntelligenceProviderAdapter.md +78 -0
  32. package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +102 -0
  33. package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +1 -1
  34. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +1 -1
  35. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +1 -1
  36. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +1 -1
  37. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +1 -1
  38. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +1 -1
  39. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +1 -1
  40. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +1 -1
  41. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +1 -1
  42. package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +1 -1
  43. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +1 -1
  44. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +1 -1
  45. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +1 -1
  46. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +1 -1
  47. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +1 -1
  48. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +1 -1
  49. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +1 -1
  50. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +1 -1
  51. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +1 -1
  52. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +1 -1
  53. package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +1 -1
  54. package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +1 -1
  55. package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +1 -1
  56. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +1 -1
  57. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +1 -1
  58. package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +1 -1
  59. package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +1 -1
  60. package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +1 -1
  61. package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +1 -1
  62. package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +1 -1
  63. package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +1 -1
  64. package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +1 -1
  65. package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +1 -1
  66. package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +1 -1
  67. package/data/packages/platform-intelligence/api/Function.createIntelligenceJsonSchema.md +31 -0
  68. package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +2 -2
  69. package/data/packages/platform-intelligence/api/Function.createMimoCustomTool.md +5 -5
  70. package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +1 -1
  71. package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +1 -1
  72. package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +1 -1
  73. package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +1 -1
  74. package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +1 -1
  75. package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +1 -1
  76. package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +1 -1
  77. package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +1 -1
  78. package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +1 -1
  79. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +1 -1
  80. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +1 -1
  81. package/data/packages/platform-intelligence/api/Function.defineIntelligenceTool.md +31 -0
  82. package/data/packages/platform-intelligence/api/Function.intelligencePrompt.md +31 -0
  83. package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md +70 -0
  84. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md +124 -0
  85. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +70 -0
  86. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +114 -0
  87. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +70 -0
  88. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +102 -0
  89. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadResult.md +60 -0
  90. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGeneratedFile.md +40 -0
  91. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGenerationStepStartEvent.md +50 -0
  92. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationOptions.md +170 -0
  93. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationResult.md +60 -0
  94. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageCompletion.md +141 -0
  95. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md +234 -0
  96. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageStream.md +50 -0
  97. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelReference.md +34 -0
  98. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelRequestOptions.md +52 -0
  99. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +30 -0
  100. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +43 -25
  101. package/data/packages/platform-intelligence/api/Interface.IIntelligenceObjectStream.md +56 -0
  102. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +50 -0
  103. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptDefinition.md +145 -0
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md +30 -0
  105. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionContext.md +20 -0
  106. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md +70 -0
  107. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md +127 -0
  108. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptInvocation.md +49 -0
  109. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptPolicyRequest.md +60 -0
  110. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptRenderContext.md +26 -0
  111. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderAdapter.md +73 -0
  112. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +10 -10
  113. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +40 -0
  114. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md +70 -0
  115. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeAudioFormat.md +3 -3
  116. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeCloseEvent.md +4 -4
  117. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +9 -21
  118. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionConfiguration.md +11 -11
  119. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +11 -11
  120. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeToolDefinition.md +5 -5
  121. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTranscriptionConfiguration.md +4 -4
  122. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTurnDetectionConfiguration.md +5 -5
  123. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +10 -10
  124. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +98 -0
  125. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +140 -0
  126. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +50 -0
  127. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +94 -0
  128. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +80 -0
  129. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +164 -0
  130. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +50 -0
  131. package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +139 -0
  132. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +7 -10
  133. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolCall.md +40 -0
  134. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolDefinition.md +91 -0
  135. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionEndEvent.md +50 -0
  136. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionStartEvent.md +30 -0
  137. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +4 -4
  138. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionOptions.md +114 -0
  139. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionResult.md +84 -0
  140. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionStream.md +97 -0
  141. package/data/packages/platform-intelligence/api/Interface.IIntelligenceUsage.md +40 -0
  142. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +229 -0
  143. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationResult.md +50 -0
  144. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceModelMessage.md +43 -0
  145. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligencePromptModelRequirement.md +25 -0
  146. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceSchema.md +70 -0
  147. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceCapability.md +14 -0
  148. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceDefaultModels.md +14 -0
  149. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceJsonValue.md +22 -0
  150. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptCapability.md +20 -0
  151. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptDefinitionConfiguration.md +29 -0
  152. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md +16 -0
  153. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptLatency.md +14 -0
  154. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptMode.md +14 -0
  155. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptQuality.md +14 -0
  156. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptReasoning.md +14 -0
  157. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
  158. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderOptions.md +14 -0
  159. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderProbeStatus.md +14 -0
  160. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderToolOptions.md +17 -0
  161. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md +1 -1
  162. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md +1 -1
  163. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +1 -1
  164. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeServerEvent.md +1 -1
  165. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeStatus.md +1 -1
  166. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRequestTimeouts.md +14 -0
  167. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolChoice.md +21 -0
  168. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolOutput.md +22 -0
  169. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolSet.md +14 -0
  170. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md +46 -0
  171. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_API_KEY.md +14 -0
  172. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_BASE_URL.md +14 -0
  173. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_CONFIG_ENTRIES.md +14 -0
  174. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  175. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  176. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  177. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  178. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +2 -2
  179. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  180. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  181. package/data/packages/platform-intelligence/api/Variable.IntelligenceCapabilityNames.md +40 -0
  182. package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +2 -0
  183. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +1 -1
  184. package/data/packages/platform-intelligence/api/index.md +98 -30
  185. package/package.json +1 -1
  186. package/data/packages/index.md +0 -8
  187. package/data/packages/platform-analytics/index.md +0 -209
  188. package/data/packages/platform-authentication/index.md +0 -725
  189. package/data/packages/platform-blob-storage/index.md +0 -416
  190. package/data/packages/platform-bootstrap/index.md +0 -162
  191. package/data/packages/platform-caching/index.md +0 -167
  192. package/data/packages/platform-configuration/index.md +0 -226
  193. package/data/packages/platform-core/index.md +0 -504
  194. package/data/packages/platform-cryptography/index.md +0 -142
  195. package/data/packages/platform-database/index.md +0 -337
  196. package/data/packages/platform-documents/index.md +0 -255
  197. package/data/packages/platform-esigning/index.md +0 -710
  198. package/data/packages/platform-feature-flags/index.md +0 -103
  199. package/data/packages/platform-health/index.md +0 -141
  200. package/data/packages/platform-intelligence/api/Class.IntelligenceStructuredGenerator.md +0 -70
  201. package/data/packages/platform-intelligence/api/Class.IntelligenceTelemetryRegistry.md +0 -44
  202. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +0 -138
  203. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +0 -39
  204. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +0 -26
  205. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +0 -26
  206. package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +0 -25
  207. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +0 -26
  208. package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +0 -25
  209. package/data/packages/platform-intelligence/api/Function.loadMimoLanguageModel.md +0 -26
  210. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +0 -26
  211. package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +0 -25
  212. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +0 -46
  213. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +0 -168
  214. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +0 -144
  215. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +0 -78
  216. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +0 -170
  217. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +0 -24
  218. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +0 -14
  219. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +0 -25
  220. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +0 -14
  221. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +0 -14
  222. package/data/packages/platform-intelligence/index.md +0 -549
  223. package/data/packages/platform-logging/index.md +0 -150
  224. package/data/packages/platform-mailing/index.md +0 -470
  225. package/data/packages/platform-mapping/index.md +0 -123
  226. package/data/packages/platform-mcp/index.md +0 -335
  227. package/data/packages/platform-openapi/index.md +0 -207
  228. package/data/packages/platform-payments/index.md +0 -610
  229. package/data/packages/platform-queue/index.md +0 -192
  230. package/data/packages/platform-reporting/index.md +0 -233
  231. package/data/packages/platform-resources/index.md +0 -137
  232. package/data/packages/platform-telemetry/index.md +0 -262
@@ -0,0 +1,139 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceStreamingTranscriptionOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceStreamingTranscriptionOptions
7
+
8
+ Defined in: contracts/IIntelligenceStreamingTranscriptionOptions.ts:12
9
+
10
+ Provider-neutral live transcription options.
11
+
12
+ ## Extends
13
+
14
+ - [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions)
15
+
16
+ ## Properties
17
+
18
+ ### abortSignal?
19
+
20
+ ```ts
21
+ readonly optional abortSignal?: AbortSignal;
22
+ ```
23
+
24
+ Defined in: contracts/IIntelligenceRequestOptions.ts:16
25
+
26
+ Caller-driven cancellation signal.
27
+
28
+ #### Inherited from
29
+
30
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`abortSignal`](Interface.IIntelligenceRequestOptions#abortsignal)
31
+
32
+ ***
33
+
34
+ ### audio
35
+
36
+ ```ts
37
+ readonly audio: ReadableStream<string | Uint8Array<ArrayBufferLike>>;
38
+ ```
39
+
40
+ Defined in: contracts/IIntelligenceStreamingTranscriptionOptions.ts:15
41
+
42
+ ***
43
+
44
+ ### headers?
45
+
46
+ ```ts
47
+ readonly optional headers?: Readonly<Record<string, string>>;
48
+ ```
49
+
50
+ Defined in: contracts/IIntelligenceRequestOptions.ts:19
51
+
52
+ Additional outbound request headers.
53
+
54
+ #### Inherited from
55
+
56
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`headers`](Interface.IIntelligenceRequestOptions#headers)
57
+
58
+ ***
59
+
60
+ ### includeRawChunks?
61
+
62
+ ```ts
63
+ readonly optional includeRawChunks?: boolean;
64
+ ```
65
+
66
+ Defined in: contracts/IIntelligenceStreamingTranscriptionOptions.ts:20
67
+
68
+ ***
69
+
70
+ ### inputAudioFormat
71
+
72
+ ```ts
73
+ readonly inputAudioFormat: {
74
+ rate?: number;
75
+ type: string;
76
+ };
77
+ ```
78
+
79
+ Defined in: contracts/IIntelligenceStreamingTranscriptionOptions.ts:16
80
+
81
+ #### rate?
82
+
83
+ ```ts
84
+ readonly optional rate?: number;
85
+ ```
86
+
87
+ #### type
88
+
89
+ ```ts
90
+ readonly type: string;
91
+ ```
92
+
93
+ ***
94
+
95
+ ### model?
96
+
97
+ ```ts
98
+ readonly optional model?: IIntelligenceModelReference;
99
+ ```
100
+
101
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
102
+
103
+ Optional provider/model override.
104
+
105
+ #### Inherited from
106
+
107
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`model`](Interface.IIntelligenceRequestOptions#model)
108
+
109
+ ***
110
+
111
+ ### providerOptions?
112
+
113
+ ```ts
114
+ readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
115
+ ```
116
+
117
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
118
+
119
+ Optional provider-specific settings.
120
+
121
+ #### Inherited from
122
+
123
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`providerOptions`](Interface.IIntelligenceRequestOptions#provideroptions)
124
+
125
+ ***
126
+
127
+ ### timeoutMs?
128
+
129
+ ```ts
130
+ readonly optional timeoutMs?: number;
131
+ ```
132
+
133
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
134
+
135
+ Total provider-operation timeout in milliseconds.
136
+
137
+ #### Inherited from
138
+
139
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`timeoutMs`](Interface.IIntelligenceRequestOptions#timeoutms)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceTool
7
7
 
8
- Defined in: [interfaces/IIntelligenceTool.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTool.ts#L12)
8
+ Defined in: [interfaces/IIntelligenceTool.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTool.ts#L13)
9
9
 
10
10
  Minimal shape required by the intelligence tool registry.
11
11
 
@@ -17,7 +17,7 @@ Minimal shape required by the intelligence tool registry.
17
17
  readonly name: string;
18
18
  ```
19
19
 
20
- Defined in: [interfaces/IIntelligenceTool.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTool.ts#L21)
20
+ Defined in: [interfaces/IIntelligenceTool.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTool.ts#L22)
21
21
 
22
22
  Gets the unique registry name for the tool.
23
23
 
@@ -26,14 +26,11 @@ Gets the unique registry name for the tool.
26
26
  ### tool
27
27
 
28
28
  ```ts
29
- readonly tool: Tool<never, never, any> | Tool<any, any, any> | Tool<any, never, any> | Tool<never, any, any> & Pick<Tool<any, any, any>,
30
- | "execute"
31
- | "needsApproval"
32
- | "onInputStart"
33
- | "onInputDelta"
34
- | "onInputAvailable">;
29
+ readonly tool:
30
+ | IIntelligenceToolDefinition<unknown, unknown>
31
+ | IIntelligenceProviderToolDefinition;
35
32
  ```
36
33
 
37
- Defined in: [interfaces/IIntelligenceTool.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTool.ts#L29)
34
+ Defined in: [interfaces/IIntelligenceTool.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTool.ts#L30)
38
35
 
39
- Gets the native AI SDK tool definition.
36
+ Gets the provider-neutral or opaque provider-owned tool definition.
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceToolCall'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceToolCall
7
+
8
+ Defined in: contracts/IIntelligenceToolCall.ts:6
9
+
10
+ Tool call selected by a language model.
11
+
12
+ ## Properties
13
+
14
+ ### input
15
+
16
+ ```ts
17
+ readonly input: unknown;
18
+ ```
19
+
20
+ Defined in: contracts/IIntelligenceToolCall.ts:9
21
+
22
+ ***
23
+
24
+ ### toolCallId
25
+
26
+ ```ts
27
+ readonly toolCallId: string;
28
+ ```
29
+
30
+ Defined in: contracts/IIntelligenceToolCall.ts:7
31
+
32
+ ***
33
+
34
+ ### toolName
35
+
36
+ ```ts
37
+ readonly toolName: string;
38
+ ```
39
+
40
+ Defined in: contracts/IIntelligenceToolCall.ts:8
@@ -0,0 +1,91 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceToolDefinition\<TInput, TOutput\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceToolDefinition\<TInput, TOutput\>
7
+
8
+ Defined in: contracts/IIntelligenceToolDefinition.ts:14
9
+
10
+ Provider-neutral application tool definition.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter | Default type |
15
+ | ------ | ------ |
16
+ | `TInput` | `unknown` |
17
+ | `TOutput` | `unknown` |
18
+
19
+ ## Properties
20
+
21
+ ### description?
22
+
23
+ ```ts
24
+ readonly optional description?: string;
25
+ ```
26
+
27
+ Defined in: contracts/IIntelligenceToolDefinition.ts:17
28
+
29
+ ***
30
+
31
+ ### inputSchema
32
+
33
+ ```ts
34
+ readonly inputSchema: IIntelligenceSchema<TInput>;
35
+ ```
36
+
37
+ Defined in: contracts/IIntelligenceToolDefinition.ts:18
38
+
39
+ ***
40
+
41
+ ### needsApproval?
42
+
43
+ ```ts
44
+ readonly optional needsApproval?: boolean;
45
+ ```
46
+
47
+ Defined in: contracts/IIntelligenceToolDefinition.ts:21
48
+
49
+ ***
50
+
51
+ ### outputSchema?
52
+
53
+ ```ts
54
+ readonly optional outputSchema?: IIntelligenceSchema<TOutput>;
55
+ ```
56
+
57
+ Defined in: contracts/IIntelligenceToolDefinition.ts:19
58
+
59
+ ***
60
+
61
+ ### providerOptions?
62
+
63
+ ```ts
64
+ readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
65
+ ```
66
+
67
+ Defined in: contracts/IIntelligenceToolDefinition.ts:20
68
+
69
+ ## Methods
70
+
71
+ ### execute()?
72
+
73
+ ```ts
74
+ optional execute(input, context): TOutput | Promise<TOutput>;
75
+ ```
76
+
77
+ Defined in: contracts/IIntelligenceToolDefinition.ts:27
78
+
79
+ #### Parameters
80
+
81
+ | Parameter | Type |
82
+ | ------ | ------ |
83
+ | `input` | `TInput` |
84
+ | `context` | \{ `abortSignal?`: `AbortSignal`; `messages`: readonly [`IIntelligenceModelMessage`](TypeAlias.IIntelligenceModelMessage)[]; `toolCallId`: `string`; \} |
85
+ | `context.abortSignal?` | `AbortSignal` |
86
+ | `context.messages` | readonly [`IIntelligenceModelMessage`](TypeAlias.IIntelligenceModelMessage)[] |
87
+ | `context.toolCallId` | `string` |
88
+
89
+ #### Returns
90
+
91
+ `TOutput` \| `Promise`\<`TOutput`\>
@@ -0,0 +1,50 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceToolExecutionEndEvent'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceToolExecutionEndEvent
7
+
8
+ Defined in: contracts/IIntelligenceToolExecutionEndEvent.ts:13
9
+
10
+ Tool execution completion event.
11
+
12
+ ## Properties
13
+
14
+ ### callId
15
+
16
+ ```ts
17
+ readonly callId: string;
18
+ ```
19
+
20
+ Defined in: contracts/IIntelligenceToolExecutionEndEvent.ts:14
21
+
22
+ ***
23
+
24
+ ### toolCall
25
+
26
+ ```ts
27
+ readonly toolCall: IIntelligenceToolCall;
28
+ ```
29
+
30
+ Defined in: contracts/IIntelligenceToolExecutionEndEvent.ts:15
31
+
32
+ ***
33
+
34
+ ### toolExecutionMs
35
+
36
+ ```ts
37
+ readonly toolExecutionMs: number;
38
+ ```
39
+
40
+ Defined in: contracts/IIntelligenceToolExecutionEndEvent.ts:17
41
+
42
+ ***
43
+
44
+ ### toolOutput
45
+
46
+ ```ts
47
+ readonly toolOutput: IntelligenceToolOutput;
48
+ ```
49
+
50
+ Defined in: contracts/IIntelligenceToolExecutionEndEvent.ts:16
@@ -0,0 +1,30 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceToolExecutionStartEvent'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceToolExecutionStartEvent
7
+
8
+ Defined in: contracts/IIntelligenceToolExecutionStartEvent.ts:12
9
+
10
+ Tool execution start event.
11
+
12
+ ## Properties
13
+
14
+ ### callId
15
+
16
+ ```ts
17
+ readonly callId: string;
18
+ ```
19
+
20
+ Defined in: contracts/IIntelligenceToolExecutionStartEvent.ts:13
21
+
22
+ ***
23
+
24
+ ### toolCall
25
+
26
+ ```ts
27
+ readonly toolCall: IIntelligenceToolCall;
28
+ ```
29
+
30
+ Defined in: contracts/IIntelligenceToolExecutionStartEvent.ts:14
@@ -132,15 +132,15 @@ Registers a tool with the registry.
132
132
  ### toToolSet()
133
133
 
134
134
  ```ts
135
- toToolSet(): ToolSet;
135
+ toToolSet(): IntelligenceToolSet;
136
136
  ```
137
137
 
138
138
  Defined in: [interfaces/IIntelligenceToolRegistry.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceToolRegistry.ts#L79)
139
139
 
140
- Converts all registered tools to the AI SDK's native tool set format.
140
+ Converts all registered application tools to an Archipel tool set.
141
141
 
142
142
  #### Returns
143
143
 
144
- `ToolSet`
144
+ [`IntelligenceToolSet`](TypeAlias.IntelligenceToolSet)
145
145
 
146
- A record mapping tool names to native AI SDK tool definitions.
146
+ A record mapping tool names to provider-neutral definitions.
@@ -0,0 +1,114 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceTranscriptionOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceTranscriptionOptions
7
+
8
+ Defined in: contracts/IIntelligenceTranscriptionOptions.ts:12
9
+
10
+ Provider-neutral transcription options.
11
+
12
+ ## Extends
13
+
14
+ - [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions)
15
+
16
+ ## Properties
17
+
18
+ ### abortSignal?
19
+
20
+ ```ts
21
+ readonly optional abortSignal?: AbortSignal;
22
+ ```
23
+
24
+ Defined in: contracts/IIntelligenceRequestOptions.ts:16
25
+
26
+ Caller-driven cancellation signal.
27
+
28
+ #### Inherited from
29
+
30
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`abortSignal`](Interface.IIntelligenceRequestOptions#abortsignal)
31
+
32
+ ***
33
+
34
+ ### audio
35
+
36
+ ```ts
37
+ readonly audio: string | ArrayBuffer | Uint8Array<ArrayBufferLike> | URL;
38
+ ```
39
+
40
+ Defined in: contracts/IIntelligenceTranscriptionOptions.ts:15
41
+
42
+ ***
43
+
44
+ ### headers?
45
+
46
+ ```ts
47
+ readonly optional headers?: Readonly<Record<string, string>>;
48
+ ```
49
+
50
+ Defined in: contracts/IIntelligenceRequestOptions.ts:19
51
+
52
+ Additional outbound request headers.
53
+
54
+ #### Inherited from
55
+
56
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`headers`](Interface.IIntelligenceRequestOptions#headers)
57
+
58
+ ***
59
+
60
+ ### maxRetries?
61
+
62
+ ```ts
63
+ readonly optional maxRetries?: number;
64
+ ```
65
+
66
+ Defined in: contracts/IIntelligenceTranscriptionOptions.ts:16
67
+
68
+ ***
69
+
70
+ ### model?
71
+
72
+ ```ts
73
+ readonly optional model?: IIntelligenceModelReference;
74
+ ```
75
+
76
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
77
+
78
+ Optional provider/model override.
79
+
80
+ #### Inherited from
81
+
82
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`model`](Interface.IIntelligenceRequestOptions#model)
83
+
84
+ ***
85
+
86
+ ### providerOptions?
87
+
88
+ ```ts
89
+ readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
90
+ ```
91
+
92
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
93
+
94
+ Optional provider-specific settings.
95
+
96
+ #### Inherited from
97
+
98
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`providerOptions`](Interface.IIntelligenceRequestOptions#provideroptions)
99
+
100
+ ***
101
+
102
+ ### timeoutMs?
103
+
104
+ ```ts
105
+ readonly optional timeoutMs?: number;
106
+ ```
107
+
108
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
109
+
110
+ Total provider-operation timeout in milliseconds.
111
+
112
+ #### Inherited from
113
+
114
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`timeoutMs`](Interface.IIntelligenceRequestOptions#timeoutms)
@@ -0,0 +1,84 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceTranscriptionResult'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceTranscriptionResult
7
+
8
+ Defined in: contracts/IIntelligenceTranscriptionResult.ts:6
9
+
10
+ Provider-neutral transcription result.
11
+
12
+ ## Properties
13
+
14
+ ### durationInSeconds?
15
+
16
+ ```ts
17
+ readonly optional durationInSeconds?: number;
18
+ ```
19
+
20
+ Defined in: contracts/IIntelligenceTranscriptionResult.ts:16
21
+
22
+ ***
23
+
24
+ ### language?
25
+
26
+ ```ts
27
+ readonly optional language?: string;
28
+ ```
29
+
30
+ Defined in: contracts/IIntelligenceTranscriptionResult.ts:15
31
+
32
+ ***
33
+
34
+ ### model
35
+
36
+ ```ts
37
+ readonly model: string;
38
+ ```
39
+
40
+ Defined in: contracts/IIntelligenceTranscriptionResult.ts:18
41
+
42
+ ***
43
+
44
+ ### provider
45
+
46
+ ```ts
47
+ readonly provider: string;
48
+ ```
49
+
50
+ Defined in: contracts/IIntelligenceTranscriptionResult.ts:17
51
+
52
+ ***
53
+
54
+ ### segments
55
+
56
+ ```ts
57
+ readonly segments: readonly {
58
+ endSecond: number;
59
+ startSecond: number;
60
+ text: string;
61
+ }[];
62
+ ```
63
+
64
+ Defined in: contracts/IIntelligenceTranscriptionResult.ts:10
65
+
66
+ ***
67
+
68
+ ### text
69
+
70
+ ```ts
71
+ readonly text: string;
72
+ ```
73
+
74
+ Defined in: contracts/IIntelligenceTranscriptionResult.ts:9
75
+
76
+ ***
77
+
78
+ ### warnings
79
+
80
+ ```ts
81
+ readonly warnings: readonly string[];
82
+ ```
83
+
84
+ Defined in: contracts/IIntelligenceTranscriptionResult.ts:19
@@ -0,0 +1,97 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceTranscriptionStream'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceTranscriptionStream
7
+
8
+ Defined in: contracts/IIntelligenceTranscriptionStream.ts:15
9
+
10
+ Provider-neutral live transcription result.
11
+
12
+ The full stream has one consumer. Access it before any final-result promise
13
+ when both incremental and final output are required.
14
+
15
+ ## Properties
16
+
17
+ ### durationInSeconds
18
+
19
+ ```ts
20
+ readonly durationInSeconds: PromiseLike<number | undefined>;
21
+ ```
22
+
23
+ Defined in: contracts/IIntelligenceTranscriptionStream.ts:30
24
+
25
+ ***
26
+
27
+ ### fullStream
28
+
29
+ ```ts
30
+ readonly fullStream: AsyncIterable<IntelligenceTranscriptionStreamPart>;
31
+ ```
32
+
33
+ Defined in: contracts/IIntelligenceTranscriptionStream.ts:20
34
+
35
+ ***
36
+
37
+ ### language
38
+
39
+ ```ts
40
+ readonly language: PromiseLike<string | undefined>;
41
+ ```
42
+
43
+ Defined in: contracts/IIntelligenceTranscriptionStream.ts:29
44
+
45
+ ***
46
+
47
+ ### model
48
+
49
+ ```ts
50
+ readonly model: string;
51
+ ```
52
+
53
+ Defined in: contracts/IIntelligenceTranscriptionStream.ts:19
54
+
55
+ ***
56
+
57
+ ### provider
58
+
59
+ ```ts
60
+ readonly provider: string;
61
+ ```
62
+
63
+ Defined in: contracts/IIntelligenceTranscriptionStream.ts:18
64
+
65
+ ***
66
+
67
+ ### segments
68
+
69
+ ```ts
70
+ readonly segments: PromiseLike<readonly {
71
+ endSecond: number;
72
+ startSecond: number;
73
+ text: string;
74
+ }[]>;
75
+ ```
76
+
77
+ Defined in: contracts/IIntelligenceTranscriptionStream.ts:22
78
+
79
+ ***
80
+
81
+ ### text
82
+
83
+ ```ts
84
+ readonly text: PromiseLike<string>;
85
+ ```
86
+
87
+ Defined in: contracts/IIntelligenceTranscriptionStream.ts:21
88
+
89
+ ***
90
+
91
+ ### warnings
92
+
93
+ ```ts
94
+ readonly warnings: PromiseLike<readonly string[]>;
95
+ ```
96
+
97
+ Defined in: contracts/IIntelligenceTranscriptionStream.ts:31