@breadstone/archipel-mcp 0.0.51 → 0.0.53

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 (98) hide show
  1. package/data/guides/ai-realtime-voice.md +506 -0
  2. package/data/guides/ai-text-generation.md +5 -0
  3. package/data/guides/health-indicators.md +12 -3
  4. package/data/guides/index.md +5 -4
  5. package/data/packages/platform-health/index.md +1 -1
  6. package/data/packages/platform-intelligence/api/Class.IntelligenceAgentFactory.md +5 -5
  7. package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +3 -3
  8. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +6 -5
  9. package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +5 -5
  10. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  11. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAssetUploader.md +7 -5
  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.IntelligenceStructuredGenerator.md +5 -5
  17. package/data/packages/platform-intelligence/api/Class.IntelligenceTelemetryRegistry.md +4 -4
  18. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +8 -8
  19. package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +3 -3
  20. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +3 -3
  21. package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +3 -3
  22. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +3 -3
  23. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +3 -3
  24. package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +3 -3
  25. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +3 -3
  26. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +3 -3
  27. package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +3 -3
  28. package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +3 -3
  29. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +3 -3
  30. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +3 -3
  31. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +3 -3
  32. package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +3 -3
  33. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +3 -3
  34. package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +3 -3
  35. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +3 -3
  36. package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +3 -3
  37. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +3 -3
  38. package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +3 -3
  39. package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +3 -3
  40. package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +3 -3
  41. package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +3 -3
  42. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +3 -3
  43. package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +3 -3
  44. package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +3 -3
  45. package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +3 -3
  46. package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +3 -3
  47. package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +3 -3
  48. package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +3 -3
  49. package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +3 -3
  50. package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +3 -3
  51. package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +3 -3
  52. package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +3 -3
  53. package/data/packages/platform-intelligence/api/Function.createMimoCustomTool.md +3 -3
  54. package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +3 -3
  55. package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +3 -3
  56. package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +3 -3
  57. package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +3 -3
  58. package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +3 -3
  59. package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +3 -3
  60. package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +3 -3
  61. package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +3 -3
  62. package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +3 -3
  63. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +3 -3
  64. package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +3 -3
  65. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +2 -2
  66. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +2 -2
  67. package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +25 -0
  68. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +2 -2
  69. package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +25 -0
  70. package/data/packages/platform-intelligence/api/Function.loadMimoLanguageModel.md +3 -3
  71. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +2 -2
  72. package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +25 -0
  73. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +20 -7
  74. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeAudioFormat.md +34 -0
  75. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeCloseEvent.md +40 -0
  76. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +120 -0
  77. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionConfiguration.md +135 -0
  78. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +148 -0
  79. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeToolDefinition.md +58 -0
  80. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTranscriptionConfiguration.md +46 -0
  81. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTurnDetectionConfiguration.md +58 -0
  82. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +103 -0
  83. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +2 -2
  84. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md +64 -0
  85. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md +14 -0
  86. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +44 -0
  87. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +25 -0
  88. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +14 -0
  89. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeServerEvent.md +159 -0
  90. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeStatus.md +14 -0
  91. package/data/packages/platform-intelligence/api/Variable.MIMO_API_KEY.md +1 -1
  92. package/data/packages/platform-intelligence/api/Variable.MIMO_BASE_URL.md +1 -1
  93. package/data/packages/platform-intelligence/api/Variable.MIMO_CONFIG_ENTRIES.md +1 -1
  94. package/data/packages/platform-intelligence/api/index.md +23 -0
  95. package/data/packages/platform-intelligence/index.md +133 -7
  96. package/data/patterns/index.md +1 -0
  97. package/data/patterns/realtime-session-pattern.md +309 -0
  98. package/package.json +1 -1
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceHealthIndicator
7
7
 
8
- Defined in: [health/IntelligenceHealthIndicator.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L17)
8
+ Defined in: [health/IntelligenceHealthIndicator.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L18)
9
9
 
10
10
  Health indicator for the intelligence infrastructure.
11
11
  Verifies that the intelligence provider configuration can be resolved.
@@ -19,16 +19,17 @@ Verifies that the intelligence provider configuration can be resolved.
19
19
  ### Constructor
20
20
 
21
21
  ```ts
22
- new IntelligenceHealthIndicator(textGenerator?): IntelligenceHealthIndicator;
22
+ new IntelligenceHealthIndicator(textGenerator?, realtimeSessionFactory?): IntelligenceHealthIndicator;
23
23
  ```
24
24
 
25
- Defined in: [health/IntelligenceHealthIndicator.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L26)
25
+ Defined in: [health/IntelligenceHealthIndicator.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L28)
26
26
 
27
27
  #### Parameters
28
28
 
29
29
  | Parameter | Type |
30
30
  | ------ | ------ |
31
31
  | `textGenerator?` | [`IntelligenceTextGenerator`](Class.IntelligenceTextGenerator) |
32
+ | `realtimeSessionFactory?` | [`IntelligenceRealtimeSessionFactory`](Class.IntelligenceRealtimeSessionFactory) |
32
33
 
33
34
  #### Returns
34
35
 
@@ -42,7 +43,7 @@ Defined in: [health/IntelligenceHealthIndicator.ts:26](https://github.com/RueDeR
42
43
  readonly key: string = 'intelligence';
43
44
  ```
44
45
 
45
- Defined in: [health/IntelligenceHealthIndicator.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L34)
46
+ Defined in: [health/IntelligenceHealthIndicator.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L37)
46
47
 
47
48
  Unique key identifying the indicator
48
49
 
@@ -60,7 +61,7 @@ IHealthIndicator.key
60
61
  check(): HealthIndicatorResult<string>;
61
62
  ```
62
63
 
63
- Defined in: [health/IntelligenceHealthIndicator.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L47)
64
+ Defined in: [health/IntelligenceHealthIndicator.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L50)
64
65
 
65
66
  Verifies that the provider configuration can be resolved.
66
67
  Returns disabled status when no text generator is configured.
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceMediaGenerator
7
7
 
8
- Defined in: IntelligenceMediaGenerator.ts:14
8
+ Defined in: [IntelligenceMediaGenerator.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceMediaGenerator.ts#L24)
9
9
 
10
10
  Executes AI SDK media generation and understanding operations.
11
11
 
@@ -29,7 +29,7 @@ new IntelligenceMediaGenerator(): IntelligenceMediaGenerator;
29
29
  generateImage(options): Promise<GenerateImageResult>;
30
30
  ```
31
31
 
32
- Defined in: IntelligenceMediaGenerator.ts:36
32
+ Defined in: [IntelligenceMediaGenerator.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceMediaGenerator.ts#L46)
33
33
 
34
34
  Generates images using the native AI SDK image API.
35
35
 
@@ -53,7 +53,7 @@ The native AI SDK image-generation result.
53
53
  generateSpeech(options): Promise<SpeechResult>;
54
54
  ```
55
55
 
56
- Defined in: IntelligenceMediaGenerator.ts:47
56
+ Defined in: [IntelligenceMediaGenerator.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceMediaGenerator.ts#L59)
57
57
 
58
58
  Generates speech using the native AI SDK speech API.
59
59
 
@@ -77,7 +77,7 @@ The native AI SDK speech-generation result.
77
77
  generateVideo(options): Promise<GenerateVideoResult>;
78
78
  ```
79
79
 
80
- Defined in: IntelligenceMediaGenerator.ts:69
80
+ Defined in: [IntelligenceMediaGenerator.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceMediaGenerator.ts#L85)
81
81
 
82
82
  Generates videos using the AI SDK experimental video API.
83
83
 
@@ -101,7 +101,7 @@ The native AI SDK video-generation result.
101
101
  transcribe(options): Promise<TranscriptionResult>;
102
102
  ```
103
103
 
104
- Defined in: IntelligenceMediaGenerator.ts:58
104
+ Defined in: [IntelligenceMediaGenerator.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceMediaGenerator.ts#L72)
105
105
 
106
106
  Transcribes audio using the native AI SDK transcription API.
107
107
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceModule
7
7
 
8
- Defined in: [IntelligenceModule.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L51)
8
+ Defined in: [IntelligenceModule.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L59)
9
9
 
10
10
  Core module exposing the shared intelligence infrastructure.
11
11
 
@@ -29,7 +29,7 @@ new IntelligenceModule(): IntelligenceModule;
29
29
  static register(options?): DynamicModule;
30
30
  ```
31
31
 
32
- Defined in: [IntelligenceModule.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L62)
32
+ Defined in: [IntelligenceModule.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L70)
33
33
 
34
34
  Registers the intelligence module and optional class-based tools.
35
35
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceProviderAssetUploader
7
7
 
8
- Defined in: IntelligenceProviderAssetUploader.ts:14
8
+ Defined in: [IntelligenceProviderAssetUploader.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L20)
9
9
 
10
10
  Uploads provider-managed files and skills for reuse in AI SDK calls.
11
11
 
@@ -29,7 +29,7 @@ new IntelligenceProviderAssetUploader(): IntelligenceProviderAssetUploader;
29
29
  uploadFile(options): Promise<UploadFileResult>;
30
30
  ```
31
31
 
32
- Defined in: IntelligenceProviderAssetUploader.ts:36
32
+ Defined in: [IntelligenceProviderAssetUploader.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L42)
33
33
 
34
34
  Uploads a provider-managed file.
35
35
 
@@ -50,10 +50,11 @@ The native AI SDK upload result.
50
50
  ### uploadSkill()
51
51
 
52
52
  ```ts
53
- uploadSkill(options): Promise<UploadSkillResult>;
53
+ uploadSkill(options): Promise<Omit<SkillsV4UploadSkillResult, "providerReference" | "warnings"> & {
54
+ }>;
54
55
  ```
55
56
 
56
- Defined in: IntelligenceProviderAssetUploader.ts:47
57
+ Defined in: [IntelligenceProviderAssetUploader.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L55)
57
58
 
58
59
  Uploads a provider-managed skill.
59
60
 
@@ -65,6 +66,7 @@ Uploads a provider-managed skill.
65
66
 
66
67
  #### Returns
67
68
 
68
- `Promise`\<`UploadSkillResult`\>
69
+ `Promise`\<`Omit`\<`SkillsV4UploadSkillResult`, `"providerReference"` \| `"warnings"`\> & \{
70
+ \}\>
69
71
 
70
72
  The native AI SDK upload result.
@@ -0,0 +1,110 @@
1
+ ---
2
+ title: 'Class: IntelligenceRealtimeError'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceRealtimeError
7
+
8
+ Defined in: errors/IntelligenceRealtimeError.ts:12
9
+
10
+ Error raised by a realtime session, transport, or metering adapter.
11
+
12
+ ## Extends
13
+
14
+ - `Error`
15
+
16
+ ## Constructors
17
+
18
+ ### Constructor
19
+
20
+ ```ts
21
+ new IntelligenceRealtimeError(
22
+ message,
23
+ phase,
24
+ provider,
25
+ model,
26
+ sessionId,
27
+ isRetryable,
28
+ cause?): IntelligenceRealtimeError;
29
+ ```
30
+
31
+ Defined in: errors/IntelligenceRealtimeError.ts:25
32
+
33
+ #### Parameters
34
+
35
+ | Parameter | Type |
36
+ | ------ | ------ |
37
+ | `message` | `string` |
38
+ | `phase` | \| `"configuration"` \| `"token"` \| `"connect"` \| `"send"` \| `"receive"` \| `"metering"` \| `"close"` |
39
+ | `provider` | [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName) |
40
+ | `model` | `string` |
41
+ | `sessionId` | `string` |
42
+ | `isRetryable` | `boolean` |
43
+ | `cause?` | `Error` |
44
+
45
+ #### Returns
46
+
47
+ `IntelligenceRealtimeError`
48
+
49
+ #### Overrides
50
+
51
+ ```ts
52
+ Error.constructor
53
+ ```
54
+
55
+ ## Properties
56
+
57
+ ### isRetryable
58
+
59
+ ```ts
60
+ readonly isRetryable: boolean;
61
+ ```
62
+
63
+ Defined in: errors/IntelligenceRealtimeError.ts:19
64
+
65
+ ***
66
+
67
+ ### model
68
+
69
+ ```ts
70
+ readonly model: string;
71
+ ```
72
+
73
+ Defined in: errors/IntelligenceRealtimeError.ts:17
74
+
75
+ ***
76
+
77
+ ### phase
78
+
79
+ ```ts
80
+ readonly phase:
81
+ | "configuration"
82
+ | "token"
83
+ | "connect"
84
+ | "send"
85
+ | "receive"
86
+ | "metering"
87
+ | "close";
88
+ ```
89
+
90
+ Defined in: errors/IntelligenceRealtimeError.ts:15
91
+
92
+ ***
93
+
94
+ ### provider
95
+
96
+ ```ts
97
+ readonly provider: IntelligenceProviderName;
98
+ ```
99
+
100
+ Defined in: errors/IntelligenceRealtimeError.ts:16
101
+
102
+ ***
103
+
104
+ ### sessionId
105
+
106
+ ```ts
107
+ readonly sessionId: string;
108
+ ```
109
+
110
+ Defined in: errors/IntelligenceRealtimeError.ts:18
@@ -0,0 +1,47 @@
1
+ ---
2
+ title: 'Abstract Class: IntelligenceRealtimeMeteringPort'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Abstract Class: IntelligenceRealtimeMeteringPort
7
+
8
+ Defined in: realtime/ports/IntelligenceRealtimeMeteringPort.ts:15
9
+
10
+ Application port for idempotently persisting realtime billing and audit events.
11
+
12
+ Implementations should treat `eventId` as an idempotency key and persist the
13
+ commercial debit and AI audit record in one application transaction.
14
+
15
+ ## Constructors
16
+
17
+ ### Constructor
18
+
19
+ ```ts
20
+ new IntelligenceRealtimeMeteringPort(): IntelligenceRealtimeMeteringPort;
21
+ ```
22
+
23
+ #### Returns
24
+
25
+ `IntelligenceRealtimeMeteringPort`
26
+
27
+ ## Methods
28
+
29
+ ### report()
30
+
31
+ ```ts
32
+ abstract report(event): Promise<void>;
33
+ ```
34
+
35
+ Defined in: realtime/ports/IntelligenceRealtimeMeteringPort.ts:23
36
+
37
+ Persists one metering event.
38
+
39
+ #### Parameters
40
+
41
+ | Parameter | Type | Description |
42
+ | ------ | ------ | ------ |
43
+ | `event` | [`IntelligenceRealtimeMeteringEvent`](TypeAlias.IntelligenceRealtimeMeteringEvent) | Normalized, idempotently identifiable metering event. |
44
+
45
+ #### Returns
46
+
47
+ `Promise`\<`void`\>
@@ -0,0 +1,129 @@
1
+ ---
2
+ title: 'Class: IntelligenceRealtimeSessionFactory'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceRealtimeSessionFactory
7
+
8
+ Defined in: IntelligenceRealtimeSessionFactory.ts:35
9
+
10
+ Creates and owns server-side, provider-neutral realtime AI sessions.
11
+
12
+ Applications forward normalized events and audio chunks through their own
13
+ authenticated WebSocket gateway. Provider credentials, provider event
14
+ mappings, token creation, and upstream sockets remain inside Archipel.
15
+
16
+ ## Implements
17
+
18
+ - `OnModuleDestroy`
19
+
20
+ ## Constructors
21
+
22
+ ### Constructor
23
+
24
+ ```ts
25
+ new IntelligenceRealtimeSessionFactory(
26
+ configService,
27
+ toolRegistry,
28
+ metering,
29
+ providerLoaders,
30
+ runtime): IntelligenceRealtimeSessionFactory;
31
+ ```
32
+
33
+ Defined in: IntelligenceRealtimeSessionFactory.ts:55
34
+
35
+ #### Parameters
36
+
37
+ | Parameter | Type |
38
+ | ------ | ------ |
39
+ | `configService` | `ConfigService` |
40
+ | `toolRegistry` | [`IntelligenceToolRegistry`](Class.IntelligenceToolRegistry) |
41
+ | `metering` | [`IntelligenceRealtimeMeteringPort`](Class.IntelligenceRealtimeMeteringPort) |
42
+ | `providerLoaders` | [`IntelligenceRealtimeModelLoaders`](TypeAlias.IntelligenceRealtimeModelLoaders) |
43
+ | `runtime` | `IIntelligenceRealtimeRuntimeOptions` |
44
+
45
+ #### Returns
46
+
47
+ `IntelligenceRealtimeSessionFactory`
48
+
49
+ ## Accessors
50
+
51
+ ### activeSessionCount
52
+
53
+ #### Get Signature
54
+
55
+ ```ts
56
+ get activeSessionCount(): number;
57
+ ```
58
+
59
+ Defined in: IntelligenceRealtimeSessionFactory.ts:74
60
+
61
+ Number of sessions currently owned by this module instance.
62
+
63
+ ##### Returns
64
+
65
+ `number`
66
+
67
+ ***
68
+
69
+ ### registeredProviders
70
+
71
+ #### Get Signature
72
+
73
+ ```ts
74
+ get registeredProviders(): readonly IntelligenceProviderName[];
75
+ ```
76
+
77
+ Defined in: IntelligenceRealtimeSessionFactory.ts:79
78
+
79
+ Providers currently registered for server-owned realtime sessions.
80
+
81
+ ##### Returns
82
+
83
+ readonly [`IntelligenceProviderName`](TypeAlias.IntelligenceProviderName)[]
84
+
85
+ ## Methods
86
+
87
+ ### createSession()
88
+
89
+ ```ts
90
+ createSession(options): Promise<IntelligenceRealtimeSessionPort>;
91
+ ```
92
+
93
+ Defined in: IntelligenceRealtimeSessionFactory.ts:93
94
+
95
+ Creates an isolated realtime session without opening the upstream socket.
96
+
97
+ #### Parameters
98
+
99
+ | Parameter | Type | Description |
100
+ | ------ | ------ | ------ |
101
+ | `options` | [`IIntelligenceRealtimeSessionOptions`](Interface.IIntelligenceRealtimeSessionOptions) | Logical session, provider, model, tools, and event callbacks. |
102
+
103
+ #### Returns
104
+
105
+ `Promise`\<[`IntelligenceRealtimeSessionPort`](Class.IntelligenceRealtimeSessionPort)\>
106
+
107
+ A provider-neutral session. Call `connect()` to start streaming.
108
+
109
+ ***
110
+
111
+ ### onModuleDestroy()
112
+
113
+ ```ts
114
+ onModuleDestroy(): Promise<void>;
115
+ ```
116
+
117
+ Defined in: IntelligenceRealtimeSessionFactory.ts:132
118
+
119
+ Closes all owned upstream sessions during Nest application shutdown.
120
+
121
+ #### Returns
122
+
123
+ `Promise`\<`void`\>
124
+
125
+ #### Implementation of
126
+
127
+ ```ts
128
+ OnModuleDestroy.onModuleDestroy
129
+ ```