@breadstone/archipel-mcp 0.0.53 → 0.0.55
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-image-generation.md +96 -0
- package/data/guides/ai-realtime-voice.md +69 -464
- package/data/guides/ai-text-generation.md +95 -622
- package/data/guides/index.md +3 -1
- package/data/guides/intelligence-prompts-warm-up.md +138 -0
- package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +78 -0
- package/data/packages/platform-intelligence/api/Class.DefaultIntelligencePromptPolicyAdapter.md +54 -0
- package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +78 -0
- package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +78 -0
- package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +78 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceAgent.md +95 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceAgentFactory.md +11 -23
- package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +25 -21
- package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +11 -7
- package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +159 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +60 -38
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
- package/data/packages/platform-intelligence/api/Class.IntelligencePromptExecutor.md +88 -0
- package/data/packages/platform-intelligence/api/Class.IntelligencePromptPolicyPort.md +48 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAssetUploader.md +21 -15
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderDiagnostics.md +55 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderError.md +14 -4
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderRegistry.md +68 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeError.md +9 -9
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +2 -2
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +12 -12
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +18 -18
- package/data/packages/platform-intelligence/api/Class.IntelligenceReranker.md +58 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +14 -16
- package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +10 -14
- package/data/packages/platform-intelligence/api/Class.MiMoIntelligenceProviderAdapter.md +78 -0
- package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +102 -0
- package/data/packages/platform-intelligence/api/Function.createAnthropicAdvisor20260301Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicBash20241022Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicBash20250124Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250522Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20250825Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicCodeExecution20260120Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20241022Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20250124Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicComputer20251124Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicMemory20250818Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20241022Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250124Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250429Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicTextEditor20250728Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchBM2520251119Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicToolSearchRegex20251119Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20250910Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebFetch20260209Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20250305Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createAnthropicWebSearch20260209Tool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleCodeExecutionTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleEnterpriseWebSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleFileSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleGoogleMapsTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleGoogleSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleUrlContextTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGoogleVertexRagStoreTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokCodeExecutionTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokFileSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokMcpServerTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokViewImageTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokViewXVideoTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokWebSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createGrokXSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createIntelligenceJsonSchema.md +31 -0
- package/data/packages/platform-intelligence/api/Function.createIntelligenceTool.md +2 -2
- package/data/packages/platform-intelligence/api/Function.createMimoCustomTool.md +5 -5
- package/data/packages/platform-intelligence/api/Function.createOpenAIApplyPatchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAICodeInterpreterTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAICustomTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIFileSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIImageGenerationTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAILocalShellTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIMcpTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIShellTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIToolSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchPreviewTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.createOpenAIWebSearchTool.md +1 -1
- package/data/packages/platform-intelligence/api/Function.defineIntelligenceTool.md +31 -0
- package/data/packages/platform-intelligence/api/Function.intelligencePrompt.md +31 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md +124 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +114 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +102 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadResult.md +60 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceGeneratedFile.md +40 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceGenerationStepStartEvent.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationOptions.md +170 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationResult.md +60 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageCompletion.md +141 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md +234 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageStream.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelReference.md +34 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelRequestOptions.md +52 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +30 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +43 -25
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceObjectStream.md +56 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptDefinition.md +145 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md +30 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionContext.md +20 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md +127 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptInvocation.md +49 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptPolicyRequest.md +60 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptRenderContext.md +26 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderAdapter.md +73 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +10 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +40 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeAudioFormat.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeCloseEvent.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeModuleOptions.md +9 -21
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionConfiguration.md +11 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +11 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeToolDefinition.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTranscriptionConfiguration.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeTurnDetectionConfiguration.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +10 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +98 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +140 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +94 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +80 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +164 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +139 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTool.md +7 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolCall.md +40 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolDefinition.md +91 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionEndEvent.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionStartEvent.md +30 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolRegistry.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionOptions.md +114 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionResult.md +84 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionStream.md +97 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceUsage.md +40 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +229 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationResult.md +50 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceModelMessage.md +43 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IIntelligencePromptModelRequirement.md +25 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceSchema.md +70 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceCapability.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceDefaultModels.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceJsonValue.md +22 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptCapability.md +20 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptDefinitionConfiguration.md +29 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md +16 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptLatency.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptMode.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptQuality.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptReasoning.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderOptions.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderProbeStatus.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderToolOptions.md +17 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeServerEvent.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeStatus.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRequestTimeouts.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolChoice.md +21 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolOutput.md +22 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolSet.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md +46 -0
- package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_API_KEY.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_BASE_URL.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +2 -2
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.IntelligenceCapabilityNames.md +40 -0
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +2 -0
- package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-intelligence/api/index.md +98 -30
- package/package.json +1 -1
- package/data/packages/index.md +0 -8
- package/data/packages/platform-analytics/index.md +0 -209
- package/data/packages/platform-authentication/index.md +0 -725
- package/data/packages/platform-blob-storage/index.md +0 -416
- package/data/packages/platform-bootstrap/index.md +0 -162
- package/data/packages/platform-caching/index.md +0 -167
- package/data/packages/platform-configuration/index.md +0 -226
- package/data/packages/platform-core/index.md +0 -504
- package/data/packages/platform-cryptography/index.md +0 -142
- package/data/packages/platform-database/index.md +0 -337
- package/data/packages/platform-documents/index.md +0 -255
- package/data/packages/platform-esigning/index.md +0 -710
- package/data/packages/platform-feature-flags/index.md +0 -103
- package/data/packages/platform-health/index.md +0 -141
- package/data/packages/platform-intelligence/api/Class.IntelligenceStructuredGenerator.md +0 -70
- package/data/packages/platform-intelligence/api/Class.IntelligenceTelemetryRegistry.md +0 -44
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +0 -138
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +0 -39
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadGoogleRealtimeModel.md +0 -25
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadGrokRealtimeModel.md +0 -25
- package/data/packages/platform-intelligence/api/Function.loadMimoLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadOpenAIRealtimeModel.md +0 -25
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +0 -168
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +0 -144
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +0 -78
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextStreamingOptions.md +0 -170
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +0 -24
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md +0 -14
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md +0 -25
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md +0 -14
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTextStream.md +0 -14
- package/data/packages/platform-intelligence/index.md +0 -549
- package/data/packages/platform-logging/index.md +0 -150
- package/data/packages/platform-mailing/index.md +0 -470
- package/data/packages/platform-mapping/index.md +0 -123
- package/data/packages/platform-mcp/index.md +0 -335
- package/data/packages/platform-openapi/index.md +0 -207
- package/data/packages/platform-payments/index.md +0 -610
- package/data/packages/platform-queue/index.md +0 -192
- package/data/packages/platform-reporting/index.md +0 -233
- package/data/packages/platform-resources/index.md +0 -137
- package/data/packages/platform-telemetry/index.md +0 -262
package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Type Alias: IntelligenceLanguageModelLoader'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Type Alias: IntelligenceLanguageModelLoader
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
type IntelligenceLanguageModelLoader = (configuration) => Promise<LanguageModelV4>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [providers/IntelligenceLanguageModelLoader.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceLanguageModelLoader.ts#L13)
|
|
13
|
-
|
|
14
|
-
Represents a factory responsible for creating a configured language model instance.
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
| Parameter | Type |
|
|
19
|
-
| ------ | ------ |
|
|
20
|
-
| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
|
|
21
|
-
|
|
22
|
-
## Returns
|
|
23
|
-
|
|
24
|
-
`Promise`\<`LanguageModelV4`\>
|
package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoaders.md
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Type Alias: IntelligenceLanguageModelLoaders'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Type Alias: IntelligenceLanguageModelLoaders
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
type IntelligenceLanguageModelLoaders = Partial<Record<IntelligenceProviderName, IntelligenceLanguageModelLoader>>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [providers/IntelligenceLanguageModelLoaders.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceLanguageModelLoaders.ts#L13)
|
|
13
|
-
|
|
14
|
-
Maps configured intelligence providers to their tree-shakable model loader.
|
package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoader.md
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Type Alias: IntelligenceRealtimeModelLoader'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Type Alias: IntelligenceRealtimeModelLoader
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
type IntelligenceRealtimeModelLoader = (configuration, options) => Promise<RealtimeModelV4>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: providers/IntelligenceRealtimeModelLoader.ts:14
|
|
13
|
-
|
|
14
|
-
Creates a configured Vercel AI SDK realtime model behind the Archipel facade.
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
| Parameter | Type |
|
|
19
|
-
| ------ | ------ |
|
|
20
|
-
| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
|
|
21
|
-
| `options` | `IIntelligenceRealtimeModelLoaderOptions` |
|
|
22
|
-
|
|
23
|
-
## Returns
|
|
24
|
-
|
|
25
|
-
`Promise`\<`RealtimeModelV4`\>
|
package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeModelLoaders.md
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Type Alias: IntelligenceRealtimeModelLoaders'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Type Alias: IntelligenceRealtimeModelLoaders
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
type IntelligenceRealtimeModelLoaders = Partial<Record<IntelligenceProviderName, IntelligenceRealtimeModelLoader>>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: providers/IntelligenceRealtimeModelLoaders.ts:13
|
|
13
|
-
|
|
14
|
-
Maps configured intelligence providers to tree-shakable realtime model loaders.
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Type Alias: IntelligenceTextStream'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Type Alias: IntelligenceTextStream
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
type IntelligenceTextStream = ReturnType<typeof streamText>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [contracts/IntelligenceTextStream.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceTextStream.ts#L12)
|
|
13
|
-
|
|
14
|
-
Native AI SDK streaming result returned by the intelligence text generator.
|
|
@@ -1,549 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: platform-intelligence
|
|
3
|
-
description: Multi-provider AI text generation, streaming, realtime voice, metering, and tool calling.
|
|
4
|
-
order: 16
|
|
5
|
-
tags: [intelligence, ai, openai, anthropic, google, grok, text-generation, streaming, realtime, voice, metering, tool-calling, health]
|
|
6
|
-
package: '@breadstone/archipel-platform-intelligence'
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# platform-intelligence
|
|
10
|
-
|
|
11
|
-
Multi-provider AI library supporting text generation and server-owned realtime voice sessions through OpenAI, Anthropic, Google Generative AI, and Grok. Tool orchestration is delegated to the AI SDK through native and provider-defined tool definitions, `toolChoice`, `activeTools`, and `stopWhen`. Advanced use cases can pass native AI SDK prompts, request-level models, provider options, headers, telemetry, output settings, and step hooks through the platform generator.
|
|
12
|
-
|
|
13
|
-
**Package:** `@breadstone/archipel-platform-intelligence`
|
|
14
|
-
|
|
15
|
-
<InstallTabs />
|
|
16
|
-
|
|
17
|
-
## Quick Start
|
|
18
|
-
|
|
19
|
-
```typescript
|
|
20
|
-
import { Module } from '@nestjs/common';
|
|
21
|
-
import { IntelligenceModule, IntelligenceProviderNames } from '@breadstone/archipel-platform-intelligence';
|
|
22
|
-
import { loadOpenAILanguageModel } from '@breadstone/archipel-platform-intelligence/providers/openai';
|
|
23
|
-
|
|
24
|
-
@Module({
|
|
25
|
-
imports: [
|
|
26
|
-
IntelligenceModule.register({
|
|
27
|
-
providerLoaders: {
|
|
28
|
-
[IntelligenceProviderNames.OpenAI]: loadOpenAILanguageModel,
|
|
29
|
-
},
|
|
30
|
-
}),
|
|
31
|
-
],
|
|
32
|
-
})
|
|
33
|
-
export class AppModule {}
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
---
|
|
37
|
-
|
|
38
|
-
## Realtime Voice
|
|
39
|
-
|
|
40
|
-
Archipel owns the upstream provider WebSocket and exposes normalized audio,
|
|
41
|
-
text, transcription, response, and tool events through
|
|
42
|
-
`IntelligenceRealtimeSessionPort`. The consuming backend can place its normal
|
|
43
|
-
authentication, authorization, tenant isolation, persistence, and client
|
|
44
|
-
WebSocket in front of this port. Provider credentials and short-lived tokens
|
|
45
|
-
never need to reach the browser.
|
|
46
|
-
|
|
47
|
-
The complete application integration is documented in
|
|
48
|
-
[AI Realtime Voice](/guides/ai-realtime-voice); the reusable ownership,
|
|
49
|
-
durability, and recovery rules are documented in the
|
|
50
|
-
[Realtime Session Pattern](/patterns/realtime-session-pattern).
|
|
51
|
-
|
|
52
|
-
The implementation uses the experimental realtime model contract in Vercel AI
|
|
53
|
-
SDK 7. OpenAI, Google, and xAI are loaded through Archipel provider subpaths;
|
|
54
|
-
consuming applications do not import the official OpenAI SDK or make direct
|
|
55
|
-
provider calls.
|
|
56
|
-
|
|
57
|
-
```typescript
|
|
58
|
-
import { Injectable, Module } from '@nestjs/common';
|
|
59
|
-
import {
|
|
60
|
-
IntelligenceModule,
|
|
61
|
-
IntelligenceProviderNames,
|
|
62
|
-
} from '@breadstone/archipel-platform-intelligence';
|
|
63
|
-
import {
|
|
64
|
-
IntelligenceRealtimeMeteringPort,
|
|
65
|
-
IntelligenceRealtimeSessionFactory,
|
|
66
|
-
type IntelligenceRealtimeMeteringEvent,
|
|
67
|
-
} from '@breadstone/archipel-platform-intelligence/realtime';
|
|
68
|
-
import { loadOpenAIRealtimeModel } from '@breadstone/archipel-platform-intelligence/providers/openai';
|
|
69
|
-
import { loadGoogleRealtimeModel } from '@breadstone/archipel-platform-intelligence/providers/google';
|
|
70
|
-
import { loadGrokRealtimeModel } from '@breadstone/archipel-platform-intelligence/providers/grok';
|
|
71
|
-
|
|
72
|
-
@Injectable()
|
|
73
|
-
export class RealtimeMeteringAdapter extends IntelligenceRealtimeMeteringPort {
|
|
74
|
-
public async report(event: IntelligenceRealtimeMeteringEvent): Promise<void> {
|
|
75
|
-
await persistIdempotently(event.eventId, event);
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
@Module({
|
|
80
|
-
imports: [
|
|
81
|
-
IntelligenceModule.register({
|
|
82
|
-
validateOnModuleInit: false,
|
|
83
|
-
realtime: {
|
|
84
|
-
providerLoaders: {
|
|
85
|
-
[IntelligenceProviderNames.OpenAI]: loadOpenAIRealtimeModel,
|
|
86
|
-
[IntelligenceProviderNames.Google]: loadGoogleRealtimeModel,
|
|
87
|
-
[IntelligenceProviderNames.Grok]: loadGrokRealtimeModel,
|
|
88
|
-
},
|
|
89
|
-
meteringAdapter: RealtimeMeteringAdapter,
|
|
90
|
-
meteringIntervalMs: 30_000,
|
|
91
|
-
},
|
|
92
|
-
}),
|
|
93
|
-
],
|
|
94
|
-
})
|
|
95
|
-
export class RealtimeModule {}
|
|
96
|
-
|
|
97
|
-
@Injectable()
|
|
98
|
-
export class RealtimeConsultationService {
|
|
99
|
-
public constructor(private readonly sessions: IntelligenceRealtimeSessionFactory) {}
|
|
100
|
-
|
|
101
|
-
public async open(consultationId: string): Promise<void> {
|
|
102
|
-
const session = await this.sessions.createSession({
|
|
103
|
-
sessionId: consultationId,
|
|
104
|
-
model: 'gpt-realtime',
|
|
105
|
-
sessionConfiguration: {
|
|
106
|
-
instructions: 'Transcribe the consultation and answer concisely.',
|
|
107
|
-
inputAudioFormat: { type: 'audio/pcm', rate: 24_000 },
|
|
108
|
-
inputAudioTranscription: {},
|
|
109
|
-
outputModalities: ['text', 'audio'],
|
|
110
|
-
turnDetection: { type: 'server-vad' },
|
|
111
|
-
},
|
|
112
|
-
onEvent: forwardToAuthenticatedClient,
|
|
113
|
-
});
|
|
114
|
-
|
|
115
|
-
await session.connect();
|
|
116
|
-
}
|
|
117
|
-
}
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
| Provider | Archipel loader | Example model |
|
|
121
|
-
| --- | --- | --- |
|
|
122
|
-
| OpenAI | `loadOpenAIRealtimeModel` | `gpt-realtime` |
|
|
123
|
-
| Google | `loadGoogleRealtimeModel` | `gemini-3.1-flash-live-preview` |
|
|
124
|
-
| xAI / Grok | `loadGrokRealtimeModel` | `grok-voice-latest` |
|
|
125
|
-
|
|
126
|
-
### Metering and audit
|
|
127
|
-
|
|
128
|
-
The application-supplied `IntelligenceRealtimeMeteringPort` receives four
|
|
129
|
-
idempotently identifiable event types:
|
|
130
|
-
|
|
131
|
-
| Event | Meaning |
|
|
132
|
-
| --- | --- |
|
|
133
|
-
| `session-started` | One upstream provider connection opened |
|
|
134
|
-
| `billing-interval` | Elapsed provider-independent usage, every 30 seconds by default and once more for the final partial interval |
|
|
135
|
-
| `provider-usage` | Exact token and modality counts when present in the raw provider event |
|
|
136
|
-
| `session-ended` | Connection duration and close reason |
|
|
137
|
-
|
|
138
|
-
An application can debit its own token ledger and append its AI audit log in
|
|
139
|
-
the same transaction keyed by `eventId`. Time-based charging remains available
|
|
140
|
-
when a provider omits exact usage; exact token usage remains available for cost
|
|
141
|
-
reconciliation when reported.
|
|
142
|
-
|
|
143
|
-
### Failure and persistence rules
|
|
144
|
-
|
|
145
|
-
- Provider token requests and WebSocket setup are capped at five seconds and
|
|
146
|
-
transient token creation is retried at most twice.
|
|
147
|
-
- Inbound, outbound, metering, and WebSocket buffers are bounded.
|
|
148
|
-
- Normalized events preserve provider wire order.
|
|
149
|
-
- Nest shutdown closes all owned sessions and flushes metering.
|
|
150
|
-
- Archipel does not silently reconnect a lost provider conversation because a
|
|
151
|
-
new connection has different conversational state.
|
|
152
|
-
- The consuming application must persist audio chunks and transcript progress
|
|
153
|
-
durably before acknowledging them, then reconstruct context when it opens a
|
|
154
|
-
replacement provider session.
|
|
155
|
-
|
|
156
|
-
---
|
|
157
|
-
|
|
158
|
-
## Provider Subpaths
|
|
159
|
-
|
|
160
|
-
Import only the providers you need:
|
|
161
|
-
|
|
162
|
-
| Provider | Subpath |
|
|
163
|
-
| --------- | ---------------------------------------------------------------- |
|
|
164
|
-
| OpenAI | `@breadstone/archipel-platform-intelligence/providers/openai` |
|
|
165
|
-
| Anthropic | `@breadstone/archipel-platform-intelligence/providers/anthropic` |
|
|
166
|
-
| Google | `@breadstone/archipel-platform-intelligence/providers/google` |
|
|
167
|
-
| Grok | `@breadstone/archipel-platform-intelligence/providers/grok` |
|
|
168
|
-
|
|
169
|
-
Provider-native tool wrappers are exported through matching `/tools` subpaths, for example `@breadstone/archipel-platform-intelligence/providers/grok/tools`.
|
|
170
|
-
|
|
171
|
-
---
|
|
172
|
-
|
|
173
|
-
## Tool Registration
|
|
174
|
-
|
|
175
|
-
Tools can be normal Nest providers or direct `IIntelligenceTool` instances. Register classes for custom application tools, or register provider-native wrappers from provider subpaths.
|
|
176
|
-
|
|
177
|
-
```typescript
|
|
178
|
-
import { Injectable, Module } from '@nestjs/common';
|
|
179
|
-
import { tool, type Tool } from 'ai';
|
|
180
|
-
import { z } from 'zod';
|
|
181
|
-
import { IntelligenceModule, IntelligenceProviderNames, IntelligenceToolBase } from '@breadstone/archipel-platform-intelligence';
|
|
182
|
-
import { loadOpenAILanguageModel } from '@breadstone/archipel-platform-intelligence/providers/openai';
|
|
183
|
-
|
|
184
|
-
interface ICustomerSearchInput {
|
|
185
|
-
readonly query: string;
|
|
186
|
-
}
|
|
187
|
-
|
|
188
|
-
interface ICustomerSearchOutput {
|
|
189
|
-
readonly customers: ReadonlyArray<string>;
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
@Injectable()
|
|
193
|
-
export class CustomerSearchTool extends IntelligenceToolBase<ICustomerSearchInput, ICustomerSearchOutput> {
|
|
194
|
-
public override get name(): string {
|
|
195
|
-
return 'searchCustomers';
|
|
196
|
-
}
|
|
197
|
-
|
|
198
|
-
public override get tool(): Tool<ICustomerSearchInput, ICustomerSearchOutput> {
|
|
199
|
-
return tool({
|
|
200
|
-
description: 'Searches customers by name, email, or company.',
|
|
201
|
-
inputSchema: z.object({
|
|
202
|
-
query: z.string().describe('Customer search query'),
|
|
203
|
-
}),
|
|
204
|
-
execute: async (input) => ({ customers: [input.query] }),
|
|
205
|
-
});
|
|
206
|
-
}
|
|
207
|
-
}
|
|
208
|
-
|
|
209
|
-
@Module({
|
|
210
|
-
imports: [
|
|
211
|
-
IntelligenceModule.register({
|
|
212
|
-
providerLoaders: {
|
|
213
|
-
[IntelligenceProviderNames.OpenAI]: loadOpenAILanguageModel,
|
|
214
|
-
},
|
|
215
|
-
tools: [CustomerSearchTool],
|
|
216
|
-
}),
|
|
217
|
-
],
|
|
218
|
-
})
|
|
219
|
-
export class AppModule {}
|
|
220
|
-
```
|
|
221
|
-
|
|
222
|
-
### Provider-Native Tools
|
|
223
|
-
|
|
224
|
-
Provider SDKs expose built-in tools such as web search, file search, code execution, and URL context. Archipel exports wrappers from provider subpaths so each tool is compatible with `IIntelligenceTool` without importing unused provider SDKs from the root entry.
|
|
225
|
-
|
|
226
|
-
```typescript
|
|
227
|
-
import { Module } from '@nestjs/common';
|
|
228
|
-
import { IntelligenceModule, IntelligenceProviderNames } from '@breadstone/archipel-platform-intelligence';
|
|
229
|
-
import { loadOpenAILanguageModel } from '@breadstone/archipel-platform-intelligence/providers/openai';
|
|
230
|
-
import { createOpenAIWebSearchTool } from '@breadstone/archipel-platform-intelligence/providers/openai/tools';
|
|
231
|
-
|
|
232
|
-
@Module({
|
|
233
|
-
imports: [
|
|
234
|
-
IntelligenceModule.register({
|
|
235
|
-
providerLoaders: {
|
|
236
|
-
[IntelligenceProviderNames.OpenAI]: loadOpenAILanguageModel,
|
|
237
|
-
},
|
|
238
|
-
tools: [createOpenAIWebSearchTool({ searchContextSize: 'medium' })],
|
|
239
|
-
}),
|
|
240
|
-
],
|
|
241
|
-
})
|
|
242
|
-
export class AppModule {}
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
Provider-native wrappers cover OpenAI web search, file search, code interpreter, image generation, shell, MCP, and tool search; Google Search, Enterprise Web Search, URL Context, Code Execution, File Search, Maps, and Vertex RAG Store; versioned Anthropic web search, web fetch, code execution, bash, text editor, computer, memory, tool search, and advisor tools; and Grok web search, X search, file search, code execution, MCP, image understanding, and X-video understanding.
|
|
246
|
-
|
|
247
|
-
The detailed AI text generation guide includes OpenAI recipes for spreadsheet analysis with Code Interpreter, image generation with generated files, deferred tool loading via Tool Search, and grammar-constrained custom tools. In the currently installed OpenAI SDK, `customTool()` constrains provider output but does not run a local `execute` callback; use a normal `tool()` when local execution is required.
|
|
248
|
-
|
|
249
|
-
### Native AI SDK Passthrough
|
|
250
|
-
|
|
251
|
-
`generateText()` and `streamText()` accept native AI SDK `Prompt` objects directly. The options intentionally extend the native AI SDK call options, so provider-specific features can flow through even when Archipel has no dedicated wrapper for them.
|
|
252
|
-
|
|
253
|
-
The configured platform model is used by default. For exact AI SDK model factories, pass `model` per request. When every call provides a native model, set `validateOnModuleInit: false` to skip startup validation of platform provider configuration.
|
|
254
|
-
|
|
255
|
-
```typescript
|
|
256
|
-
import { openai } from '@ai-sdk/openai';
|
|
257
|
-
import { Injectable, Module } from '@nestjs/common';
|
|
258
|
-
import { IntelligenceModule, IntelligenceTextGenerator } from '@breadstone/archipel-platform-intelligence';
|
|
259
|
-
|
|
260
|
-
@Module({
|
|
261
|
-
imports: [
|
|
262
|
-
IntelligenceModule.register({
|
|
263
|
-
validateOnModuleInit: false,
|
|
264
|
-
}),
|
|
265
|
-
],
|
|
266
|
-
})
|
|
267
|
-
export class RawAiSdkModule {}
|
|
268
|
-
|
|
269
|
-
@Injectable()
|
|
270
|
-
export class RawAiSdkRecipeService {
|
|
271
|
-
public constructor(private readonly _textGenerator: IntelligenceTextGenerator) {}
|
|
272
|
-
|
|
273
|
-
public async answerWithNativeOptions(): Promise<string> {
|
|
274
|
-
const completion = await this._textGenerator.generateText(
|
|
275
|
-
{
|
|
276
|
-
system: 'Answer concisely and include assumptions.',
|
|
277
|
-
prompt: 'Compare the operational risks of outdoor work tomorrow.',
|
|
278
|
-
},
|
|
279
|
-
{
|
|
280
|
-
model: openai.responses('gpt-5'),
|
|
281
|
-
headers: { 'x-use-case': 'outdoor-risk' },
|
|
282
|
-
providerOptions: {
|
|
283
|
-
openai: {
|
|
284
|
-
reasoningEffort: 'medium',
|
|
285
|
-
},
|
|
286
|
-
},
|
|
287
|
-
seed: 42,
|
|
288
|
-
},
|
|
289
|
-
);
|
|
290
|
-
|
|
291
|
-
return completion.text;
|
|
292
|
-
}
|
|
293
|
-
}
|
|
294
|
-
```
|
|
295
|
-
|
|
296
|
-
### Outdoor Order Weather Risk Example
|
|
297
|
-
|
|
298
|
-
Use a class-based application tool for tenant data and a provider-native web search tool for current weather context. Set `INTELLIGENCE_PROVIDER=openai` and `INTELLIGENCE_MODEL=gpt-5` in configuration when this flow should use GPT-5.
|
|
299
|
-
|
|
300
|
-
```typescript
|
|
301
|
-
import { Injectable, Module } from '@nestjs/common';
|
|
302
|
-
import { stepCountIs, tool, type Tool } from 'ai';
|
|
303
|
-
import { z } from 'zod';
|
|
304
|
-
import {
|
|
305
|
-
IntelligenceModule,
|
|
306
|
-
IntelligenceProviderNames,
|
|
307
|
-
IntelligenceTextGenerator,
|
|
308
|
-
IntelligenceToolBase,
|
|
309
|
-
type IIntelligenceTextCompletion,
|
|
310
|
-
} from '@breadstone/archipel-platform-intelligence';
|
|
311
|
-
import { OpenAIIntelligenceToolNames, loadOpenAILanguageModel } from '@breadstone/archipel-platform-intelligence/providers/openai';
|
|
312
|
-
import { createOpenAIWebSearchTool } from '@breadstone/archipel-platform-intelligence/providers/openai/tools';
|
|
313
|
-
|
|
314
|
-
interface IOutdoorOrderLookupInput {
|
|
315
|
-
readonly date: string;
|
|
316
|
-
}
|
|
317
|
-
|
|
318
|
-
interface IOutdoorOrderLookupOutput {
|
|
319
|
-
readonly date: string;
|
|
320
|
-
readonly orders: ReadonlyArray<{
|
|
321
|
-
readonly id: string;
|
|
322
|
-
readonly location: string;
|
|
323
|
-
readonly scheduledAt: string;
|
|
324
|
-
readonly outdoorWork: boolean;
|
|
325
|
-
}>;
|
|
326
|
-
}
|
|
327
|
-
|
|
328
|
-
@Injectable()
|
|
329
|
-
export class OutdoorOrdersTool extends IntelligenceToolBase<IOutdoorOrderLookupInput, IOutdoorOrderLookupOutput> {
|
|
330
|
-
public override get name(): string {
|
|
331
|
-
return 'get_outdoor_orders';
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
public override get tool(): Tool<IOutdoorOrderLookupInput, IOutdoorOrderLookupOutput> {
|
|
335
|
-
return tool({
|
|
336
|
-
description: 'Returns outdoor field orders for the current tenant and date.',
|
|
337
|
-
inputSchema: z.object({
|
|
338
|
-
date: z.string().describe('Date in YYYY-MM-DD format'),
|
|
339
|
-
}),
|
|
340
|
-
execute: async (input: IOutdoorOrderLookupInput) => ({
|
|
341
|
-
date: input.date,
|
|
342
|
-
orders: [
|
|
343
|
-
{
|
|
344
|
-
id: 'ord_4711',
|
|
345
|
-
location: 'Berlin',
|
|
346
|
-
scheduledAt: `${input.date}T08:00:00+02:00`,
|
|
347
|
-
outdoorWork: true,
|
|
348
|
-
},
|
|
349
|
-
],
|
|
350
|
-
}),
|
|
351
|
-
});
|
|
352
|
-
}
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
@Injectable()
|
|
356
|
-
export class OutdoorOrderRiskAnalysisService {
|
|
357
|
-
public constructor(private readonly _textGenerator: IntelligenceTextGenerator) {}
|
|
358
|
-
|
|
359
|
-
public async analyseOutdoorOrders(date: string): Promise<{ readonly text: string; readonly sources: IIntelligenceTextCompletion['sources'] }> {
|
|
360
|
-
const result = await this._textGenerator.generateText(
|
|
361
|
-
{
|
|
362
|
-
system: 'You assess weather-related risks for tenant outdoor field orders.',
|
|
363
|
-
messages: [{ role: 'user', content: `Review outdoor field orders for ${date} and flag weather-related risks.` }],
|
|
364
|
-
},
|
|
365
|
-
{
|
|
366
|
-
toolChoice: 'auto',
|
|
367
|
-
activeTools: ['get_outdoor_orders', OpenAIIntelligenceToolNames.WebSearch],
|
|
368
|
-
stopWhen: stepCountIs(3),
|
|
369
|
-
},
|
|
370
|
-
);
|
|
371
|
-
|
|
372
|
-
return {
|
|
373
|
-
text: result.text,
|
|
374
|
-
sources: result.sources,
|
|
375
|
-
};
|
|
376
|
-
}
|
|
377
|
-
}
|
|
378
|
-
|
|
379
|
-
@Module({
|
|
380
|
-
imports: [
|
|
381
|
-
IntelligenceModule.register({
|
|
382
|
-
providerLoaders: {
|
|
383
|
-
[IntelligenceProviderNames.OpenAI]: loadOpenAILanguageModel,
|
|
384
|
-
},
|
|
385
|
-
tools: [
|
|
386
|
-
OutdoorOrdersTool,
|
|
387
|
-
createOpenAIWebSearchTool({
|
|
388
|
-
externalWebAccess: true,
|
|
389
|
-
searchContextSize: 'medium',
|
|
390
|
-
filters: { allowedDomains: ['dwd.de'] },
|
|
391
|
-
}),
|
|
392
|
-
],
|
|
393
|
-
}),
|
|
394
|
-
],
|
|
395
|
-
providers: [OutdoorOrderRiskAnalysisService],
|
|
396
|
-
})
|
|
397
|
-
export class OutdoorOrderRiskAnalysisModule {}
|
|
398
|
-
```
|
|
399
|
-
|
|
400
|
-
---
|
|
401
|
-
|
|
402
|
-
## Text Generation
|
|
403
|
-
|
|
404
|
-
Inject `IntelligenceTextGenerator` and call `generateText()`:
|
|
405
|
-
|
|
406
|
-
```typescript
|
|
407
|
-
import { Injectable } from '@nestjs/common';
|
|
408
|
-
import type { Prompt } from 'ai';
|
|
409
|
-
import { IntelligenceTextGenerator } from '@breadstone/archipel-platform-intelligence';
|
|
410
|
-
|
|
411
|
-
@Injectable()
|
|
412
|
-
export class SummaryService {
|
|
413
|
-
constructor(private readonly _textGenerator: IntelligenceTextGenerator) {}
|
|
414
|
-
|
|
415
|
-
async summarize(content: string): Promise<string> {
|
|
416
|
-
const prompt: Prompt = {
|
|
417
|
-
system: 'You are a concise summarizer.',
|
|
418
|
-
messages: [{ role: 'user', content }],
|
|
419
|
-
};
|
|
420
|
-
|
|
421
|
-
const result = await this._textGenerator.generateText(prompt, {
|
|
422
|
-
temperature: 0.3,
|
|
423
|
-
toolChoice: 'auto',
|
|
424
|
-
});
|
|
425
|
-
|
|
426
|
-
return result.text;
|
|
427
|
-
}
|
|
428
|
-
}
|
|
429
|
-
```
|
|
430
|
-
|
|
431
|
-
---
|
|
432
|
-
|
|
433
|
-
## Streaming
|
|
434
|
-
`streamText()` uses the same registered tools and returns the native AI SDK stream result.
|
|
435
|
-
|
|
436
|
-
```typescript
|
|
437
|
-
const stream = await this._textGenerator.streamText(prompt, {
|
|
438
|
-
activeTools: ['searchCustomers'],
|
|
439
|
-
stopWhen: stepCountIs(3),
|
|
440
|
-
});
|
|
441
|
-
|
|
442
|
-
return stream.toUIMessageStreamResponse();
|
|
443
|
-
```
|
|
444
|
-
|
|
445
|
-
---
|
|
446
|
-
|
|
447
|
-
## Environment Variables
|
|
448
|
-
|
|
449
|
-
| Variable | Description | Required |
|
|
450
|
-
| -------------------------------- | ---------------------------- | ------------------ |
|
|
451
|
-
| `OPENAI_API_KEY` | OpenAI API key | If using OpenAI |
|
|
452
|
-
| `ANTHROPIC_API_KEY` | Anthropic API key | If using Anthropic |
|
|
453
|
-
| `GOOGLE_API_KEY` | Google Generative AI API key | If using Google |
|
|
454
|
-
| `GROK_API_KEY` | Grok / xAI API key | If using Grok |
|
|
455
|
-
|
|
456
|
-
---
|
|
457
|
-
|
|
458
|
-
## Timeout & Retry
|
|
459
|
-
|
|
460
|
-
All `generateText()` calls include built-in resilience:
|
|
461
|
-
|
|
462
|
-
| Setting | Default | Description |
|
|
463
|
-
| ----------- | -------- | -------------------------------------------------------- |
|
|
464
|
-
| `timeoutMs` | `30000` | Abort the provider request after this many milliseconds |
|
|
465
|
-
| Max retries | `2` | Retryable errors are retried with exponential backoff |
|
|
466
|
-
| Backoff | 1s → 4s | Exponential with a 4-second cap |
|
|
467
|
-
|
|
468
|
-
Override the timeout per call via the options parameter:
|
|
469
|
-
|
|
470
|
-
```typescript
|
|
471
|
-
const result = await this._textGenerator.generateText(prompt, {
|
|
472
|
-
timeoutMs: 15_000,
|
|
473
|
-
});
|
|
474
|
-
```
|
|
475
|
-
|
|
476
|
-
All errors are wrapped in `IntelligenceProviderError` with `provider`, `model`, and `retryable` metadata.
|
|
477
|
-
|
|
478
|
-
---
|
|
479
|
-
|
|
480
|
-
## Error Handling
|
|
481
|
-
|
|
482
|
-
The library provides domain error classes for different failure scenarios:
|
|
483
|
-
|
|
484
|
-
| Error class | Code | When thrown |
|
|
485
|
-
| ---------------------------------- | ----------------------------- | --------------------------------------------------------------------- |
|
|
486
|
-
| `IntelligenceProviderError` | `INTELLIGENCE_PROVIDER` | Provider SDK failures during text generation |
|
|
487
|
-
| `IntelligenceRealtimeError` | Realtime phase metadata | Configuration, token, connect, send, receive, metering, or close failures |
|
|
488
|
-
| `IntelligenceValidationError` | `INTELLIGENCE_VALIDATION` | Invalid generation parameters (temperature, topP, maxOutputTokens) |
|
|
489
|
-
| `IntelligenceConfigurationError` | `INTELLIGENCE_CONFIGURATION` | Unsupported provider, missing API key, or missing provider loader |
|
|
490
|
-
|
|
491
|
-
```typescript
|
|
492
|
-
import {
|
|
493
|
-
IntelligenceProviderError,
|
|
494
|
-
IntelligenceValidationError,
|
|
495
|
-
IntelligenceConfigurationError,
|
|
496
|
-
} from '@breadstone/archipel-platform-intelligence';
|
|
497
|
-
```
|
|
498
|
-
|
|
499
|
-
---
|
|
500
|
-
|
|
501
|
-
## Lifecycle
|
|
502
|
-
|
|
503
|
-
`IntelligenceTextGenerator` implements `OnModuleInit` and validates the provider configuration plus registered provider loader eagerly at startup. Missing API keys, unsupported providers, or missing loaders throw `IntelligenceConfigurationError` before the first request is processed. `IntelligenceRealtimeSessionFactory` implements `OnModuleDestroy`, closes all owned provider WebSockets, and flushes queued metering on shutdown.
|
|
504
|
-
|
|
505
|
-
Set `validateOnModuleInit: false` for a realtime-only module because that option
|
|
506
|
-
controls eager text-model initialization. When text and realtime are both
|
|
507
|
-
used, register the language-model loaders and keep the default eager
|
|
508
|
-
validation.
|
|
509
|
-
|
|
510
|
-
---
|
|
511
|
-
|
|
512
|
-
## Tool Registry Limits
|
|
513
|
-
|
|
514
|
-
`IntelligenceToolRegistry` enforces a maximum of **128** registered tools. Attempts to register beyond this limit throw `IntelligenceValidationError` to prevent unbounded memory growth.
|
|
515
|
-
|
|
516
|
-
---
|
|
517
|
-
|
|
518
|
-
## Health Check
|
|
519
|
-
|
|
520
|
-
The `IntelligenceHealthIndicator` verifies that provider configuration can be resolved and reports registered realtime providers plus active session count. If neither text nor realtime infrastructure is available, it reports `disabled: true`. Import it from the `/health` subpath:
|
|
521
|
-
|
|
522
|
-
```typescript
|
|
523
|
-
import { IntelligenceModule, IntelligenceProviderNames } from '@breadstone/archipel-platform-intelligence';
|
|
524
|
-
import { IntelligenceHealthIndicator } from '@breadstone/archipel-platform-intelligence/health';
|
|
525
|
-
import { loadOpenAILanguageModel } from '@breadstone/archipel-platform-intelligence/providers/openai';
|
|
526
|
-
import { HealthModule } from '@breadstone/archipel-platform-health';
|
|
527
|
-
|
|
528
|
-
@Module({
|
|
529
|
-
imports: [
|
|
530
|
-
IntelligenceModule.register({
|
|
531
|
-
providerLoaders: {
|
|
532
|
-
[IntelligenceProviderNames.OpenAI]: loadOpenAILanguageModel,
|
|
533
|
-
},
|
|
534
|
-
}),
|
|
535
|
-
HealthModule.withIndicators([IntelligenceHealthIndicator]),
|
|
536
|
-
],
|
|
537
|
-
})
|
|
538
|
-
export class AppModule {}
|
|
539
|
-
```
|
|
540
|
-
|
|
541
|
-
| Key | Check | Dependencies |
|
|
542
|
-
| --- | ----- | ------------ |
|
|
543
|
-
| `intelligence` | `up` when provider configuration resolves, else `down`; includes realtime readiness when registered | `@Optional() IntelligenceTextGenerator`, `@Optional() IntelligenceRealtimeSessionFactory` |
|
|
544
|
-
|
|
545
|
-
---
|
|
546
|
-
|
|
547
|
-
## API Reference
|
|
548
|
-
|
|
549
|
-
See the full [API documentation](./api/) for all exported types, interfaces, and classes.
|