@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,40 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceUsage'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceUsage
7
+
8
+ Defined in: contracts/IIntelligenceUsage.ts:6
9
+
10
+ Provider-neutral usage counters.
11
+
12
+ ## Properties
13
+
14
+ ### inputTokens
15
+
16
+ ```ts
17
+ readonly inputTokens: number | null;
18
+ ```
19
+
20
+ Defined in: contracts/IIntelligenceUsage.ts:9
21
+
22
+ ***
23
+
24
+ ### outputTokens
25
+
26
+ ```ts
27
+ readonly outputTokens: number | null;
28
+ ```
29
+
30
+ Defined in: contracts/IIntelligenceUsage.ts:10
31
+
32
+ ***
33
+
34
+ ### totalTokens
35
+
36
+ ```ts
37
+ readonly totalTokens: number | null;
38
+ ```
39
+
40
+ Defined in: contracts/IIntelligenceUsage.ts:11
@@ -0,0 +1,229 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceVideoGenerationOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceVideoGenerationOptions
7
+
8
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:12
9
+
10
+ Provider-neutral video generation 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
+ ### aspectRatio?
35
+
36
+ ```ts
37
+ readonly optional aspectRatio?: `${number}:${number}`;
38
+ ```
39
+
40
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:24
41
+
42
+ ***
43
+
44
+ ### count?
45
+
46
+ ```ts
47
+ readonly optional count?: number;
48
+ ```
49
+
50
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:22
51
+
52
+ ***
53
+
54
+ ### durationSeconds?
55
+
56
+ ```ts
57
+ readonly optional durationSeconds?: number;
58
+ ```
59
+
60
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:26
61
+
62
+ ***
63
+
64
+ ### frameImages?
65
+
66
+ ```ts
67
+ readonly optional frameImages?: readonly {
68
+ frameType: "first_frame" | "last_frame";
69
+ image: string | ArrayBuffer | Uint8Array<ArrayBufferLike>;
70
+ }[];
71
+ ```
72
+
73
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:30
74
+
75
+ ***
76
+
77
+ ### framesPerSecond?
78
+
79
+ ```ts
80
+ readonly optional framesPerSecond?: number;
81
+ ```
82
+
83
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:27
84
+
85
+ ***
86
+
87
+ ### generateAudio?
88
+
89
+ ```ts
90
+ readonly optional generateAudio?: boolean;
91
+ ```
92
+
93
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:29
94
+
95
+ ***
96
+
97
+ ### headers?
98
+
99
+ ```ts
100
+ readonly optional headers?: Readonly<Record<string, string>>;
101
+ ```
102
+
103
+ Defined in: contracts/IIntelligenceRequestOptions.ts:19
104
+
105
+ Additional outbound request headers.
106
+
107
+ #### Inherited from
108
+
109
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`headers`](Interface.IIntelligenceRequestOptions#headers)
110
+
111
+ ***
112
+
113
+ ### inputReferences?
114
+
115
+ ```ts
116
+ readonly optional inputReferences?: readonly (
117
+ | string
118
+ | ArrayBuffer
119
+ | Uint8Array<ArrayBufferLike>
120
+ | {
121
+ data: string | ArrayBuffer | Uint8Array<ArrayBufferLike>;
122
+ mediaType?: string;
123
+ })[];
124
+ ```
125
+
126
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:34
127
+
128
+ ***
129
+
130
+ ### maxRetries?
131
+
132
+ ```ts
133
+ readonly optional maxRetries?: number;
134
+ ```
135
+
136
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:21
137
+
138
+ ***
139
+
140
+ ### maxVideosPerCall?
141
+
142
+ ```ts
143
+ readonly optional maxVideosPerCall?: number;
144
+ ```
145
+
146
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:23
147
+
148
+ ***
149
+
150
+ ### model?
151
+
152
+ ```ts
153
+ readonly optional model?: IIntelligenceModelReference;
154
+ ```
155
+
156
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
157
+
158
+ Optional provider/model override.
159
+
160
+ #### Inherited from
161
+
162
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`model`](Interface.IIntelligenceRequestOptions#model)
163
+
164
+ ***
165
+
166
+ ### prompt
167
+
168
+ ```ts
169
+ readonly prompt:
170
+ | string
171
+ | {
172
+ image: string | ArrayBuffer | Uint8Array<ArrayBufferLike>;
173
+ text?: string;
174
+ };
175
+ ```
176
+
177
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:15
178
+
179
+ ***
180
+
181
+ ### providerOptions?
182
+
183
+ ```ts
184
+ readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
185
+ ```
186
+
187
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
188
+
189
+ Optional provider-specific settings.
190
+
191
+ #### Inherited from
192
+
193
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`providerOptions`](Interface.IIntelligenceRequestOptions#provideroptions)
194
+
195
+ ***
196
+
197
+ ### resolution?
198
+
199
+ ```ts
200
+ readonly optional resolution?: `${number}x${number}`;
201
+ ```
202
+
203
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:25
204
+
205
+ ***
206
+
207
+ ### seed?
208
+
209
+ ```ts
210
+ readonly optional seed?: number;
211
+ ```
212
+
213
+ Defined in: contracts/IIntelligenceVideoGenerationOptions.ts:28
214
+
215
+ ***
216
+
217
+ ### timeoutMs?
218
+
219
+ ```ts
220
+ readonly optional timeoutMs?: number;
221
+ ```
222
+
223
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
224
+
225
+ Total provider-operation timeout in milliseconds.
226
+
227
+ #### Inherited from
228
+
229
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`timeoutMs`](Interface.IIntelligenceRequestOptions#timeoutms)
@@ -0,0 +1,50 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceVideoGenerationResult'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceVideoGenerationResult
7
+
8
+ Defined in: contracts/IIntelligenceVideoGenerationResult.ts:12
9
+
10
+ Provider-neutral video generation result.
11
+
12
+ ## Properties
13
+
14
+ ### model
15
+
16
+ ```ts
17
+ readonly model: string;
18
+ ```
19
+
20
+ Defined in: contracts/IIntelligenceVideoGenerationResult.ts:17
21
+
22
+ ***
23
+
24
+ ### provider
25
+
26
+ ```ts
27
+ readonly provider: string;
28
+ ```
29
+
30
+ Defined in: contracts/IIntelligenceVideoGenerationResult.ts:16
31
+
32
+ ***
33
+
34
+ ### videos
35
+
36
+ ```ts
37
+ readonly videos: readonly IIntelligenceGeneratedFile[];
38
+ ```
39
+
40
+ Defined in: contracts/IIntelligenceVideoGenerationResult.ts:15
41
+
42
+ ***
43
+
44
+ ### warnings
45
+
46
+ ```ts
47
+ readonly warnings: readonly string[];
48
+ ```
49
+
50
+ Defined in: contracts/IIntelligenceVideoGenerationResult.ts:18
@@ -0,0 +1,43 @@
1
+ ---
2
+ title: 'Type Alias: IIntelligenceModelMessage'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IIntelligenceModelMessage
7
+
8
+ ```ts
9
+ type IIntelligenceModelMessage =
10
+ | {
11
+ content: | string
12
+ | ReadonlyArray<
13
+ | {
14
+ text: string;
15
+ type: "text";
16
+ }
17
+ | {
18
+ image: string | URL | Uint8Array | ArrayBuffer;
19
+ mediaType?: string;
20
+ type: "image";
21
+ }
22
+ | {
23
+ data: string | URL | Uint8Array | ArrayBuffer;
24
+ filename?: string;
25
+ mediaType: string;
26
+ type: "file";
27
+ }>;
28
+ role: "system" | "developer" | "user" | "assistant";
29
+ }
30
+ | {
31
+ content: ReadonlyArray<{
32
+ output: IntelligenceJsonValue;
33
+ toolCallId: string;
34
+ toolName: string;
35
+ type: "tool-result";
36
+ }>;
37
+ role: "tool";
38
+ };
39
+ ```
40
+
41
+ Defined in: contracts/IIntelligenceModelMessage.ts:12
42
+
43
+ Provider-neutral conversation message.
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: 'Type Alias: IIntelligencePromptModelRequirement'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IIntelligencePromptModelRequirement
7
+
8
+ ```ts
9
+ type IIntelligencePromptModelRequirement =
10
+ | {
11
+ strategy: "automatic";
12
+ }
13
+ | {
14
+ models: ReadonlyArray<IIntelligenceModelReference>;
15
+ strategy: "preferred";
16
+ }
17
+ | {
18
+ model: IIntelligenceModelReference;
19
+ strategy: "fixed";
20
+ };
21
+ ```
22
+
23
+ Defined in: [prompts/IIntelligencePromptModelRequirement.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptModelRequirement.ts#L12)
24
+
25
+ Model selection requested by a reusable intelligence prompt.
@@ -0,0 +1,70 @@
1
+ ---
2
+ title: 'Type Alias: IIntelligenceSchema\<T\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IIntelligenceSchema\<T\>
7
+
8
+ ```ts
9
+ type IIntelligenceSchema<T> =
10
+ | {
11
+ jsonSchema: Readonly<Record<string, unknown>>;
12
+ kind: "json-schema";
13
+ validate?: (value) =>
14
+ | {
15
+ success: true;
16
+ value: T;
17
+ }
18
+ | {
19
+ error: Error;
20
+ success: false;
21
+ }
22
+ | Promise<
23
+ | {
24
+ success: true;
25
+ value: T;
26
+ }
27
+ | {
28
+ error: Error;
29
+ success: false;
30
+ }>;
31
+ }
32
+ | {
33
+ ~standard: {
34
+ validate: (value) =>
35
+ | {
36
+ issues?: undefined;
37
+ value: T;
38
+ }
39
+ | {
40
+ issues: ReadonlyArray<unknown>;
41
+ value?: undefined;
42
+ }
43
+ | Promise<
44
+ | {
45
+ issues?: undefined;
46
+ value: T;
47
+ }
48
+ | {
49
+ issues: ReadonlyArray<unknown>;
50
+ value?: undefined;
51
+ }>;
52
+ vendor: string;
53
+ version: 1;
54
+ };
55
+ };
56
+ ```
57
+
58
+ Defined in: contracts/IIntelligenceSchema.ts:10
59
+
60
+ Provider-neutral schema accepted by prompts, structured outputs, and tools.
61
+
62
+ Zod and other Standard Schema implementations satisfy the second union
63
+ member structurally. Plain JSON Schema values can be created with
64
+ [createIntelligenceJsonSchema](Function.createIntelligenceJsonSchema).
65
+
66
+ ## Type Parameters
67
+
68
+ | Type Parameter |
69
+ | ------ |
70
+ | `T` |
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligenceCapability'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligenceCapability
7
+
8
+ ```ts
9
+ type IntelligenceCapability = typeof IntelligenceCapabilityNames[keyof typeof IntelligenceCapabilityNames];
10
+ ```
11
+
12
+ Defined in: contracts/IntelligenceCapability.ts:12
13
+
14
+ Intelligence capability identifier.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligenceDefaultModels'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligenceDefaultModels
7
+
8
+ ```ts
9
+ type IntelligenceDefaultModels = Readonly<Partial<Record<IntelligenceCapability, IIntelligenceModelReference>>>;
10
+ ```
11
+
12
+ Defined in: contracts/IntelligenceDefaultModels.ts:13
13
+
14
+ Capability-specific default provider and model references.
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: 'Type Alias: IntelligenceJsonValue'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligenceJsonValue
7
+
8
+ ```ts
9
+ type IntelligenceJsonValue =
10
+ | string
11
+ | number
12
+ | boolean
13
+ | null
14
+ | ReadonlyArray<IntelligenceJsonValue>
15
+ | {
16
+ [key: string]: IntelligenceJsonValue;
17
+ };
18
+ ```
19
+
20
+ Defined in: contracts/IntelligenceJsonValue.ts:6
21
+
22
+ JSON-compatible value used by provider-neutral intelligence contracts.
@@ -0,0 +1,20 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptCapability'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptCapability
7
+
8
+ ```ts
9
+ type IntelligencePromptCapability =
10
+ | "textInput"
11
+ | "imageInput"
12
+ | "textOutput"
13
+ | "structuredOutput"
14
+ | "toolCalling"
15
+ | "reasoning";
16
+ ```
17
+
18
+ Defined in: [prompts/IntelligencePromptCapability.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptCapability.ts#L6)
19
+
20
+ Provider-neutral capability required by an intelligence prompt.
@@ -0,0 +1,29 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptDefinitionConfiguration\<TInput, TOutput\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptDefinitionConfiguration\<TInput, TOutput\>
7
+
8
+ ```ts
9
+ type IntelligencePromptDefinitionConfiguration<TInput, TOutput> =
10
+ | IIntelligencePromptDefinitionConfigurationBase<TInput> & {
11
+ mode: "text";
12
+ outputSchema?: never;
13
+ }
14
+ | IIntelligencePromptDefinitionConfigurationBase<TInput> & {
15
+ mode: "object";
16
+ outputSchema: IIntelligenceSchema<TOutput>;
17
+ };
18
+ ```
19
+
20
+ Defined in: [prompts/IntelligencePromptDefinitionConfiguration.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptDefinitionConfiguration.ts#L24)
21
+
22
+ Configuration accepted by [intelligencePrompt](Function.intelligencePrompt).
23
+
24
+ ## Type Parameters
25
+
26
+ | Type Parameter |
27
+ | ------ |
28
+ | `TInput` |
29
+ | `TOutput` |
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptGenerationOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptGenerationOptions
7
+
8
+ ```ts
9
+ type IntelligencePromptGenerationOptions = IIntelligenceLanguageGenerationOptions;
10
+ ```
11
+
12
+ Defined in: [prompts/IntelligencePromptGenerationOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptGenerationOptions.ts#L14)
13
+
14
+ Native generation settings that can be stored on a prompt definition.
15
+
16
+ The output contract is owned by the prompt mode and cannot be overridden.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptLatency'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptLatency
7
+
8
+ ```ts
9
+ type IntelligencePromptLatency = "interactive" | "standard" | "background";
10
+ ```
11
+
12
+ Defined in: [prompts/IntelligencePromptLatency.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptLatency.ts#L6)
13
+
14
+ Latency profile requested by an intelligence prompt.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptMode'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptMode
7
+
8
+ ```ts
9
+ type IntelligencePromptMode = "text" | "object";
10
+ ```
11
+
12
+ Defined in: [prompts/IntelligencePromptMode.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptMode.ts#L6)
13
+
14
+ Supported execution modes for reusable intelligence prompts.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptQuality'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptQuality
7
+
8
+ ```ts
9
+ type IntelligencePromptQuality = "economy" | "balanced" | "capable" | "premium";
10
+ ```
11
+
12
+ Defined in: [prompts/IntelligencePromptQuality.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptQuality.ts#L6)
13
+
14
+ Provider-neutral model quality requested by an intelligence prompt.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptReasoning'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptReasoning
7
+
8
+ ```ts
9
+ type IntelligencePromptReasoning = "none" | "minimal" | "low" | "medium" | "high";
10
+ ```
11
+
12
+ Defined in: [prompts/IntelligencePromptReasoning.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptReasoning.ts#L6)
13
+
14
+ Provider-neutral reasoning effort requested by an intelligence prompt.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type IntelligenceProviderName = typeof IntelligenceProviderNames[keyof typeof IntelligenceProviderNames];
10
10
  ```
11
11
 
12
- Defined in: [contracts/IntelligenceProviderNames.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L19)
12
+ Defined in: contracts/IntelligenceProviderName.ts:12
13
13
 
14
14
  Represents the union of supported intelligence provider identifiers.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligenceProviderOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligenceProviderOptions
7
+
8
+ ```ts
9
+ type IntelligenceProviderOptions = Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
10
+ ```
11
+
12
+ Defined in: contracts/IntelligenceProviderOptions.ts:12
13
+
14
+ Provider-specific request options kept behind an explicit escape hatch.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligenceProviderProbeStatus'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligenceProviderProbeStatus
7
+
8
+ ```ts
9
+ type IntelligenceProviderProbeStatus = "operational" | "degraded" | "down";
10
+ ```
11
+
12
+ Defined in: contracts/IntelligenceProviderProbeStatus.ts:6
13
+
14
+ Normalized provider availability state.