@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.
- package/data/guides/ai-realtime-voice.md +506 -0
- package/data/guides/ai-text-generation.md +5 -0
- package/data/guides/health-indicators.md +12 -3
- package/data/guides/index.md +5 -4
- package/data/packages/platform-health/index.md +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceAgentFactory.md +5 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +3 -3
- package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +6 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +5 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAssetUploader.md +7 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +110 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +47 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +129 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +308 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceStructuredGenerator.md +5 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceTelemetryRegistry.md +4 -4
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +8 -8
- package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createMimoCustomTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +3 -3
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +2 -2
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +2 -2
- package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +25 -0
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +2 -2
- package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +25 -0
- package/data/packages/platform-intelligence/api/Function.loadMimoLanguageModel.md +3 -3
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +2 -2
- package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +25 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +20 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeAudioFormat.md +34 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeCloseEvent.md +40 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +120 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionConfiguration.md +135 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +148 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeToolDefinition.md +58 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTranscriptionConfiguration.md +46 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTurnDetectionConfiguration.md +58 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +103 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +2 -2
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md +64 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +44 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +25 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeServerEvent.md +159 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeStatus.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.MIMO_API_KEY.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.MIMO_BASE_URL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.MIMO_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-intelligence/api/index.md +23 -0
- package/data/packages/platform-intelligence/index.md +133 -7
- package/data/patterns/index.md +1 -0
- package/data/patterns/realtime-session-pattern.md +309 -0
- package/package.json +1 -1
|
@@ -6,10 +6,10 @@ editUrl: false
|
|
|
6
6
|
# Function: createOpenAIImageGenerationTool()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function createOpenAIImageGenerationTool(options?): IIntelligenceTool
|
|
9
|
+
function createOpenAIImageGenerationTool(options?): Promise<IIntelligenceTool>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [providers/openai/tools/createOpenAIImageGenerationTool.ts:
|
|
12
|
+
Defined in: [providers/openai/tools/createOpenAIImageGenerationTool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIImageGenerationTool.ts#L19)
|
|
13
13
|
|
|
14
14
|
Creates an OpenAI image-generation tool registration.
|
|
15
15
|
|
|
@@ -21,6 +21,6 @@ Creates an OpenAI image-generation tool registration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
[`IIntelligenceTool`](Interface.IIntelligenceTool)
|
|
24
|
+
`Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
|
|
25
25
|
|
|
26
26
|
Tool registration compatible with the intelligence tool registry.
|
|
@@ -6,10 +6,10 @@ editUrl: false
|
|
|
6
6
|
# Function: createOpenAILocalShellTool()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function createOpenAILocalShellTool(options?): IIntelligenceTool
|
|
9
|
+
function createOpenAILocalShellTool(options?): Promise<IIntelligenceTool>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [providers/openai/tools/createOpenAILocalShellTool.ts:
|
|
12
|
+
Defined in: [providers/openai/tools/createOpenAILocalShellTool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAILocalShellTool.ts#L19)
|
|
13
13
|
|
|
14
14
|
Creates an OpenAI local-shell tool registration.
|
|
15
15
|
|
|
@@ -21,6 +21,6 @@ Creates an OpenAI local-shell tool registration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
[`IIntelligenceTool`](Interface.IIntelligenceTool)
|
|
24
|
+
`Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
|
|
25
25
|
|
|
26
26
|
Tool registration compatible with the intelligence tool registry.
|
|
@@ -6,10 +6,10 @@ editUrl: false
|
|
|
6
6
|
# Function: createOpenAIMcpTool()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function createOpenAIMcpTool(options): IIntelligenceTool
|
|
9
|
+
function createOpenAIMcpTool(options): Promise<IIntelligenceTool>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [providers/openai/tools/createOpenAIMcpTool.ts:
|
|
12
|
+
Defined in: [providers/openai/tools/createOpenAIMcpTool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIMcpTool.ts#L19)
|
|
13
13
|
|
|
14
14
|
Creates an OpenAI MCP connector tool registration.
|
|
15
15
|
|
|
@@ -21,6 +21,6 @@ Creates an OpenAI MCP connector tool registration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
[`IIntelligenceTool`](Interface.IIntelligenceTool)
|
|
24
|
+
`Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
|
|
25
25
|
|
|
26
26
|
Tool registration compatible with the intelligence tool registry.
|
|
@@ -6,10 +6,10 @@ editUrl: false
|
|
|
6
6
|
# Function: createOpenAIShellTool()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function createOpenAIShellTool(options?): IIntelligenceTool
|
|
9
|
+
function createOpenAIShellTool(options?): Promise<IIntelligenceTool>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [providers/openai/tools/createOpenAIShellTool.ts:
|
|
12
|
+
Defined in: [providers/openai/tools/createOpenAIShellTool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIShellTool.ts#L19)
|
|
13
13
|
|
|
14
14
|
Creates an OpenAI shell tool registration.
|
|
15
15
|
|
|
@@ -21,6 +21,6 @@ Creates an OpenAI shell tool registration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
[`IIntelligenceTool`](Interface.IIntelligenceTool)
|
|
24
|
+
`Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
|
|
25
25
|
|
|
26
26
|
Tool registration compatible with the intelligence tool registry.
|
|
@@ -6,10 +6,10 @@ editUrl: false
|
|
|
6
6
|
# Function: createOpenAIToolSearchTool()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function createOpenAIToolSearchTool(options?): IIntelligenceTool
|
|
9
|
+
function createOpenAIToolSearchTool(options?): Promise<IIntelligenceTool>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [providers/openai/tools/createOpenAIToolSearchTool.ts:
|
|
12
|
+
Defined in: [providers/openai/tools/createOpenAIToolSearchTool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIToolSearchTool.ts#L19)
|
|
13
13
|
|
|
14
14
|
Creates an OpenAI tool-search tool registration.
|
|
15
15
|
|
|
@@ -21,6 +21,6 @@ Creates an OpenAI tool-search tool registration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
[`IIntelligenceTool`](Interface.IIntelligenceTool)
|
|
24
|
+
`Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
|
|
25
25
|
|
|
26
26
|
Tool registration compatible with the intelligence tool registry.
|
package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md
CHANGED
|
@@ -6,10 +6,10 @@ editUrl: false
|
|
|
6
6
|
# Function: createOpenAIWebSearchPreviewTool()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function createOpenAIWebSearchPreviewTool(options?): IIntelligenceTool
|
|
9
|
+
function createOpenAIWebSearchPreviewTool(options?): Promise<IIntelligenceTool>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [providers/openai/tools/createOpenAIWebSearchPreviewTool.ts:
|
|
12
|
+
Defined in: [providers/openai/tools/createOpenAIWebSearchPreviewTool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIWebSearchPreviewTool.ts#L19)
|
|
13
13
|
|
|
14
14
|
Creates an OpenAI web-search-preview tool registration.
|
|
15
15
|
|
|
@@ -21,6 +21,6 @@ Creates an OpenAI web-search-preview tool registration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
[`IIntelligenceTool`](Interface.IIntelligenceTool)
|
|
24
|
+
`Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
|
|
25
25
|
|
|
26
26
|
Tool registration compatible with the intelligence tool registry.
|
|
@@ -6,10 +6,10 @@ editUrl: false
|
|
|
6
6
|
# Function: createOpenAIWebSearchTool()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function createOpenAIWebSearchTool(options?): IIntelligenceTool
|
|
9
|
+
function createOpenAIWebSearchTool(options?): Promise<IIntelligenceTool>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [providers/openai/tools/createOpenAIWebSearchTool.ts:
|
|
12
|
+
Defined in: [providers/openai/tools/createOpenAIWebSearchTool.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/tools/createOpenAIWebSearchTool.ts#L19)
|
|
13
13
|
|
|
14
14
|
Creates an OpenAI web-search tool registration.
|
|
15
15
|
|
|
@@ -21,6 +21,6 @@ Creates an OpenAI web-search tool registration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
[`IIntelligenceTool`](Interface.IIntelligenceTool)
|
|
24
|
+
`Promise`\<[`IIntelligenceTool`](Interface.IIntelligenceTool)\>
|
|
25
25
|
|
|
26
26
|
Tool registration compatible with the intelligence tool registry.
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
# Function: loadAnthropicLanguageModel()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function loadAnthropicLanguageModel(configuration): LanguageModelV4
|
|
9
|
+
function loadAnthropicLanguageModel(configuration): Promise<LanguageModelV4>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Defined in: [providers/anthropic/loadAnthropicLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/loadAnthropicLanguageModel.ts#L17)
|
|
@@ -21,6 +21,6 @@ Creates the Anthropic language model from the resolved provider configuration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
`LanguageModelV4
|
|
24
|
+
`Promise`\<`LanguageModelV4`\>
|
|
25
25
|
|
|
26
26
|
The configured language model instance.
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
# Function: loadGoogleLanguageModel()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function loadGoogleLanguageModel(configuration): LanguageModelV4
|
|
9
|
+
function loadGoogleLanguageModel(configuration): Promise<LanguageModelV4>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Defined in: [providers/google/loadGoogleLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/loadGoogleLanguageModel.ts#L17)
|
|
@@ -21,6 +21,6 @@ Creates the Google Gemini language model from the resolved provider configuratio
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
`LanguageModelV4
|
|
24
|
+
`Promise`\<`LanguageModelV4`\>
|
|
25
25
|
|
|
26
26
|
The configured language model instance.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: loadGoogleRealtimeModel()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: loadGoogleRealtimeModel()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function loadGoogleRealtimeModel(configuration, options): Promise<RealtimeModelV4>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: providers/google/loadGoogleRealtimeModel.ts:17
|
|
13
|
+
|
|
14
|
+
Creates a Google Gemini Live 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`\>
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
# Function: loadGrokLanguageModel()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function loadGrokLanguageModel(configuration): LanguageModelV4
|
|
9
|
+
function loadGrokLanguageModel(configuration): Promise<LanguageModelV4>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Defined in: [providers/grok/loadGrokLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/loadGrokLanguageModel.ts#L17)
|
|
@@ -21,6 +21,6 @@ Creates the Grok language model through the native xAI provider.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
`LanguageModelV4
|
|
24
|
+
`Promise`\<`LanguageModelV4`\>
|
|
25
25
|
|
|
26
26
|
The configured language model instance.
|
|
@@ -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
|
|
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`\>
|
|
@@ -6,10 +6,10 @@ editUrl: false
|
|
|
6
6
|
# Function: loadMimoLanguageModel()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function loadMimoLanguageModel(configuration): LanguageModelV4
|
|
9
|
+
function loadMimoLanguageModel(configuration): Promise<LanguageModelV4>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: providers/mimo/loadMimoLanguageModel.ts:17
|
|
12
|
+
Defined in: [providers/mimo/loadMimoLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/mimo/loadMimoLanguageModel.ts#L17)
|
|
13
13
|
|
|
14
14
|
Creates the Xiaomi MiMo language model from the resolved provider configuration.
|
|
15
15
|
|
|
@@ -21,6 +21,6 @@ Creates the Xiaomi MiMo language model from the resolved provider configuration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
`LanguageModelV4
|
|
24
|
+
`Promise`\<`LanguageModelV4`\>
|
|
25
25
|
|
|
26
26
|
The configured language model instance.
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
# Function: loadOpenAILanguageModel()
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
function loadOpenAILanguageModel(configuration): LanguageModelV4
|
|
9
|
+
function loadOpenAILanguageModel(configuration): Promise<LanguageModelV4>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Defined in: [providers/openai/loadOpenAILanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/loadOpenAILanguageModel.ts#L17)
|
|
@@ -21,6 +21,6 @@ Creates the OpenAI language model from the resolved provider configuration.
|
|
|
21
21
|
|
|
22
22
|
## Returns
|
|
23
23
|
|
|
24
|
-
`LanguageModelV4
|
|
24
|
+
`Promise`\<`LanguageModelV4`\>
|
|
25
25
|
|
|
26
26
|
The configured language model instance.
|
|
@@ -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
|
|
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:
|
|
8
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L16)
|
|
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:
|
|
20
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L31)
|
|
21
21
|
|
|
22
22
|
Provider-specific configuration entries to register with the config module.
|
|
23
23
|
|
|
@@ -29,7 +29,7 @@ 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:
|
|
32
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L65)
|
|
33
33
|
|
|
34
34
|
When `true` the module is registered globally.
|
|
35
35
|
|
|
@@ -41,7 +41,7 @@ When `true` the module is registered globally.
|
|
|
41
41
|
readonly optional providerLoaders?: Partial<Record<IntelligenceProviderName, IntelligenceLanguageModelLoader>>;
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
44
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L41)
|
|
45
45
|
|
|
46
46
|
Tree-shakable language model loaders keyed by provider name.
|
|
47
47
|
|
|
@@ -50,18 +50,31 @@ Import these from provider-specific subpaths such as
|
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
53
|
+
### realtime?
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
readonly optional realtime?: IIntelligenceRealtimeModuleOptions;
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L48)
|
|
60
|
+
|
|
61
|
+
Server-owned realtime model sessions, resilience limits, and metering.
|
|
62
|
+
|
|
63
|
+
***
|
|
64
|
+
|
|
53
65
|
### tools?
|
|
54
66
|
|
|
55
67
|
```ts
|
|
56
68
|
readonly optional tools?: readonly (
|
|
57
69
|
| IIntelligenceTool
|
|
70
|
+
| Promise<IIntelligenceTool>
|
|
58
71
|
| Type<IIntelligenceTool>
|
|
59
72
|
| Provider<IIntelligenceTool>)[];
|
|
60
73
|
```
|
|
61
74
|
|
|
62
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
75
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L24)
|
|
63
76
|
|
|
64
|
-
Tool instances, class providers, or custom Nest providers registered at bootstrap.
|
|
77
|
+
Tool instances, tool factory promises, class providers, or custom Nest providers registered at bootstrap.
|
|
65
78
|
|
|
66
79
|
***
|
|
67
80
|
|
|
@@ -71,7 +84,7 @@ Tool instances, class providers, or custom Nest providers registered at bootstra
|
|
|
71
84
|
readonly optional validateOnModuleInit?: boolean;
|
|
72
85
|
```
|
|
73
86
|
|
|
74
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
87
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L58)
|
|
75
88
|
|
|
76
89
|
When `true`, provider configuration is resolved during module initialization.
|
|
77
90
|
|
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### code
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
readonly code: number;
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Defined in: realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:9
|
|
31
|
+
|
|
32
|
+
***
|
|
33
|
+
|
|
34
|
+
### reason
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
readonly reason: string;
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Defined in: realtime/contracts/IIntelligenceRealtimeCloseEvent.ts:10
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md
ADDED
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
119
|
+
|
|
120
|
+
Transient token request retries, capped at two.
|