@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,34 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceRealtimeAudioFormat'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceRealtimeAudioFormat
7
+
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
+
10
+ Provider-neutral audio format configuration.
11
+
12
+ ## Properties
13
+
14
+ ### rate?
15
+
16
+ ```ts
17
+ readonly optional rate?: number;
18
+ ```
19
+
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
+
22
+ Sample rate in Hertz when the format requires one.
23
+
24
+ ***
25
+
26
+ ### type
27
+
28
+ ```ts
29
+ readonly type: string;
30
+ ```
31
+
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
+
34
+ MIME-style audio format identifier such as `audio/pcm`.
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceRealtimeCloseEvent'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceRealtimeCloseEvent
7
+
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
+
10
+ Describes why an upstream realtime connection closed.
11
+
12
+ ## Properties
13
+
14
+ ### clean
15
+
16
+ ```ts
17
+ readonly clean: boolean;
18
+ ```
19
+
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
+
22
+ ***
23
+
24
+ ### code
25
+
26
+ ```ts
27
+ readonly code: number;
28
+ ```
29
+
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
+
32
+ ***
33
+
34
+ ### reason
35
+
36
+ ```ts
37
+ readonly reason: string;
38
+ ```
39
+
40
+ Defined in: [realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeCloseEvent.ts#L10)
@@ -0,0 +1,120 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceRealtimeModuleOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceRealtimeModuleOptions
7
+
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
+
10
+ Module-level resilience and resource limits for realtime intelligence.
11
+
12
+ ## Properties
13
+
14
+ ### closeTimeoutMs?
15
+
16
+ ```ts
17
+ readonly optional closeTimeoutMs?: number;
18
+ ```
19
+
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
+
22
+ Graceful close timeout, capped at five seconds.
23
+
24
+ ***
25
+
26
+ ### connectionTimeoutMs?
27
+
28
+ ```ts
29
+ readonly optional connectionTimeoutMs?: number;
30
+ ```
31
+
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
+
34
+ Provider token and WebSocket connection timeout, capped at five seconds.
35
+
36
+ ***
37
+
38
+ ### maxActiveSessions?
39
+
40
+ ```ts
41
+ readonly optional maxActiveSessions?: number;
42
+ ```
43
+
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
+
46
+ Maximum simultaneous upstream sessions. Defaults to 1,000.
47
+
48
+ ***
49
+
50
+ ### maxBufferedBytes?
51
+
52
+ ```ts
53
+ readonly optional maxBufferedBytes?: number;
54
+ ```
55
+
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
+
58
+ Maximum upstream WebSocket buffered bytes. Defaults to 4 MiB.
59
+
60
+ ***
61
+
62
+ ### maxPendingEvents?
63
+
64
+ ```ts
65
+ readonly optional maxPendingEvents?: number;
66
+ ```
67
+
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
+
70
+ Maximum queued inbound or outbound events per session. Defaults to 512.
71
+
72
+ ***
73
+
74
+ ### meteringAdapter?
75
+
76
+ ```ts
77
+ readonly optional meteringAdapter?:
78
+ | IntelligenceRealtimeMeteringPort
79
+ | Type<IntelligenceRealtimeMeteringPort>;
80
+ ```
81
+
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
+
84
+ Application adapter that persists metering and audit events.
85
+
86
+ ***
87
+
88
+ ### meteringIntervalMs?
89
+
90
+ ```ts
91
+ readonly optional meteringIntervalMs?: number;
92
+ ```
93
+
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
+
96
+ Provider-independent billing interval. Defaults to 30 seconds.
97
+
98
+ ***
99
+
100
+ ### providerLoaders?
101
+
102
+ ```ts
103
+ readonly optional providerLoaders?: Partial<Record<IntelligenceProviderName, IntelligenceRealtimeModelLoader>>;
104
+ ```
105
+
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
+
108
+ Tree-shakable realtime model loaders keyed by provider.
109
+
110
+ ***
111
+
112
+ ### tokenRequestMaxRetries?
113
+
114
+ ```ts
115
+ readonly optional tokenRequestMaxRetries?: number;
116
+ ```
117
+
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
+
120
+ Transient token request retries, capped at two.
@@ -0,0 +1,135 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceRealtimeSessionConfiguration'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceRealtimeSessionConfiguration
7
+
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
+
10
+ Provider-neutral configuration for a realtime AI session.
11
+
12
+ This contract intentionally mirrors the stable Archipel surface instead of
13
+ exposing the AI SDK's experimental realtime types to applications.
14
+
15
+ ## Properties
16
+
17
+ ### inputAudioFormat?
18
+
19
+ ```ts
20
+ readonly optional inputAudioFormat?: IIntelligenceRealtimeAudioFormat;
21
+ ```
22
+
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
+
25
+ Input audio format.
26
+
27
+ ***
28
+
29
+ ### inputAudioTranscription?
30
+
31
+ ```ts
32
+ readonly optional inputAudioTranscription?: IIntelligenceRealtimeTranscriptionConfiguration;
33
+ ```
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
+
37
+ Optional input transcription settings.
38
+
39
+ ***
40
+
41
+ ### instructions?
42
+
43
+ ```ts
44
+ readonly optional instructions?: string;
45
+ ```
46
+
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
+
49
+ System instructions for the model.
50
+
51
+ ***
52
+
53
+ ### outputAudioFormat?
54
+
55
+ ```ts
56
+ readonly optional outputAudioFormat?: IIntelligenceRealtimeAudioFormat;
57
+ ```
58
+
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
+
61
+ Output audio format.
62
+
63
+ ***
64
+
65
+ ### outputAudioTranscription?
66
+
67
+ ```ts
68
+ readonly optional outputAudioTranscription?: IIntelligenceRealtimeTranscriptionConfiguration;
69
+ ```
70
+
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
+
73
+ Optional spoken-output transcription settings.
74
+
75
+ ***
76
+
77
+ ### outputModalities?
78
+
79
+ ```ts
80
+ readonly optional outputModalities?: readonly ("text" | "audio")[];
81
+ ```
82
+
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
+
85
+ Modalities the model may produce.
86
+
87
+ ***
88
+
89
+ ### providerOptions?
90
+
91
+ ```ts
92
+ readonly optional providerOptions?: Readonly<Record<string, unknown>>;
93
+ ```
94
+
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
+
97
+ Provider-specific escape hatch retained inside the Archipel boundary.
98
+
99
+ ***
100
+
101
+ ### tools?
102
+
103
+ ```ts
104
+ readonly optional tools?: readonly IIntelligenceRealtimeToolDefinition[];
105
+ ```
106
+
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
+
109
+ Explicit tool definitions. Registered Archipel tools are used when omitted.
110
+
111
+ ***
112
+
113
+ ### turnDetection?
114
+
115
+ ```ts
116
+ readonly optional turnDetection?:
117
+ | IIntelligenceRealtimeTurnDetectionConfiguration
118
+ | null;
119
+ ```
120
+
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
+
123
+ Voice activity detection settings, or `null` for push-to-talk.
124
+
125
+ ***
126
+
127
+ ### voice?
128
+
129
+ ```ts
130
+ readonly optional voice?: string;
131
+ ```
132
+
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
+
135
+ Provider voice identifier for spoken model output.
@@ -0,0 +1,148 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceRealtimeSessionOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceRealtimeSessionOptions
7
+
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
+
10
+ Options used to create one server-owned realtime model connection.
11
+
12
+ ## Properties
13
+
14
+ ### activeToolNames?
15
+
16
+ ```ts
17
+ readonly optional activeToolNames?: readonly string[];
18
+ ```
19
+
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
+
22
+ Optional allow-list of registered Archipel tools exposed to this session.
23
+
24
+ ***
25
+
26
+ ### metadata?
27
+
28
+ ```ts
29
+ readonly optional metadata?: Readonly<Record<string, IntelligenceRealtimeMetadataValue>>;
30
+ ```
31
+
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
+
34
+ Bounded, non-sensitive correlation metadata copied to metering events.
35
+
36
+ ***
37
+
38
+ ### model
39
+
40
+ ```ts
41
+ readonly model: string;
42
+ ```
43
+
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
+
46
+ Realtime model identifier such as `gpt-realtime`.
47
+
48
+ ***
49
+
50
+ ### onClose?
51
+
52
+ ```ts
53
+ readonly optional onClose?: (event) => void | Promise<void>;
54
+ ```
55
+
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
+
58
+ Receives the terminal upstream connection state.
59
+
60
+ #### Parameters
61
+
62
+ | Parameter | Type |
63
+ | ------ | ------ |
64
+ | `event` | [`IIntelligenceRealtimeCloseEvent`](Interface.IIntelligenceRealtimeCloseEvent) |
65
+
66
+ #### Returns
67
+
68
+ `void` \| `Promise`\<`void`\>
69
+
70
+ ***
71
+
72
+ ### onError?
73
+
74
+ ```ts
75
+ readonly optional onError?: (error) => void | Promise<void>;
76
+ ```
77
+
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
+
80
+ Receives transport, provider, parsing, and metering adapter failures.
81
+
82
+ #### Parameters
83
+
84
+ | Parameter | Type |
85
+ | ------ | ------ |
86
+ | `error` | `Error` |
87
+
88
+ #### Returns
89
+
90
+ `void` \| `Promise`\<`void`\>
91
+
92
+ ***
93
+
94
+ ### onEvent?
95
+
96
+ ```ts
97
+ readonly optional onEvent?: (event) => void | Promise<void>;
98
+ ```
99
+
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
+
102
+ Receives normalized provider events in wire order.
103
+
104
+ #### Parameters
105
+
106
+ | Parameter | Type |
107
+ | ------ | ------ |
108
+ | `event` | [`IntelligenceRealtimeServerEvent`](TypeAlias.IntelligenceRealtimeServerEvent) |
109
+
110
+ #### Returns
111
+
112
+ `void` \| `Promise`\<`void`\>
113
+
114
+ ***
115
+
116
+ ### provider?
117
+
118
+ ```ts
119
+ readonly optional provider?: IntelligenceProviderName;
120
+ ```
121
+
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
+
124
+ Optional provider override. Defaults to the configured intelligence provider.
125
+
126
+ ***
127
+
128
+ ### sessionConfiguration?
129
+
130
+ ```ts
131
+ readonly optional sessionConfiguration?: IIntelligenceRealtimeSessionConfiguration;
132
+ ```
133
+
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
+
136
+ Provider-neutral realtime session configuration.
137
+
138
+ ***
139
+
140
+ ### sessionId
141
+
142
+ ```ts
143
+ readonly sessionId: string;
144
+ ```
145
+
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
+
148
+ Application-owned identifier used for persistence, billing, and audit correlation.
@@ -0,0 +1,58 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceRealtimeToolDefinition'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceRealtimeToolDefinition
7
+
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
+
10
+ Provider-neutral function definition exposed to a realtime model.
11
+
12
+ ## Properties
13
+
14
+ ### description?
15
+
16
+ ```ts
17
+ readonly optional description?: string;
18
+ ```
19
+
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
+
22
+ Optional model-facing description.
23
+
24
+ ***
25
+
26
+ ### name
27
+
28
+ ```ts
29
+ readonly name: string;
30
+ ```
31
+
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
+
34
+ Unique tool name within the session.
35
+
36
+ ***
37
+
38
+ ### parameters
39
+
40
+ ```ts
41
+ readonly parameters: Record<string, unknown>;
42
+ ```
43
+
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
+
46
+ JSON Schema describing the function parameters.
47
+
48
+ ***
49
+
50
+ ### type
51
+
52
+ ```ts
53
+ readonly type: "function";
54
+ ```
55
+
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
+
58
+ Tool kind.
@@ -0,0 +1,46 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceRealtimeTranscriptionConfiguration'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceRealtimeTranscriptionConfiguration
7
+
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
+
10
+ Provider-neutral transcription configuration.
11
+
12
+ ## Properties
13
+
14
+ ### language?
15
+
16
+ ```ts
17
+ readonly optional language?: string;
18
+ ```
19
+
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
+
22
+ Optional BCP 47 language hint.
23
+
24
+ ***
25
+
26
+ ### model?
27
+
28
+ ```ts
29
+ readonly optional model?: string;
30
+ ```
31
+
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
+
34
+ Provider-specific transcription model.
35
+
36
+ ***
37
+
38
+ ### prompt?
39
+
40
+ ```ts
41
+ readonly optional prompt?: string;
42
+ ```
43
+
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
+
46
+ Optional prompt used to guide the transcription.
@@ -0,0 +1,58 @@
1
+ ---
2
+ title: 'Interface: IIntelligenceRealtimeTurnDetectionConfiguration'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IIntelligenceRealtimeTurnDetectionConfiguration
7
+
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
+
10
+ Provider-neutral voice activity detection configuration.
11
+
12
+ ## Properties
13
+
14
+ ### prefixPaddingMs?
15
+
16
+ ```ts
17
+ readonly optional prefixPaddingMs?: number;
18
+ ```
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
+
22
+ Audio retained before detected speech starts.
23
+
24
+ ***
25
+
26
+ ### silenceDurationMs?
27
+
28
+ ```ts
29
+ readonly optional silenceDurationMs?: number;
30
+ ```
31
+
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
+
34
+ Silence duration that closes a turn.
35
+
36
+ ***
37
+
38
+ ### threshold?
39
+
40
+ ```ts
41
+ readonly optional threshold?: number;
42
+ ```
43
+
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
+
46
+ Activation threshold between zero and one.
47
+
48
+ ***
49
+
50
+ ### type
51
+
52
+ ```ts
53
+ readonly type: "server-vad" | "semantic-vad" | "disabled";
54
+ ```
55
+
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
+
58
+ Voice activity detection strategy.