@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
@@ -5,22 +5,96 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceRealtimeUsage
7
7
 
8
- Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L9)
8
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L15)
9
9
 
10
10
  Normalized token usage reported by a realtime provider.
11
11
 
12
12
  Null values mean the provider did not expose that dimension. Applications
13
13
  can therefore distinguish missing data from an actual zero-token count.
14
14
 
15
+ ## Extends
16
+
17
+ - [`IIntelligenceUsage`](Interface.IIntelligenceUsage)
18
+
15
19
  ## Properties
16
20
 
21
+ ### cachedInputAudioTokens
22
+
23
+ ```ts
24
+ readonly cachedInputAudioTokens: number | null;
25
+ ```
26
+
27
+ Defined in: [contracts/IIntelligenceUsage.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L27)
28
+
29
+ Cached input tokens attributed to audio.
30
+
31
+ #### Inherited from
32
+
33
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`cachedInputAudioTokens`](Interface.IIntelligenceUsage#cachedinputaudiotokens)
34
+
35
+ ***
36
+
37
+ ### cachedInputImageTokens
38
+
39
+ ```ts
40
+ readonly cachedInputImageTokens: number | null;
41
+ ```
42
+
43
+ Defined in: [contracts/IIntelligenceUsage.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L25)
44
+
45
+ Cached input tokens attributed to images.
46
+
47
+ #### Inherited from
48
+
49
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`cachedInputImageTokens`](Interface.IIntelligenceUsage#cachedinputimagetokens)
50
+
51
+ ***
52
+
53
+ ### cachedInputTextTokens
54
+
55
+ ```ts
56
+ readonly cachedInputTextTokens: number | null;
57
+ ```
58
+
59
+ Defined in: [contracts/IIntelligenceUsage.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L23)
60
+
61
+ Cached input tokens attributed to text.
62
+
63
+ #### Inherited from
64
+
65
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`cachedInputTextTokens`](Interface.IIntelligenceUsage#cachedinputtexttokens)
66
+
67
+ ***
68
+
17
69
  ### cachedInputTokens
18
70
 
19
71
  ```ts
20
72
  readonly cachedInputTokens: number | null;
21
73
  ```
22
74
 
23
- Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L15)
75
+ Defined in: [contracts/IIntelligenceUsage.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L19)
76
+
77
+ Input tokens read from a provider cache.
78
+
79
+ #### Inherited from
80
+
81
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`cachedInputTokens`](Interface.IIntelligenceUsage#cachedinputtokens)
82
+
83
+ ***
84
+
85
+ ### cacheWriteInputTokens
86
+
87
+ ```ts
88
+ readonly cacheWriteInputTokens: number | null;
89
+ ```
90
+
91
+ Defined in: [contracts/IIntelligenceUsage.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L21)
92
+
93
+ Input tokens written to a provider cache.
94
+
95
+ #### Inherited from
96
+
97
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`cacheWriteInputTokens`](Interface.IIntelligenceUsage#cachewriteinputtokens)
24
98
 
25
99
  ***
26
100
 
@@ -30,7 +104,29 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:15](https://github
30
104
  readonly inputAudioTokens: number | null;
31
105
  ```
32
106
 
33
- Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L17)
107
+ Defined in: [contracts/IIntelligenceUsage.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L33)
108
+
109
+ Input tokens attributed to audio.
110
+
111
+ #### Inherited from
112
+
113
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`inputAudioTokens`](Interface.IIntelligenceUsage#inputaudiotokens)
114
+
115
+ ***
116
+
117
+ ### inputImageTokens
118
+
119
+ ```ts
120
+ readonly inputImageTokens: number | null;
121
+ ```
122
+
123
+ Defined in: [contracts/IIntelligenceUsage.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L31)
124
+
125
+ Input tokens attributed to images.
126
+
127
+ #### Inherited from
128
+
129
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`inputImageTokens`](Interface.IIntelligenceUsage#inputimagetokens)
34
130
 
35
131
  ***
36
132
 
@@ -40,7 +136,13 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:17](https://github
40
136
  readonly inputTextTokens: number | null;
41
137
  ```
42
138
 
43
- Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L16)
139
+ Defined in: [contracts/IIntelligenceUsage.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L29)
140
+
141
+ Input tokens attributed to text.
142
+
143
+ #### Inherited from
144
+
145
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`inputTextTokens`](Interface.IIntelligenceUsage#inputtexttokens)
44
146
 
45
147
  ***
46
148
 
@@ -50,7 +152,13 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:16](https://github
50
152
  readonly inputTokens: number | null;
51
153
  ```
52
154
 
53
- Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L12)
155
+ Defined in: [contracts/IIntelligenceUsage.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L13)
156
+
157
+ All uncached and cached input tokens reported for the operation.
158
+
159
+ #### Inherited from
160
+
161
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`inputTokens`](Interface.IIntelligenceUsage#inputtokens)
54
162
 
55
163
  ***
56
164
 
@@ -60,7 +168,29 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:12](https://github
60
168
  readonly outputAudioTokens: number | null;
61
169
  ```
62
170
 
63
- Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L19)
171
+ Defined in: [contracts/IIntelligenceUsage.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L39)
172
+
173
+ Output tokens attributed to generated audio.
174
+
175
+ #### Inherited from
176
+
177
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`outputAudioTokens`](Interface.IIntelligenceUsage#outputaudiotokens)
178
+
179
+ ***
180
+
181
+ ### outputImageTokens
182
+
183
+ ```ts
184
+ readonly outputImageTokens: number | null;
185
+ ```
186
+
187
+ Defined in: [contracts/IIntelligenceUsage.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L37)
188
+
189
+ Output tokens attributed to generated images.
190
+
191
+ #### Inherited from
192
+
193
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`outputImageTokens`](Interface.IIntelligenceUsage#outputimagetokens)
64
194
 
65
195
  ***
66
196
 
@@ -70,7 +200,13 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:19](https://github
70
200
  readonly outputTextTokens: number | null;
71
201
  ```
72
202
 
73
- Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L18)
203
+ Defined in: [contracts/IIntelligenceUsage.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L35)
204
+
205
+ Output tokens attributed to text, including reasoning when the provider does so.
206
+
207
+ #### Inherited from
208
+
209
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`outputTextTokens`](Interface.IIntelligenceUsage#outputtexttokens)
74
210
 
75
211
  ***
76
212
 
@@ -80,7 +216,13 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:18](https://github
80
216
  readonly outputTokens: number | null;
81
217
  ```
82
218
 
83
- Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L13)
219
+ Defined in: [contracts/IIntelligenceUsage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L15)
220
+
221
+ All output tokens, including any reasoning tokens, reported for the operation.
222
+
223
+ #### Inherited from
224
+
225
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`outputTokens`](Interface.IIntelligenceUsage#outputtokens)
84
226
 
85
227
  ***
86
228
 
@@ -90,7 +232,23 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:13](https://github
90
232
  readonly rawUsage: unknown;
91
233
  ```
92
234
 
93
- Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L20)
235
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L18)
236
+
237
+ ***
238
+
239
+ ### reasoningTokens
240
+
241
+ ```ts
242
+ readonly reasoningTokens: number | null;
243
+ ```
244
+
245
+ Defined in: [contracts/IIntelligenceUsage.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L41)
246
+
247
+ Reasoning tokens included in the provider's output total.
248
+
249
+ #### Inherited from
250
+
251
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`reasoningTokens`](Interface.IIntelligenceUsage#reasoningtokens)
94
252
 
95
253
  ***
96
254
 
@@ -100,4 +258,10 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:20](https://github
100
258
  readonly totalTokens: number | null;
101
259
  ```
102
260
 
103
- Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L14)
261
+ Defined in: [contracts/IIntelligenceUsage.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L17)
262
+
263
+ Provider-reported total input and output tokens.
264
+
265
+ #### Inherited from
266
+
267
+ [`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`totalTokens`](Interface.IIntelligenceUsage#totaltokens)
@@ -0,0 +1,114 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceRequestOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceRequestOptions
7
+
8
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L12)
9
+
10
+ Shared execution controls for bounded intelligence requests.
11
+
12
+ ## Extends
13
+
14
+ - [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions)
15
+
16
+ ## Extended by
17
+
18
+ - [`IIntelligenceEmbeddingBatchOptions`](Interface.IIntelligenceEmbeddingBatchOptions)
19
+ - [`IIntelligenceEmbeddingOptions`](Interface.IIntelligenceEmbeddingOptions)
20
+ - [`IIntelligenceImageGenerationOptions`](Interface.IIntelligenceImageGenerationOptions)
21
+ - [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions)
22
+ - [`IIntelligenceRerankingOptions`](Interface.IIntelligenceRerankingOptions)
23
+ - [`IIntelligenceSpeechGenerationOptions`](Interface.IIntelligenceSpeechGenerationOptions)
24
+ - [`IIntelligenceTranscriptionOptions`](Interface.IIntelligenceTranscriptionOptions)
25
+ - [`IIntelligenceStreamingTranscriptionOptions`](Interface.IIntelligenceStreamingTranscriptionOptions)
26
+ - [`IIntelligenceVideoGenerationOptions`](Interface.IIntelligenceVideoGenerationOptions)
27
+
28
+ ## Properties
29
+
30
+ ### abortSignal?
31
+
32
+ ```ts
33
+ readonly optional abortSignal?: AbortSignal;
34
+ ```
35
+
36
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L16)
37
+
38
+ Caller-driven cancellation signal.
39
+
40
+ ***
41
+
42
+ ### headers?
43
+
44
+ ```ts
45
+ readonly optional headers?: Readonly<Record<string, string>>;
46
+ ```
47
+
48
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L19)
49
+
50
+ Additional outbound request headers.
51
+
52
+ ***
53
+
54
+ ### model?
55
+
56
+ ```ts
57
+ readonly optional model?: IIntelligenceModelReference;
58
+ ```
59
+
60
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
61
+
62
+ Optional provider/model override.
63
+
64
+ #### Inherited from
65
+
66
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`model`](Interface.IIntelligenceModelRequestOptions#model)
67
+
68
+ ***
69
+
70
+ ### providerOptions?
71
+
72
+ ```ts
73
+ readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
74
+ ```
75
+
76
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
77
+
78
+ Optional provider-specific settings.
79
+
80
+ #### Inherited from
81
+
82
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`providerOptions`](Interface.IIntelligenceModelRequestOptions#provideroptions)
83
+
84
+ ***
85
+
86
+ ### requestId?
87
+
88
+ ```ts
89
+ readonly optional requestId?: string;
90
+ ```
91
+
92
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
93
+
94
+ Correlation identifier included in structured Archipel logs.
95
+
96
+ #### Inherited from
97
+
98
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`requestId`](Interface.IIntelligenceModelRequestOptions#requestid)
99
+
100
+ ***
101
+
102
+ ### timeoutMs?
103
+
104
+ ```ts
105
+ readonly optional timeoutMs?: number;
106
+ ```
107
+
108
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
109
+
110
+ Total provider-operation timeout in milliseconds.
111
+
112
+ #### Inherited from
113
+
114
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`timeoutMs`](Interface.IIntelligenceModelRequestOptions#timeoutms)
@@ -0,0 +1,156 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceRerankingOptions\<TDocument\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceRerankingOptions\<TDocument\>
7
+
8
+ Defined in: [contracts/IIntelligenceRerankingOptions.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingOptions.ts#L13)
9
+
10
+ Provider-neutral reranking options.
11
+
12
+ ## Extends
13
+
14
+ - [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions)
15
+
16
+ ## Type Parameters
17
+
18
+ | Type Parameter | Default type |
19
+ | ------ | ------ |
20
+ | `TDocument` *extends* \| `string` \| `Readonly`\<`Record`\<`string`, [`IntelligenceJsonValue`](TypeAlias.IntelligenceJsonValue)\>\> | `string` |
21
+
22
+ ## Properties
23
+
24
+ ### abortSignal?
25
+
26
+ ```ts
27
+ readonly optional abortSignal?: AbortSignal;
28
+ ```
29
+
30
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L16)
31
+
32
+ Caller-driven cancellation signal.
33
+
34
+ #### Inherited from
35
+
36
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`abortSignal`](Interface.IIntelligenceRequestOptions#abortsignal)
37
+
38
+ ***
39
+
40
+ ### documents
41
+
42
+ ```ts
43
+ readonly documents: readonly TDocument[];
44
+ ```
45
+
46
+ Defined in: [contracts/IIntelligenceRerankingOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingOptions.ts#L19)
47
+
48
+ ***
49
+
50
+ ### headers?
51
+
52
+ ```ts
53
+ readonly optional headers?: Readonly<Record<string, string>>;
54
+ ```
55
+
56
+ Defined in: [contracts/IIntelligenceRequestOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L19)
57
+
58
+ Additional outbound request headers.
59
+
60
+ #### Inherited from
61
+
62
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`headers`](Interface.IIntelligenceRequestOptions#headers)
63
+
64
+ ***
65
+
66
+ ### maxRetries?
67
+
68
+ ```ts
69
+ readonly optional maxRetries?: number;
70
+ ```
71
+
72
+ Defined in: [contracts/IIntelligenceRerankingOptions.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingOptions.ts#L20)
73
+
74
+ ***
75
+
76
+ ### model?
77
+
78
+ ```ts
79
+ readonly optional model?: IIntelligenceModelReference;
80
+ ```
81
+
82
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
83
+
84
+ Optional provider/model override.
85
+
86
+ #### Inherited from
87
+
88
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`model`](Interface.IIntelligenceRequestOptions#model)
89
+
90
+ ***
91
+
92
+ ### providerOptions?
93
+
94
+ ```ts
95
+ readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
96
+ ```
97
+
98
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
99
+
100
+ Optional provider-specific settings.
101
+
102
+ #### Inherited from
103
+
104
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`providerOptions`](Interface.IIntelligenceRequestOptions#provideroptions)
105
+
106
+ ***
107
+
108
+ ### query
109
+
110
+ ```ts
111
+ readonly query: string;
112
+ ```
113
+
114
+ Defined in: [contracts/IIntelligenceRerankingOptions.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingOptions.ts#L18)
115
+
116
+ ***
117
+
118
+ ### requestId?
119
+
120
+ ```ts
121
+ readonly optional requestId?: string;
122
+ ```
123
+
124
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
125
+
126
+ Correlation identifier included in structured Archipel logs.
127
+
128
+ #### Inherited from
129
+
130
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`requestId`](Interface.IIntelligenceRequestOptions#requestid)
131
+
132
+ ***
133
+
134
+ ### timeoutMs?
135
+
136
+ ```ts
137
+ readonly optional timeoutMs?: number;
138
+ ```
139
+
140
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
141
+
142
+ Total provider-operation timeout in milliseconds.
143
+
144
+ #### Inherited from
145
+
146
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`timeoutMs`](Interface.IIntelligenceRequestOptions#timeoutms)
147
+
148
+ ***
149
+
150
+ ### topN?
151
+
152
+ ```ts
153
+ readonly optional topN?: number;
154
+ ```
155
+
156
+ Defined in: [contracts/IIntelligenceRerankingOptions.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingOptions.ts#L21)
@@ -0,0 +1,50 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceRerankingResult\<TDocument\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceRerankingResult\<TDocument\>
7
+
8
+ Defined in: [contracts/IIntelligenceRerankingResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingResult.ts#L12)
9
+
10
+ Provider-neutral reranking result.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter | Default type |
15
+ | ------ | ------ |
16
+ | `TDocument` *extends* \| `string` \| `Readonly`\<`Record`\<`string`, [`IntelligenceJsonValue`](TypeAlias.IntelligenceJsonValue)\>\> | `string` |
17
+
18
+ ## Properties
19
+
20
+ ### model
21
+
22
+ ```ts
23
+ readonly model: string;
24
+ ```
25
+
26
+ Defined in: [contracts/IIntelligenceRerankingResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingResult.ts#L21)
27
+
28
+ ***
29
+
30
+ ### provider
31
+
32
+ ```ts
33
+ readonly provider: string;
34
+ ```
35
+
36
+ Defined in: [contracts/IIntelligenceRerankingResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingResult.ts#L20)
37
+
38
+ ***
39
+
40
+ ### ranking
41
+
42
+ ```ts
43
+ readonly ranking: readonly {
44
+ document: TDocument;
45
+ originalIndex: number;
46
+ score: number;
47
+ }[];
48
+ ```
49
+
50
+ Defined in: [contracts/IIntelligenceRerankingResult.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingResult.ts#L15)
@@ -0,0 +1,110 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceSkillUploadOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceSkillUploadOptions
7
+
8
+ Defined in: [contracts/IIntelligenceSkillUploadOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceSkillUploadOptions.ts#L12)
9
+
10
+ Provider-neutral skill bundle upload options.
11
+
12
+ ## Extends
13
+
14
+ - [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions)
15
+
16
+ ## Properties
17
+
18
+ ### displayTitle?
19
+
20
+ ```ts
21
+ readonly optional displayTitle?: string;
22
+ ```
23
+
24
+ Defined in: [contracts/IIntelligenceSkillUploadOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceSkillUploadOptions.ts#L19)
25
+
26
+ ***
27
+
28
+ ### files
29
+
30
+ ```ts
31
+ readonly files: readonly {
32
+ data: | string
33
+ | Uint8Array<ArrayBufferLike>
34
+ | {
35
+ data: string | Uint8Array<ArrayBufferLike>;
36
+ type: "data";
37
+ }
38
+ | {
39
+ text: string;
40
+ type: "text";
41
+ };
42
+ path: string;
43
+ }[];
44
+ ```
45
+
46
+ Defined in: [contracts/IIntelligenceSkillUploadOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceSkillUploadOptions.ts#L15)
47
+
48
+ ***
49
+
50
+ ### model?
51
+
52
+ ```ts
53
+ readonly optional model?: IIntelligenceModelReference;
54
+ ```
55
+
56
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
57
+
58
+ Optional provider/model override.
59
+
60
+ #### Inherited from
61
+
62
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`model`](Interface.IIntelligenceModelRequestOptions#model)
63
+
64
+ ***
65
+
66
+ ### providerOptions?
67
+
68
+ ```ts
69
+ readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
70
+ ```
71
+
72
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
73
+
74
+ Optional provider-specific settings.
75
+
76
+ #### Inherited from
77
+
78
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`providerOptions`](Interface.IIntelligenceModelRequestOptions#provideroptions)
79
+
80
+ ***
81
+
82
+ ### requestId?
83
+
84
+ ```ts
85
+ readonly optional requestId?: string;
86
+ ```
87
+
88
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
89
+
90
+ Correlation identifier included in structured Archipel logs.
91
+
92
+ #### Inherited from
93
+
94
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`requestId`](Interface.IIntelligenceModelRequestOptions#requestid)
95
+
96
+ ***
97
+
98
+ ### timeoutMs?
99
+
100
+ ```ts
101
+ readonly optional timeoutMs?: number;
102
+ ```
103
+
104
+ Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
105
+
106
+ Total provider-operation timeout in milliseconds.
107
+
108
+ #### Inherited from
109
+
110
+ [`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`timeoutMs`](Interface.IIntelligenceModelRequestOptions#timeoutms)