@breadstone/archipel-mcp 0.0.52 → 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 (59) hide show
  1. package/data/guides/ai-realtime-voice.md +506 -0
  2. package/data/guides/ai-text-generation.md +9 -0
  3. package/data/guides/health-indicators.md +12 -3
  4. package/data/guides/index.md +6 -4
  5. package/data/guides/intelligence-prompts-warm-up.md +358 -0
  6. package/data/packages/platform-health/index.md +1 -1
  7. package/data/packages/platform-intelligence/api/Class.DefaultIntelligencePromptPolicyAdapter.md +54 -0
  8. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +6 -5
  9. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  10. package/data/packages/platform-intelligence/api/Class.IntelligencePromptExecutor.md +88 -0
  11. package/data/packages/platform-intelligence/api/Class.IntelligencePromptPolicyPort.md +48 -0
  12. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +110 -0
  13. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +47 -0
  14. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +129 -0
  15. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +308 -0
  16. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +6 -6
  17. package/data/packages/platform-intelligence/api/Function.intelligencePrompt.md +31 -0
  18. package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +25 -0
  19. package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +25 -0
  20. package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +25 -0
  21. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +30 -6
  22. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptDefinition.md +145 -0
  23. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md +30 -0
  24. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionContext.md +20 -0
  25. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md +70 -0
  26. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md +139 -0
  27. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptInvocation.md +49 -0
  28. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptPolicyRequest.md +60 -0
  29. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptRenderContext.md +26 -0
  30. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeAudioFormat.md +34 -0
  31. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeCloseEvent.md +40 -0
  32. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +120 -0
  33. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionConfiguration.md +135 -0
  34. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +148 -0
  35. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeToolDefinition.md +58 -0
  36. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTranscriptionConfiguration.md +46 -0
  37. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTurnDetectionConfiguration.md +58 -0
  38. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +103 -0
  39. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +24 -12
  40. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligencePromptModelRequirement.md +25 -0
  41. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptCapability.md +20 -0
  42. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptDefinitionConfiguration.md +29 -0
  43. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md +16 -0
  44. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptLatency.md +14 -0
  45. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptMode.md +14 -0
  46. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptQuality.md +14 -0
  47. package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptReasoning.md +14 -0
  48. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md +64 -0
  49. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md +14 -0
  50. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +44 -0
  51. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +25 -0
  52. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +14 -0
  53. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeServerEvent.md +159 -0
  54. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeStatus.md +14 -0
  55. package/data/packages/platform-intelligence/api/index.md +43 -0
  56. package/data/packages/platform-intelligence/index.md +211 -7
  57. package/data/patterns/index.md +1 -0
  58. package/data/patterns/realtime-session-pattern.md +309 -0
  59. package/package.json +1 -1
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: 'Function: loadGrokRealtimeModel()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: loadGrokRealtimeModel()
7
+
8
+ ```ts
9
+ function loadGrokRealtimeModel(configuration, options): Promise<RealtimeModelV4>;
10
+ ```
11
+
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
+
14
+ Creates an xAI Grok voice model exclusively through the Vercel AI SDK provider.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type |
19
+ | ------ | ------ |
20
+ | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
21
+ | `options` | `IIntelligenceRealtimeModelLoaderOptions` |
22
+
23
+ ## Returns
24
+
25
+ `Promise`\<`RealtimeModelV4`\>
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: 'Function: loadOpenAIRealtimeModel()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Function: loadOpenAIRealtimeModel()
7
+
8
+ ```ts
9
+ function loadOpenAIRealtimeModel(configuration, options): Promise<RealtimeModelV4>;
10
+ ```
11
+
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
+
14
+ Creates an OpenAI realtime model exclusively through the Vercel AI SDK provider.
15
+
16
+ ## Parameters
17
+
18
+ | Parameter | Type |
19
+ | ------ | ------ |
20
+ | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
21
+ | `options` | `IIntelligenceRealtimeModelLoaderOptions` |
22
+
23
+ ## Returns
24
+
25
+ `Promise`\<`RealtimeModelV4`\>
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceModuleOptions
7
7
 
8
- Defined in: [interfaces/IIntelligenceModuleOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L15)
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:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L30)
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:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L57)
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:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L40)
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
 
@@ -50,6 +62,18 @@ Import these from provider-specific subpaths such as
50
62
 
51
63
  ***
52
64
 
65
+ ### realtime?
66
+
67
+ ```ts
68
+ readonly optional realtime?: IIntelligenceRealtimeModuleOptions;
69
+ ```
70
+
71
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L49)
72
+
73
+ Server-owned realtime model sessions, resilience limits, and metering.
74
+
75
+ ***
76
+
53
77
  ### tools?
54
78
 
55
79
  ```ts
@@ -60,7 +84,7 @@ readonly optional tools?: readonly (
60
84
  | Provider<IIntelligenceTool>)[];
61
85
  ```
62
86
 
63
- Defined in: [interfaces/IIntelligenceModuleOptions.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L23)
87
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L25)
64
88
 
65
89
  Tool instances, tool factory promises, class providers, or custom Nest providers registered at bootstrap.
66
90
 
@@ -72,7 +96,7 @@ Tool instances, tool factory promises, class providers, or custom Nest providers
72
96
  readonly optional validateOnModuleInit?: boolean;
73
97
  ```
74
98
 
75
- Defined in: [interfaces/IIntelligenceModuleOptions.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L50)
99
+ Defined in: [interfaces/IIntelligenceModuleOptions.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L59)
76
100
 
77
101
  When `true`, provider configuration is resolved during module initialization.
78
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`\>
@@ -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)
@@ -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)
@@ -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)
@@ -0,0 +1,139 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptExecutionResult\<TOutput, TMetadata\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptExecutionResult\<TOutput, TMetadata\>
7
+
8
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L15)
9
+
10
+ Normalized result of an intelligence prompt execution.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter | Default type |
15
+ | ------ | ------ |
16
+ | `TOutput` | - |
17
+ | `TMetadata` | `undefined` |
18
+
19
+ ## Properties
20
+
21
+ ### effectivePolicy
22
+
23
+ ```ts
24
+ readonly effectivePolicy: IIntelligencePromptEffectivePolicy;
25
+ ```
26
+
27
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L32)
28
+
29
+ ***
30
+
31
+ ### finishReason?
32
+
33
+ ```ts
34
+ readonly optional finishReason?: FinishReason;
35
+ ```
36
+
37
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L26)
38
+
39
+ ***
40
+
41
+ ### metadata
42
+
43
+ ```ts
44
+ readonly metadata: TMetadata | undefined;
45
+ ```
46
+
47
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L33)
48
+
49
+ ***
50
+
51
+ ### model
52
+
53
+ ```ts
54
+ readonly model: string;
55
+ ```
56
+
57
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L22)
58
+
59
+ ***
60
+
61
+ ### output
62
+
63
+ ```ts
64
+ readonly output: TOutput;
65
+ ```
66
+
67
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L18)
68
+
69
+ ***
70
+
71
+ ### promptName
72
+
73
+ ```ts
74
+ readonly promptName: string;
75
+ ```
76
+
77
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L19)
78
+
79
+ ***
80
+
81
+ ### promptVersion
82
+
83
+ ```ts
84
+ readonly promptVersion: number;
85
+ ```
86
+
87
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L20)
88
+
89
+ ***
90
+
91
+ ### provider
92
+
93
+ ```ts
94
+ readonly provider: string;
95
+ ```
96
+
97
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L21)
98
+
99
+ ***
100
+
101
+ ### reasoning
102
+
103
+ ```ts
104
+ readonly reasoning: (ReasoningOutput | ReasoningFileOutput)[] | undefined;
105
+ ```
106
+
107
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L24)
108
+
109
+ ***
110
+
111
+ ### reasoningText?
112
+
113
+ ```ts
114
+ readonly optional reasoningText?: string;
115
+ ```
116
+
117
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L25)
118
+
119
+ ***
120
+
121
+ ### requestedPolicy
122
+
123
+ ```ts
124
+ readonly requestedPolicy: IIntelligencePromptExecutionPolicy;
125
+ ```
126
+
127
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L31)
128
+
129
+ ***
130
+
131
+ ### usage
132
+
133
+ ```ts
134
+ readonly usage:
135
+ | IIntelligenceCompletionUsage
136
+ | null;
137
+ ```
138
+
139
+ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L23)
@@ -0,0 +1,49 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptInvocation\<TInput, TOutput, TMode, TMetadata\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptInvocation\<TInput, TOutput, TMode, TMetadata\>
7
+
8
+ Defined in: [prompts/IIntelligencePromptInvocation.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptInvocation.ts#L13)
9
+
10
+ Bound prompt definition ready for execution.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter | Default type |
15
+ | ------ | ------ |
16
+ | `TInput` | - |
17
+ | `TOutput` | - |
18
+ | `TMode` *extends* [`IntelligencePromptMode`](TypeAlias.IntelligencePromptMode) | - |
19
+ | `TMetadata` | `undefined` |
20
+
21
+ ## Properties
22
+
23
+ ### definition
24
+
25
+ ```ts
26
+ readonly definition: IIntelligencePromptDefinition<TInput, TOutput, TMode>;
27
+ ```
28
+
29
+ Defined in: [prompts/IIntelligencePromptInvocation.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptInvocation.ts#L16)
30
+
31
+ ***
32
+
33
+ ### input
34
+
35
+ ```ts
36
+ readonly input: Readonly<TInput>;
37
+ ```
38
+
39
+ Defined in: [prompts/IIntelligencePromptInvocation.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptInvocation.ts#L17)
40
+
41
+ ***
42
+
43
+ ### metadata
44
+
45
+ ```ts
46
+ readonly metadata: TMetadata | undefined;
47
+ ```
48
+
49
+ Defined in: [prompts/IIntelligencePromptInvocation.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptInvocation.ts#L18)
@@ -0,0 +1,60 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptPolicyRequest'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptPolicyRequest
7
+
8
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L14)
9
+
10
+ Policy resolution request for one prompt invocation.
11
+
12
+ ## Properties
13
+
14
+ ### context
15
+
16
+ ```ts
17
+ readonly context: IIntelligencePromptExecutionContext;
18
+ ```
19
+
20
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L21)
21
+
22
+ ***
23
+
24
+ ### mode
25
+
26
+ ```ts
27
+ readonly mode: IntelligencePromptMode;
28
+ ```
29
+
30
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L19)
31
+
32
+ ***
33
+
34
+ ### promptName
35
+
36
+ ```ts
37
+ readonly promptName: string;
38
+ ```
39
+
40
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L17)
41
+
42
+ ***
43
+
44
+ ### promptVersion
45
+
46
+ ```ts
47
+ readonly promptVersion: number;
48
+ ```
49
+
50
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L18)
51
+
52
+ ***
53
+
54
+ ### requestedPolicy
55
+
56
+ ```ts
57
+ readonly requestedPolicy: IIntelligencePromptExecutionPolicy;
58
+ ```
59
+
60
+ Defined in: [prompts/IIntelligencePromptPolicyRequest.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptPolicyRequest.ts#L20)
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: 'Interface: IIntelligencePromptRenderContext\<TInput\>'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligencePromptRenderContext\<TInput\>
7
+
8
+ Defined in: [prompts/IIntelligencePromptRenderContext.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptRenderContext.ts#L6)
9
+
10
+ Input exposed to pure prompt rendering functions.
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter |
15
+ | ------ |
16
+ | `TInput` |
17
+
18
+ ## Properties
19
+
20
+ ### input
21
+
22
+ ```ts
23
+ readonly input: Readonly<TInput>;
24
+ ```
25
+
26
+ Defined in: [prompts/IIntelligencePromptRenderContext.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptRenderContext.ts#L9)