@breadstone/archipel-mcp 0.0.53 → 0.0.54
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/guides/ai-text-generation.md +4 -0
- package/data/guides/index.md +1 -0
- package/data/guides/intelligence-prompts-warm-up.md +358 -0
- package/data/packages/platform-intelligence/api/Class.DefaultIntelligencePromptPolicyAdapter.md +54 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
- package/data/packages/platform-intelligence/api/Class.IntelligencePromptExecutor.md +88 -0
- package/data/packages/platform-intelligence/api/Class.IntelligencePromptPolicyPort.md +48 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +7 -7
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +2 -2
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +6 -6
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +16 -16
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +2 -2
- package/data/packages/platform-intelligence/api/Function.intelligencePrompt.md +31 -0
- package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +1 -1
- package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +1 -1
- package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +1 -1
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +19 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptDefinition.md +145 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md +30 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionContext.md +20 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md +139 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptInvocation.md +49 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptPolicyRequest.md +60 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptRenderContext.md +26 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeAudioFormat.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeCloseEvent.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +10 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionConfiguration.md +11 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +10 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeToolDefinition.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTranscriptionConfiguration.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTurnDetectionConfiguration.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +10 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +24 -12
- package/data/packages/platform-intelligence/api/TypeAlias.IIntelligencePromptModelRequirement.md +25 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptCapability.md +20 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptDefinitionConfiguration.md +29 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md +16 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptLatency.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptMode.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptQuality.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptReasoning.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeServerEvent.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeStatus.md +1 -1
- package/data/packages/platform-intelligence/api/index.md +20 -0
- package/data/packages/platform-intelligence/index.md +78 -0
- package/package.json +1 -1
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: IntelligenceRealtimeSessionFactory
|
|
7
7
|
|
|
8
|
-
Defined in: IntelligenceRealtimeSessionFactory.ts:35
|
|
8
|
+
Defined in: [IntelligenceRealtimeSessionFactory.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L35)
|
|
9
9
|
|
|
10
10
|
Creates and owns server-side, provider-neutral realtime AI sessions.
|
|
11
11
|
|
|
@@ -30,7 +30,7 @@ new IntelligenceRealtimeSessionFactory(
|
|
|
30
30
|
runtime): IntelligenceRealtimeSessionFactory;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: IntelligenceRealtimeSessionFactory.ts:55
|
|
33
|
+
Defined in: [IntelligenceRealtimeSessionFactory.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L55)
|
|
34
34
|
|
|
35
35
|
#### Parameters
|
|
36
36
|
|
|
@@ -56,7 +56,7 @@ Defined in: IntelligenceRealtimeSessionFactory.ts:55
|
|
|
56
56
|
get activeSessionCount(): number;
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
Defined in: IntelligenceRealtimeSessionFactory.ts:74
|
|
59
|
+
Defined in: [IntelligenceRealtimeSessionFactory.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L74)
|
|
60
60
|
|
|
61
61
|
Number of sessions currently owned by this module instance.
|
|
62
62
|
|
|
@@ -74,7 +74,7 @@ Number of sessions currently owned by this module instance.
|
|
|
74
74
|
get registeredProviders(): readonly IntelligenceProviderName[];
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
-
Defined in: IntelligenceRealtimeSessionFactory.ts:79
|
|
77
|
+
Defined in: [IntelligenceRealtimeSessionFactory.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L79)
|
|
78
78
|
|
|
79
79
|
Providers currently registered for server-owned realtime sessions.
|
|
80
80
|
|
|
@@ -90,7 +90,7 @@ readonly [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName)[]
|
|
|
90
90
|
createSession(options): Promise<IntelligenceRealtimeSessionPort>;
|
|
91
91
|
```
|
|
92
92
|
|
|
93
|
-
Defined in: IntelligenceRealtimeSessionFactory.ts:93
|
|
93
|
+
Defined in: [IntelligenceRealtimeSessionFactory.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L93)
|
|
94
94
|
|
|
95
95
|
Creates an isolated realtime session without opening the upstream socket.
|
|
96
96
|
|
|
@@ -114,7 +114,7 @@ A provider-neutral session. Call `connect()` to start streaming.
|
|
|
114
114
|
onModuleDestroy(): Promise<void>;
|
|
115
115
|
```
|
|
116
116
|
|
|
117
|
-
Defined in: IntelligenceRealtimeSessionFactory.ts:132
|
|
117
|
+
Defined in: [IntelligenceRealtimeSessionFactory.ts:132](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L132)
|
|
118
118
|
|
|
119
119
|
Closes all owned upstream sessions during Nest application shutdown.
|
|
120
120
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Abstract Class: IntelligenceRealtimeSessionPort
|
|
7
7
|
|
|
8
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:14
|
|
8
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L14)
|
|
9
9
|
|
|
10
10
|
Provider-neutral control surface for one realtime model connection.
|
|
11
11
|
|
|
@@ -31,7 +31,7 @@ new IntelligenceRealtimeSessionPort(): IntelligenceRealtimeSessionPort;
|
|
|
31
31
|
get abstract connectionId(): string;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:18
|
|
34
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L18)
|
|
35
35
|
|
|
36
36
|
##### Returns
|
|
37
37
|
|
|
@@ -47,7 +47,7 @@ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:18
|
|
|
47
47
|
get abstract model(): string;
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:20
|
|
50
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L20)
|
|
51
51
|
|
|
52
52
|
##### Returns
|
|
53
53
|
|
|
@@ -63,7 +63,7 @@ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:20
|
|
|
63
63
|
get abstract provider(): IntelligenceProviderName;
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:19
|
|
66
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L19)
|
|
67
67
|
|
|
68
68
|
##### Returns
|
|
69
69
|
|
|
@@ -79,7 +79,7 @@ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:19
|
|
|
79
79
|
get abstract sessionId(): string;
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:17
|
|
82
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L17)
|
|
83
83
|
|
|
84
84
|
##### Returns
|
|
85
85
|
|
|
@@ -95,7 +95,7 @@ Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:17
|
|
|
95
95
|
get abstract status(): IntelligenceRealtimeStatus;
|
|
96
96
|
```
|
|
97
97
|
|
|
98
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:21
|
|
98
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L21)
|
|
99
99
|
|
|
100
100
|
##### Returns
|
|
101
101
|
|
|
@@ -112,7 +112,7 @@ abstract addToolOutput(
|
|
|
112
112
|
name?): Promise<void>;
|
|
113
113
|
```
|
|
114
114
|
|
|
115
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:56
|
|
115
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L56)
|
|
116
116
|
|
|
117
117
|
Returns a completed function result to the model.
|
|
118
118
|
|
|
@@ -136,7 +136,7 @@ Returns a completed function result to the model.
|
|
|
136
136
|
abstract appendAudio(audio): Promise<void>;
|
|
137
137
|
```
|
|
138
138
|
|
|
139
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:34
|
|
139
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L34)
|
|
140
140
|
|
|
141
141
|
Appends a base64-encoded audio fragment to the upstream input buffer.
|
|
142
142
|
|
|
@@ -158,7 +158,7 @@ Appends a base64-encoded audio fragment to the upstream input buffer.
|
|
|
158
158
|
abstract cancelResponse(): Promise<void>;
|
|
159
159
|
```
|
|
160
160
|
|
|
161
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:53
|
|
161
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L53)
|
|
162
162
|
|
|
163
163
|
Cancels the active model response.
|
|
164
164
|
|
|
@@ -174,7 +174,7 @@ Cancels the active model response.
|
|
|
174
174
|
abstract clearAudio(): Promise<void>;
|
|
175
175
|
```
|
|
176
176
|
|
|
177
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:40
|
|
177
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L40)
|
|
178
178
|
|
|
179
179
|
Clears the provider input audio buffer.
|
|
180
180
|
|
|
@@ -190,7 +190,7 @@ Clears the provider input audio buffer.
|
|
|
190
190
|
abstract close(code?, reason?): Promise<void>;
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:59
|
|
193
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L59)
|
|
194
194
|
|
|
195
195
|
Gracefully closes the upstream connection and flushes metering events.
|
|
196
196
|
|
|
@@ -213,7 +213,7 @@ Gracefully closes the upstream connection and flushes metering events.
|
|
|
213
213
|
abstract commitAudio(): Promise<void>;
|
|
214
214
|
```
|
|
215
215
|
|
|
216
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:37
|
|
216
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L37)
|
|
217
217
|
|
|
218
218
|
Commits the provider input audio buffer.
|
|
219
219
|
|
|
@@ -229,7 +229,7 @@ Commits the provider input audio buffer.
|
|
|
229
229
|
abstract connect(): Promise<void>;
|
|
230
230
|
```
|
|
231
231
|
|
|
232
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:28
|
|
232
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L28)
|
|
233
233
|
|
|
234
234
|
Opens the upstream provider WebSocket and applies the session configuration.
|
|
235
235
|
|
|
@@ -245,7 +245,7 @@ Opens the upstream provider WebSocket and applies the session configuration.
|
|
|
245
245
|
abstract requestResponse(options?): Promise<void>;
|
|
246
246
|
```
|
|
247
247
|
|
|
248
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:46
|
|
248
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L46)
|
|
249
249
|
|
|
250
250
|
Requests a new model response.
|
|
251
251
|
|
|
@@ -270,7 +270,7 @@ Requests a new model response.
|
|
|
270
270
|
abstract send(event): Promise<void>;
|
|
271
271
|
```
|
|
272
272
|
|
|
273
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:31
|
|
273
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L31)
|
|
274
274
|
|
|
275
275
|
Sends any provider-neutral client event.
|
|
276
276
|
|
|
@@ -292,7 +292,7 @@ Sends any provider-neutral client event.
|
|
|
292
292
|
abstract sendText(text, requestResponse?): Promise<void>;
|
|
293
293
|
```
|
|
294
294
|
|
|
295
|
-
Defined in: realtime/ports/IntelligenceRealtimeSessionPort.ts:43
|
|
295
|
+
Defined in: [realtime/ports/IntelligenceRealtimeSessionPort.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeSessionPort.ts#L43)
|
|
296
296
|
|
|
297
297
|
Sends a text turn and optionally asks the model to respond.
|
|
298
298
|
|
|
@@ -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:270](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L270)
|
|
80
80
|
|
|
81
81
|
Returns the resolved provider configuration with the API key redacted.
|
|
82
82
|
|
|
@@ -118,7 +118,7 @@ OnModuleInit.onModuleInit
|
|
|
118
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:195](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L195)
|
|
122
122
|
|
|
123
123
|
Streams a completion using the configured provider.
|
|
124
124
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: intelligencePrompt()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: intelligencePrompt()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function intelligencePrompt<TInput, TOutput>(configuration): IIntelligencePromptDefinition<TInput, TOutput, "object" | "text">;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [prompts/intelligencePrompt.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/intelligencePrompt.ts#L15)
|
|
13
|
+
|
|
14
|
+
Creates a reusable intelligence prompt definition.
|
|
15
|
+
|
|
16
|
+
## Type Parameters
|
|
17
|
+
|
|
18
|
+
| Type Parameter | Default type |
|
|
19
|
+
| ------ | ------ |
|
|
20
|
+
| `TInput` | - |
|
|
21
|
+
| `TOutput` | `string` |
|
|
22
|
+
|
|
23
|
+
## Parameters
|
|
24
|
+
|
|
25
|
+
| Parameter | Type |
|
|
26
|
+
| ------ | ------ |
|
|
27
|
+
| `configuration` | [`IntelligencePromptDefinitionConfiguration`](TypeAlias.IntelligencePromptDefinitionConfiguration)\<`TInput`, `TOutput`\> |
|
|
28
|
+
|
|
29
|
+
## Returns
|
|
30
|
+
|
|
31
|
+
[`IIntelligencePromptDefinition`](Interface.IIntelligencePromptDefinition)\<`TInput`, `TOutput`, `"object"` \| `"text"`\>
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
function loadGoogleRealtimeModel(configuration, options): Promise<RealtimeModelV4>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: providers/google/loadGoogleRealtimeModel.ts:17
|
|
12
|
+
Defined in: [providers/google/loadGoogleRealtimeModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/loadGoogleRealtimeModel.ts#L17)
|
|
13
13
|
|
|
14
14
|
Creates a Google Gemini Live model exclusively through the Vercel AI SDK provider.
|
|
15
15
|
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
function loadGrokRealtimeModel(configuration, options): Promise<RealtimeModelV4>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: providers/grok/loadGrokRealtimeModel.ts:17
|
|
12
|
+
Defined in: [providers/grok/loadGrokRealtimeModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/loadGrokRealtimeModel.ts#L17)
|
|
13
13
|
|
|
14
14
|
Creates an xAI Grok voice model exclusively through the Vercel AI SDK provider.
|
|
15
15
|
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
function loadOpenAIRealtimeModel(configuration, options): Promise<RealtimeModelV4>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: providers/openai/loadOpenAIRealtimeModel.ts:17
|
|
12
|
+
Defined in: [providers/openai/loadOpenAIRealtimeModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/loadOpenAIRealtimeModel.ts#L17)
|
|
13
13
|
|
|
14
14
|
Creates an OpenAI realtime model exclusively through the Vercel AI SDK provider.
|
|
15
15
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceModuleOptions
|
|
7
7
|
|
|
8
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
8
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L17)
|
|
9
9
|
|
|
10
10
|
Options for configuring the intelligence module.
|
|
11
11
|
|
|
@@ -17,7 +17,7 @@ Options for configuring the intelligence module.
|
|
|
17
17
|
readonly optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
20
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L32)
|
|
21
21
|
|
|
22
22
|
Provider-specific configuration entries to register with the config module.
|
|
23
23
|
|
|
@@ -29,19 +29,31 @@ Provider-specific configuration entries to register with the config module.
|
|
|
29
29
|
readonly optional isGlobal?: boolean;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
32
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L73)
|
|
33
33
|
|
|
34
34
|
When `true` the module is registered globally.
|
|
35
35
|
|
|
36
36
|
***
|
|
37
37
|
|
|
38
|
+
### promptPolicyAdapter?
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
readonly optional promptPolicyAdapter?: Type<IntelligencePromptPolicyPort>;
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L66)
|
|
45
|
+
|
|
46
|
+
Optional application policy adapter for provider-neutral prompt requirements.
|
|
47
|
+
|
|
48
|
+
***
|
|
49
|
+
|
|
38
50
|
### providerLoaders?
|
|
39
51
|
|
|
40
52
|
```ts
|
|
41
53
|
readonly optional providerLoaders?: Partial<Record<IntelligenceProviderName, IntelligenceLanguageModelLoader>>;
|
|
42
54
|
```
|
|
43
55
|
|
|
44
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
56
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L42)
|
|
45
57
|
|
|
46
58
|
Tree-shakable language model loaders keyed by provider name.
|
|
47
59
|
|
|
@@ -56,7 +68,7 @@ Import these from provider-specific subpaths such as
|
|
|
56
68
|
readonly optional realtime?: IIntelligenceRealtimeModuleOptions;
|
|
57
69
|
```
|
|
58
70
|
|
|
59
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
71
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L49)
|
|
60
72
|
|
|
61
73
|
Server-owned realtime model sessions, resilience limits, and metering.
|
|
62
74
|
|
|
@@ -72,7 +84,7 @@ readonly optional tools?: readonly (
|
|
|
72
84
|
| Provider<IIntelligenceTool>)[];
|
|
73
85
|
```
|
|
74
86
|
|
|
75
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
87
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L25)
|
|
76
88
|
|
|
77
89
|
Tool instances, tool factory promises, class providers, or custom Nest providers registered at bootstrap.
|
|
78
90
|
|
|
@@ -84,7 +96,7 @@ Tool instances, tool factory promises, class providers, or custom Nest providers
|
|
|
84
96
|
readonly optional validateOnModuleInit?: boolean;
|
|
85
97
|
```
|
|
86
98
|
|
|
87
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
99
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L59)
|
|
88
100
|
|
|
89
101
|
When `true`, provider configuration is resolved during module initialization.
|
|
90
102
|
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligencePromptDefinition\<TInput, TOutput, TMode\>'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligencePromptDefinition\<TInput, TOutput, TMode\>
|
|
7
|
+
|
|
8
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L16)
|
|
9
|
+
|
|
10
|
+
Reusable, immutable definition of an intelligence prompt.
|
|
11
|
+
|
|
12
|
+
## Type Parameters
|
|
13
|
+
|
|
14
|
+
| Type Parameter | Default type |
|
|
15
|
+
| ------ | ------ |
|
|
16
|
+
| `TInput` | - |
|
|
17
|
+
| `TOutput` | - |
|
|
18
|
+
| `TMode` *extends* [`IntelligencePromptMode`](TypeAlias.IntelligencePromptMode) | [`IntelligencePromptMode`](TypeAlias.IntelligencePromptMode) |
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
### execution?
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
readonly optional execution?: IIntelligencePromptExecutionPolicy;
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L24)
|
|
29
|
+
|
|
30
|
+
***
|
|
31
|
+
|
|
32
|
+
### inputSchema
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
readonly inputSchema: FlexibleSchema<TInput>;
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L22)
|
|
39
|
+
|
|
40
|
+
***
|
|
41
|
+
|
|
42
|
+
### mode
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
readonly mode: TMode;
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L21)
|
|
49
|
+
|
|
50
|
+
***
|
|
51
|
+
|
|
52
|
+
### name
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
readonly name: string;
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L19)
|
|
59
|
+
|
|
60
|
+
***
|
|
61
|
+
|
|
62
|
+
### outputSchema?
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
readonly optional outputSchema?: FlexibleSchema<TOutput>;
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L23)
|
|
69
|
+
|
|
70
|
+
***
|
|
71
|
+
|
|
72
|
+
### version
|
|
73
|
+
|
|
74
|
+
```ts
|
|
75
|
+
readonly version: number;
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L20)
|
|
79
|
+
|
|
80
|
+
## Methods
|
|
81
|
+
|
|
82
|
+
### messages()
|
|
83
|
+
|
|
84
|
+
```ts
|
|
85
|
+
messages(context): readonly ModelMessage[];
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L31)
|
|
89
|
+
|
|
90
|
+
#### Parameters
|
|
91
|
+
|
|
92
|
+
| Parameter | Type |
|
|
93
|
+
| ------ | ------ |
|
|
94
|
+
| `context` | [`IIntelligencePromptRenderContext`](Interface.IIntelligencePromptRenderContext)\<`TInput`\> |
|
|
95
|
+
|
|
96
|
+
#### Returns
|
|
97
|
+
|
|
98
|
+
readonly `ModelMessage`[]
|
|
99
|
+
|
|
100
|
+
***
|
|
101
|
+
|
|
102
|
+
### system()
|
|
103
|
+
|
|
104
|
+
```ts
|
|
105
|
+
system(context): string | readonly string[];
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L30)
|
|
109
|
+
|
|
110
|
+
#### Parameters
|
|
111
|
+
|
|
112
|
+
| Parameter | Type |
|
|
113
|
+
| ------ | ------ |
|
|
114
|
+
| `context` | [`IIntelligencePromptRenderContext`](Interface.IIntelligencePromptRenderContext)\<`TInput`\> |
|
|
115
|
+
|
|
116
|
+
#### Returns
|
|
117
|
+
|
|
118
|
+
`string` \| readonly `string`[]
|
|
119
|
+
|
|
120
|
+
***
|
|
121
|
+
|
|
122
|
+
### with()
|
|
123
|
+
|
|
124
|
+
```ts
|
|
125
|
+
with<TMetadata>(input, metadata?): IIntelligencePromptInvocation<TInput, TOutput, TMode, TMetadata>;
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L32)
|
|
129
|
+
|
|
130
|
+
#### Type Parameters
|
|
131
|
+
|
|
132
|
+
| Type Parameter | Default type |
|
|
133
|
+
| ------ | ------ |
|
|
134
|
+
| `TMetadata` | `undefined` |
|
|
135
|
+
|
|
136
|
+
#### Parameters
|
|
137
|
+
|
|
138
|
+
| Parameter | Type |
|
|
139
|
+
| ------ | ------ |
|
|
140
|
+
| `input` | `TInput` |
|
|
141
|
+
| `metadata?` | `TMetadata` |
|
|
142
|
+
|
|
143
|
+
#### Returns
|
|
144
|
+
|
|
145
|
+
[`IIntelligencePromptInvocation`](Interface.IIntelligencePromptInvocation)\<`TInput`, `TOutput`, `TMode`, `TMetadata`\>
|
package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligencePromptEffectivePolicy'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligencePromptEffectivePolicy
|
|
7
|
+
|
|
8
|
+
Defined in: [prompts/IIntelligencePromptEffectivePolicy.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptEffectivePolicy.ts#L13)
|
|
9
|
+
|
|
10
|
+
Effective settings resolved for one prompt execution.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### capabilities
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly capabilities: readonly IntelligencePromptCapability[];
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [prompts/IIntelligencePromptEffectivePolicy.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptEffectivePolicy.ts#L17)
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### options
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
readonly options: IntelligencePromptGenerationOptions;
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Defined in: [prompts/IIntelligencePromptEffectivePolicy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptEffectivePolicy.ts#L16)
|
package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionContext.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligencePromptExecutionContext'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligencePromptExecutionContext
|
|
7
|
+
|
|
8
|
+
Defined in: [prompts/IIntelligencePromptExecutionContext.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionContext.ts#L6)
|
|
9
|
+
|
|
10
|
+
Application context made available to prompt policy adapters.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### metadata?
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly optional metadata?: Readonly<Record<string, unknown>>;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [prompts/IIntelligencePromptExecutionContext.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionContext.ts#L9)
|
package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligencePromptExecutionPolicy'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligencePromptExecutionPolicy
|
|
7
|
+
|
|
8
|
+
Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L17)
|
|
9
|
+
|
|
10
|
+
Native settings and provider-neutral requirements declared by an intelligence prompt.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### latency?
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly optional latency?: IntelligencePromptLatency;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L23)
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### model?
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
readonly optional model?: IIntelligencePromptModelRequirement;
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L24)
|
|
31
|
+
|
|
32
|
+
***
|
|
33
|
+
|
|
34
|
+
### options?
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
readonly optional options?: IntelligencePromptGenerationOptions;
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L20)
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### quality?
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly optional quality?: IntelligencePromptQuality;
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L21)
|
|
51
|
+
|
|
52
|
+
***
|
|
53
|
+
|
|
54
|
+
### reasoning?
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
readonly optional reasoning?: IntelligencePromptReasoning;
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L22)
|
|
61
|
+
|
|
62
|
+
***
|
|
63
|
+
|
|
64
|
+
### requiredCapabilities?
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
readonly optional requiredCapabilities?: readonly IntelligencePromptCapability[];
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L25)
|