@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,145 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptDefinition\<TInput, TOutput, TMode\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptDefinition\<TInput, TOutput, TMode\>
7
+
8
+ Defined in: [prompts/IIntelligencePromptDefinition.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L17)
9
+
10
+ Reusable, immutable definition of an intelligence prompt.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter | Default type |
15
+ | ------ | ------ |
16
+ | `TInput` | - |
17
+ | `TOutput` | - |
18
+ | `TMode` *extends* [`IntelligencePromptMode`](TypeAlias.IntelligencePromptMode) | [`IntelligencePromptMode`](TypeAlias.IntelligencePromptMode) |
19
+
20
+ ## Properties
21
+
22
+ ### execution?
23
+
24
+ ```ts
25
+ readonly optional execution?: IIntelligencePromptExecutionPolicy;
26
+ ```
27
+
28
+ Defined in: [prompts/IIntelligencePromptDefinition.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L25)
29
+
30
+ ***
31
+
32
+ ### inputSchema
33
+
34
+ ```ts
35
+ readonly inputSchema: IIntelligenceSchema<TInput>;
36
+ ```
37
+
38
+ Defined in: [prompts/IIntelligencePromptDefinition.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L23)
39
+
40
+ ***
41
+
42
+ ### mode
43
+
44
+ ```ts
45
+ readonly mode: TMode;
46
+ ```
47
+
48
+ Defined in: [prompts/IIntelligencePromptDefinition.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L22)
49
+
50
+ ***
51
+
52
+ ### name
53
+
54
+ ```ts
55
+ readonly name: string;
56
+ ```
57
+
58
+ Defined in: [prompts/IIntelligencePromptDefinition.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L20)
59
+
60
+ ***
61
+
62
+ ### outputSchema?
63
+
64
+ ```ts
65
+ readonly optional outputSchema?: IIntelligenceSchema<TOutput>;
66
+ ```
67
+
68
+ Defined in: [prompts/IIntelligencePromptDefinition.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L24)
69
+
70
+ ***
71
+
72
+ ### version
73
+
74
+ ```ts
75
+ readonly version: number;
76
+ ```
77
+
78
+ Defined in: [prompts/IIntelligencePromptDefinition.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L21)
79
+
80
+ ## Methods
81
+
82
+ ### messages()
83
+
84
+ ```ts
85
+ messages(context): readonly IIntelligenceModelMessage[];
86
+ ```
87
+
88
+ Defined in: [prompts/IIntelligencePromptDefinition.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L32)
89
+
90
+ #### Parameters
91
+
92
+ | Parameter | Type |
93
+ | ------ | ------ |
94
+ | `context` | [`IIntelligencePromptRenderContext`](Interface.IIntelligencePromptRenderContext)\<`TInput`\> |
95
+
96
+ #### Returns
97
+
98
+ readonly [`IIntelligenceModelMessage`](TypeAlias.IIntelligenceModelMessage)[]
99
+
100
+ ***
101
+
102
+ ### system()
103
+
104
+ ```ts
105
+ system(context): string | readonly string[];
106
+ ```
107
+
108
+ Defined in: [prompts/IIntelligencePromptDefinition.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L31)
109
+
110
+ #### Parameters
111
+
112
+ | Parameter | Type |
113
+ | ------ | ------ |
114
+ | `context` | [`IIntelligencePromptRenderContext`](Interface.IIntelligencePromptRenderContext)\<`TInput`\> |
115
+
116
+ #### Returns
117
+
118
+ `string` \| readonly `string`[]
119
+
120
+ ***
121
+
122
+ ### with()
123
+
124
+ ```ts
125
+ with<TMetadata>(input, metadata?): IIntelligencePromptInvocation<TInput, TOutput, TMode, TMetadata>;
126
+ ```
127
+
128
+ Defined in: [prompts/IIntelligencePromptDefinition.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L33)
129
+
130
+ #### Type Parameters
131
+
132
+ | Type Parameter | Default type |
133
+ | ------ | ------ |
134
+ | `TMetadata` | `undefined` |
135
+
136
+ #### Parameters
137
+
138
+ | Parameter | Type |
139
+ | ------ | ------ |
140
+ | `input` | `TInput` |
141
+ | `metadata?` | `TMetadata` |
142
+
143
+ #### Returns
144
+
145
+ [`IIntelligencePromptInvocation`](Interface.IIntelligencePromptInvocation)\<`TInput`, `TOutput`, `TMode`, `TMetadata`\>
@@ -0,0 +1,30 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptEffectivePolicy'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptEffectivePolicy
7
+
8
+ Defined in: [prompts/IIntelligencePromptEffectivePolicy.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptEffectivePolicy.ts#L13)
9
+
10
+ Effective settings resolved for one prompt execution.
11
+
12
+ ## Properties
13
+
14
+ ### capabilities
15
+
16
+ ```ts
17
+ readonly capabilities: readonly IntelligencePromptCapability[];
18
+ ```
19
+
20
+ Defined in: [prompts/IIntelligencePromptEffectivePolicy.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptEffectivePolicy.ts#L17)
21
+
22
+ ***
23
+
24
+ ### options
25
+
26
+ ```ts
27
+ readonly options: IIntelligenceLanguageGenerationOptions;
28
+ ```
29
+
30
+ Defined in: [prompts/IIntelligencePromptEffectivePolicy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptEffectivePolicy.ts#L16)
@@ -0,0 +1,20 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptExecutionContext'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptExecutionContext
7
+
8
+ Defined in: [prompts/IIntelligencePromptExecutionContext.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionContext.ts#L6)
9
+
10
+ Application context made available to prompt policy adapters.
11
+
12
+ ## Properties
13
+
14
+ ### metadata?
15
+
16
+ ```ts
17
+ readonly optional metadata?: Readonly<Record<string, unknown>>;
18
+ ```
19
+
20
+ Defined in: [prompts/IIntelligencePromptExecutionContext.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionContext.ts#L9)
@@ -0,0 +1,70 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptExecutionPolicy'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptExecutionPolicy
7
+
8
+ Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L17)
9
+
10
+ Native settings and provider-neutral requirements declared by an intelligence prompt.
11
+
12
+ ## Properties
13
+
14
+ ### latency?
15
+
16
+ ```ts
17
+ readonly optional latency?: IntelligencePromptLatency;
18
+ ```
19
+
20
+ Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L23)
21
+
22
+ ***
23
+
24
+ ### model?
25
+
26
+ ```ts
27
+ readonly optional model?: IIntelligencePromptModelRequirement;
28
+ ```
29
+
30
+ Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L24)
31
+
32
+ ***
33
+
34
+ ### options?
35
+
36
+ ```ts
37
+ readonly optional options?: IIntelligenceLanguageGenerationOptions;
38
+ ```
39
+
40
+ Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L20)
41
+
42
+ ***
43
+
44
+ ### quality?
45
+
46
+ ```ts
47
+ readonly optional quality?: IntelligencePromptQuality;
48
+ ```
49
+
50
+ Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L21)
51
+
52
+ ***
53
+
54
+ ### reasoning?
55
+
56
+ ```ts
57
+ readonly optional reasoning?: IntelligencePromptReasoning;
58
+ ```
59
+
60
+ Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L22)
61
+
62
+ ***
63
+
64
+ ### requiredCapabilities?
65
+
66
+ ```ts
67
+ readonly optional requiredCapabilities?: readonly IntelligencePromptCapability[];
68
+ ```
69
+
70
+ Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L25)
@@ -0,0 +1,127 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptExecutionResult\<TOutput, TMetadata\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptExecutionResult\<TOutput, TMetadata\>
7
+
8
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L14)
9
+
10
+ Normalized result of an intelligence prompt execution.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter | Default type |
15
+ | ------ | ------ |
16
+ | `TOutput` | - |
17
+ | `TMetadata` | `undefined` |
18
+
19
+ ## Properties
20
+
21
+ ### effectivePolicy
22
+
23
+ ```ts
24
+ readonly effectivePolicy: IIntelligencePromptEffectivePolicy;
25
+ ```
26
+
27
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L26)
28
+
29
+ ***
30
+
31
+ ### finishReason
32
+
33
+ ```ts
34
+ readonly finishReason: string;
35
+ ```
36
+
37
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L24)
38
+
39
+ ***
40
+
41
+ ### metadata
42
+
43
+ ```ts
44
+ readonly metadata: TMetadata | undefined;
45
+ ```
46
+
47
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L27)
48
+
49
+ ***
50
+
51
+ ### model
52
+
53
+ ```ts
54
+ readonly model: string;
55
+ ```
56
+
57
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L21)
58
+
59
+ ***
60
+
61
+ ### output
62
+
63
+ ```ts
64
+ readonly output: TOutput;
65
+ ```
66
+
67
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L17)
68
+
69
+ ***
70
+
71
+ ### promptName
72
+
73
+ ```ts
74
+ readonly promptName: string;
75
+ ```
76
+
77
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L18)
78
+
79
+ ***
80
+
81
+ ### promptVersion
82
+
83
+ ```ts
84
+ readonly promptVersion: number;
85
+ ```
86
+
87
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L19)
88
+
89
+ ***
90
+
91
+ ### provider
92
+
93
+ ```ts
94
+ readonly provider: string;
95
+ ```
96
+
97
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L20)
98
+
99
+ ***
100
+
101
+ ### reasoningText?
102
+
103
+ ```ts
104
+ readonly optional reasoningText?: string;
105
+ ```
106
+
107
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L23)
108
+
109
+ ***
110
+
111
+ ### requestedPolicy
112
+
113
+ ```ts
114
+ readonly requestedPolicy: IIntelligencePromptExecutionPolicy;
115
+ ```
116
+
117
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L25)
118
+
119
+ ***
120
+
121
+ ### usage
122
+
123
+ ```ts
124
+ readonly usage: IIntelligenceUsage | null;
125
+ ```
126
+
127
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L22)
@@ -0,0 +1,49 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptInvocation\<TInput, TOutput, TMode, TMetadata\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptInvocation\<TInput, TOutput, TMode, TMetadata\>
7
+
8
+ Defined in: [prompts/IIntelligencePromptInvocation.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptInvocation.ts#L13)
9
+
10
+ Bound prompt definition ready for execution.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter | Default type |
15
+ | ------ | ------ |
16
+ | `TInput` | - |
17
+ | `TOutput` | - |
18
+ | `TMode` *extends* [`IntelligencePromptMode`](TypeAlias.IntelligencePromptMode) | - |
19
+ | `TMetadata` | `undefined` |
20
+
21
+ ## Properties
22
+
23
+ ### definition
24
+
25
+ ```ts
26
+ readonly definition: IIntelligencePromptDefinition<TInput, TOutput, TMode>;
27
+ ```
28
+
29
+ Defined in: [prompts/IIntelligencePromptInvocation.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptInvocation.ts#L16)
30
+
31
+ ***
32
+
33
+ ### input
34
+
35
+ ```ts
36
+ readonly input: Readonly<TInput>;
37
+ ```
38
+
39
+ Defined in: [prompts/IIntelligencePromptInvocation.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptInvocation.ts#L17)
40
+
41
+ ***
42
+
43
+ ### metadata
44
+
45
+ ```ts
46
+ readonly metadata: TMetadata | undefined;
47
+ ```
48
+
49
+ Defined in: [prompts/IIntelligencePromptInvocation.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptInvocation.ts#L18)
@@ -0,0 +1,60 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptPolicyRequest'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptPolicyRequest
7
+
8
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L14)
9
+
10
+ Policy resolution request for one prompt invocation.
11
+
12
+ ## Properties
13
+
14
+ ### context
15
+
16
+ ```ts
17
+ readonly context: IIntelligencePromptExecutionContext;
18
+ ```
19
+
20
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L21)
21
+
22
+ ***
23
+
24
+ ### mode
25
+
26
+ ```ts
27
+ readonly mode: IntelligencePromptMode;
28
+ ```
29
+
30
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L19)
31
+
32
+ ***
33
+
34
+ ### promptName
35
+
36
+ ```ts
37
+ readonly promptName: string;
38
+ ```
39
+
40
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L17)
41
+
42
+ ***
43
+
44
+ ### promptVersion
45
+
46
+ ```ts
47
+ readonly promptVersion: number;
48
+ ```
49
+
50
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L18)
51
+
52
+ ***
53
+
54
+ ### requestedPolicy
55
+
56
+ ```ts
57
+ readonly requestedPolicy: IIntelligencePromptExecutionPolicy;
58
+ ```
59
+
60
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L20)
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptRenderContext\<TInput\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptRenderContext\<TInput\>
7
+
8
+ Defined in: [prompts/IIntelligencePromptRenderContext.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptRenderContext.ts#L6)
9
+
10
+ Input exposed to pure prompt rendering functions.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter |
15
+ | ------ |
16
+ | `TInput` |
17
+
18
+ ## Properties
19
+
20
+ ### input
21
+
22
+ ```ts
23
+ readonly input: Readonly<TInput>;
24
+ ```
25
+
26
+ Defined in: [prompts/IIntelligencePromptRenderContext.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptRenderContext.ts#L9)
@@ -0,0 +1,73 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceProviderAdapter'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceProviderAdapter
7
+
8
+ Defined in: providers/IIntelligenceProviderAdapter.ts:17
9
+
10
+ Provider adapter registered with the intelligence capability registry.
11
+
12
+ The loaded handle is intentionally opaque. Only Archipel's internal
13
+ execution adapters unwrap it into an AI SDK model or provider API.
14
+
15
+ ## Properties
16
+
17
+ ### capabilities
18
+
19
+ ```ts
20
+ readonly capabilities: readonly IntelligenceCapability[];
21
+ ```
22
+
23
+ Defined in: providers/IIntelligenceProviderAdapter.ts:21
24
+
25
+ ***
26
+
27
+ ### provider
28
+
29
+ ```ts
30
+ readonly provider: string;
31
+ ```
32
+
33
+ Defined in: providers/IIntelligenceProviderAdapter.ts:20
34
+
35
+ ## Methods
36
+
37
+ ### load()
38
+
39
+ ```ts
40
+ load(request): Promise<unknown>;
41
+ ```
42
+
43
+ Defined in: providers/IIntelligenceProviderAdapter.ts:27
44
+
45
+ #### Parameters
46
+
47
+ | Parameter | Type |
48
+ | ------ | ------ |
49
+ | `request` | [`IIntelligenceProviderLoadRequest`](Interface.IIntelligenceProviderLoadRequest) |
50
+
51
+ #### Returns
52
+
53
+ `Promise`\<`unknown`\>
54
+
55
+ ***
56
+
57
+ ### probe()?
58
+
59
+ ```ts
60
+ optional probe(request): Promise<IIntelligenceProviderProbeResult>;
61
+ ```
62
+
63
+ Defined in: providers/IIntelligenceProviderAdapter.ts:28
64
+
65
+ #### Parameters
66
+
67
+ | Parameter | Type |
68
+ | ------ | ------ |
69
+ | `request` | [`IIntelligenceProviderLoadRequest`](Interface.IIntelligenceProviderLoadRequest) |
70
+
71
+ #### Returns
72
+
73
+ `Promise`\<[`IIntelligenceProviderProbeResult`](Interface.IIntelligenceProviderProbeResult)\>
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceProviderConfiguration
7
7
 
8
- Defined in: [contracts/IIntelligenceProviderConfiguration.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L12)
8
+ Defined in: [contracts/IIntelligenceProviderConfiguration.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L6)
9
9
 
10
10
  Describes the resolved configuration for the intelligence provider.
11
11
 
@@ -14,10 +14,10 @@ Describes the resolved configuration for the intelligence provider.
14
14
  ### apiKey
15
15
 
16
16
  ```ts
17
- readonly apiKey: string;
17
+ readonly apiKey: string | null;
18
18
  ```
19
19
 
20
- Defined in: [contracts/IIntelligenceProviderConfiguration.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L34)
20
+ Defined in: [contracts/IIntelligenceProviderConfiguration.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L28)
21
21
 
22
22
  The API key used to authenticate with the provider.
23
23
 
@@ -29,7 +29,7 @@ The API key used to authenticate with the provider.
29
29
  readonly baseUrl: string | null;
30
30
  ```
31
31
 
32
- Defined in: [contracts/IIntelligenceProviderConfiguration.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L41)
32
+ Defined in: [contracts/IIntelligenceProviderConfiguration.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L35)
33
33
 
34
34
  An optional base URL override for the provider API.
35
35
 
@@ -41,7 +41,7 @@ An optional base URL override for the provider API.
41
41
  readonly maxOutputTokens: number;
42
42
  ```
43
43
 
44
- Defined in: [contracts/IIntelligenceProviderConfiguration.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L62)
44
+ Defined in: [contracts/IIntelligenceProviderConfiguration.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L56)
45
45
 
46
46
  The maximum number of output tokens per completion.
47
47
 
@@ -53,7 +53,7 @@ The maximum number of output tokens per completion.
53
53
  readonly model: string;
54
54
  ```
55
55
 
56
- Defined in: [contracts/IIntelligenceProviderConfiguration.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L27)
56
+ Defined in: [contracts/IIntelligenceProviderConfiguration.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L21)
57
57
 
58
58
  The model identifier to use for text generation.
59
59
 
@@ -62,10 +62,10 @@ The model identifier to use for text generation.
62
62
  ### provider
63
63
 
64
64
  ```ts
65
- readonly provider: IntelligenceProviderName;
65
+ readonly provider: string;
66
66
  ```
67
67
 
68
- Defined in: [contracts/IIntelligenceProviderConfiguration.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L20)
68
+ Defined in: [contracts/IIntelligenceProviderConfiguration.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L14)
69
69
 
70
70
  The resolved provider identifier.
71
71
 
@@ -77,7 +77,7 @@ The resolved provider identifier.
77
77
  readonly temperature: number;
78
78
  ```
79
79
 
80
- Defined in: [contracts/IIntelligenceProviderConfiguration.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L48)
80
+ Defined in: [contracts/IIntelligenceProviderConfiguration.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L42)
81
81
 
82
82
  The sampling temperature used for text generation.
83
83
 
@@ -89,6 +89,6 @@ The sampling temperature used for text generation.
89
89
  readonly topP: number;
90
90
  ```
91
91
 
92
- Defined in: [contracts/IIntelligenceProviderConfiguration.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L55)
92
+ Defined in: [contracts/IIntelligenceProviderConfiguration.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L49)
93
93
 
94
94
  The top-p (nucleus) sampling parameter.