@breadstone/archipel-mcp 0.0.42 → 0.0.44

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 (115) hide show
  1. package/data/guides/ai-text-generation.md +397 -107
  2. package/data/packages/platform-bootstrap/api/Function.useExpressServer.md +32 -0
  3. package/data/packages/platform-bootstrap/api/Interface.IExpressServerStepOptions.md +46 -0
  4. package/data/packages/platform-bootstrap/api/index.md +2 -0
  5. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +5 -5
  6. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +26 -2
  7. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +43 -9
  8. package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +93 -0
  9. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +217 -0
  10. package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +26 -0
  11. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +26 -0
  12. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +26 -0
  13. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +26 -0
  14. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +26 -0
  15. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +26 -0
  16. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +26 -0
  17. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +26 -0
  18. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +26 -0
  19. package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +26 -0
  20. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +26 -0
  21. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +26 -0
  22. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +26 -0
  23. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +26 -0
  24. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +26 -0
  25. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +26 -0
  26. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +26 -0
  27. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +26 -0
  28. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +26 -0
  29. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +26 -0
  30. package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +26 -0
  31. package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +26 -0
  32. package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +26 -0
  33. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +26 -0
  34. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +26 -0
  35. package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +26 -0
  36. package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +26 -0
  37. package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +27 -0
  38. package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +26 -0
  39. package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +26 -0
  40. package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +27 -0
  41. package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +26 -0
  42. package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +26 -0
  43. package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +26 -0
  44. package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +26 -0
  45. package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +26 -0
  46. package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +26 -0
  47. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +26 -0
  48. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +26 -0
  49. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +15 -2
  50. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +4 -4
  51. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +4 -4
  52. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +4 -4
  53. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +4 -4
  54. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +79 -0
  55. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +30 -6
  56. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +106 -5
  57. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +29 -4
  58. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +183 -0
  59. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +39 -0
  60. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +146 -0
  61. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +3 -3
  62. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +14 -0
  63. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +14 -0
  64. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_API_KEY.md +1 -1
  65. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_BASE_URL.md +1 -1
  66. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_CONFIG_ENTRIES.md +14 -0
  67. package/data/packages/platform-intelligence/api/Variable.AnthropicIntelligenceToolNames.md +42 -0
  68. package/data/packages/platform-intelligence/api/Variable.GEMINI_API_KEY.md +2 -2
  69. package/data/packages/platform-intelligence/api/Variable.GOOGLE_API_KEY.md +1 -1
  70. package/data/packages/platform-intelligence/api/Variable.GOOGLE_BASE_URL.md +1 -1
  71. package/data/packages/platform-intelligence/api/Variable.GOOGLE_CONFIG_ENTRIES.md +14 -0
  72. package/data/packages/platform-intelligence/api/Variable.GROK_API_KEY.md +1 -1
  73. package/data/packages/platform-intelligence/api/Variable.GROK_BASE_URL.md +1 -1
  74. package/data/packages/platform-intelligence/api/Variable.GROK_CONFIG_ENTRIES.md +14 -0
  75. package/data/packages/platform-intelligence/api/Variable.GoogleIntelligenceToolNames.md +34 -0
  76. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  77. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  78. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  79. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  80. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +1 -1
  81. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  82. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  83. package/data/packages/platform-intelligence/api/Variable.OPENAI_API_KEY.md +1 -1
  84. package/data/packages/platform-intelligence/api/Variable.OPENAI_BASE_URL.md +1 -1
  85. package/data/packages/platform-intelligence/api/Variable.OPENAI_CONFIG_ENTRIES.md +14 -0
  86. package/data/packages/platform-intelligence/api/Variable.OpenAIIntelligenceToolNames.md +40 -0
  87. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +1 -1
  88. package/data/packages/platform-intelligence/api/Variable.XAI_API_KEY.md +2 -2
  89. package/data/packages/platform-intelligence/api/Variable.XAI_BASE_URL.md +2 -2
  90. package/data/packages/platform-intelligence/api/index.md +64 -33
  91. package/data/packages/platform-intelligence/index.md +278 -69
  92. package/package.json +1 -1
  93. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +0 -94
  94. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +0 -106
  95. package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +0 -31
  96. package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +0 -34
  97. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +0 -71
  98. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +0 -70
  99. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +0 -46
  100. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +0 -78
  101. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +0 -46
  102. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +0 -72
  103. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +0 -35
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -70
  105. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +0 -58
  106. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +0 -46
  107. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +0 -46
  108. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +0 -34
  109. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +0 -70
  110. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +0 -34
  111. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +0 -34
  112. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +0 -34
  113. package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +0 -34
  114. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +0 -14
  115. package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +0 -26
@@ -5,55 +5,156 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceTextGenerationOptions
7
7
 
8
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L6)
8
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L31)
9
9
 
10
10
  Options that can be supplied when generating text with the intelligence provider.
11
11
 
12
+ ## Extends
13
+
14
+ - `IntelligenceGenerateTextPassthroughOptions`
15
+
12
16
  ## Properties
13
17
 
18
+ ### abortSignal?
19
+
20
+ ```ts
21
+ readonly optional abortSignal?: AbortSignal;
22
+ ```
23
+
24
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L92)
25
+
26
+ Optional AI SDK abort signal for this generation request.
27
+
28
+ The signal is linked with the platform timeout so either cancellation
29
+ source can stop the request.
30
+
31
+ ***
32
+
33
+ ### activeTools?
34
+
35
+ ```ts
36
+ readonly optional activeTools?: string[];
37
+ ```
38
+
39
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:123](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L123)
40
+
41
+ Optional list of tool names available to the model for this request.
42
+
43
+ ***
44
+
14
45
  ### maxOutputTokens?
15
46
 
16
47
  ```ts
17
48
  readonly optional maxOutputTokens?: number;
18
49
  ```
19
50
 
20
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L28)
51
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L64)
21
52
 
22
53
  Optional maximum output tokens override.
23
54
 
24
55
  ***
25
56
 
57
+ ### model?
58
+
59
+ ```ts
60
+ readonly optional model?: LanguageModel;
61
+ ```
62
+
63
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L43)
64
+
65
+ Optional per-request AI SDK model override.
66
+
67
+ Use this escape hatch when a use case needs a provider-specific model
68
+ factory, wrapped model, middleware, or gateway model that should bypass
69
+ the configured platform model for this call.
70
+
71
+ ***
72
+
73
+ ### stopWhen?
74
+
75
+ ```ts
76
+ readonly optional stopWhen?: StopCondition<ToolSet> | StopCondition<ToolSet>[];
77
+ ```
78
+
79
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:116](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L116)
80
+
81
+ Optional AI SDK stop condition for multi-step tool execution.
82
+
83
+ ***
84
+
26
85
  ### temperature?
27
86
 
28
87
  ```ts
29
88
  readonly optional temperature?: number;
30
89
  ```
31
90
 
32
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L14)
91
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L50)
33
92
 
34
93
  Optional sampling temperature override.
35
94
 
36
95
  ***
37
96
 
97
+ ### timeout?
98
+
99
+ ```ts
100
+ readonly optional timeout?: TimeoutConfiguration;
101
+ ```
102
+
103
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L74)
104
+
105
+ Native AI SDK timeout configuration.
106
+
107
+ `timeoutMs` remains available as the platform shorthand for a total
108
+ timeout in milliseconds.
109
+
110
+ ***
111
+
38
112
  ### timeoutMs?
39
113
 
40
114
  ```ts
41
115
  readonly optional timeoutMs?: number;
42
116
  ```
43
117
 
44
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L36)
118
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L82)
45
119
 
46
120
  Optional timeout in milliseconds for the LLM request.
47
121
  Defaults to 30000 (30 seconds) if not specified.
48
122
 
49
123
  ***
50
124
 
125
+ ### toolChoice?
126
+
127
+ ```ts
128
+ readonly optional toolChoice?: ToolChoice<ToolSet>;
129
+ ```
130
+
131
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L109)
132
+
133
+ Optional AI SDK tool choice strategy.
134
+
135
+ ***
136
+
137
+ ### tools?
138
+
139
+ ```ts
140
+ readonly optional tools?: ToolSet;
141
+ ```
142
+
143
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L102)
144
+
145
+ Optional AI SDK tools available for this generation request.
146
+
147
+ Tools registered in the intelligence tool registry are merged with these
148
+ request-specific tools before calling the AI SDK.
149
+
150
+ ***
151
+
51
152
  ### topP?
52
153
 
53
154
  ```ts
54
155
  readonly optional topP?: number;
55
156
  ```
56
157
 
57
- Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L21)
158
+ Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L57)
58
159
 
59
160
  Optional top-p (nucleus) sampling override.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceTextGenerator
7
7
 
8
- Defined in: [interfaces/IIntelligenceTextGenerator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L15)
8
+ Defined in: [interfaces/IIntelligenceTextGenerator.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L17)
9
9
 
10
10
  Abstraction responsible for executing text completions using the configured provider.
11
11
 
@@ -17,7 +17,7 @@ Abstraction responsible for executing text completions using the configured prov
17
17
  generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
18
18
  ```
19
19
 
20
- Defined in: [interfaces/IIntelligenceTextGenerator.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L26)
20
+ Defined in: [interfaces/IIntelligenceTextGenerator.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L28)
21
21
 
22
22
  Generates a text completion using the configured intelligence provider.
23
23
 
@@ -25,7 +25,7 @@ Generates a text completion using the configured intelligence provider.
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | ------ | ------ | ------ |
28
- | `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) | The assembled prompt payload. |
28
+ | `prompt` | `Prompt` | The assembled prompt payload. |
29
29
  | `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) | Optional overrides for the text generation request. |
30
30
 
31
31
  #### Returns
@@ -42,7 +42,7 @@ The normalized text completion result.
42
42
  getConfiguration(): IIntelligenceProviderConfiguration;
43
43
  ```
44
44
 
45
- Defined in: [interfaces/IIntelligenceTextGenerator.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L37)
45
+ Defined in: [interfaces/IIntelligenceTextGenerator.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L46)
46
46
 
47
47
  Returns the currently resolved provider configuration.
48
48
 
@@ -51,3 +51,28 @@ Returns the currently resolved provider configuration.
51
51
  [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration)
52
52
 
53
53
  The active provider configuration.
54
+
55
+ ***
56
+
57
+ ### streamText()
58
+
59
+ ```ts
60
+ streamText(prompt, options?): Promise<StreamTextResult<ToolSet, Output<string, string, never>>>;
61
+ ```
62
+
63
+ Defined in: [interfaces/IIntelligenceTextGenerator.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L38)
64
+
65
+ Streams a text completion using the configured intelligence provider.
66
+
67
+ #### Parameters
68
+
69
+ | Parameter | Type | Description |
70
+ | ------ | ------ | ------ |
71
+ | `prompt` | `Prompt` | The assembled prompt payload. |
72
+ | `options?` | [`IIntelligenceTextStreamingOptions`](Interface.IIntelligenceTextStreamingOptions) | Optional overrides for the streaming request. |
73
+
74
+ #### Returns
75
+
76
+ `Promise`\<`StreamTextResult`\<`ToolSet`, `Output`\<`string`, `string`, `never`\>\>\>
77
+
78
+ The native AI SDK streaming result.
@@ -0,0 +1,183 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceTextStreamingOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceTextStreamingOptions
7
+
8
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L44)
9
+
10
+ Options that can be supplied when streaming text with the intelligence provider.
11
+
12
+ ## Extends
13
+
14
+ - `IntelligenceStreamTextPassthroughOptions`
15
+
16
+ ## Properties
17
+
18
+ ### activeTools?
19
+
20
+ ```ts
21
+ readonly optional activeTools?: string[];
22
+ ```
23
+
24
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:116](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L116)
25
+
26
+ Optional list of tool names available to the model for this request.
27
+
28
+ ***
29
+
30
+ ### maxOutputTokens?
31
+
32
+ ```ts
33
+ readonly optional maxOutputTokens?: number;
34
+ ```
35
+
36
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L73)
37
+
38
+ Optional maximum output tokens override.
39
+
40
+ ***
41
+
42
+ ### model?
43
+
44
+ ```ts
45
+ readonly optional model?: LanguageModel;
46
+ ```
47
+
48
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L52)
49
+
50
+ Optional per-request AI SDK model override.
51
+
52
+ ***
53
+
54
+ ### onChunk?
55
+
56
+ ```ts
57
+ readonly optional onChunk?: StreamTextOnChunkCallback<ToolSet>;
58
+ ```
59
+
60
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:123](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L123)
61
+
62
+ Optional callback invoked for every emitted stream chunk.
63
+
64
+ ***
65
+
66
+ ### onError?
67
+
68
+ ```ts
69
+ readonly optional onError?: StreamTextOnErrorCallback;
70
+ ```
71
+
72
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:144](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L144)
73
+
74
+ Optional callback invoked when streaming fails.
75
+
76
+ ***
77
+
78
+ ### onFinish?
79
+
80
+ ```ts
81
+ readonly optional onFinish?: StreamTextOnFinishCallback<ToolSet>;
82
+ ```
83
+
84
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:137](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L137)
85
+
86
+ Optional callback invoked when the full stream finishes.
87
+
88
+ ***
89
+
90
+ ### onStepFinish?
91
+
92
+ ```ts
93
+ readonly optional onStepFinish?: StreamTextOnStepFinishCallback<ToolSet>;
94
+ ```
95
+
96
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:130](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L130)
97
+
98
+ Optional callback invoked when a stream step completes.
99
+
100
+ ***
101
+
102
+ ### stopWhen?
103
+
104
+ ```ts
105
+ readonly optional stopWhen?: StopCondition<ToolSet> | StopCondition<ToolSet>[];
106
+ ```
107
+
108
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L109)
109
+
110
+ Optional AI SDK stop condition for multi-step tool execution.
111
+
112
+ ***
113
+
114
+ ### temperature?
115
+
116
+ ```ts
117
+ readonly optional temperature?: number;
118
+ ```
119
+
120
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L59)
121
+
122
+ Optional sampling temperature override.
123
+
124
+ ***
125
+
126
+ ### timeout?
127
+
128
+ ```ts
129
+ readonly optional timeout?: TimeoutConfiguration;
130
+ ```
131
+
132
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L80)
133
+
134
+ Native AI SDK timeout configuration.
135
+
136
+ ***
137
+
138
+ ### timeoutMs?
139
+
140
+ ```ts
141
+ readonly optional timeoutMs?: number;
142
+ ```
143
+
144
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:88](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L88)
145
+
146
+ Optional timeout in milliseconds for the LLM request.
147
+ Defaults to 30000 (30 seconds) if not specified.
148
+
149
+ ***
150
+
151
+ ### toolChoice?
152
+
153
+ ```ts
154
+ readonly optional toolChoice?: ToolChoice<ToolSet>;
155
+ ```
156
+
157
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L102)
158
+
159
+ Optional AI SDK tool choice strategy.
160
+
161
+ ***
162
+
163
+ ### tools?
164
+
165
+ ```ts
166
+ readonly optional tools?: ToolSet;
167
+ ```
168
+
169
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L95)
170
+
171
+ Optional AI SDK tools available for this streaming request.
172
+
173
+ ***
174
+
175
+ ### topP?
176
+
177
+ ```ts
178
+ readonly optional topP?: number;
179
+ ```
180
+
181
+ Defined in: [contracts/IIntelligenceTextStreamingOptions.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextStreamingOptions.ts#L66)
182
+
183
+ Optional top-p (nucleus) sampling override.
@@ -0,0 +1,39 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceTool'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceTool
7
+
8
+ Defined in: [interfaces/IIntelligenceTool.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTool.ts#L12)
9
+
10
+ Minimal shape required by the intelligence tool registry.
11
+
12
+ ## Properties
13
+
14
+ ### name
15
+
16
+ ```ts
17
+ readonly name: string;
18
+ ```
19
+
20
+ Defined in: [interfaces/IIntelligenceTool.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTool.ts#L21)
21
+
22
+ Gets the unique registry name for the tool.
23
+
24
+ ***
25
+
26
+ ### tool
27
+
28
+ ```ts
29
+ readonly tool: Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any> & Pick<Tool<any, any>,
30
+ | "execute"
31
+ | "needsApproval"
32
+ | "onInputStart"
33
+ | "onInputDelta"
34
+ | "onInputAvailable">;
35
+ ```
36
+
37
+ Defined in: [interfaces/IIntelligenceTool.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTool.ts#L29)
38
+
39
+ Gets the native AI SDK tool definition.
@@ -0,0 +1,146 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceToolRegistry'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceToolRegistry
7
+
8
+ Defined in: [interfaces/IIntelligenceToolRegistry.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceToolRegistry.ts#L13)
9
+
10
+ Contract for the intelligence tool registry.
11
+
12
+ ## Properties
13
+
14
+ ### count
15
+
16
+ ```ts
17
+ readonly count: number;
18
+ ```
19
+
20
+ Defined in: [interfaces/IIntelligenceToolRegistry.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceToolRegistry.ts#L22)
21
+
22
+ Gets the number of registered tools.
23
+
24
+ ## Methods
25
+
26
+ ### get()
27
+
28
+ ```ts
29
+ get(name): IIntelligenceTool | undefined;
30
+ ```
31
+
32
+ Defined in: [interfaces/IIntelligenceToolRegistry.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceToolRegistry.ts#L45)
33
+
34
+ Gets a tool by name.
35
+
36
+ #### Parameters
37
+
38
+ | Parameter | Type | Description |
39
+ | ------ | ------ | ------ |
40
+ | `name` | `string` | The name of the tool to retrieve. |
41
+
42
+ #### Returns
43
+
44
+ [`IIntelligenceTool`](Interface.IIntelligenceTool) \| `undefined`
45
+
46
+ The tool instance, or `undefined` if not found.
47
+
48
+ ***
49
+
50
+ ### has()
51
+
52
+ ```ts
53
+ has(name): boolean;
54
+ ```
55
+
56
+ Defined in: [interfaces/IIntelligenceToolRegistry.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceToolRegistry.ts#L55)
57
+
58
+ Checks whether a tool with the given name is registered.
59
+
60
+ #### Parameters
61
+
62
+ | Parameter | Type | Description |
63
+ | ------ | ------ | ------ |
64
+ | `name` | `string` | The tool name to check. |
65
+
66
+ #### Returns
67
+
68
+ `boolean`
69
+
70
+ `true` if the tool exists; otherwise `false`.
71
+
72
+ ***
73
+
74
+ ### list()
75
+
76
+ ```ts
77
+ list(): readonly IIntelligenceTool[];
78
+ ```
79
+
80
+ Defined in: [interfaces/IIntelligenceToolRegistry.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceToolRegistry.ts#L63)
81
+
82
+ Returns all registered tools as a readonly array.
83
+
84
+ #### Returns
85
+
86
+ readonly [`IIntelligenceTool`](Interface.IIntelligenceTool)[]
87
+
88
+ Array of all registered tool instances.
89
+
90
+ ***
91
+
92
+ ### listNames()
93
+
94
+ ```ts
95
+ listNames(): readonly string[];
96
+ ```
97
+
98
+ Defined in: [interfaces/IIntelligenceToolRegistry.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceToolRegistry.ts#L71)
99
+
100
+ Returns all registered tool names.
101
+
102
+ #### Returns
103
+
104
+ readonly `string`[]
105
+
106
+ Array of tool names.
107
+
108
+ ***
109
+
110
+ ### register()
111
+
112
+ ```ts
113
+ register(tool): void;
114
+ ```
115
+
116
+ Defined in: [interfaces/IIntelligenceToolRegistry.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceToolRegistry.ts#L35)
117
+
118
+ Registers a tool with the registry.
119
+
120
+ #### Parameters
121
+
122
+ | Parameter | Type | Description |
123
+ | ------ | ------ | ------ |
124
+ | `tool` | [`IIntelligenceTool`](Interface.IIntelligenceTool) | The tool instance to register. |
125
+
126
+ #### Returns
127
+
128
+ `void`
129
+
130
+ ***
131
+
132
+ ### toToolSet()
133
+
134
+ ```ts
135
+ toToolSet(): ToolSet;
136
+ ```
137
+
138
+ Defined in: [interfaces/IIntelligenceToolRegistry.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceToolRegistry.ts#L79)
139
+
140
+ Converts all registered tools to the AI SDK's native tool set format.
141
+
142
+ #### Returns
143
+
144
+ `ToolSet`
145
+
146
+ A record mapping tool names to native AI SDK tool definitions.
@@ -6,12 +6,12 @@ editUrl: false
6
6
  # Type Alias: IntelligenceLanguageModelLoader
7
7
 
8
8
  ```ts
9
- type IntelligenceLanguageModelLoader = (configuration) => Promise<LanguageModelV2>;
9
+ type IntelligenceLanguageModelLoader = (configuration) => LanguageModelV3;
10
10
  ```
11
11
 
12
12
  Defined in: [providers/IntelligenceLanguageModelLoader.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceLanguageModelLoader.ts#L13)
13
13
 
14
- Represents a factory responsible for resolving a configured language model instance.
14
+ Represents a factory responsible for creating a configured language model instance.
15
15
 
16
16
  ## Parameters
17
17
 
@@ -21,4 +21,4 @@ Represents a factory responsible for resolving a configured language model insta
21
21
 
22
22
  ## Returns
23
23
 
24
- `Promise`\<`LanguageModelV2`\>
24
+ `LanguageModelV3`
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligenceLanguageModelLoaders'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligenceLanguageModelLoaders
7
+
8
+ ```ts
9
+ type IntelligenceLanguageModelLoaders = Partial<Record<IntelligenceProviderName, IntelligenceLanguageModelLoader>>;
10
+ ```
11
+
12
+ Defined in: [providers/IntelligenceLanguageModelLoaders.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceLanguageModelLoaders.ts#L13)
13
+
14
+ Maps configured intelligence providers to their tree-shakable model loader.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligenceTextStream'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligenceTextStream
7
+
8
+ ```ts
9
+ type IntelligenceTextStream = ReturnType<typeof streamText>;
10
+ ```
11
+
12
+ Defined in: [contracts/IntelligenceTextStream.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceTextStream.ts#L12)
13
+
14
+ Native AI SDK streaming result returned by the intelligence text generator.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const ANTHROPIC_API_KEY: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [env.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L39)
12
+ Defined in: [providers/anthropic/env.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/env.ts#L10)
13
13
 
14
14
  Anthropic-specific API key.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  const ANTHROPIC_BASE_URL: IConfigKey<string>;
10
10
  ```
11
11
 
12
- Defined in: [env.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L42)
12
+ Defined in: [providers/anthropic/env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/env.ts#L13)
13
13
 
14
14
  Anthropic-specific base URL.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: ANTHROPIC\_CONFIG\_ENTRIES'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: ANTHROPIC\_CONFIG\_ENTRIES
7
+
8
+ ```ts
9
+ const ANTHROPIC_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ ```
11
+
12
+ Defined in: [providers/anthropic/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/env.ts#L16)
13
+
14
+ Configuration entries used by the Anthropic intelligence provider.