@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
@@ -5,18 +5,26 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceProviderAssetUploader
7
7
 
8
- Defined in: [IntelligenceProviderAssetUploader.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L20)
8
+ Defined in: [IntelligenceProviderAssetUploader.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L25)
9
9
 
10
- Uploads provider-managed files and skills for reuse in AI SDK calls.
10
+ Uploads provider-managed files and skills behind provider-neutral contracts.
11
11
 
12
12
  ## Constructors
13
13
 
14
14
  ### Constructor
15
15
 
16
16
  ```ts
17
- new IntelligenceProviderAssetUploader(): IntelligenceProviderAssetUploader;
17
+ new IntelligenceProviderAssetUploader(modelResolver): IntelligenceProviderAssetUploader;
18
18
  ```
19
19
 
20
+ Defined in: [IntelligenceProviderAssetUploader.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L32)
21
+
22
+ #### Parameters
23
+
24
+ | Parameter | Type |
25
+ | ------ | ------ |
26
+ | `modelResolver` | `IntelligenceModelResolver` |
27
+
20
28
  #### Returns
21
29
 
22
30
  `IntelligenceProviderAssetUploader`
@@ -26,10 +34,10 @@ new IntelligenceProviderAssetUploader(): IntelligenceProviderAssetUploader;
26
34
  ### uploadFile()
27
35
 
28
36
  ```ts
29
- uploadFile(options): Promise<UploadFileResult>;
37
+ uploadFile(options): Promise<IIntelligenceFileUploadResult>;
30
38
  ```
31
39
 
32
- Defined in: [IntelligenceProviderAssetUploader.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L42)
40
+ Defined in: [IntelligenceProviderAssetUploader.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L51)
33
41
 
34
42
  Uploads a provider-managed file.
35
43
 
@@ -37,24 +45,23 @@ Uploads a provider-managed file.
37
45
 
38
46
  | Parameter | Type | Description |
39
47
  | ------ | ------ | ------ |
40
- | `options` | \{ \} & `Omit`\<`FilesV4UploadFileCallOptions`, `"mediaType"` \| `"data"`\> & \{ \} | Native AI SDK `uploadFile()` options. |
48
+ | `options` | [`IIntelligenceFileUploadOptions`](Interface.IIntelligenceFileUploadOptions) | Provider-neutral file upload options. |
41
49
 
42
50
  #### Returns
43
51
 
44
- `Promise`\<`UploadFileResult`\>
52
+ `Promise`\<[`IIntelligenceFileUploadResult`](Interface.IIntelligenceFileUploadResult)\>
45
53
 
46
- The native AI SDK upload result.
54
+ A normalized provider reference.
47
55
 
48
56
  ***
49
57
 
50
58
  ### uploadSkill()
51
59
 
52
60
  ```ts
53
- uploadSkill(options): Promise<Omit<SkillsV4UploadSkillResult, "providerReference" | "warnings"> & {
54
- }>;
61
+ uploadSkill(options): Promise<IIntelligenceSkillUploadResult>;
55
62
  ```
56
63
 
57
- Defined in: [IntelligenceProviderAssetUploader.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L55)
64
+ Defined in: [IntelligenceProviderAssetUploader.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L83)
58
65
 
59
66
  Uploads a provider-managed skill.
60
67
 
@@ -62,11 +69,10 @@ Uploads a provider-managed skill.
62
69
 
63
70
  | Parameter | Type | Description |
64
71
  | ------ | ------ | ------ |
65
- | `options` | \{ \} & `Omit`\<`SkillsV4UploadSkillCallOptions`, `"files"`\> & \{ \} | Native AI SDK `uploadSkill()` options. |
72
+ | `options` | [`IIntelligenceSkillUploadOptions`](Interface.IIntelligenceSkillUploadOptions) | Provider-neutral skill upload options. |
66
73
 
67
74
  #### Returns
68
75
 
69
- `Promise`\<`Omit`\<`SkillsV4UploadSkillResult`, `"providerReference"` \| `"warnings"`\> & \{
70
- \}\>
76
+ `Promise`\<[`IIntelligenceSkillUploadResult`](Interface.IIntelligenceSkillUploadResult)\>
71
77
 
72
- The native AI SDK upload result.
78
+ A normalized provider reference and skill metadata.
@@ -0,0 +1,55 @@
1
+ ---
2
+ title: 'Class: IntelligenceProviderDiagnostics'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceProviderDiagnostics
7
+
8
+ Defined in: IntelligenceProviderDiagnostics.ts:18
9
+
10
+ Performs bounded, provider-neutral provider availability diagnostics.
11
+
12
+ ## Constructors
13
+
14
+ ### Constructor
15
+
16
+ ```ts
17
+ new IntelligenceProviderDiagnostics(modelResolver): IntelligenceProviderDiagnostics;
18
+ ```
19
+
20
+ Defined in: IntelligenceProviderDiagnostics.ts:27
21
+
22
+ #### Parameters
23
+
24
+ | Parameter | Type |
25
+ | ------ | ------ |
26
+ | `modelResolver` | `IntelligenceModelResolver` |
27
+
28
+ #### Returns
29
+
30
+ `IntelligenceProviderDiagnostics`
31
+
32
+ ## Methods
33
+
34
+ ### probe()
35
+
36
+ ```ts
37
+ probe(
38
+ capability?,
39
+ model?,
40
+ timeoutMs?): Promise<IIntelligenceProviderProbeResult>;
41
+ ```
42
+
43
+ Defined in: IntelligenceProviderDiagnostics.ts:39
44
+
45
+ #### Parameters
46
+
47
+ | Parameter | Type | Default value |
48
+ | ------ | ------ | ------ |
49
+ | `capability` | [`IntelligenceCapability`](TypeAlias.IntelligenceCapability) | `IntelligenceCapabilityNames.Language` |
50
+ | `model?` | [`IIntelligenceModelReference`](Interface.IIntelligenceModelReference) | `undefined` |
51
+ | `timeoutMs?` | `number` | `undefined` |
52
+
53
+ #### Returns
54
+
55
+ `Promise`\<[`IIntelligenceProviderProbeResult`](Interface.IIntelligenceProviderProbeResult)\>
@@ -26,7 +26,7 @@ new IntelligenceProviderError(
26
26
  cause?): IntelligenceProviderError;
27
27
  ```
28
28
 
29
- Defined in: [errors/IntelligenceProviderError.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L17)
29
+ Defined in: [errors/IntelligenceProviderError.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L18)
30
30
 
31
31
  #### Parameters
32
32
 
@@ -50,13 +50,23 @@ Error.constructor
50
50
 
51
51
  ## Properties
52
52
 
53
+ ### code
54
+
55
+ ```ts
56
+ readonly code: "INTELLIGENCE_PROVIDER" = 'INTELLIGENCE_PROVIDER';
57
+ ```
58
+
59
+ Defined in: [errors/IntelligenceProviderError.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L9)
60
+
61
+ ***
62
+
53
63
  ### isRetryable
54
64
 
55
65
  ```ts
56
66
  readonly isRetryable: boolean;
57
67
  ```
58
68
 
59
- Defined in: [errors/IntelligenceProviderError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L11)
69
+ Defined in: [errors/IntelligenceProviderError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L12)
60
70
 
61
71
  ***
62
72
 
@@ -66,7 +76,7 @@ Defined in: [errors/IntelligenceProviderError.ts:11](https://github.com/RueDeRen
66
76
  readonly model: string;
67
77
  ```
68
78
 
69
- Defined in: [errors/IntelligenceProviderError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L10)
79
+ Defined in: [errors/IntelligenceProviderError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L11)
70
80
 
71
81
  ***
72
82
 
@@ -76,4 +86,4 @@ Defined in: [errors/IntelligenceProviderError.ts:10](https://github.com/RueDeRen
76
86
  readonly provider: string;
77
87
  ```
78
88
 
79
- Defined in: [errors/IntelligenceProviderError.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L9)
89
+ Defined in: [errors/IntelligenceProviderError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L10)
@@ -0,0 +1,68 @@
1
+ ---
2
+ title: 'Class: IntelligenceProviderRegistry'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceProviderRegistry
7
+
8
+ Defined in: IntelligenceProviderRegistry.ts:17
9
+
10
+ Immutable registry of provider adapters and their supported capabilities.
11
+
12
+ ## Constructors
13
+
14
+ ### Constructor
15
+
16
+ ```ts
17
+ new IntelligenceProviderRegistry(adapters): IntelligenceProviderRegistry;
18
+ ```
19
+
20
+ Defined in: IntelligenceProviderRegistry.ts:27
21
+
22
+ #### Parameters
23
+
24
+ | Parameter | Type |
25
+ | ------ | ------ |
26
+ | `adapters` | readonly [`IIntelligenceProviderAdapter`](Interface.IIntelligenceProviderAdapter)[] |
27
+
28
+ #### Returns
29
+
30
+ `IntelligenceProviderRegistry`
31
+
32
+ ## Methods
33
+
34
+ ### listProviders()
35
+
36
+ ```ts
37
+ listProviders(): readonly string[];
38
+ ```
39
+
40
+ Defined in: IntelligenceProviderRegistry.ts:64
41
+
42
+ Returns all registered provider identifiers.
43
+
44
+ #### Returns
45
+
46
+ readonly `string`[]
47
+
48
+ ***
49
+
50
+ ### listProvidersFor()
51
+
52
+ ```ts
53
+ listProvidersFor(capability): readonly string[];
54
+ ```
55
+
56
+ Defined in: IntelligenceProviderRegistry.ts:73
57
+
58
+ Returns providers supporting one capability.
59
+
60
+ #### Parameters
61
+
62
+ | Parameter | Type |
63
+ | ------ | ------ |
64
+ | `capability` | [`IntelligenceCapability`](TypeAlias.IntelligenceCapability) |
65
+
66
+ #### Returns
67
+
68
+ readonly `string`[]
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceRealtimeError
7
7
 
8
- Defined in: errors/IntelligenceRealtimeError.ts:12
8
+ Defined in: [errors/IntelligenceRealtimeError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L6)
9
9
 
10
10
  Error raised by a realtime session, transport, or metering adapter.
11
11
 
@@ -28,7 +28,7 @@ new IntelligenceRealtimeError(
28
28
  cause?): IntelligenceRealtimeError;
29
29
  ```
30
30
 
31
- Defined in: errors/IntelligenceRealtimeError.ts:25
31
+ Defined in: [errors/IntelligenceRealtimeError.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L19)
32
32
 
33
33
  #### Parameters
34
34
 
@@ -36,7 +36,7 @@ Defined in: errors/IntelligenceRealtimeError.ts:25
36
36
  | ------ | ------ |
37
37
  | `message` | `string` |
38
38
  | `phase` | \| `"configuration"` \| `"token"` \| `"connect"` \| `"send"` \| `"receive"` \| `"metering"` \| `"close"` |
39
- | `provider` | [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName) |
39
+ | `provider` | `string` |
40
40
  | `model` | `string` |
41
41
  | `sessionId` | `string` |
42
42
  | `isRetryable` | `boolean` |
@@ -60,7 +60,7 @@ Error.constructor
60
60
  readonly isRetryable: boolean;
61
61
  ```
62
62
 
63
- Defined in: errors/IntelligenceRealtimeError.ts:19
63
+ Defined in: [errors/IntelligenceRealtimeError.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L13)
64
64
 
65
65
  ***
66
66
 
@@ -70,7 +70,7 @@ Defined in: errors/IntelligenceRealtimeError.ts:19
70
70
  readonly model: string;
71
71
  ```
72
72
 
73
- Defined in: errors/IntelligenceRealtimeError.ts:17
73
+ Defined in: [errors/IntelligenceRealtimeError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L11)
74
74
 
75
75
  ***
76
76
 
@@ -87,17 +87,17 @@ readonly phase:
87
87
  | "close";
88
88
  ```
89
89
 
90
- Defined in: errors/IntelligenceRealtimeError.ts:15
90
+ Defined in: [errors/IntelligenceRealtimeError.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L9)
91
91
 
92
92
  ***
93
93
 
94
94
  ### provider
95
95
 
96
96
  ```ts
97
- readonly provider: IntelligenceProviderName;
97
+ readonly provider: string;
98
98
  ```
99
99
 
100
- Defined in: errors/IntelligenceRealtimeError.ts:16
100
+ Defined in: [errors/IntelligenceRealtimeError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L10)
101
101
 
102
102
  ***
103
103
 
@@ -107,4 +107,4 @@ Defined in: errors/IntelligenceRealtimeError.ts:16
107
107
  readonly sessionId: string;
108
108
  ```
109
109
 
110
- Defined in: errors/IntelligenceRealtimeError.ts:18
110
+ Defined in: [errors/IntelligenceRealtimeError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L12)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Abstract Class: IntelligenceRealtimeMeteringPort
7
7
 
8
- Defined in: realtime/ports/IntelligenceRealtimeMeteringPort.ts:15
8
+ Defined in: [realtime/ports/IntelligenceRealtimeMeteringPort.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeMeteringPort.ts#L15)
9
9
 
10
10
  Application port for idempotently persisting realtime billing and audit events.
11
11
 
@@ -32,7 +32,7 @@ new IntelligenceRealtimeMeteringPort(): IntelligenceRealtimeMeteringPort;
32
32
  abstract report(event): Promise<void>;
33
33
  ```
34
34
 
35
- Defined in: realtime/ports/IntelligenceRealtimeMeteringPort.ts:23
35
+ Defined in: [realtime/ports/IntelligenceRealtimeMeteringPort.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeMeteringPort.ts#L23)
36
36
 
37
37
  Persists one metering event.
38
38
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceRealtimeSessionFactory
7
7
 
8
- Defined in: IntelligenceRealtimeSessionFactory.ts:35
8
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L34)
9
9
 
10
10
  Creates and owns server-side, provider-neutral realtime AI sessions.
11
11
 
@@ -23,23 +23,23 @@ mappings, token creation, and upstream sockets remain inside Archipel.
23
23
 
24
24
  ```ts
25
25
  new IntelligenceRealtimeSessionFactory(
26
- configService,
26
+ modelResolver,
27
+ providerRegistry,
27
28
  toolRegistry,
28
29
  metering,
29
- providerLoaders,
30
30
  runtime): IntelligenceRealtimeSessionFactory;
31
31
  ```
32
32
 
33
- Defined in: IntelligenceRealtimeSessionFactory.ts:55
33
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L54)
34
34
 
35
35
  #### Parameters
36
36
 
37
37
  | Parameter | Type |
38
38
  | ------ | ------ |
39
- | `configService` | `ConfigService` |
39
+ | `modelResolver` | `IntelligenceModelResolver` |
40
+ | `providerRegistry` | [`IntelligenceProviderRegistry`](Class.IntelligenceProviderRegistry) |
40
41
  | `toolRegistry` | [`IntelligenceToolRegistry`](Class.IntelligenceToolRegistry) |
41
42
  | `metering` | [`IntelligenceRealtimeMeteringPort`](Class.IntelligenceRealtimeMeteringPort) |
42
- | `providerLoaders` | [`IntelligenceRealtimeModelLoaders`](TypeAlias.IntelligenceRealtimeModelLoaders) |
43
43
  | `runtime` | `IIntelligenceRealtimeRuntimeOptions` |
44
44
 
45
45
  #### Returns
@@ -56,7 +56,7 @@ Defined in: IntelligenceRealtimeSessionFactory.ts:55
56
56
  get activeSessionCount(): number;
57
57
  ```
58
58
 
59
- Defined in: IntelligenceRealtimeSessionFactory.ts:74
59
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L73)
60
60
 
61
61
  Number of sessions currently owned by this module instance.
62
62
 
@@ -71,16 +71,16 @@ Number of sessions currently owned by this module instance.
71
71
  #### Get Signature
72
72
 
73
73
  ```ts
74
- get registeredProviders(): readonly IntelligenceProviderName[];
74
+ get registeredProviders(): readonly string[];
75
75
  ```
76
76
 
77
- Defined in: IntelligenceRealtimeSessionFactory.ts:79
77
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L78)
78
78
 
79
79
  Providers currently registered for server-owned realtime sessions.
80
80
 
81
81
  ##### Returns
82
82
 
83
- readonly [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName)[]
83
+ readonly `string`[]
84
84
 
85
85
  ## Methods
86
86
 
@@ -90,7 +90,7 @@ readonly [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName)[]
90
90
  createSession(options): Promise<IntelligenceRealtimeSessionPort>;
91
91
  ```
92
92
 
93
- Defined in: IntelligenceRealtimeSessionFactory.ts:93
93
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L92)
94
94
 
95
95
  Creates an isolated realtime session without opening the upstream socket.
96
96
 
@@ -114,7 +114,7 @@ A provider-neutral session. Call `connect()` to start streaming.
114
114
  onModuleDestroy(): Promise<void>;
115
115
  ```
116
116
 
117
- Defined in: IntelligenceRealtimeSessionFactory.ts:132
117
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L126)
118
118
 
119
119
  Closes all owned upstream sessions during Nest application shutdown.
120
120
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Abstract Class: IntelligenceRealtimeSessionPort
7
7
 
8
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:14
8
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L13)
9
9
 
10
10
  Provider-neutral control surface for one realtime model connection.
11
11
 
@@ -31,7 +31,7 @@ new IntelligenceRealtimeSessionPort(): IntelligenceRealtimeSessionPort;
31
31
  get abstract connectionId(): string;
32
32
  ```
33
33
 
34
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:18
34
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L17)
35
35
 
36
36
  ##### Returns
37
37
 
@@ -47,7 +47,7 @@ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:18
47
47
  get abstract model(): string;
48
48
  ```
49
49
 
50
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:20
50
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L19)
51
51
 
52
52
  ##### Returns
53
53
 
@@ -60,14 +60,14 @@ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:20
60
60
  #### Get Signature
61
61
 
62
62
  ```ts
63
- get abstract provider(): IntelligenceProviderName;
63
+ get abstract provider(): string;
64
64
  ```
65
65
 
66
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:19
66
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L18)
67
67
 
68
68
  ##### Returns
69
69
 
70
- [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName)
70
+ `string`
71
71
 
72
72
  ***
73
73
 
@@ -79,7 +79,7 @@ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:19
79
79
  get abstract sessionId(): string;
80
80
  ```
81
81
 
82
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:17
82
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L16)
83
83
 
84
84
  ##### Returns
85
85
 
@@ -95,7 +95,7 @@ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:17
95
95
  get abstract status(): IntelligenceRealtimeStatus;
96
96
  ```
97
97
 
98
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:21
98
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L20)
99
99
 
100
100
  ##### Returns
101
101
 
@@ -112,7 +112,7 @@ abstract addToolOutput(
112
112
  name?): Promise<void>;
113
113
  ```
114
114
 
115
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:56
115
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L55)
116
116
 
117
117
  Returns a completed function result to the model.
118
118
 
@@ -136,7 +136,7 @@ Returns a completed function result to the model.
136
136
  abstract appendAudio(audio): Promise<void>;
137
137
  ```
138
138
 
139
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:34
139
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L33)
140
140
 
141
141
  Appends a base64-encoded audio fragment to the upstream input buffer.
142
142
 
@@ -158,7 +158,7 @@ Appends a base64-encoded audio fragment to the upstream input buffer.
158
158
  abstract cancelResponse(): Promise<void>;
159
159
  ```
160
160
 
161
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:53
161
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L52)
162
162
 
163
163
  Cancels the active model response.
164
164
 
@@ -174,7 +174,7 @@ Cancels the active model response.
174
174
  abstract clearAudio(): Promise<void>;
175
175
  ```
176
176
 
177
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:40
177
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L39)
178
178
 
179
179
  Clears the provider input audio buffer.
180
180
 
@@ -190,7 +190,7 @@ Clears the provider input audio buffer.
190
190
  abstract close(code?, reason?): Promise<void>;
191
191
  ```
192
192
 
193
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:59
193
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L58)
194
194
 
195
195
  Gracefully closes the upstream connection and flushes metering events.
196
196
 
@@ -213,7 +213,7 @@ Gracefully closes the upstream connection and flushes metering events.
213
213
  abstract commitAudio(): Promise<void>;
214
214
  ```
215
215
 
216
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:37
216
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L36)
217
217
 
218
218
  Commits the provider input audio buffer.
219
219
 
@@ -229,7 +229,7 @@ Commits the provider input audio buffer.
229
229
  abstract connect(): Promise<void>;
230
230
  ```
231
231
 
232
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:28
232
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L27)
233
233
 
234
234
  Opens the upstream provider WebSocket and applies the session configuration.
235
235
 
@@ -245,7 +245,7 @@ Opens the upstream provider WebSocket and applies the session configuration.
245
245
  abstract requestResponse(options?): Promise<void>;
246
246
  ```
247
247
 
248
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:46
248
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L45)
249
249
 
250
250
  Requests a new model response.
251
251
 
@@ -270,7 +270,7 @@ Requests a new model response.
270
270
  abstract send(event): Promise<void>;
271
271
  ```
272
272
 
273
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:31
273
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L30)
274
274
 
275
275
  Sends any provider-neutral client event.
276
276
 
@@ -292,7 +292,7 @@ Sends any provider-neutral client event.
292
292
  abstract sendText(text, requestResponse?): Promise<void>;
293
293
  ```
294
294
 
295
- Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:43
295
+ Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L42)
296
296
 
297
297
  Sends a text turn and optionally asks the model to respond.
298
298
 
@@ -0,0 +1,58 @@
1
+ ---
2
+ title: 'Class: IntelligenceReranker'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceReranker
7
+
8
+ Defined in: IntelligenceReranker.ts:24
9
+
10
+ Provider-neutral semantic reranking facade.
11
+
12
+ ## Constructors
13
+
14
+ ### Constructor
15
+
16
+ ```ts
17
+ new IntelligenceReranker(modelResolver): IntelligenceReranker;
18
+ ```
19
+
20
+ Defined in: IntelligenceReranker.ts:33
21
+
22
+ #### Parameters
23
+
24
+ | Parameter | Type |
25
+ | ------ | ------ |
26
+ | `modelResolver` | `IntelligenceModelResolver` |
27
+
28
+ #### Returns
29
+
30
+ `IntelligenceReranker`
31
+
32
+ ## Methods
33
+
34
+ ### rerank()
35
+
36
+ ```ts
37
+ rerank<TDocument>(options): Promise<IIntelligenceRerankingResult<TDocument>>;
38
+ ```
39
+
40
+ Defined in: IntelligenceReranker.ts:50
41
+
42
+ Reranks documents by relevance to a query.
43
+
44
+ #### Type Parameters
45
+
46
+ | Type Parameter |
47
+ | ------ |
48
+ | `TDocument` *extends* \| `string` \| `Readonly`\<`Record`\<`string`, [`IntelligenceJsonValue`](TypeAlias.IntelligenceJsonValue)\>\> |
49
+
50
+ #### Parameters
51
+
52
+ | Parameter | Type |
53
+ | ------ | ------ |
54
+ | `options` | [`IIntelligenceRerankingOptions`](Interface.IIntelligenceRerankingOptions)\<`TDocument`\> |
55
+
56
+ #### Returns
57
+
58
+ `Promise`\<[`IIntelligenceRerankingResult`](Interface.IIntelligenceRerankingResult)\<`TDocument`\>\>