@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.
Files changed (53) hide show
  1. package/data/guides/ai-text-generation.md +4 -0
  2. package/data/guides/index.md +1 -0
  3. package/data/guides/intelligence-prompts-warm-up.md +358 -0
  4. package/data/packages/platform-intelligence/api/Class.DefaultIntelligencePromptPolicyAdapter.md +54 -0
  5. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  6. package/data/packages/platform-intelligence/api/Class.IntelligencePromptExecutor.md +88 -0
  7. package/data/packages/platform-intelligence/api/Class.IntelligencePromptPolicyPort.md +48 -0
  8. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +7 -7
  9. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +2 -2
  10. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +6 -6
  11. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +16 -16
  12. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +2 -2
  13. package/data/packages/platform-intelligence/api/Function.intelligencePrompt.md +31 -0
  14. package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +1 -1
  15. package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +1 -1
  16. package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +1 -1
  17. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +19 -7
  18. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptDefinition.md +145 -0
  19. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md +30 -0
  20. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionContext.md +20 -0
  21. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md +70 -0
  22. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md +139 -0
  23. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptInvocation.md +49 -0
  24. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptPolicyRequest.md +60 -0
  25. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptRenderContext.md +26 -0
  26. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeAudioFormat.md +3 -3
  27. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeCloseEvent.md +4 -4
  28. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +10 -10
  29. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionConfiguration.md +11 -11
  30. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +10 -10
  31. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeToolDefinition.md +5 -5
  32. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTranscriptionConfiguration.md +4 -4
  33. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTurnDetectionConfiguration.md +5 -5
  34. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +10 -10
  35. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +24 -12
  36. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligencePromptModelRequirement.md +25 -0
  37. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptCapability.md +20 -0
  38. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptDefinitionConfiguration.md +29 -0
  39. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md +16 -0
  40. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptLatency.md +14 -0
  41. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptMode.md +14 -0
  42. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptQuality.md +14 -0
  43. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptReasoning.md +14 -0
  44. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md +1 -1
  45. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md +1 -1
  46. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +1 -1
  47. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +1 -1
  48. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +1 -1
  49. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeServerEvent.md +1 -1
  50. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeStatus.md +1 -1
  51. package/data/packages/platform-intelligence/api/index.md +20 -0
  52. package/data/packages/platform-intelligence/index.md +78 -0
  53. package/package.json +1 -1
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceRealtimeTranscriptionConfiguration
7
7
 
8
- Defined in: realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:6
8
+ Defined in: [realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts#L6)
9
9
 
10
10
  Provider-neutral transcription configuration.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral transcription configuration.
17
17
  readonly optional language?: string;
18
18
  ```
19
19
 
20
- Defined in: realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:13
20
+ Defined in: [realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts#L13)
21
21
 
22
22
  Optional BCP 47 language hint.
23
23
 
@@ -29,7 +29,7 @@ Optional BCP 47 language hint.
29
29
  readonly optional model?: string;
30
30
  ```
31
31
 
32
- Defined in: realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:10
32
+ Defined in: [realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts#L10)
33
33
 
34
34
  Provider-specific transcription model.
35
35
 
@@ -41,6 +41,6 @@ Provider-specific transcription model.
41
41
  readonly optional prompt?: string;
42
42
  ```
43
43
 
44
- Defined in: realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:16
44
+ Defined in: [realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeTranscriptionConfiguration.ts#L16)
45
45
 
46
46
  Optional prompt used to guide the transcription.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceRealtimeTurnDetectionConfiguration
7
7
 
8
- Defined in: realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:6
8
+ Defined in: [realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts#L6)
9
9
 
10
10
  Provider-neutral voice activity detection configuration.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral voice activity detection configuration.
17
17
  readonly optional prefixPaddingMs?: number;
18
18
  ```
19
19
 
20
- Defined in: realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:19
20
+ Defined in: [realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts#L19)
21
21
 
22
22
  Audio retained before detected speech starts.
23
23
 
@@ -29,7 +29,7 @@ Audio retained before detected speech starts.
29
29
  readonly optional silenceDurationMs?: number;
30
30
  ```
31
31
 
32
- Defined in: realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:16
32
+ Defined in: [realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts#L16)
33
33
 
34
34
  Silence duration that closes a turn.
35
35
 
@@ -41,7 +41,7 @@ Silence duration that closes a turn.
41
41
  readonly optional threshold?: number;
42
42
  ```
43
43
 
44
- Defined in: realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:13
44
+ Defined in: [realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts#L13)
45
45
 
46
46
  Activation threshold between zero and one.
47
47
 
@@ -53,6 +53,6 @@ Activation threshold between zero and one.
53
53
  readonly type: "server-vad" | "semantic-vad" | "disabled";
54
54
  ```
55
55
 
56
- Defined in: realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:10
56
+ Defined in: [realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeTurnDetectionConfiguration.ts#L10)
57
57
 
58
58
  Voice activity detection strategy.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceRealtimeUsage
7
7
 
8
- Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:9
8
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L9)
9
9
 
10
10
  Normalized token usage reported by a realtime provider.
11
11
 
@@ -20,7 +20,7 @@ can therefore distinguish missing data from an actual zero-token count.
20
20
  readonly cachedInputTokens: number | null;
21
21
  ```
22
22
 
23
- Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:15
23
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L15)
24
24
 
25
25
  ***
26
26
 
@@ -30,7 +30,7 @@ Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:15
30
30
  readonly inputAudioTokens: number | null;
31
31
  ```
32
32
 
33
- Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:17
33
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L17)
34
34
 
35
35
  ***
36
36
 
@@ -40,7 +40,7 @@ Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:17
40
40
  readonly inputTextTokens: number | null;
41
41
  ```
42
42
 
43
- Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:16
43
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L16)
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:16
50
50
  readonly inputTokens: number | null;
51
51
  ```
52
52
 
53
- Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:12
53
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L12)
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:12
60
60
  readonly outputAudioTokens: number | null;
61
61
  ```
62
62
 
63
- Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:19
63
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L19)
64
64
 
65
65
  ***
66
66
 
@@ -70,7 +70,7 @@ Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:19
70
70
  readonly outputTextTokens: number | null;
71
71
  ```
72
72
 
73
- Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:18
73
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L18)
74
74
 
75
75
  ***
76
76
 
@@ -80,7 +80,7 @@ Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:18
80
80
  readonly outputTokens: number | null;
81
81
  ```
82
82
 
83
- Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:13
83
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L13)
84
84
 
85
85
  ***
86
86
 
@@ -90,7 +90,7 @@ Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:13
90
90
  readonly rawUsage: unknown;
91
91
  ```
92
92
 
93
- Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:20
93
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L20)
94
94
 
95
95
  ***
96
96
 
@@ -100,4 +100,4 @@ Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:20
100
100
  readonly totalTokens: number | null;
101
101
  ```
102
102
 
103
- Defined in: realtime/contracts/IIntelligenceRealtimeUsage.ts:14
103
+ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L14)
@@ -17,7 +17,7 @@ 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:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L56)
20
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L63)
21
21
 
22
22
  Files generated by provider-native tools such as image generation or code interpreter.
23
23
 
@@ -29,7 +29,7 @@ Files generated by provider-native tools such as image generation or code interp
29
29
  readonly optional finalStep?: StepResult<ToolSet, Record<string, unknown>>;
30
30
  ```
31
31
 
32
- Defined in: [contracts/IIntelligenceTextCompletion.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L84)
32
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L91)
33
33
 
34
34
  Final AI SDK generation step.
35
35
 
@@ -41,19 +41,31 @@ Final AI SDK generation step.
41
41
  readonly model: string;
42
42
  ```
43
43
 
44
- Defined in: [contracts/IIntelligenceTextCompletion.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L42)
44
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L49)
45
45
 
46
46
  The model identifier used for the completion.
47
47
 
48
48
  ***
49
49
 
50
+ ### output?
51
+
52
+ ```ts
53
+ readonly optional output?: unknown;
54
+ ```
55
+
56
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L35)
57
+
58
+ Generated output parsed according to the supplied AI SDK output specification.
59
+
60
+ ***
61
+
50
62
  ### provider
51
63
 
52
64
  ```ts
53
65
  readonly provider: string;
54
66
  ```
55
67
 
56
- Defined in: [contracts/IIntelligenceTextCompletion.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L35)
68
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L42)
57
69
 
58
70
  The provider that produced the completion.
59
71
 
@@ -65,7 +77,7 @@ The provider that produced the completion.
65
77
  readonly optional reasoning?: (ReasoningOutput | ReasoningFileOutput)[];
66
78
  ```
67
79
 
68
- Defined in: [contracts/IIntelligenceTextCompletion.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L63)
80
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L70)
69
81
 
70
82
  Reasoning parts reported by AI SDK 7 compatible models.
71
83
 
@@ -77,7 +89,7 @@ Reasoning parts reported by AI SDK 7 compatible models.
77
89
  readonly optional reasoningText?: string;
78
90
  ```
79
91
 
80
- Defined in: [contracts/IIntelligenceTextCompletion.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L70)
92
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L77)
81
93
 
82
94
  Concatenated reasoning text reported by the final generation step.
83
95
 
@@ -89,7 +101,7 @@ Concatenated reasoning text reported by the final generation step.
89
101
  readonly sources: readonly LanguageModelV4Source[];
90
102
  ```
91
103
 
92
- Defined in: [contracts/IIntelligenceTextCompletion.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L49)
104
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L56)
93
105
 
94
106
  Sources reported by provider-native tools such as web search.
95
107
 
@@ -101,7 +113,7 @@ Sources reported by provider-native tools such as web search.
101
113
  readonly optional steps?: StepResult<ToolSet, Record<string, unknown>>[];
102
114
  ```
103
115
 
104
- Defined in: [contracts/IIntelligenceTextCompletion.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L77)
116
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L84)
105
117
 
106
118
  All AI SDK generation steps.
107
119
 
@@ -125,7 +137,7 @@ The generated text content.
125
137
  readonly optional toolCalls?: TypedToolCall<ToolSet>[];
126
138
  ```
127
139
 
128
- Defined in: [contracts/IIntelligenceTextCompletion.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L91)
140
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L98)
129
141
 
130
142
  Tool calls produced across the generation.
131
143
 
@@ -137,7 +149,7 @@ Tool calls produced across the generation.
137
149
  readonly optional toolResults?: TypedToolResult<ToolSet>[];
138
150
  ```
139
151
 
140
- Defined in: [contracts/IIntelligenceTextCompletion.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L98)
152
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L105)
141
153
 
142
154
  Tool results produced across the generation.
143
155
 
@@ -151,7 +163,7 @@ readonly usage:
151
163
  | null;
152
164
  ```
153
165
 
154
- Defined in: [contracts/IIntelligenceTextCompletion.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L112)
166
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:119](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L119)
155
167
 
156
168
  Token usage telemetry, or `null` when the provider does not report usage.
157
169
 
@@ -163,6 +175,6 @@ Token usage telemetry, or `null` when the provider does not report usage.
163
175
  readonly optional warnings?: SharedV4Warning[];
164
176
  ```
165
177
 
166
- Defined in: [contracts/IIntelligenceTextCompletion.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L105)
178
+ Defined in: [contracts/IIntelligenceTextCompletion.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L112)
167
179
 
168
180
  Provider or model warnings reported by the AI SDK.
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: 'Type Alias: IIntelligencePromptModelRequirement'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IIntelligencePromptModelRequirement
7
+
8
+ ```ts
9
+ type IIntelligencePromptModelRequirement =
10
+ | {
11
+ strategy: "automatic";
12
+ }
13
+ | {
14
+ models: ReadonlyArray<string>;
15
+ strategy: "preferred";
16
+ }
17
+ | {
18
+ model: string | LanguageModel;
19
+ strategy: "fixed";
20
+ };
21
+ ```
22
+
23
+ Defined in: [prompts/IIntelligencePromptModelRequirement.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptModelRequirement.ts#L12)
24
+
25
+ Model selection requested by a reusable intelligence prompt.
@@ -0,0 +1,20 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptCapability'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptCapability
7
+
8
+ ```ts
9
+ type IntelligencePromptCapability =
10
+ | "textInput"
11
+ | "imageInput"
12
+ | "textOutput"
13
+ | "structuredOutput"
14
+ | "toolCalling"
15
+ | "reasoning";
16
+ ```
17
+
18
+ Defined in: [prompts/IntelligencePromptCapability.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptCapability.ts#L6)
19
+
20
+ Provider-neutral capability required by an intelligence prompt.
@@ -0,0 +1,29 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptDefinitionConfiguration\<TInput, TOutput\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptDefinitionConfiguration\<TInput, TOutput\>
7
+
8
+ ```ts
9
+ type IntelligencePromptDefinitionConfiguration<TInput, TOutput> =
10
+ | IIntelligencePromptDefinitionConfigurationBase<TInput> & {
11
+ mode: "text";
12
+ outputSchema?: never;
13
+ }
14
+ | IIntelligencePromptDefinitionConfigurationBase<TInput> & {
15
+ mode: "object";
16
+ outputSchema: FlexibleSchema<TOutput>;
17
+ };
18
+ ```
19
+
20
+ Defined in: [prompts/IntelligencePromptDefinitionConfiguration.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptDefinitionConfiguration.ts#L23)
21
+
22
+ Configuration accepted by [intelligencePrompt](Function.intelligencePrompt).
23
+
24
+ ## Type Parameters
25
+
26
+ | Type Parameter |
27
+ | ------ |
28
+ | `TInput` |
29
+ | `TOutput` |
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptGenerationOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptGenerationOptions
7
+
8
+ ```ts
9
+ type IntelligencePromptGenerationOptions = Omit<IIntelligenceTextGenerationOptions, "output">;
10
+ ```
11
+
12
+ Defined in: [prompts/IntelligencePromptGenerationOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptGenerationOptions.ts#L14)
13
+
14
+ Native generation settings that can be stored on a prompt definition.
15
+
16
+ The output contract is owned by the prompt mode and cannot be overridden.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptLatency'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptLatency
7
+
8
+ ```ts
9
+ type IntelligencePromptLatency = "interactive" | "standard" | "background";
10
+ ```
11
+
12
+ Defined in: [prompts/IntelligencePromptLatency.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptLatency.ts#L6)
13
+
14
+ Latency profile requested by an intelligence prompt.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptMode'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptMode
7
+
8
+ ```ts
9
+ type IntelligencePromptMode = "text" | "object";
10
+ ```
11
+
12
+ Defined in: [prompts/IntelligencePromptMode.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptMode.ts#L6)
13
+
14
+ Supported execution modes for reusable intelligence prompts.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptQuality'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptQuality
7
+
8
+ ```ts
9
+ type IntelligencePromptQuality = "economy" | "balanced" | "capable" | "premium";
10
+ ```
11
+
12
+ Defined in: [prompts/IntelligencePromptQuality.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptQuality.ts#L6)
13
+
14
+ Provider-neutral model quality requested by an intelligence prompt.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Type Alias: IntelligencePromptReasoning'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Type Alias: IntelligencePromptReasoning
7
+
8
+ ```ts
9
+ type IntelligencePromptReasoning = "none" | "minimal" | "low" | "medium" | "high";
10
+ ```
11
+
12
+ Defined in: [prompts/IntelligencePromptReasoning.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptReasoning.ts#L6)
13
+
14
+ Provider-neutral reasoning effort requested by an intelligence prompt.
@@ -59,6 +59,6 @@ type IntelligenceRealtimeClientEvent =
59
59
  };
60
60
  ```
61
61
 
62
- Defined in: realtime/contracts/IntelligenceRealtimeClientEvent.ts:12
62
+ Defined in: [realtime/contracts/IntelligenceRealtimeClientEvent.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeClientEvent.ts#L12)
63
63
 
64
64
  Provider-neutral event sent from an application to a realtime model.
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type IntelligenceRealtimeMetadataValue = string | number | boolean | null;
10
10
  ```
11
11
 
12
- Defined in: realtime/contracts/IntelligenceRealtimeMetadataValue.ts:6
12
+ Defined in: [realtime/contracts/IntelligenceRealtimeMetadataValue.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeMetadataValue.ts#L6)
13
13
 
14
14
  Serializable metadata copied into realtime metering events.
@@ -34,7 +34,7 @@ type IntelligenceRealtimeMeteringEvent =
34
34
  };
35
35
  ```
36
36
 
37
- Defined in: realtime/contracts/IntelligenceRealtimeMeteringEvent.ts:44
37
+ Defined in: [realtime/contracts/IntelligenceRealtimeMeteringEvent.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeMeteringEvent.ts#L44)
38
38
 
39
39
  Durable metering event emitted by an Archipel realtime session.
40
40
 
@@ -9,7 +9,7 @@ editUrl: false
9
9
  type IntelligenceRealtimeModelLoader = (configuration, options) => Promise<RealtimeModelV4>;
10
10
  ```
11
11
 
12
- Defined in: providers/IntelligenceRealtimeModelLoader.ts:14
12
+ Defined in: [providers/IntelligenceRealtimeModelLoader.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceRealtimeModelLoader.ts#L14)
13
13
 
14
14
  Creates a configured Vercel AI SDK realtime model behind the Archipel facade.
15
15
 
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type IntelligenceRealtimeModelLoaders = Partial<Record<IntelligenceProviderName, IntelligenceRealtimeModelLoader>>;
10
10
  ```
11
11
 
12
- Defined in: providers/IntelligenceRealtimeModelLoaders.ts:13
12
+ Defined in: [providers/IntelligenceRealtimeModelLoaders.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceRealtimeModelLoaders.ts#L13)
13
13
 
14
14
  Maps configured intelligence providers to tree-shakable realtime model loaders.
@@ -150,7 +150,7 @@ type IntelligenceRealtimeServerEvent =
150
150
  };
151
151
  ```
152
152
 
153
- Defined in: realtime/contracts/IntelligenceRealtimeServerEvent.ts:10
153
+ Defined in: [realtime/contracts/IntelligenceRealtimeServerEvent.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeServerEvent.ts#L10)
154
154
 
155
155
  Provider-neutral event emitted by a realtime model.
156
156
 
@@ -9,6 +9,6 @@ editUrl: false
9
9
  type IntelligenceRealtimeStatus = "idle" | "connecting" | "connected" | "closing" | "closed" | "error";
10
10
  ```
11
11
 
12
- Defined in: realtime/contracts/IntelligenceRealtimeStatus.ts:6
12
+ Defined in: [realtime/contracts/IntelligenceRealtimeStatus.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeStatus.ts#L6)
13
13
 
14
14
  Describes the lifecycle state of an upstream realtime model connection.
@@ -9,12 +9,15 @@ editUrl: false
9
9
 
10
10
  | Class | Description |
11
11
  | ------ | ------ |
12
+ | [DefaultIntelligencePromptPolicyAdapter](Class.DefaultIntelligencePromptPolicyAdapter) | Default prompt policy that supports native settings and automatic model selection. |
12
13
  | [IntelligenceAgentFactory](Class.IntelligenceAgentFactory) | Creates AI SDK 7 tool-loop agents with platform-registered tools merged in. |
13
14
  | [IntelligenceConfigurationError](Class.IntelligenceConfigurationError) | Error thrown when an intelligence provider configuration is invalid or missing. |
14
15
  | [IntelligenceEmbeddingGenerator](Class.IntelligenceEmbeddingGenerator) | Executes AI SDK embedding operations. |
15
16
  | [IntelligenceHealthIndicator](Class.IntelligenceHealthIndicator) | Health indicator for the intelligence infrastructure. Verifies that the intelligence provider configuration can be resolved. |
16
17
  | [IntelligenceMediaGenerator](Class.IntelligenceMediaGenerator) | Executes AI SDK media generation and understanding operations. |
17
18
  | [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure. |
19
+ | [IntelligencePromptExecutor](Class.IntelligencePromptExecutor) | Validates and executes reusable intelligence prompt invocations. |
20
+ | [IntelligencePromptPolicyPort](Class.IntelligencePromptPolicyPort) | Resolves provider-neutral prompt requirements into effective generation settings. |
18
21
  | [IntelligenceProviderAssetUploader](Class.IntelligenceProviderAssetUploader) | Uploads provider-managed files and skills for reuse in AI SDK calls. |
19
22
  | [IntelligenceProviderError](Class.IntelligenceProviderError) | Error thrown when an intelligence provider call fails. |
20
23
  | [IntelligenceRealtimeError](Class.IntelligenceRealtimeError) | Error raised by a realtime session, transport, or metering adapter. |
@@ -34,6 +37,14 @@ editUrl: false
34
37
  | ------ | ------ |
35
38
  | [IIntelligenceCompletionUsage](Interface.IIntelligenceCompletionUsage) | Captures usage telemetry returned by the intelligence provider. |
36
39
  | [IIntelligenceModuleOptions](Interface.IIntelligenceModuleOptions) | Options for configuring the intelligence module. |
40
+ | [IIntelligencePromptDefinition](Interface.IIntelligencePromptDefinition) | Reusable, immutable definition of an intelligence prompt. |
41
+ | [IIntelligencePromptEffectivePolicy](Interface.IIntelligencePromptEffectivePolicy) | Effective settings resolved for one prompt execution. |
42
+ | [IIntelligencePromptExecutionContext](Interface.IIntelligencePromptExecutionContext) | Application context made available to prompt policy adapters. |
43
+ | [IIntelligencePromptExecutionPolicy](Interface.IIntelligencePromptExecutionPolicy) | Native settings and provider-neutral requirements declared by an intelligence prompt. |
44
+ | [IIntelligencePromptExecutionResult](Interface.IIntelligencePromptExecutionResult) | Normalized result of an intelligence prompt execution. |
45
+ | [IIntelligencePromptInvocation](Interface.IIntelligencePromptInvocation) | Bound prompt definition ready for execution. |
46
+ | [IIntelligencePromptPolicyRequest](Interface.IIntelligencePromptPolicyRequest) | Policy resolution request for one prompt invocation. |
47
+ | [IIntelligencePromptRenderContext](Interface.IIntelligencePromptRenderContext) | Input exposed to pure prompt rendering functions. |
37
48
  | [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration) | Describes the resolved configuration for the intelligence provider. |
38
49
  | [IIntelligenceRealtimeAudioFormat](Interface.IIntelligenceRealtimeAudioFormat) | Provider-neutral audio format configuration. |
39
50
  | [IIntelligenceRealtimeCloseEvent](Interface.IIntelligenceRealtimeCloseEvent) | Describes why an upstream realtime connection closed. |
@@ -55,8 +66,16 @@ editUrl: false
55
66
 
56
67
  | Type Alias | Description |
57
68
  | ------ | ------ |
69
+ | [IIntelligencePromptModelRequirement](TypeAlias.IIntelligencePromptModelRequirement) | Model selection requested by a reusable intelligence prompt. |
58
70
  | [IntelligenceLanguageModelLoader](TypeAlias.IntelligenceLanguageModelLoader) | Represents a factory responsible for creating a configured language model instance. |
59
71
  | [IntelligenceLanguageModelLoaders](TypeAlias.IntelligenceLanguageModelLoaders) | Maps configured intelligence providers to their tree-shakable model loader. |
72
+ | [IntelligencePromptCapability](TypeAlias.IntelligencePromptCapability) | Provider-neutral capability required by an intelligence prompt. |
73
+ | [IntelligencePromptDefinitionConfiguration](TypeAlias.IntelligencePromptDefinitionConfiguration) | Configuration accepted by [intelligencePrompt](Function.intelligencePrompt). |
74
+ | [IntelligencePromptGenerationOptions](TypeAlias.IntelligencePromptGenerationOptions) | Native generation settings that can be stored on a prompt definition. |
75
+ | [IntelligencePromptLatency](TypeAlias.IntelligencePromptLatency) | Latency profile requested by an intelligence prompt. |
76
+ | [IntelligencePromptMode](TypeAlias.IntelligencePromptMode) | Supported execution modes for reusable intelligence prompts. |
77
+ | [IntelligencePromptQuality](TypeAlias.IntelligencePromptQuality) | Provider-neutral model quality requested by an intelligence prompt. |
78
+ | [IntelligencePromptReasoning](TypeAlias.IntelligencePromptReasoning) | Provider-neutral reasoning effort requested by an intelligence prompt. |
60
79
  | [IntelligenceProviderName](TypeAlias.IntelligenceProviderName) | Represents the union of supported intelligence provider identifiers. |
61
80
  | [IntelligenceRealtimeClientEvent](TypeAlias.IntelligenceRealtimeClientEvent) | Provider-neutral event sent from an application to a realtime model. |
62
81
  | [IntelligenceRealtimeMetadataValue](TypeAlias.IntelligenceRealtimeMetadataValue) | Serializable metadata copied into realtime metering events. |
@@ -155,6 +174,7 @@ editUrl: false
155
174
  | [createOpenAIWebSearchPreviewTool](Function.createOpenAIWebSearchPreviewTool) | Creates an OpenAI web-search-preview tool registration. |
156
175
  | [createOpenAIWebSearchTool](Function.createOpenAIWebSearchTool) | Creates an OpenAI web-search tool registration. |
157
176
  | [createProviderOptions](Function.createProviderOptions) | Creates the provider options object consumed by the AI SDK model factories. |
177
+ | [intelligencePrompt](Function.intelligencePrompt) | Creates a reusable intelligence prompt definition. |
158
178
  | [loadAnthropicLanguageModel](Function.loadAnthropicLanguageModel) | Creates the Anthropic language model from the resolved provider configuration. |
159
179
  | [loadGoogleLanguageModel](Function.loadGoogleLanguageModel) | Creates the Google Gemini language model from the resolved provider configuration. |
160
180
  | [loadGoogleRealtimeModel](Function.loadGoogleRealtimeModel) | Creates a Google Gemini Live model exclusively through the Vercel AI SDK provider. |