@breadstone/archipel-mcp 0.0.49 → 0.0.51
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.
- package/data/packages/platform-bootstrap/api/Class.CompositionContext.md +8 -8
- package/data/packages/platform-bootstrap/api/Class.CompositionModule.md +1 -1
- package/data/packages/platform-bootstrap/api/Class.CompositionResolver.md +7 -7
- package/data/packages/platform-bootstrap/api/Function.createCompositionContext.md +1 -1
- package/data/packages/platform-bootstrap/api/Interface.ICompositionContext.md +7 -7
- package/data/packages/platform-bootstrap/api/Interface.ICreateCompositionContextOptions.md +3 -3
- package/data/packages/platform-bootstrap/api/Interface.IProviderDecision.md +3 -3
- package/data/packages/platform-bootstrap/api/TypeAlias.CompositionImport.md +1 -1
- package/data/packages/platform-bootstrap/api/TypeAlias.ProviderComposer.md +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceAgentFactory.md +64 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +70 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +118 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAssetUploader.md +70 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceStructuredGenerator.md +70 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceTelemetryRegistry.md +44 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +8 -8
- package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createMimoCustomTool.md +30 -0
- package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +5 -5
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +2 -2
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +2 -2
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +2 -2
- package/data/packages/platform-intelligence/api/Function.loadMimoLanguageModel.md +26 -0
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +9 -9
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +92 -8
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +7 -23
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +23 -36
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +2 -2
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +2 -2
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +2 -0
- package/data/packages/platform-intelligence/api/Variable.MIMO_API_KEY.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.MIMO_BASE_URL.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.MIMO_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-intelligence/api/index.md +12 -1
- package/package.json +1 -1
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: IntelligenceStructuredGenerator'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: IntelligenceStructuredGenerator
|
|
7
|
+
|
|
8
|
+
Defined in: IntelligenceStructuredGenerator.ts:14
|
|
9
|
+
|
|
10
|
+
Executes AI SDK structured-output generation.
|
|
11
|
+
|
|
12
|
+
## Constructors
|
|
13
|
+
|
|
14
|
+
### Constructor
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
new IntelligenceStructuredGenerator(): IntelligenceStructuredGenerator;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
#### Returns
|
|
21
|
+
|
|
22
|
+
`IntelligenceStructuredGenerator`
|
|
23
|
+
|
|
24
|
+
## Methods
|
|
25
|
+
|
|
26
|
+
### generateObject()
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
generateObject(options): Promise<GenerateObjectResult<unknown>>;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: IntelligenceStructuredGenerator.ts:36
|
|
33
|
+
|
|
34
|
+
Generates a structured object using the native AI SDK object API.
|
|
35
|
+
|
|
36
|
+
#### Parameters
|
|
37
|
+
|
|
38
|
+
| Parameter | Type | Description |
|
|
39
|
+
| ------ | ------ | ------ |
|
|
40
|
+
| `options` | `Omit`\<`LanguageModelCallOptions`, `"stopSequences"`\> & Omit\<RequestOptions\<ToolSet\>, "timeout"\> & (Prompt & ((\{\} \| \{ schema: FlexibleSchema\<unknown\>; schemaName?: string \| undefined; schemaDescription?: string \| undefined; \} \| \{ ...; \}) & \{ ...; \})) | Native AI SDK `generateObject()` options. |
|
|
41
|
+
|
|
42
|
+
#### Returns
|
|
43
|
+
|
|
44
|
+
`Promise`\<`GenerateObjectResult`\<`unknown`\>\>
|
|
45
|
+
|
|
46
|
+
The native AI SDK object-generation result.
|
|
47
|
+
|
|
48
|
+
***
|
|
49
|
+
|
|
50
|
+
### streamObject()
|
|
51
|
+
|
|
52
|
+
```ts
|
|
53
|
+
streamObject(options): StreamObjectResult<unknown>;
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Defined in: IntelligenceStructuredGenerator.ts:47
|
|
57
|
+
|
|
58
|
+
Streams a structured object using the native AI SDK object API.
|
|
59
|
+
|
|
60
|
+
#### Parameters
|
|
61
|
+
|
|
62
|
+
| Parameter | Type | Description |
|
|
63
|
+
| ------ | ------ | ------ |
|
|
64
|
+
| `options` | `Omit`\<`LanguageModelCallOptions`, `"stopSequences"`\> & Omit\<RequestOptions\<ToolSet\>, "timeout"\> & (Prompt & ((\{\} \| \{ schema: FlexibleSchema\<unknown\>; schemaName?: string \| undefined; schemaDescription?: string \| undefined; \} \| \{ ...; \}) & \{ ...; \})) | Native AI SDK `streamObject()` options. |
|
|
65
|
+
|
|
66
|
+
#### Returns
|
|
67
|
+
|
|
68
|
+
`StreamObjectResult`\<`unknown`\>
|
|
69
|
+
|
|
70
|
+
The native AI SDK streaming object result.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: IntelligenceTelemetryRegistry'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: IntelligenceTelemetryRegistry
|
|
7
|
+
|
|
8
|
+
Defined in: IntelligenceTelemetryRegistry.ts:14
|
|
9
|
+
|
|
10
|
+
Registers AI SDK telemetry integrations for the current process.
|
|
11
|
+
|
|
12
|
+
## Constructors
|
|
13
|
+
|
|
14
|
+
### Constructor
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
new IntelligenceTelemetryRegistry(): IntelligenceTelemetryRegistry;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
#### Returns
|
|
21
|
+
|
|
22
|
+
`IntelligenceTelemetryRegistry`
|
|
23
|
+
|
|
24
|
+
## Methods
|
|
25
|
+
|
|
26
|
+
### register()
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
register(...integrations): void;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: IntelligenceTelemetryRegistry.ts:35
|
|
33
|
+
|
|
34
|
+
Registers one or more native AI SDK telemetry integrations.
|
|
35
|
+
|
|
36
|
+
#### Parameters
|
|
37
|
+
|
|
38
|
+
| Parameter | Type | Description |
|
|
39
|
+
| ------ | ------ | ------ |
|
|
40
|
+
| ...`integrations` | `Telemetry`[] | Native AI SDK telemetry integrations. |
|
|
41
|
+
|
|
42
|
+
#### Returns
|
|
43
|
+
|
|
44
|
+
`void`
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: IntelligenceTextGenerator
|
|
7
7
|
|
|
8
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
8
|
+
Defined in: [IntelligenceTextGenerator.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L56)
|
|
9
9
|
|
|
10
10
|
Executes text completions using the configured intelligence provider.
|
|
11
11
|
|
|
@@ -26,7 +26,7 @@ new IntelligenceTextGenerator(
|
|
|
26
26
|
validateOnModuleInit?): IntelligenceTextGenerator;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
29
|
+
Defined in: [IntelligenceTextGenerator.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L71)
|
|
30
30
|
|
|
31
31
|
#### Parameters
|
|
32
32
|
|
|
@@ -49,7 +49,7 @@ Defined in: [IntelligenceTextGenerator.ts:69](https://github.com/RueDeRennes/arc
|
|
|
49
49
|
generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
|
|
50
50
|
```
|
|
51
51
|
|
|
52
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
52
|
+
Defined in: [IntelligenceTextGenerator.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L112)
|
|
53
53
|
|
|
54
54
|
Generates a completion using the configured provider.
|
|
55
55
|
|
|
@@ -76,7 +76,7 @@ Generates a completion using the configured provider.
|
|
|
76
76
|
getConfiguration(): IIntelligenceProviderConfiguration;
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
79
|
+
Defined in: [IntelligenceTextGenerator.ts:286](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L286)
|
|
80
80
|
|
|
81
81
|
Returns the resolved provider configuration with the API key redacted.
|
|
82
82
|
|
|
@@ -96,7 +96,7 @@ Returns the resolved provider configuration with the API key redacted.
|
|
|
96
96
|
onModuleInit(): void;
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
99
|
+
Defined in: [IntelligenceTextGenerator.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L96)
|
|
100
100
|
|
|
101
101
|
Eagerly resolves configuration at startup to fail fast on missing keys.
|
|
102
102
|
|
|
@@ -115,10 +115,10 @@ OnModuleInit.onModuleInit
|
|
|
115
115
|
### streamText()
|
|
116
116
|
|
|
117
117
|
```ts
|
|
118
|
-
streamText(prompt, options?): Promise<StreamTextResult<ToolSet, Output<string, string, never>>>;
|
|
118
|
+
streamText(prompt, options?): Promise<StreamTextResult<ToolSet, Context, Output<string, string, never>>>;
|
|
119
119
|
```
|
|
120
120
|
|
|
121
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
121
|
+
Defined in: [IntelligenceTextGenerator.ts:213](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L213)
|
|
122
122
|
|
|
123
123
|
Streams a completion using the configured provider.
|
|
124
124
|
|
|
@@ -131,7 +131,7 @@ Streams a completion using the configured provider.
|
|
|
131
131
|
|
|
132
132
|
#### Returns
|
|
133
133
|
|
|
134
|
-
`Promise`\<`StreamTextResult`\<`ToolSet`, `Output`\<`string`, `string`, `never`\>\>\>
|
|
134
|
+
`Promise`\<`StreamTextResult`\<`ToolSet`, `Context`, `Output`\<`string`, `string`, `never`\>\>\>
|
|
135
135
|
|
|
136
136
|
#### Implementation of
|
|
137
137
|
|
|
@@ -17,7 +17,7 @@ Creates an Anthropic bash tool registration for the 2024-10-22 version.
|
|
|
17
17
|
|
|
18
18
|
| Parameter | Type | Description |
|
|
19
19
|
| ------ | ------ | ------ |
|
|
20
|
-
| `options
|
|
20
|
+
| `options?` | `Omit`\<`Bash20241022Options`\<`unknown`\>, `"execute"`\> & \{ \} | Anthropic bash tool options. |
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
@@ -17,7 +17,7 @@ Creates an Anthropic bash tool registration for the 2025-01-24 version.
|
|
|
17
17
|
|
|
18
18
|
| Parameter | Type | Description |
|
|
19
19
|
| ------ | ------ | ------ |
|
|
20
|
-
| `options
|
|
20
|
+
| `options?` | `Omit`\<`Bash20250124Options`\<`unknown`\>, `"execute"`\> & \{ \} | Anthropic bash tool options. |
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
@@ -18,7 +18,7 @@ Adapts a native AI SDK tool to the Archipel intelligence tool schema.
|
|
|
18
18
|
| Parameter | Type | Description |
|
|
19
19
|
| ------ | ------ | ------ |
|
|
20
20
|
| `name` | `string` | Tool name used as key in the AI SDK tool set. |
|
|
21
|
-
| `tool` | Tool\<never, never\> \| Tool\<any, any\> \| Tool\<any, never\> \| Tool\<never, any\> & `Pick`\<`Tool`\<`any`, `any`\>, \| `"execute"` \| `"needsApproval"` \| `"onInputStart"` \| `"onInputDelta"` \| `"onInputAvailable"`\> | Native AI SDK tool definition. |
|
|
21
|
+
| `tool` | Tool\<never, never, any\> \| Tool\<any, any, any\> \| Tool\<any, never, any\> \| Tool\<never, any, any\> & `Pick`\<`Tool`\<`any`, `any`, `any`\>, \| `"execute"` \| `"needsApproval"` \| `"onInputStart"` \| `"onInputDelta"` \| `"onInputAvailable"`\> | Native AI SDK tool definition. |
|
|
22
22
|
|
|
23
23
|
## Returns
|
|
24
24
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: createMimoCustomTool()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: createMimoCustomTool()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function createMimoCustomTool(options, name): IIntelligenceTool;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: providers/mimo/tools/createMimoCustomTool.ts:21
|
|
13
|
+
|
|
14
|
+
Creates a MiMo function tool registration.
|
|
15
|
+
|
|
16
|
+
MiMo exposes OpenAI-compatible function tools, so this adapter keeps the same
|
|
17
|
+
Archipel shape as the other provider-specific tool factories.
|
|
18
|
+
|
|
19
|
+
## Parameters
|
|
20
|
+
|
|
21
|
+
| Parameter | Type | Description |
|
|
22
|
+
| ------ | ------ | ------ |
|
|
23
|
+
| `options` | `Tool`\<`never`, `never`, `Context`\> | Tool options passed to the AI SDK `tool()` helper. |
|
|
24
|
+
| `name` | `string` | Archipel registry name. |
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
[`IIntelligenceTool`](Interface.IIntelligenceTool)
|
|
29
|
+
|
|
30
|
+
Tool registration compatible with the intelligence tool registry.
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
# Function: createOpenAICustomTool()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function createOpenAICustomTool(options, name
|
|
9
|
+
function createOpenAICustomTool(options, name): IIntelligenceTool;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Defined in: [providers/openai/tools/createOpenAICustomTool.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAICustomTool.ts#L18)
|
|
@@ -15,10 +15,10 @@ Creates an OpenAI custom provider-defined tool registration.
|
|
|
15
15
|
|
|
16
16
|
## Parameters
|
|
17
17
|
|
|
18
|
-
| Parameter | Type |
|
|
19
|
-
| ------ | ------ | ------ |
|
|
20
|
-
| `options` | \{ \} & \{ \} |
|
|
21
|
-
| `name` | `string` |
|
|
18
|
+
| Parameter | Type | Description |
|
|
19
|
+
| ------ | ------ | ------ |
|
|
20
|
+
| `options` | \{ \} & \{ \} | OpenAI custom tool options. |
|
|
21
|
+
| `name` | `string` | Optional Archipel registry name. |
|
|
22
22
|
|
|
23
23
|
## Returns
|
|
24
24
|
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
# Function: loadAnthropicLanguageModel()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function loadAnthropicLanguageModel(configuration):
|
|
9
|
+
function loadAnthropicLanguageModel(configuration): LanguageModelV4;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Defined in: [providers/anthropic/loadAnthropicLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/loadAnthropicLanguageModel.ts#L17)
|
|
@@ -21,6 +21,6 @@ Creates the Anthropic language model from the resolved provider configuration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
`
|
|
24
|
+
`LanguageModelV4`
|
|
25
25
|
|
|
26
26
|
The configured language model instance.
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
# Function: loadGoogleLanguageModel()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function loadGoogleLanguageModel(configuration):
|
|
9
|
+
function loadGoogleLanguageModel(configuration): LanguageModelV4;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Defined in: [providers/google/loadGoogleLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/loadGoogleLanguageModel.ts#L17)
|
|
@@ -21,6 +21,6 @@ Creates the Google Gemini language model from the resolved provider configuratio
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
`
|
|
24
|
+
`LanguageModelV4`
|
|
25
25
|
|
|
26
26
|
The configured language model instance.
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
# Function: loadGrokLanguageModel()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function loadGrokLanguageModel(configuration):
|
|
9
|
+
function loadGrokLanguageModel(configuration): LanguageModelV4;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Defined in: [providers/grok/loadGrokLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/loadGrokLanguageModel.ts#L17)
|
|
@@ -21,6 +21,6 @@ Creates the Grok language model through the native xAI provider.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
`
|
|
24
|
+
`LanguageModelV4`
|
|
25
25
|
|
|
26
26
|
The configured language model instance.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: loadMimoLanguageModel()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: loadMimoLanguageModel()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function loadMimoLanguageModel(configuration): LanguageModelV4;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: providers/mimo/loadMimoLanguageModel.ts:17
|
|
13
|
+
|
|
14
|
+
Creates the Xiaomi MiMo language model from the resolved provider configuration.
|
|
15
|
+
|
|
16
|
+
## Parameters
|
|
17
|
+
|
|
18
|
+
| Parameter | Type | Description |
|
|
19
|
+
| ------ | ------ | ------ |
|
|
20
|
+
| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
|
|
21
|
+
|
|
22
|
+
## Returns
|
|
23
|
+
|
|
24
|
+
`LanguageModelV4`
|
|
25
|
+
|
|
26
|
+
The configured language model instance.
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
# Function: loadOpenAILanguageModel()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function loadOpenAILanguageModel(configuration):
|
|
9
|
+
function loadOpenAILanguageModel(configuration): LanguageModelV4;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Defined in: [providers/openai/loadOpenAILanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/loadOpenAILanguageModel.ts#L17)
|
|
@@ -21,6 +21,6 @@ Creates the OpenAI language model from the resolved provider configuration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
`
|
|
24
|
+
`LanguageModelV4`
|
|
25
25
|
|
|
26
26
|
The configured language model instance.
|
|
@@ -11,27 +11,27 @@ Captures usage telemetry returned by the intelligence provider.
|
|
|
11
11
|
|
|
12
12
|
## Properties
|
|
13
13
|
|
|
14
|
-
###
|
|
14
|
+
### inputTokens
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
|
-
readonly
|
|
17
|
+
readonly inputTokens: number | null;
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [contracts/IIntelligenceCompletionUsage.ts:
|
|
20
|
+
Defined in: [contracts/IIntelligenceCompletionUsage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L14)
|
|
21
21
|
|
|
22
|
-
The number of tokens
|
|
22
|
+
The number of input tokens consumed by the prompt.
|
|
23
23
|
|
|
24
24
|
***
|
|
25
25
|
|
|
26
|
-
###
|
|
26
|
+
### outputTokens
|
|
27
27
|
|
|
28
28
|
```ts
|
|
29
|
-
readonly
|
|
29
|
+
readonly outputTokens: number | null;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [contracts/IIntelligenceCompletionUsage.ts:
|
|
32
|
+
Defined in: [contracts/IIntelligenceCompletionUsage.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L21)
|
|
33
33
|
|
|
34
|
-
The number of tokens
|
|
34
|
+
The number of output tokens generated in the completion.
|
|
35
35
|
|
|
36
36
|
***
|
|
37
37
|
|
|
@@ -43,4 +43,4 @@ readonly totalTokens: number | null;
|
|
|
43
43
|
|
|
44
44
|
Defined in: [contracts/IIntelligenceCompletionUsage.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L28)
|
|
45
45
|
|
|
46
|
-
The total number of tokens
|
|
46
|
+
The total number of tokens reported by the provider.
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceTextCompletion
|
|
7
7
|
|
|
8
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:
|
|
8
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L20)
|
|
9
9
|
|
|
10
10
|
Represents the normalized completion result produced by the intelligence provider.
|
|
11
11
|
|
|
@@ -17,19 +17,31 @@ Represents the normalized completion result produced by the intelligence provide
|
|
|
17
17
|
readonly files: readonly GeneratedFile[];
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:
|
|
20
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L56)
|
|
21
21
|
|
|
22
22
|
Files generated by provider-native tools such as image generation or code interpreter.
|
|
23
23
|
|
|
24
24
|
***
|
|
25
25
|
|
|
26
|
+
### finalStep?
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
readonly optional finalStep?: StepResult<ToolSet, Record<string, unknown>>;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L84)
|
|
33
|
+
|
|
34
|
+
Final AI SDK generation step.
|
|
35
|
+
|
|
36
|
+
***
|
|
37
|
+
|
|
26
38
|
### model
|
|
27
39
|
|
|
28
40
|
```ts
|
|
29
41
|
readonly model: string;
|
|
30
42
|
```
|
|
31
43
|
|
|
32
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:
|
|
44
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L42)
|
|
33
45
|
|
|
34
46
|
The model identifier used for the completion.
|
|
35
47
|
|
|
@@ -41,36 +53,96 @@ The model identifier used for the completion.
|
|
|
41
53
|
readonly provider: string;
|
|
42
54
|
```
|
|
43
55
|
|
|
44
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:
|
|
56
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L35)
|
|
45
57
|
|
|
46
58
|
The provider that produced the completion.
|
|
47
59
|
|
|
48
60
|
***
|
|
49
61
|
|
|
62
|
+
### reasoning?
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
readonly optional reasoning?: (ReasoningOutput | ReasoningFileOutput)[];
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L63)
|
|
69
|
+
|
|
70
|
+
Reasoning parts reported by AI SDK 7 compatible models.
|
|
71
|
+
|
|
72
|
+
***
|
|
73
|
+
|
|
74
|
+
### reasoningText?
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
readonly optional reasoningText?: string;
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L70)
|
|
81
|
+
|
|
82
|
+
Concatenated reasoning text reported by the final generation step.
|
|
83
|
+
|
|
84
|
+
***
|
|
85
|
+
|
|
50
86
|
### sources
|
|
51
87
|
|
|
52
88
|
```ts
|
|
53
|
-
readonly sources: readonly
|
|
89
|
+
readonly sources: readonly LanguageModelV4Source[];
|
|
54
90
|
```
|
|
55
91
|
|
|
56
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:
|
|
92
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L49)
|
|
57
93
|
|
|
58
94
|
Sources reported by provider-native tools such as web search.
|
|
59
95
|
|
|
60
96
|
***
|
|
61
97
|
|
|
98
|
+
### steps?
|
|
99
|
+
|
|
100
|
+
```ts
|
|
101
|
+
readonly optional steps?: StepResult<ToolSet, Record<string, unknown>>[];
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L77)
|
|
105
|
+
|
|
106
|
+
All AI SDK generation steps.
|
|
107
|
+
|
|
108
|
+
***
|
|
109
|
+
|
|
62
110
|
### text
|
|
63
111
|
|
|
64
112
|
```ts
|
|
65
113
|
readonly text: string;
|
|
66
114
|
```
|
|
67
115
|
|
|
68
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:
|
|
116
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L28)
|
|
69
117
|
|
|
70
118
|
The generated text content.
|
|
71
119
|
|
|
72
120
|
***
|
|
73
121
|
|
|
122
|
+
### toolCalls?
|
|
123
|
+
|
|
124
|
+
```ts
|
|
125
|
+
readonly optional toolCalls?: TypedToolCall<ToolSet>[];
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L91)
|
|
129
|
+
|
|
130
|
+
Tool calls produced across the generation.
|
|
131
|
+
|
|
132
|
+
***
|
|
133
|
+
|
|
134
|
+
### toolResults?
|
|
135
|
+
|
|
136
|
+
```ts
|
|
137
|
+
readonly optional toolResults?: TypedToolResult<ToolSet>[];
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L98)
|
|
141
|
+
|
|
142
|
+
Tool results produced across the generation.
|
|
143
|
+
|
|
144
|
+
***
|
|
145
|
+
|
|
74
146
|
### usage
|
|
75
147
|
|
|
76
148
|
```ts
|
|
@@ -79,6 +151,18 @@ readonly usage:
|
|
|
79
151
|
| null;
|
|
80
152
|
```
|
|
81
153
|
|
|
82
|
-
Defined in: [contracts/IIntelligenceTextCompletion.ts:
|
|
154
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L112)
|
|
83
155
|
|
|
84
156
|
Token usage telemetry, or `null` when the provider does not report usage.
|
|
157
|
+
|
|
158
|
+
***
|
|
159
|
+
|
|
160
|
+
### warnings?
|
|
161
|
+
|
|
162
|
+
```ts
|
|
163
|
+
readonly optional warnings?: SharedV4Warning[];
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L105)
|
|
167
|
+
|
|
168
|
+
Provider or model warnings reported by the AI SDK.
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md
CHANGED
|
@@ -21,7 +21,7 @@ Options that can be supplied when generating text with the intelligence provider
|
|
|
21
21
|
readonly optional abortSignal?: AbortSignal;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:
|
|
24
|
+
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L81)
|
|
25
25
|
|
|
26
26
|
Optional AI SDK abort signal for this generation request.
|
|
27
27
|
|
|
@@ -36,7 +36,7 @@ source can stop the request.
|
|
|
36
36
|
readonly optional activeTools?: string[];
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:
|
|
39
|
+
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L112)
|
|
40
40
|
|
|
41
41
|
Optional list of tool names available to the model for this request.
|
|
42
42
|
|
|
@@ -76,7 +76,7 @@ the configured platform model for this call.
|
|
|
76
76
|
readonly optional stopWhen?: StopCondition<ToolSet> | StopCondition<ToolSet>[];
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:
|
|
79
|
+
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L105)
|
|
80
80
|
|
|
81
81
|
Optional AI SDK stop condition for multi-step tool execution.
|
|
82
82
|
|
|
@@ -97,29 +97,13 @@ Optional sampling temperature override.
|
|
|
97
97
|
### timeout?
|
|
98
98
|
|
|
99
99
|
```ts
|
|
100
|
-
readonly optional timeout?: TimeoutConfiguration
|
|
100
|
+
readonly optional timeout?: TimeoutConfiguration<ToolSet>;
|
|
101
101
|
```
|
|
102
102
|
|
|
103
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:
|
|
103
|
+
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L71)
|
|
104
104
|
|
|
105
105
|
Native AI SDK timeout configuration.
|
|
106
106
|
|
|
107
|
-
`timeoutMs` remains available as the platform shorthand for a total
|
|
108
|
-
timeout in milliseconds.
|
|
109
|
-
|
|
110
|
-
***
|
|
111
|
-
|
|
112
|
-
### timeoutMs?
|
|
113
|
-
|
|
114
|
-
```ts
|
|
115
|
-
readonly optional timeoutMs?: number;
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L82)
|
|
119
|
-
|
|
120
|
-
Optional timeout in milliseconds for the LLM request.
|
|
121
|
-
Defaults to 30000 (30 seconds) if not specified.
|
|
122
|
-
|
|
123
107
|
***
|
|
124
108
|
|
|
125
109
|
### toolChoice?
|
|
@@ -128,7 +112,7 @@ Defaults to 30000 (30 seconds) if not specified.
|
|
|
128
112
|
readonly optional toolChoice?: ToolChoice<ToolSet>;
|
|
129
113
|
```
|
|
130
114
|
|
|
131
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:
|
|
115
|
+
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L98)
|
|
132
116
|
|
|
133
117
|
Optional AI SDK tool choice strategy.
|
|
134
118
|
|
|
@@ -140,7 +124,7 @@ Optional AI SDK tool choice strategy.
|
|
|
140
124
|
readonly optional tools?: ToolSet;
|
|
141
125
|
```
|
|
142
126
|
|
|
143
|
-
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:
|
|
127
|
+
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L91)
|
|
144
128
|
|
|
145
129
|
Optional AI SDK tools available for this generation request.
|
|
146
130
|
|
|
@@ -57,7 +57,7 @@ The active provider configuration.
|
|
|
57
57
|
### streamText()
|
|
58
58
|
|
|
59
59
|
```ts
|
|
60
|
-
streamText(prompt, options?): Promise<StreamTextResult<ToolSet, Output<string, string, never>>>;
|
|
60
|
+
streamText(prompt, options?): Promise<StreamTextResult<ToolSet, Context, Output<string, string, never>>>;
|
|
61
61
|
```
|
|
62
62
|
|
|
63
63
|
Defined in: [interfaces/IIntelligenceTextGenerator.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L38)
|
|
@@ -73,6 +73,6 @@ Streams a text completion using the configured intelligence provider.
|
|
|
73
73
|
|
|
74
74
|
#### Returns
|
|
75
75
|
|
|
76
|
-
`Promise`\<`StreamTextResult`\<`ToolSet`, `Output`\<`string`, `string`, `never`\>\>\>
|
|
76
|
+
`Promise`\<`StreamTextResult`\<`ToolSet`, `Context`, `Output`\<`string`, `string`, `never`\>\>\>
|
|
77
77
|
|
|
78
78
|
The native AI SDK streaming result.
|