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