@breadstone/archipel-mcp 0.0.43 → 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 (112) hide show
  1. package/data/guides/ai-text-generation.md +397 -107
  2. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +5 -5
  3. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +26 -2
  4. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +43 -9
  5. package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +93 -0
  6. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +217 -0
  7. package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +26 -0
  8. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +26 -0
  9. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +26 -0
  10. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +26 -0
  11. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +26 -0
  12. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +26 -0
  13. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +26 -0
  14. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +26 -0
  15. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +26 -0
  16. package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +26 -0
  17. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +26 -0
  18. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +26 -0
  19. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +26 -0
  20. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +26 -0
  21. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +26 -0
  22. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +26 -0
  23. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +26 -0
  24. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +26 -0
  25. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +26 -0
  26. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +26 -0
  27. package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +26 -0
  28. package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +26 -0
  29. package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +26 -0
  30. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +26 -0
  31. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +26 -0
  32. package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +26 -0
  33. package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +26 -0
  34. package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +27 -0
  35. package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +26 -0
  36. package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +26 -0
  37. package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +27 -0
  38. package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +26 -0
  39. package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +26 -0
  40. package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +26 -0
  41. package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +26 -0
  42. package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +26 -0
  43. package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +26 -0
  44. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +26 -0
  45. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +26 -0
  46. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +15 -2
  47. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +4 -4
  48. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +4 -4
  49. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +4 -4
  50. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +4 -4
  51. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +79 -0
  52. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +30 -6
  53. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +106 -5
  54. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +29 -4
  55. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +183 -0
  56. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +39 -0
  57. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +146 -0
  58. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +3 -3
  59. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +14 -0
  60. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +14 -0
  61. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_API_KEY.md +1 -1
  62. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_BASE_URL.md +1 -1
  63. package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_CONFIG_ENTRIES.md +14 -0
  64. package/data/packages/platform-intelligence/api/Variable.AnthropicIntelligenceToolNames.md +42 -0
  65. package/data/packages/platform-intelligence/api/Variable.GEMINI_API_KEY.md +2 -2
  66. package/data/packages/platform-intelligence/api/Variable.GOOGLE_API_KEY.md +1 -1
  67. package/data/packages/platform-intelligence/api/Variable.GOOGLE_BASE_URL.md +1 -1
  68. package/data/packages/platform-intelligence/api/Variable.GOOGLE_CONFIG_ENTRIES.md +14 -0
  69. package/data/packages/platform-intelligence/api/Variable.GROK_API_KEY.md +1 -1
  70. package/data/packages/platform-intelligence/api/Variable.GROK_BASE_URL.md +1 -1
  71. package/data/packages/platform-intelligence/api/Variable.GROK_CONFIG_ENTRIES.md +14 -0
  72. package/data/packages/platform-intelligence/api/Variable.GoogleIntelligenceToolNames.md +34 -0
  73. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  74. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  75. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  76. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  77. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +1 -1
  78. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  79. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  80. package/data/packages/platform-intelligence/api/Variable.OPENAI_API_KEY.md +1 -1
  81. package/data/packages/platform-intelligence/api/Variable.OPENAI_BASE_URL.md +1 -1
  82. package/data/packages/platform-intelligence/api/Variable.OPENAI_CONFIG_ENTRIES.md +14 -0
  83. package/data/packages/platform-intelligence/api/Variable.OpenAIIntelligenceToolNames.md +40 -0
  84. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +1 -1
  85. package/data/packages/platform-intelligence/api/Variable.XAI_API_KEY.md +2 -2
  86. package/data/packages/platform-intelligence/api/Variable.XAI_BASE_URL.md +2 -2
  87. package/data/packages/platform-intelligence/api/index.md +64 -33
  88. package/data/packages/platform-intelligence/index.md +278 -69
  89. package/package.json +1 -1
  90. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +0 -94
  91. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +0 -106
  92. package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +0 -31
  93. package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +0 -34
  94. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +0 -71
  95. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +0 -70
  96. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +0 -46
  97. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +0 -78
  98. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +0 -46
  99. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +0 -72
  100. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +0 -35
  101. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -70
  102. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +0 -58
  103. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +0 -46
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +0 -46
  105. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +0 -34
  106. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +0 -70
  107. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +0 -34
  108. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +0 -34
  109. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +0 -34
  110. package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +0 -34
  111. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +0 -14
  112. package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +0 -26
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createOpenAIFileSearchTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createOpenAIFileSearchTool()
7
+
8
+ ```ts
9
+ function createOpenAIFileSearchTool(options): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/openai/tools/createOpenAIFileSearchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIFileSearchTool.ts#L18)
13
+
14
+ Creates an OpenAI file-search tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \{ \} & \{ \} | OpenAI file-search tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createOpenAIImageGenerationTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createOpenAIImageGenerationTool()
7
+
8
+ ```ts
9
+ function createOpenAIImageGenerationTool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/openai/tools/createOpenAIImageGenerationTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIImageGenerationTool.ts#L18)
13
+
14
+ Creates an OpenAI image-generation tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \| \{ \} \| `undefined` | OpenAI image-generation tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createOpenAILocalShellTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createOpenAILocalShellTool()
7
+
8
+ ```ts
9
+ function createOpenAILocalShellTool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/openai/tools/createOpenAILocalShellTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAILocalShellTool.ts#L18)
13
+
14
+ Creates an OpenAI local-shell tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \{ \} | OpenAI local-shell tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createOpenAIMcpTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createOpenAIMcpTool()
7
+
8
+ ```ts
9
+ function createOpenAIMcpTool(options): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/openai/tools/createOpenAIMcpTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIMcpTool.ts#L18)
13
+
14
+ Creates an OpenAI MCP connector tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \{ \} | OpenAI MCP tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createOpenAIShellTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createOpenAIShellTool()
7
+
8
+ ```ts
9
+ function createOpenAIShellTool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/openai/tools/createOpenAIShellTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIShellTool.ts#L18)
13
+
14
+ Creates an OpenAI shell tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \{ \} & \{ \} | OpenAI shell tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createOpenAIToolSearchTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createOpenAIToolSearchTool()
7
+
8
+ ```ts
9
+ function createOpenAIToolSearchTool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/openai/tools/createOpenAIToolSearchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIToolSearchTool.ts#L18)
13
+
14
+ Creates an OpenAI tool-search tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \| \{ \} & \{ \} \| `undefined` | OpenAI tool-search options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createOpenAIWebSearchPreviewTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createOpenAIWebSearchPreviewTool()
7
+
8
+ ```ts
9
+ function createOpenAIWebSearchPreviewTool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/openai/tools/createOpenAIWebSearchPreviewTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIWebSearchPreviewTool.ts#L18)
13
+
14
+ Creates an OpenAI web-search-preview tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \{ \} & \{ \} | OpenAI web-search-preview tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Function: createOpenAIWebSearchTool()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: createOpenAIWebSearchTool()
7
+
8
+ ```ts
9
+ function createOpenAIWebSearchTool(options?): IIntelligenceTool;
10
+ ```
11
+
12
+ Defined in: [providers/openai/tools/createOpenAIWebSearchTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIWebSearchTool.ts#L18)
13
+
14
+ Creates an OpenAI web-search tool registration.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `options` | \| \{ \} & \{ \} \| `undefined` | OpenAI web-search tool options. |
21
+
22
+ ## Returns
23
+
24
+ [`IIntelligenceTool`](Interface.IIntelligenceTool)
25
+
26
+ Tool registration compatible with the intelligence tool registry.
@@ -6,7 +6,10 @@ editUrl: false
6
6
  # Function: createProviderOptions()
7
7
 
8
8
  ```ts
9
- function createProviderOptions(configuration): Record<string, unknown>;
9
+ function createProviderOptions(configuration): {
10
+ apiKey: string;
11
+ baseURL?: string;
12
+ };
10
13
  ```
11
14
 
12
15
  Defined in: [providers/createProviderOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/createProviderOptions.ts#L14)
@@ -21,6 +24,16 @@ Creates the provider options object consumed by the AI SDK model factories.
21
24
 
22
25
  ## Returns
23
26
 
24
- `Record`\<`string`, `unknown`\>
27
+ ```ts
28
+ {
29
+ apiKey: string;
30
+ baseURL?: string;
31
+ }
32
+ ```
25
33
 
26
34
  The options record containing `apiKey` and optionally `baseURL`.
35
+
36
+ | Name | Type | Defined in |
37
+ | ------ | ------ | ------ |
38
+ | `apiKey` | `string` | [providers/createProviderOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/createProviderOptions.ts#L14) |
39
+ | `baseURL?` | `string` | [providers/createProviderOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/createProviderOptions.ts#L14) |
@@ -6,12 +6,12 @@ editUrl: false
6
6
  # Function: loadAnthropicLanguageModel()
7
7
 
8
8
  ```ts
9
- function loadAnthropicLanguageModel(configuration): Promise<LanguageModelV2>;
9
+ function loadAnthropicLanguageModel(configuration): LanguageModelV3;
10
10
  ```
11
11
 
12
- Defined in: [providers/loadAnthropicLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadAnthropicLanguageModel.ts#L17)
12
+ Defined in: [providers/anthropic/loadAnthropicLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/loadAnthropicLanguageModel.ts#L17)
13
13
 
14
- Loads the Anthropic language model based on the resolved provider configuration.
14
+ Creates the Anthropic language model from the resolved provider configuration.
15
15
 
16
16
  ## Parameters
17
17
 
@@ -21,6 +21,6 @@ Loads the Anthropic language model based on the resolved provider configuration.
21
21
 
22
22
  ## Returns
23
23
 
24
- `Promise`\<`LanguageModelV2`\>
24
+ `LanguageModelV3`
25
25
 
26
26
  The configured language model instance.
@@ -6,12 +6,12 @@ editUrl: false
6
6
  # Function: loadGoogleLanguageModel()
7
7
 
8
8
  ```ts
9
- function loadGoogleLanguageModel(configuration): Promise<LanguageModelV2>;
9
+ function loadGoogleLanguageModel(configuration): LanguageModelV3;
10
10
  ```
11
11
 
12
- Defined in: [providers/loadGoogleLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadGoogleLanguageModel.ts#L17)
12
+ Defined in: [providers/google/loadGoogleLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/loadGoogleLanguageModel.ts#L17)
13
13
 
14
- Loads the Google (Gemini) language model based on the resolved provider configuration.
14
+ Creates the Google Gemini language model from the resolved provider configuration.
15
15
 
16
16
  ## Parameters
17
17
 
@@ -21,6 +21,6 @@ Loads the Google (Gemini) language model based on the resolved provider configur
21
21
 
22
22
  ## Returns
23
23
 
24
- `Promise`\<`LanguageModelV2`\>
24
+ `LanguageModelV3`
25
25
 
26
26
  The configured language model instance.
@@ -6,12 +6,12 @@ editUrl: false
6
6
  # Function: loadGrokLanguageModel()
7
7
 
8
8
  ```ts
9
- function loadGrokLanguageModel(configuration): Promise<LanguageModelV2>;
9
+ function loadGrokLanguageModel(configuration): LanguageModelV3;
10
10
  ```
11
11
 
12
- Defined in: [providers/loadGrokLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadGrokLanguageModel.ts#L17)
12
+ Defined in: [providers/grok/loadGrokLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/loadGrokLanguageModel.ts#L17)
13
13
 
14
- Loads the Grok (xAI) language model based on the resolved provider configuration.
14
+ Creates the Grok language model through the OpenAI-compatible xAI endpoint.
15
15
 
16
16
  ## Parameters
17
17
 
@@ -21,6 +21,6 @@ Loads the Grok (xAI) language model based on the resolved provider configuration
21
21
 
22
22
  ## Returns
23
23
 
24
- `Promise`\<`LanguageModelV2`\>
24
+ `LanguageModelV3`
25
25
 
26
26
  The configured language model instance.
@@ -6,12 +6,12 @@ editUrl: false
6
6
  # Function: loadOpenAILanguageModel()
7
7
 
8
8
  ```ts
9
- function loadOpenAILanguageModel(configuration): Promise<LanguageModelV2>;
9
+ function loadOpenAILanguageModel(configuration): LanguageModelV3;
10
10
  ```
11
11
 
12
- Defined in: [providers/loadOpenAILanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/loadOpenAILanguageModel.ts#L17)
12
+ Defined in: [providers/openai/loadOpenAILanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/loadOpenAILanguageModel.ts#L17)
13
13
 
14
- Loads the OpenAI compatible language model based on the resolved provider configuration.
14
+ Creates the OpenAI language model from the resolved provider configuration.
15
15
 
16
16
  ## Parameters
17
17
 
@@ -21,6 +21,6 @@ Loads the OpenAI compatible language model based on the resolved provider config
21
21
 
22
22
  ## Returns
23
23
 
24
- `Promise`\<`LanguageModelV2`\>
24
+ `LanguageModelV3`
25
25
 
26
26
  The configured language model instance.
@@ -0,0 +1,79 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceModuleOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceModuleOptions
7
+
8
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L15)
9
+
10
+ Options for configuring the intelligence module.
11
+
12
+ ## Properties
13
+
14
+ ### configEntries?
15
+
16
+ ```ts
17
+ readonly optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
18
+ ```
19
+
20
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L30)
21
+
22
+ Provider-specific configuration entries to register with the config module.
23
+
24
+ ***
25
+
26
+ ### isGlobal?
27
+
28
+ ```ts
29
+ readonly optional isGlobal?: boolean;
30
+ ```
31
+
32
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L57)
33
+
34
+ When `true` the module is registered globally.
35
+
36
+ ***
37
+
38
+ ### providerLoaders?
39
+
40
+ ```ts
41
+ readonly optional providerLoaders?: Partial<Record<IntelligenceProviderName, IntelligenceLanguageModelLoader>>;
42
+ ```
43
+
44
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L40)
45
+
46
+ Tree-shakable language model loaders keyed by provider name.
47
+
48
+ Import these from provider-specific subpaths such as
49
+ `@breadstone/archipel-platform-intelligence/providers/openai`.
50
+
51
+ ***
52
+
53
+ ### tools?
54
+
55
+ ```ts
56
+ readonly optional tools?: readonly (
57
+ | IIntelligenceTool
58
+ | Type<IIntelligenceTool>
59
+ | Provider<IIntelligenceTool>)[];
60
+ ```
61
+
62
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L23)
63
+
64
+ Tool instances, class providers, or custom Nest providers registered at bootstrap.
65
+
66
+ ***
67
+
68
+ ### validateOnModuleInit?
69
+
70
+ ```ts
71
+ readonly optional validateOnModuleInit?: boolean;
72
+ ```
73
+
74
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L50)
75
+
76
+ When `true`, provider configuration is resolved during module initialization.
77
+
78
+ Set this to `false` for fully request-driven use cases that always pass a
79
+ native AI SDK model through `generateText()` or `streamText()` options.
@@ -5,19 +5,31 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceTextCompletion
7
7
 
8
- Defined in: [contracts/IIntelligenceTextCompletion.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L13)
8
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L14)
9
9
 
10
10
  Represents the normalized completion result produced by the intelligence provider.
11
11
 
12
12
  ## Properties
13
13
 
14
+ ### files
15
+
16
+ ```ts
17
+ readonly files: readonly GeneratedFile[];
18
+ ```
19
+
20
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L50)
21
+
22
+ Files generated by provider-native tools such as image generation or code interpreter.
23
+
24
+ ***
25
+
14
26
  ### model
15
27
 
16
28
  ```ts
17
29
  readonly model: string;
18
30
  ```
19
31
 
20
- Defined in: [contracts/IIntelligenceTextCompletion.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L35)
32
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L36)
21
33
 
22
34
  The model identifier used for the completion.
23
35
 
@@ -26,22 +38,34 @@ The model identifier used for the completion.
26
38
  ### provider
27
39
 
28
40
  ```ts
29
- readonly provider: IntelligenceProviderName;
41
+ readonly provider: string;
30
42
  ```
31
43
 
32
- Defined in: [contracts/IIntelligenceTextCompletion.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L28)
44
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L29)
33
45
 
34
46
  The provider that produced the completion.
35
47
 
36
48
  ***
37
49
 
50
+ ### sources
51
+
52
+ ```ts
53
+ readonly sources: readonly LanguageModelV3Source[];
54
+ ```
55
+
56
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L43)
57
+
58
+ Sources reported by provider-native tools such as web search.
59
+
60
+ ***
61
+
38
62
  ### text
39
63
 
40
64
  ```ts
41
65
  readonly text: string;
42
66
  ```
43
67
 
44
- Defined in: [contracts/IIntelligenceTextCompletion.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L21)
68
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L22)
45
69
 
46
70
  The generated text content.
47
71
 
@@ -55,6 +79,6 @@ readonly usage:
55
79
  | null;
56
80
  ```
57
81
 
58
- Defined in: [contracts/IIntelligenceTextCompletion.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L42)
82
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L57)
59
83
 
60
84
  Token usage telemetry, or `null` when the provider does not report usage.
@@ -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.