@breadstone/archipel-mcp 0.0.54 → 0.0.56

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 (216) hide show
  1. package/data/guides/ai-image-generation.md +101 -0
  2. package/data/guides/ai-realtime-voice.md +85 -473
  3. package/data/guides/ai-text-generation.md +98 -635
  4. package/data/guides/health-indicators.md +67 -66
  5. package/data/guides/index.md +2 -1
  6. package/data/guides/intelligence-prompts-warm-up.md +81 -312
  7. package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +122 -0
  8. package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +122 -0
  9. package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +122 -0
  10. package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +122 -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 +15 -10
  15. package/data/packages/platform-intelligence/api/Class.IntelligenceImageGenerator.md +117 -0
  16. package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +159 -0
  17. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  18. package/data/packages/platform-intelligence/api/Class.IntelligencePromptExecutor.md +6 -6
  19. package/data/packages/platform-intelligence/api/Class.IntelligencePromptPolicyPort.md +1 -1
  20. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAdapterPort.md +104 -0
  21. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAssetUploader.md +21 -15
  22. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderDiagnostics.md +55 -0
  23. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderError.md +14 -4
  24. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderRegistry.md +68 -0
  25. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +9 -9
  26. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +1 -1
  27. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +8 -8
  28. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +18 -18
  29. package/data/packages/platform-intelligence/api/Class.IntelligenceReranker.md +58 -0
  30. package/data/packages/platform-intelligence/api/Class.IntelligenceSpeechGenerator.md +117 -0
  31. package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +14 -16
  32. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +14 -18
  33. package/data/packages/platform-intelligence/api/Class.IntelligenceTranscriptionGenerator.md +139 -0
  34. package/data/packages/platform-intelligence/api/Class.IntelligenceVideoGenerator.md +117 -0
  35. package/data/packages/platform-intelligence/api/Class.MiMoIntelligenceProviderAdapter.md +122 -0
  36. package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +122 -0
  37. package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +1 -1
  38. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +1 -1
  39. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +1 -1
  40. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +1 -1
  41. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +1 -1
  42. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +1 -1
  43. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +1 -1
  44. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +1 -1
  45. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +1 -1
  46. package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +1 -1
  47. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +1 -1
  48. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +1 -1
  49. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +1 -1
  50. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +1 -1
  51. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +1 -1
  52. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +1 -1
  53. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +1 -1
  54. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +1 -1
  55. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +1 -1
  56. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +1 -1
  57. package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +1 -1
  58. package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +1 -1
  59. package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +1 -1
  60. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +1 -1
  61. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +1 -1
  62. package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +1 -1
  63. package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +1 -1
  64. package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +1 -1
  65. package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +1 -1
  66. package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +1 -1
  67. package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +1 -1
  68. package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +1 -1
  69. package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +1 -1
  70. package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +1 -1
  71. package/data/packages/platform-intelligence/api/Function.createIntelligenceJsonSchema.md +31 -0
  72. package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +2 -2
  73. package/data/packages/platform-intelligence/api/Function.createMimoCustomTool.md +5 -5
  74. package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +1 -1
  75. package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +1 -1
  76. package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +1 -1
  77. package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +1 -1
  78. package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +1 -1
  79. package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +1 -1
  80. package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +1 -1
  81. package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +1 -1
  82. package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +1 -1
  83. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +1 -1
  84. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +1 -1
  85. package/data/packages/platform-intelligence/api/Function.defineIntelligenceTool.md +31 -0
  86. package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md +70 -0
  87. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md +140 -0
  88. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +70 -0
  89. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +130 -0
  90. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +70 -0
  91. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +118 -0
  92. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadResult.md +60 -0
  93. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGeneratedFile.md +40 -0
  94. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGenerationStepStartEvent.md +50 -0
  95. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationOptions.md +186 -0
  96. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationResult.md +60 -0
  97. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageCompletion.md +141 -0
  98. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md +250 -0
  99. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageStream.md +50 -0
  100. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelReference.md +34 -0
  101. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelRequestOptions.md +72 -0
  102. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +30 -0
  103. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +54 -26
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceObjectStream.md +56 -0
  105. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +50 -0
  106. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptDefinition.md +14 -14
  107. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md +1 -1
  108. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md +1 -1
  109. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md +15 -27
  110. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +10 -10
  111. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +54 -0
  112. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md +70 -0
  113. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +9 -21
  114. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +23 -11
  115. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +174 -10
  116. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +114 -0
  117. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +156 -0
  118. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +50 -0
  119. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +110 -0
  120. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +80 -0
  121. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +180 -0
  122. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +50 -0
  123. package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +155 -0
  124. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +7 -10
  125. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolCall.md +40 -0
  126. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolDefinition.md +91 -0
  127. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionEndEvent.md +50 -0
  128. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionStartEvent.md +30 -0
  129. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +4 -4
  130. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionOptions.md +130 -0
  131. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionResult.md +84 -0
  132. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionStream.md +97 -0
  133. package/data/packages/platform-intelligence/api/Interface.IIntelligenceUsage.md +197 -0
  134. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +245 -0
  135. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationResult.md +50 -0
  136. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceModelMessage.md +43 -0
  137. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligencePromptModelRequirement.md +2 -2
  138. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceSchema.md +70 -0
  139. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceCapability.md +14 -0
  140. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceDefaultModels.md +14 -0
  141. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceJsonValue.md +22 -0
  142. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptDefinitionConfiguration.md +2 -2
  143. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md +1 -1
  144. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
  145. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderOptions.md +14 -0
  146. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderProbeStatus.md +14 -0
  147. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderToolOptions.md +17 -0
  148. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +1 -1
  149. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRequestTimeouts.md +14 -0
  150. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolChoice.md +21 -0
  151. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolOutput.md +22 -0
  152. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolSet.md +14 -0
  153. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md +46 -0
  154. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_API_KEY.md +14 -0
  155. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_BASE_URL.md +14 -0
  156. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_CONFIG_ENTRIES.md +14 -0
  157. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  158. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  159. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  160. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  161. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +2 -2
  162. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  163. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  164. package/data/packages/platform-intelligence/api/Variable.IntelligenceCapabilityNames.md +40 -0
  165. package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +2 -0
  166. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +2 -2
  167. package/data/packages/platform-intelligence/api/index.md +83 -32
  168. package/data/packages/platform-intelligence/index.md +81 -622
  169. package/package.json +1 -1
  170. package/data/packages/index.md +0 -8
  171. package/data/packages/platform-analytics/index.md +0 -209
  172. package/data/packages/platform-authentication/index.md +0 -725
  173. package/data/packages/platform-blob-storage/index.md +0 -416
  174. package/data/packages/platform-bootstrap/index.md +0 -162
  175. package/data/packages/platform-caching/index.md +0 -167
  176. package/data/packages/platform-configuration/index.md +0 -226
  177. package/data/packages/platform-core/index.md +0 -504
  178. package/data/packages/platform-cryptography/index.md +0 -142
  179. package/data/packages/platform-database/index.md +0 -337
  180. package/data/packages/platform-documents/index.md +0 -255
  181. package/data/packages/platform-esigning/index.md +0 -710
  182. package/data/packages/platform-feature-flags/index.md +0 -103
  183. package/data/packages/platform-health/index.md +0 -141
  184. package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +0 -118
  185. package/data/packages/platform-intelligence/api/Class.IntelligenceStructuredGenerator.md +0 -70
  186. package/data/packages/platform-intelligence/api/Class.IntelligenceTelemetryRegistry.md +0 -44
  187. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +0 -138
  188. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +0 -39
  189. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +0 -26
  190. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +0 -26
  191. package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +0 -25
  192. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +0 -26
  193. package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +0 -25
  194. package/data/packages/platform-intelligence/api/Function.loadMimoLanguageModel.md +0 -26
  195. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +0 -26
  196. package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +0 -25
  197. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +0 -46
  198. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +0 -180
  199. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +0 -144
  200. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +0 -78
  201. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +0 -170
  202. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +0 -24
  203. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +0 -14
  204. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +0 -25
  205. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +0 -14
  206. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +0 -14
  207. package/data/packages/platform-logging/index.md +0 -150
  208. package/data/packages/platform-mailing/index.md +0 -470
  209. package/data/packages/platform-mapping/index.md +0 -123
  210. package/data/packages/platform-mcp/index.md +0 -335
  211. package/data/packages/platform-openapi/index.md +0 -207
  212. package/data/packages/platform-payments/index.md +0 -610
  213. package/data/packages/platform-queue/index.md +0 -192
  214. package/data/packages/platform-reporting/index.md +0 -233
  215. package/data/packages/platform-resources/index.md +0 -137
  216. package/data/packages/platform-telemetry/index.md +0 -262
@@ -0,0 +1,70 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceEmbeddingBatchResult'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceEmbeddingBatchResult
7
+
8
+ Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L12)
9
+
10
+ Provider-neutral batch embedding result.
11
+
12
+ ## Properties
13
+
14
+ ### embeddings
15
+
16
+ ```ts
17
+ readonly embeddings: readonly readonly number[][];
18
+ ```
19
+
20
+ Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L16)
21
+
22
+ ***
23
+
24
+ ### model
25
+
26
+ ```ts
27
+ readonly model: string;
28
+ ```
29
+
30
+ Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L18)
31
+
32
+ ***
33
+
34
+ ### provider
35
+
36
+ ```ts
37
+ readonly provider: string;
38
+ ```
39
+
40
+ Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L17)
41
+
42
+ ***
43
+
44
+ ### usage
45
+
46
+ ```ts
47
+ readonly usage: IIntelligenceUsage | null;
48
+ ```
49
+
50
+ Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L20)
51
+
52
+ ***
53
+
54
+ ### values
55
+
56
+ ```ts
57
+ readonly values: readonly string[];
58
+ ```
59
+
60
+ Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L15)
61
+
62
+ ***
63
+
64
+ ### warnings
65
+
66
+ ```ts
67
+ readonly warnings: readonly string[];
68
+ ```
69
+
70
+ Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L19)
@@ -0,0 +1,130 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceEmbeddingOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceEmbeddingOptions
7
+
8
+ Defined in: [contracts/IIntelligenceEmbeddingOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingOptions.ts#L12)
9
+
10
+ Provider-neutral single-value embedding options.
11
+
12
+ ## Extends
13
+
14
+ - [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions)
15
+
16
+ ## Properties
17
+
18
+ ### abortSignal?
19
+
20
+ ```ts
21
+ readonly optional abortSignal?: AbortSignal;
22
+ ```
23
+
24
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L16)
25
+
26
+ Caller-driven cancellation signal.
27
+
28
+ #### Inherited from
29
+
30
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`abortSignal`](Interface.IIntelligenceRequestOptions#abortsignal)
31
+
32
+ ***
33
+
34
+ ### headers?
35
+
36
+ ```ts
37
+ readonly optional headers?: Readonly<Record<string, string>>;
38
+ ```
39
+
40
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L19)
41
+
42
+ Additional outbound request headers.
43
+
44
+ #### Inherited from
45
+
46
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`headers`](Interface.IIntelligenceRequestOptions#headers)
47
+
48
+ ***
49
+
50
+ ### maxRetries?
51
+
52
+ ```ts
53
+ readonly optional maxRetries?: number;
54
+ ```
55
+
56
+ Defined in: [contracts/IIntelligenceEmbeddingOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingOptions.ts#L16)
57
+
58
+ ***
59
+
60
+ ### model?
61
+
62
+ ```ts
63
+ readonly optional model?: IIntelligenceModelReference;
64
+ ```
65
+
66
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
67
+
68
+ Optional provider/model override.
69
+
70
+ #### Inherited from
71
+
72
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`model`](Interface.IIntelligenceRequestOptions#model)
73
+
74
+ ***
75
+
76
+ ### providerOptions?
77
+
78
+ ```ts
79
+ readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
80
+ ```
81
+
82
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
83
+
84
+ Optional provider-specific settings.
85
+
86
+ #### Inherited from
87
+
88
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`providerOptions`](Interface.IIntelligenceRequestOptions#provideroptions)
89
+
90
+ ***
91
+
92
+ ### requestId?
93
+
94
+ ```ts
95
+ readonly optional requestId?: string;
96
+ ```
97
+
98
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
99
+
100
+ Correlation identifier included in structured Archipel logs.
101
+
102
+ #### Inherited from
103
+
104
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`requestId`](Interface.IIntelligenceRequestOptions#requestid)
105
+
106
+ ***
107
+
108
+ ### timeoutMs?
109
+
110
+ ```ts
111
+ readonly optional timeoutMs?: number;
112
+ ```
113
+
114
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
115
+
116
+ Total provider-operation timeout in milliseconds.
117
+
118
+ #### Inherited from
119
+
120
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`timeoutMs`](Interface.IIntelligenceRequestOptions#timeoutms)
121
+
122
+ ***
123
+
124
+ ### value
125
+
126
+ ```ts
127
+ readonly value: string;
128
+ ```
129
+
130
+ Defined in: [contracts/IIntelligenceEmbeddingOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingOptions.ts#L15)
@@ -0,0 +1,70 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceEmbeddingResult'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceEmbeddingResult
7
+
8
+ Defined in: [contracts/IIntelligenceEmbeddingResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L12)
9
+
10
+ Provider-neutral embedding result.
11
+
12
+ ## Properties
13
+
14
+ ### embedding
15
+
16
+ ```ts
17
+ readonly embedding: readonly number[];
18
+ ```
19
+
20
+ Defined in: [contracts/IIntelligenceEmbeddingResult.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L16)
21
+
22
+ ***
23
+
24
+ ### model
25
+
26
+ ```ts
27
+ readonly model: string;
28
+ ```
29
+
30
+ Defined in: [contracts/IIntelligenceEmbeddingResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L18)
31
+
32
+ ***
33
+
34
+ ### provider
35
+
36
+ ```ts
37
+ readonly provider: string;
38
+ ```
39
+
40
+ Defined in: [contracts/IIntelligenceEmbeddingResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L17)
41
+
42
+ ***
43
+
44
+ ### usage
45
+
46
+ ```ts
47
+ readonly usage: IIntelligenceUsage | null;
48
+ ```
49
+
50
+ Defined in: [contracts/IIntelligenceEmbeddingResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L20)
51
+
52
+ ***
53
+
54
+ ### value
55
+
56
+ ```ts
57
+ readonly value: string;
58
+ ```
59
+
60
+ Defined in: [contracts/IIntelligenceEmbeddingResult.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L15)
61
+
62
+ ***
63
+
64
+ ### warnings
65
+
66
+ ```ts
67
+ readonly warnings: readonly string[];
68
+ ```
69
+
70
+ Defined in: [contracts/IIntelligenceEmbeddingResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L19)
@@ -0,0 +1,118 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceFileUploadOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceFileUploadOptions
7
+
8
+ Defined in: [contracts/IIntelligenceFileUploadOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadOptions.ts#L12)
9
+
10
+ Provider-neutral file upload options.
11
+
12
+ ## Extends
13
+
14
+ - [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions)
15
+
16
+ ## Properties
17
+
18
+ ### data
19
+
20
+ ```ts
21
+ readonly data:
22
+ | string
23
+ | Uint8Array<ArrayBufferLike>
24
+ | {
25
+ data: string | Uint8Array<ArrayBufferLike>;
26
+ type: "data";
27
+ }
28
+ | {
29
+ text: string;
30
+ type: "text";
31
+ };
32
+ ```
33
+
34
+ Defined in: [contracts/IIntelligenceFileUploadOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadOptions.ts#L15)
35
+
36
+ ***
37
+
38
+ ### filename?
39
+
40
+ ```ts
41
+ readonly optional filename?: string;
42
+ ```
43
+
44
+ Defined in: [contracts/IIntelligenceFileUploadOptions.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadOptions.ts#L17)
45
+
46
+ ***
47
+
48
+ ### mediaType?
49
+
50
+ ```ts
51
+ readonly optional mediaType?: string;
52
+ ```
53
+
54
+ Defined in: [contracts/IIntelligenceFileUploadOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadOptions.ts#L16)
55
+
56
+ ***
57
+
58
+ ### model?
59
+
60
+ ```ts
61
+ readonly optional model?: IIntelligenceModelReference;
62
+ ```
63
+
64
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
65
+
66
+ Optional provider/model override.
67
+
68
+ #### Inherited from
69
+
70
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`model`](Interface.IIntelligenceModelRequestOptions#model)
71
+
72
+ ***
73
+
74
+ ### providerOptions?
75
+
76
+ ```ts
77
+ readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
78
+ ```
79
+
80
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
81
+
82
+ Optional provider-specific settings.
83
+
84
+ #### Inherited from
85
+
86
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`providerOptions`](Interface.IIntelligenceModelRequestOptions#provideroptions)
87
+
88
+ ***
89
+
90
+ ### requestId?
91
+
92
+ ```ts
93
+ readonly optional requestId?: string;
94
+ ```
95
+
96
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
97
+
98
+ Correlation identifier included in structured Archipel logs.
99
+
100
+ #### Inherited from
101
+
102
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`requestId`](Interface.IIntelligenceModelRequestOptions#requestid)
103
+
104
+ ***
105
+
106
+ ### timeoutMs?
107
+
108
+ ```ts
109
+ readonly optional timeoutMs?: number;
110
+ ```
111
+
112
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
113
+
114
+ Total provider-operation timeout in milliseconds.
115
+
116
+ #### Inherited from
117
+
118
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`timeoutMs`](Interface.IIntelligenceModelRequestOptions#timeoutms)
@@ -0,0 +1,60 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceFileUploadResult'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceFileUploadResult
7
+
8
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L6)
9
+
10
+ Normalized provider-managed file upload result.
11
+
12
+ ## Properties
13
+
14
+ ### filename?
15
+
16
+ ```ts
17
+ readonly optional filename?: string;
18
+ ```
19
+
20
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L12)
21
+
22
+ ***
23
+
24
+ ### mediaType?
25
+
26
+ ```ts
27
+ readonly optional mediaType?: string;
28
+ ```
29
+
30
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L11)
31
+
32
+ ***
33
+
34
+ ### provider
35
+
36
+ ```ts
37
+ readonly provider: string;
38
+ ```
39
+
40
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L10)
41
+
42
+ ***
43
+
44
+ ### providerReference
45
+
46
+ ```ts
47
+ readonly providerReference: Readonly<Record<string, string>>;
48
+ ```
49
+
50
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L9)
51
+
52
+ ***
53
+
54
+ ### warnings
55
+
56
+ ```ts
57
+ readonly warnings: readonly string[];
58
+ ```
59
+
60
+ Defined in: [contracts/IIntelligenceFileUploadResult.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFileUploadResult.ts#L13)
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceGeneratedFile'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceGeneratedFile
7
+
8
+ Defined in: [contracts/IIntelligenceGeneratedFile.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGeneratedFile.ts#L6)
9
+
10
+ Binary content generated by an intelligence capability.
11
+
12
+ ## Properties
13
+
14
+ ### data
15
+
16
+ ```ts
17
+ readonly data: Uint8Array;
18
+ ```
19
+
20
+ Defined in: [contracts/IIntelligenceGeneratedFile.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGeneratedFile.ts#L9)
21
+
22
+ ***
23
+
24
+ ### filename?
25
+
26
+ ```ts
27
+ readonly optional filename?: string;
28
+ ```
29
+
30
+ Defined in: [contracts/IIntelligenceGeneratedFile.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGeneratedFile.ts#L11)
31
+
32
+ ***
33
+
34
+ ### mediaType
35
+
36
+ ```ts
37
+ readonly mediaType: string;
38
+ ```
39
+
40
+ Defined in: [contracts/IIntelligenceGeneratedFile.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGeneratedFile.ts#L10)
@@ -0,0 +1,50 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceGenerationStepStartEvent'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceGenerationStepStartEvent
7
+
8
+ Defined in: [contracts/IIntelligenceGenerationStepStartEvent.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGenerationStepStartEvent.ts#L6)
9
+
10
+ Language generation step metadata.
11
+
12
+ ## Properties
13
+
14
+ ### callId
15
+
16
+ ```ts
17
+ readonly callId: string;
18
+ ```
19
+
20
+ Defined in: [contracts/IIntelligenceGenerationStepStartEvent.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGenerationStepStartEvent.ts#L7)
21
+
22
+ ***
23
+
24
+ ### modelId
25
+
26
+ ```ts
27
+ readonly modelId: string;
28
+ ```
29
+
30
+ Defined in: [contracts/IIntelligenceGenerationStepStartEvent.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGenerationStepStartEvent.ts#L9)
31
+
32
+ ***
33
+
34
+ ### provider
35
+
36
+ ```ts
37
+ readonly provider: string;
38
+ ```
39
+
40
+ Defined in: [contracts/IIntelligenceGenerationStepStartEvent.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGenerationStepStartEvent.ts#L8)
41
+
42
+ ***
43
+
44
+ ### stepNumber
45
+
46
+ ```ts
47
+ readonly stepNumber: number;
48
+ ```
49
+
50
+ Defined in: [contracts/IIntelligenceGenerationStepStartEvent.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceGenerationStepStartEvent.ts#L10)