@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
@@ -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)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceRealtimeAudioFormat
7
7
 
8
- Defined in: realtime/contracts/IIntelligenceRealtimeAudioFormat.ts:6
8
+ Defined in: [realtime/contracts/IIntelligenceRealtimeAudioFormat.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeAudioFormat.ts#L6)
9
9
 
10
10
  Provider-neutral audio format configuration.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral audio format configuration.
17
17
  readonly optional rate?: number;
18
18
  ```
19
19
 
20
- Defined in: realtime/contracts/IIntelligenceRealtimeAudioFormat.ts:13
20
+ Defined in: [realtime/contracts/IIntelligenceRealtimeAudioFormat.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeAudioFormat.ts#L13)
21
21
 
22
22
  Sample rate in Hertz when the format requires one.
23
23
 
@@ -29,6 +29,6 @@ Sample rate in Hertz when the format requires one.
29
29
  readonly type: string;
30
30
  ```
31
31
 
32
- Defined in: realtime/contracts/IIntelligenceRealtimeAudioFormat.ts:10
32
+ Defined in: [realtime/contracts/IIntelligenceRealtimeAudioFormat.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeAudioFormat.ts#L10)
33
33
 
34
34
  MIME-style audio format identifier such as `audio/pcm`.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceRealtimeCloseEvent
7
7
 
8
- Defined in: realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:6
8
+ Defined in: [realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeCloseEvent.ts#L6)
9
9
 
10
10
  Describes why an upstream realtime connection closed.
11
11
 
@@ -17,7 +17,7 @@ Describes why an upstream realtime connection closed.
17
17
  readonly clean: boolean;
18
18
  ```
19
19
 
20
- Defined in: realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:11
20
+ Defined in: [realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeCloseEvent.ts#L11)
21
21
 
22
22
  ***
23
23
 
@@ -27,7 +27,7 @@ Defined in: realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:11
27
27
  readonly code: number;
28
28
  ```
29
29
 
30
- Defined in: realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:9
30
+ Defined in: [realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeCloseEvent.ts#L9)
31
31
 
32
32
  ***
33
33
 
@@ -37,4 +37,4 @@ Defined in: realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:9
37
37
  readonly reason: string;
38
38
  ```
39
39
 
40
- Defined in: realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:10
40
+ Defined in: [realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeCloseEvent.ts#L10)
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceRealtimeModuleOptions
7
7
 
8
- Defined in: realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:14
8
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L14)
9
9
 
10
10
  Module-level resilience and resource limits for realtime intelligence.
11
11
 
@@ -17,7 +17,7 @@ Module-level resilience and resource limits for realtime intelligence.
17
17
  readonly optional closeTimeoutMs?: number;
18
18
  ```
19
19
 
20
- Defined in: realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:36
20
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L36)
21
21
 
22
22
  Graceful close timeout, capped at five seconds.
23
23
 
@@ -29,7 +29,7 @@ Graceful close timeout, capped at five seconds.
29
29
  readonly optional connectionTimeoutMs?: number;
30
30
  ```
31
31
 
32
- Defined in: realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:33
32
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L33)
33
33
 
34
34
  Provider token and WebSocket connection timeout, capped at five seconds.
35
35
 
@@ -41,7 +41,7 @@ Provider token and WebSocket connection timeout, capped at five seconds.
41
41
  readonly optional maxActiveSessions?: number;
42
42
  ```
43
43
 
44
- Defined in: realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:24
44
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L24)
45
45
 
46
46
  Maximum simultaneous upstream sessions. Defaults to 1,000.
47
47
 
@@ -53,7 +53,7 @@ Maximum simultaneous upstream sessions. Defaults to 1,000.
53
53
  readonly optional maxBufferedBytes?: number;
54
54
  ```
55
55
 
56
- Defined in: realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:30
56
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L30)
57
57
 
58
58
  Maximum upstream WebSocket buffered bytes. Defaults to 4 MiB.
59
59
 
@@ -65,7 +65,7 @@ Maximum upstream WebSocket buffered bytes. Defaults to 4 MiB.
65
65
  readonly optional maxPendingEvents?: number;
66
66
  ```
67
67
 
68
- Defined in: realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:27
68
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L27)
69
69
 
70
70
  Maximum queued inbound or outbound events per session. Defaults to 512.
71
71
 
@@ -79,7 +79,7 @@ readonly optional meteringAdapter?:
79
79
  | Type<IntelligenceRealtimeMeteringPort>;
80
80
  ```
81
81
 
82
- Defined in: realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:21
82
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L21)
83
83
 
84
84
  Application adapter that persists metering and audit events.
85
85
 
@@ -91,7 +91,7 @@ Application adapter that persists metering and audit events.
91
91
  readonly optional meteringIntervalMs?: number;
92
92
  ```
93
93
 
94
- Defined in: realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:39
94
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L39)
95
95
 
96
96
  Provider-independent billing interval. Defaults to 30 seconds.
97
97
 
@@ -103,7 +103,7 @@ Provider-independent billing interval. Defaults to 30 seconds.
103
103
  readonly optional providerLoaders?: Partial<Record<IntelligenceProviderName, IntelligenceRealtimeModelLoader>>;
104
104
  ```
105
105
 
106
- Defined in: realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:18
106
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L18)
107
107
 
108
108
  Tree-shakable realtime model loaders keyed by provider.
109
109
 
@@ -115,6 +115,6 @@ Tree-shakable realtime model loaders keyed by provider.
115
115
  readonly optional tokenRequestMaxRetries?: number;
116
116
  ```
117
117
 
118
- Defined in: realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:42
118
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeModuleOptions.ts#L42)
119
119
 
120
120
  Transient token request retries, capped at two.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceRealtimeSessionConfiguration
7
7
 
8
- Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:18
8
+ Defined in: [realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts#L18)
9
9
 
10
10
  Provider-neutral configuration for a realtime AI session.
11
11
 
@@ -20,7 +20,7 @@ exposing the AI SDK's experimental realtime types to applications.
20
20
  readonly optional inputAudioFormat?: IIntelligenceRealtimeAudioFormat;
21
21
  ```
22
22
 
23
- Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:31
23
+ Defined in: [realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts#L31)
24
24
 
25
25
  Input audio format.
26
26
 
@@ -32,7 +32,7 @@ Input audio format.
32
32
  readonly optional inputAudioTranscription?: IIntelligenceRealtimeTranscriptionConfiguration;
33
33
  ```
34
34
 
35
- Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:34
35
+ Defined in: [realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts#L34)
36
36
 
37
37
  Optional input transcription settings.
38
38
 
@@ -44,7 +44,7 @@ Optional input transcription settings.
44
44
  readonly optional instructions?: string;
45
45
  ```
46
46
 
47
- Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:22
47
+ Defined in: [realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts#L22)
48
48
 
49
49
  System instructions for the model.
50
50
 
@@ -56,7 +56,7 @@ System instructions for the model.
56
56
  readonly optional outputAudioFormat?: IIntelligenceRealtimeAudioFormat;
57
57
  ```
58
58
 
59
- Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:40
59
+ Defined in: [realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts#L40)
60
60
 
61
61
  Output audio format.
62
62
 
@@ -68,7 +68,7 @@ Output audio format.
68
68
  readonly optional outputAudioTranscription?: IIntelligenceRealtimeTranscriptionConfiguration;
69
69
  ```
70
70
 
71
- Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:37
71
+ Defined in: [realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts#L37)
72
72
 
73
73
  Optional spoken-output transcription settings.
74
74
 
@@ -80,7 +80,7 @@ Optional spoken-output transcription settings.
80
80
  readonly optional outputModalities?: readonly ("text" | "audio")[];
81
81
  ```
82
82
 
83
- Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:28
83
+ Defined in: [realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts#L28)
84
84
 
85
85
  Modalities the model may produce.
86
86
 
@@ -92,7 +92,7 @@ Modalities the model may produce.
92
92
  readonly optional providerOptions?: Readonly<Record<string, unknown>>;
93
93
  ```
94
94
 
95
- Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:49
95
+ Defined in: [realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts#L49)
96
96
 
97
97
  Provider-specific escape hatch retained inside the Archipel boundary.
98
98
 
@@ -104,7 +104,7 @@ Provider-specific escape hatch retained inside the Archipel boundary.
104
104
  readonly optional tools?: readonly IIntelligenceRealtimeToolDefinition[];
105
105
  ```
106
106
 
107
- Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:46
107
+ Defined in: [realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts#L46)
108
108
 
109
109
  Explicit tool definitions. Registered Archipel tools are used when omitted.
110
110
 
@@ -118,7 +118,7 @@ readonly optional turnDetection?:
118
118
  | null;
119
119
  ```
120
120
 
121
- Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:43
121
+ Defined in: [realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts#L43)
122
122
 
123
123
  Voice activity detection settings, or `null` for push-to-talk.
124
124
 
@@ -130,6 +130,6 @@ Voice activity detection settings, or `null` for push-to-talk.
130
130
  readonly optional voice?: string;
131
131
  ```
132
132
 
133
- Defined in: realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:25
133
+ Defined in: [realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeSessionConfiguration.ts#L25)
134
134
 
135
135
  Provider voice identifier for spoken model output.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceRealtimeSessionOptions
7
7
 
8
- Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:16
8
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L16)
9
9
 
10
10
  Options used to create one server-owned realtime model connection.
11
11
 
@@ -17,7 +17,7 @@ Options used to create one server-owned realtime model connection.
17
17
  readonly optional activeToolNames?: readonly string[];
18
18
  ```
19
19
 
20
- Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:32
20
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L32)
21
21
 
22
22
  Optional allow-list of registered Archipel tools exposed to this session.
23
23
 
@@ -29,7 +29,7 @@ Optional allow-list of registered Archipel tools exposed to this session.
29
29
  readonly optional metadata?: Readonly<Record<string, IntelligenceRealtimeMetadataValue>>;
30
30
  ```
31
31
 
32
- Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:35
32
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L35)
33
33
 
34
34
  Bounded, non-sensitive correlation metadata copied to metering events.
35
35
 
@@ -41,7 +41,7 @@ Bounded, non-sensitive correlation metadata copied to metering events.
41
41
  readonly model: string;
42
42
  ```
43
43
 
44
- Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:23
44
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L23)
45
45
 
46
46
  Realtime model identifier such as `gpt-realtime`.
47
47
 
@@ -53,7 +53,7 @@ Realtime model identifier such as `gpt-realtime`.
53
53
  readonly optional onClose?: (event) => void | Promise<void>;
54
54
  ```
55
55
 
56
- Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:44
56
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L44)
57
57
 
58
58
  Receives the terminal upstream connection state.
59
59
 
@@ -75,7 +75,7 @@ Receives the terminal upstream connection state.
75
75
  readonly optional onError?: (error) => void | Promise<void>;
76
76
  ```
77
77
 
78
- Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:41
78
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L41)
79
79
 
80
80
  Receives transport, provider, parsing, and metering adapter failures.
81
81
 
@@ -97,7 +97,7 @@ Receives transport, provider, parsing, and metering adapter failures.
97
97
  readonly optional onEvent?: (event) => void | Promise<void>;
98
98
  ```
99
99
 
100
- Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:38
100
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L38)
101
101
 
102
102
  Receives normalized provider events in wire order.
103
103
 
@@ -119,7 +119,7 @@ Receives normalized provider events in wire order.
119
119
  readonly optional provider?: IntelligenceProviderName;
120
120
  ```
121
121
 
122
- Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:26
122
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L26)
123
123
 
124
124
  Optional provider override. Defaults to the configured intelligence provider.
125
125
 
@@ -131,7 +131,7 @@ Optional provider override. Defaults to the configured intelligence provider.
131
131
  readonly optional sessionConfiguration?: IIntelligenceRealtimeSessionConfiguration;
132
132
  ```
133
133
 
134
- Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:29
134
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L29)
135
135
 
136
136
  Provider-neutral realtime session configuration.
137
137
 
@@ -143,6 +143,6 @@ Provider-neutral realtime session configuration.
143
143
  readonly sessionId: string;
144
144
  ```
145
145
 
146
- Defined in: realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:20
146
+ Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L20)
147
147
 
148
148
  Application-owned identifier used for persistence, billing, and audit correlation.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Interface: IIntelligenceRealtimeToolDefinition
7
7
 
8
- Defined in: realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:6
8
+ Defined in: [realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeToolDefinition.ts#L6)
9
9
 
10
10
  Provider-neutral function definition exposed to a realtime model.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral function definition exposed to a realtime model.
17
17
  readonly optional description?: string;
18
18
  ```
19
19
 
20
- Defined in: realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:16
20
+ Defined in: [realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeToolDefinition.ts#L16)
21
21
 
22
22
  Optional model-facing description.
23
23
 
@@ -29,7 +29,7 @@ Optional model-facing description.
29
29
  readonly name: string;
30
30
  ```
31
31
 
32
- Defined in: realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:13
32
+ Defined in: [realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeToolDefinition.ts#L13)
33
33
 
34
34
  Unique tool name within the session.
35
35
 
@@ -41,7 +41,7 @@ Unique tool name within the session.
41
41
  readonly parameters: Record<string, unknown>;
42
42
  ```
43
43
 
44
- Defined in: realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:19
44
+ Defined in: [realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeToolDefinition.ts#L19)
45
45
 
46
46
  JSON Schema describing the function parameters.
47
47
 
@@ -53,6 +53,6 @@ JSON Schema describing the function parameters.
53
53
  readonly type: "function";
54
54
  ```
55
55
 
56
- Defined in: realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:10
56
+ Defined in: [realtime/contracts/IIntelligenceRealtimeToolDefinition.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeToolDefinition.ts#L10)
57
57
 
58
58
  Tool kind.