@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,60 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceImageGenerationResult'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceImageGenerationResult
7
+
8
+ Defined in: contracts/IIntelligenceImageGenerationResult.ts:13
9
+
10
+ Provider-neutral image generation result.
11
+
12
+ ## Properties
13
+
14
+ ### images
15
+
16
+ ```ts
17
+ readonly images: readonly IIntelligenceGeneratedFile[];
18
+ ```
19
+
20
+ Defined in: contracts/IIntelligenceImageGenerationResult.ts:16
21
+
22
+ ***
23
+
24
+ ### model
25
+
26
+ ```ts
27
+ readonly model: string;
28
+ ```
29
+
30
+ Defined in: contracts/IIntelligenceImageGenerationResult.ts:18
31
+
32
+ ***
33
+
34
+ ### provider
35
+
36
+ ```ts
37
+ readonly provider: string;
38
+ ```
39
+
40
+ Defined in: contracts/IIntelligenceImageGenerationResult.ts:17
41
+
42
+ ***
43
+
44
+ ### usage
45
+
46
+ ```ts
47
+ readonly usage: IIntelligenceUsage | null;
48
+ ```
49
+
50
+ Defined in: contracts/IIntelligenceImageGenerationResult.ts:20
51
+
52
+ ***
53
+
54
+ ### warnings
55
+
56
+ ```ts
57
+ readonly warnings: readonly string[];
58
+ ```
59
+
60
+ Defined in: contracts/IIntelligenceImageGenerationResult.ts:19
@@ -0,0 +1,141 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceLanguageCompletion\<TOutput\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceLanguageCompletion\<TOutput\>
7
+
8
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:14
9
+
10
+ Normalized language generation result.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter | Default type |
15
+ | ------ | ------ |
16
+ | `TOutput` | `string` |
17
+
18
+ ## Properties
19
+
20
+ ### files
21
+
22
+ ```ts
23
+ readonly files: readonly IIntelligenceGeneratedFile[];
24
+ ```
25
+
26
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:29
27
+
28
+ ***
29
+
30
+ ### finishReason
31
+
32
+ ```ts
33
+ readonly finishReason: string;
34
+ ```
35
+
36
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:21
37
+
38
+ ***
39
+
40
+ ### model
41
+
42
+ ```ts
43
+ readonly model: string;
44
+ ```
45
+
46
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:20
47
+
48
+ ***
49
+
50
+ ### output
51
+
52
+ ```ts
53
+ readonly output: TOutput;
54
+ ```
55
+
56
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:18
57
+
58
+ ***
59
+
60
+ ### provider
61
+
62
+ ```ts
63
+ readonly provider: string;
64
+ ```
65
+
66
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:19
67
+
68
+ ***
69
+
70
+ ### reasoningText?
71
+
72
+ ```ts
73
+ readonly optional reasoningText?: string;
74
+ ```
75
+
76
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:22
77
+
78
+ ***
79
+
80
+ ### sources
81
+
82
+ ```ts
83
+ readonly sources: readonly {
84
+ id?: string;
85
+ title?: string;
86
+ type: string;
87
+ url?: string;
88
+ }[];
89
+ ```
90
+
91
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:23
92
+
93
+ ***
94
+
95
+ ### text
96
+
97
+ ```ts
98
+ readonly text: string;
99
+ ```
100
+
101
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:17
102
+
103
+ ***
104
+
105
+ ### toolCalls
106
+
107
+ ```ts
108
+ readonly toolCalls: readonly IIntelligenceToolCall[];
109
+ ```
110
+
111
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:30
112
+
113
+ ***
114
+
115
+ ### toolResults
116
+
117
+ ```ts
118
+ readonly toolResults: readonly unknown[];
119
+ ```
120
+
121
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:31
122
+
123
+ ***
124
+
125
+ ### usage
126
+
127
+ ```ts
128
+ readonly usage: IIntelligenceUsage | null;
129
+ ```
130
+
131
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:33
132
+
133
+ ***
134
+
135
+ ### warnings
136
+
137
+ ```ts
138
+ readonly warnings: readonly string[];
139
+ ```
140
+
141
+ Defined in: contracts/IIntelligenceLanguageCompletion.ts:32
@@ -0,0 +1,234 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceLanguageGenerationOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceLanguageGenerationOptions
7
+
8
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:17
9
+
10
+ Provider-neutral language generation controls.
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
+ ### activeToolNames?
35
+
36
+ ```ts
37
+ readonly optional activeToolNames?: readonly string[];
38
+ ```
39
+
40
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:26
41
+
42
+ ***
43
+
44
+ ### headers?
45
+
46
+ ```ts
47
+ readonly optional headers?: Readonly<Record<string, string>>;
48
+ ```
49
+
50
+ Defined in: contracts/IIntelligenceRequestOptions.ts:19
51
+
52
+ Additional outbound request headers.
53
+
54
+ #### Inherited from
55
+
56
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`headers`](Interface.IIntelligenceRequestOptions#headers)
57
+
58
+ ***
59
+
60
+ ### maxOutputTokens?
61
+
62
+ ```ts
63
+ readonly optional maxOutputTokens?: number;
64
+ ```
65
+
66
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:22
67
+
68
+ ***
69
+
70
+ ### maxRetries?
71
+
72
+ ```ts
73
+ readonly optional maxRetries?: number;
74
+ ```
75
+
76
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:23
77
+
78
+ ***
79
+
80
+ ### maxSteps?
81
+
82
+ ```ts
83
+ readonly optional maxSteps?: number;
84
+ ```
85
+
86
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:27
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
+ ### onStepStart?
107
+
108
+ ```ts
109
+ readonly optional onStepStart?: (event) => void | Promise<void>;
110
+ ```
111
+
112
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:28
113
+
114
+ #### Parameters
115
+
116
+ | Parameter | Type |
117
+ | ------ | ------ |
118
+ | `event` | [`IIntelligenceGenerationStepStartEvent`](Interface.IIntelligenceGenerationStepStartEvent) |
119
+
120
+ #### Returns
121
+
122
+ `void` \| `Promise`\<`void`\>
123
+
124
+ ***
125
+
126
+ ### onToolExecutionEnd?
127
+
128
+ ```ts
129
+ readonly optional onToolExecutionEnd?: (event) => void | Promise<void>;
130
+ ```
131
+
132
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:30
133
+
134
+ #### Parameters
135
+
136
+ | Parameter | Type |
137
+ | ------ | ------ |
138
+ | `event` | [`IIntelligenceToolExecutionEndEvent`](Interface.IIntelligenceToolExecutionEndEvent) |
139
+
140
+ #### Returns
141
+
142
+ `void` \| `Promise`\<`void`\>
143
+
144
+ ***
145
+
146
+ ### onToolExecutionStart?
147
+
148
+ ```ts
149
+ readonly optional onToolExecutionStart?: (event) => void | Promise<void>;
150
+ ```
151
+
152
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:29
153
+
154
+ #### Parameters
155
+
156
+ | Parameter | Type |
157
+ | ------ | ------ |
158
+ | `event` | [`IIntelligenceToolExecutionStartEvent`](Interface.IIntelligenceToolExecutionStartEvent) |
159
+
160
+ #### Returns
161
+
162
+ `void` \| `Promise`\<`void`\>
163
+
164
+ ***
165
+
166
+ ### providerOptions?
167
+
168
+ ```ts
169
+ readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
170
+ ```
171
+
172
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
173
+
174
+ Optional provider-specific settings.
175
+
176
+ #### Inherited from
177
+
178
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`providerOptions`](Interface.IIntelligenceRequestOptions#provideroptions)
179
+
180
+ ***
181
+
182
+ ### temperature?
183
+
184
+ ```ts
185
+ readonly optional temperature?: number;
186
+ ```
187
+
188
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:20
189
+
190
+ ***
191
+
192
+ ### timeoutMs?
193
+
194
+ ```ts
195
+ readonly optional timeoutMs?: number;
196
+ ```
197
+
198
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
199
+
200
+ Total provider-operation timeout in milliseconds.
201
+
202
+ #### Inherited from
203
+
204
+ [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`timeoutMs`](Interface.IIntelligenceRequestOptions#timeoutms)
205
+
206
+ ***
207
+
208
+ ### toolChoice?
209
+
210
+ ```ts
211
+ readonly optional toolChoice?: IntelligenceToolChoice;
212
+ ```
213
+
214
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:25
215
+
216
+ ***
217
+
218
+ ### tools?
219
+
220
+ ```ts
221
+ readonly optional tools?: Readonly<Record<string, IIntelligenceToolDefinition<unknown, unknown>>>;
222
+ ```
223
+
224
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:24
225
+
226
+ ***
227
+
228
+ ### topP?
229
+
230
+ ```ts
231
+ readonly optional topP?: number;
232
+ ```
233
+
234
+ Defined in: contracts/IIntelligenceLanguageGenerationOptions.ts:21
@@ -0,0 +1,50 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceLanguageStream'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceLanguageStream
7
+
8
+ Defined in: contracts/IIntelligenceLanguageStream.ts:12
9
+
10
+ Provider-neutral text stream.
11
+
12
+ ## Properties
13
+
14
+ ### finishReason
15
+
16
+ ```ts
17
+ readonly finishReason: PromiseLike<string>;
18
+ ```
19
+
20
+ Defined in: contracts/IIntelligenceLanguageStream.ts:17
21
+
22
+ ***
23
+
24
+ ### text
25
+
26
+ ```ts
27
+ readonly text: PromiseLike<string>;
28
+ ```
29
+
30
+ Defined in: contracts/IIntelligenceLanguageStream.ts:16
31
+
32
+ ***
33
+
34
+ ### textStream
35
+
36
+ ```ts
37
+ readonly textStream: AsyncIterable<string>;
38
+ ```
39
+
40
+ Defined in: contracts/IIntelligenceLanguageStream.ts:15
41
+
42
+ ***
43
+
44
+ ### usage
45
+
46
+ ```ts
47
+ readonly usage: PromiseLike<IIntelligenceUsage | null>;
48
+ ```
49
+
50
+ Defined in: contracts/IIntelligenceLanguageStream.ts:18
@@ -0,0 +1,34 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceModelReference'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceModelReference
7
+
8
+ Defined in: contracts/IIntelligenceModelReference.ts:6
9
+
10
+ Selects a provider-owned model without exposing a provider SDK model object.
11
+
12
+ ## Properties
13
+
14
+ ### model?
15
+
16
+ ```ts
17
+ readonly optional model?: string;
18
+ ```
19
+
20
+ Defined in: contracts/IIntelligenceModelReference.ts:13
21
+
22
+ Provider model identifier.
23
+
24
+ ***
25
+
26
+ ### provider?
27
+
28
+ ```ts
29
+ readonly optional provider?: string;
30
+ ```
31
+
32
+ Defined in: contracts/IIntelligenceModelReference.ts:10
33
+
34
+ Provider registered with [IntelligenceModule](Class.IntelligenceModule).
@@ -0,0 +1,52 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceModelRequestOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceModelRequestOptions
7
+
8
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:13
9
+
10
+ Shared provider/model controls for intelligence operations.
11
+
12
+ ## Extended by
13
+
14
+ - [`IIntelligenceFileUploadOptions`](Interface.IIntelligenceFileUploadOptions)
15
+ - [`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions)
16
+ - [`IIntelligenceSkillUploadOptions`](Interface.IIntelligenceSkillUploadOptions)
17
+
18
+ ## Properties
19
+
20
+ ### model?
21
+
22
+ ```ts
23
+ readonly optional model?: IIntelligenceModelReference;
24
+ ```
25
+
26
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:17
27
+
28
+ Optional provider/model override.
29
+
30
+ ***
31
+
32
+ ### providerOptions?
33
+
34
+ ```ts
35
+ readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
36
+ ```
37
+
38
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:23
39
+
40
+ Optional provider-specific settings.
41
+
42
+ ***
43
+
44
+ ### timeoutMs?
45
+
46
+ ```ts
47
+ readonly optional timeoutMs?: number;
48
+ ```
49
+
50
+ Defined in: contracts/IIntelligenceModelRequestOptions.ts:20
51
+
52
+ Total provider-operation timeout in milliseconds.
@@ -0,0 +1,30 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceModelStatus'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceModelStatus
7
+
8
+ Defined in: contracts/IIntelligenceModelStatus.ts:6
9
+
10
+ Safe resolved model status that never includes credentials.
11
+
12
+ ## Properties
13
+
14
+ ### model
15
+
16
+ ```ts
17
+ readonly model: string;
18
+ ```
19
+
20
+ Defined in: contracts/IIntelligenceModelStatus.ts:10
21
+
22
+ ***
23
+
24
+ ### provider
25
+
26
+ ```ts
27
+ readonly provider: string;
28
+ ```
29
+
30
+ Defined in: contracts/IIntelligenceModelStatus.ts:9