@breadstone/archipel-mcp 0.0.54 → 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 -626
- package/data/guides/index.md +2 -1
- package/data/guides/intelligence-prompts-warm-up.md +63 -283
- package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +78 -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 +6 -6
- 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.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/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 +33 -27
- 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 +14 -14
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md +1 -1
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md +1 -1
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md +15 -27
- 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.IIntelligenceRealtimeModuleOptions.md +9 -21
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +11 -11
- 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 +2 -2
- 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.IntelligencePromptDefinitionConfiguration.md +2 -2
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligencePromptGenerationOptions.md +1 -1
- 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.IntelligenceRealtimeMeteringEvent.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 +78 -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 -180
- 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 -627
- 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
|
@@ -1,103 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: platform-feature-flags
|
|
3
|
-
description: Provider-agnostic feature flag infrastructure for NestJS with support for Azure App Configuration and Vercel Edge Config.
|
|
4
|
-
order: 3
|
|
5
|
-
tags: [feature-flags, azure, vercel, edge-config, configuration]
|
|
6
|
-
package: '@breadstone/archipel-platform-feature-flags'
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# platform-feature-flags
|
|
10
|
-
|
|
11
|
-
Provider-agnostic feature flag infrastructure for NestJS with support for Azure App Configuration and Vercel Edge Config.
|
|
12
|
-
|
|
13
|
-
**Package:** `@breadstone/archipel-platform-feature-flags`
|
|
14
|
-
|
|
15
|
-
<InstallTabs />
|
|
16
|
-
|
|
17
|
-
## Provider Subpaths
|
|
18
|
-
|
|
19
|
-
Import only the providers you need:
|
|
20
|
-
|
|
21
|
-
| Provider | Subpath | SDK |
|
|
22
|
-
| ----------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
|
|
23
|
-
| Azure App Configuration | `@breadstone/archipel-platform-feature-flags/azure` | `@azure/app-configuration-provider` + `@microsoft/feature-management` |
|
|
24
|
-
| Vercel Edge Config | `@breadstone/archipel-platform-feature-flags/vercel` | `@vercel/edge-config` |
|
|
25
|
-
|
|
26
|
-
## Quick Start
|
|
27
|
-
|
|
28
|
-
```typescript
|
|
29
|
-
import { Module } from '@nestjs/common';
|
|
30
|
-
import { FeatureFlagsModule } from '@breadstone/archipel-platform-feature-flags';
|
|
31
|
-
import { AzureFeatureFlagsClient, AZURE_FEATURE_FLAGS_CONFIG_ENTRIES } from '@breadstone/archipel-platform-feature-flags/azure';
|
|
32
|
-
|
|
33
|
-
@Module({
|
|
34
|
-
imports: [
|
|
35
|
-
FeatureFlagsModule.register({
|
|
36
|
-
client: AzureFeatureFlagsClient,
|
|
37
|
-
configEntries: AZURE_FEATURE_FLAGS_CONFIG_ENTRIES,
|
|
38
|
-
}),
|
|
39
|
-
],
|
|
40
|
-
})
|
|
41
|
-
export class AppModule {}
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
## Environment Variables
|
|
45
|
-
|
|
46
|
-
### Azure App Configuration
|
|
47
|
-
|
|
48
|
-
| Variable | Required | Description |
|
|
49
|
-
| --------------------------------------- | -------- | ------------------------------------------------ |
|
|
50
|
-
| `AZURE_APP_CONFIGURATION_CONNECTION_STRING` | Yes | Connection string for Azure App Configuration |
|
|
51
|
-
| `AZURE_FEATURE_FLAGS_LABEL` | No | Label filter for feature flags (e.g., `prod`) |
|
|
52
|
-
|
|
53
|
-
### Vercel Edge Config
|
|
54
|
-
|
|
55
|
-
| Variable | Required | Description |
|
|
56
|
-
| ----------------------- | -------- | ------------------------------------ |
|
|
57
|
-
| `EDGE_CONFIG` | Yes | Vercel Edge Config connection string |
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
|
-
## Checking Feature Flags
|
|
62
|
-
|
|
63
|
-
```typescript
|
|
64
|
-
import { Injectable } from '@nestjs/common';
|
|
65
|
-
import { FeatureFlagsService } from '@breadstone/archipel-platform-feature-flags';
|
|
66
|
-
|
|
67
|
-
@Injectable()
|
|
68
|
-
export class MyService {
|
|
69
|
-
public constructor(private readonly _featureFlags: FeatureFlagsService) {}
|
|
70
|
-
|
|
71
|
-
public async doSomething(): Promise<void> {
|
|
72
|
-
const isEnabled = await this._featureFlags.isEnabled('my-feature');
|
|
73
|
-
|
|
74
|
-
if (isEnabled) {
|
|
75
|
-
// Feature is enabled
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
---
|
|
82
|
-
|
|
83
|
-
## Architecture
|
|
84
|
-
|
|
85
|
-
```mermaid
|
|
86
|
-
flowchart TB
|
|
87
|
-
subgraph FeatureFlagsModule
|
|
88
|
-
Service[FeatureFlagsService]
|
|
89
|
-
Port[FeatureFlagsClientPort]
|
|
90
|
-
end
|
|
91
|
-
|
|
92
|
-
subgraph Providers
|
|
93
|
-
Azure[AzureFeatureFlagsClient]
|
|
94
|
-
Vercel[VercelFeatureFlagsClient]
|
|
95
|
-
end
|
|
96
|
-
|
|
97
|
-
Service --> Port
|
|
98
|
-
Port -.-> Azure
|
|
99
|
-
Port -.-> Vercel
|
|
100
|
-
|
|
101
|
-
Azure --> AzureSDK[@azure/app-configuration-provider]
|
|
102
|
-
Vercel --> VercelSDK[@vercel/edge-config]
|
|
103
|
-
```
|
|
@@ -1,141 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: platform-health
|
|
3
|
-
description: Health check orchestration with indicator-based architecture built on @nestjs/terminus.
|
|
4
|
-
order: 4
|
|
5
|
-
tags: [health, terminus, indicators, monitoring]
|
|
6
|
-
package: '@breadstone/archipel-platform-health'
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# platform-health
|
|
10
|
-
|
|
11
|
-
Health check orchestration for NestJS applications built on `@nestjs/terminus`. Register custom health indicators and expose aggregated health status via a single orchestrator. Extracted from `platform-core` to provide a focused, independently versionable health module.
|
|
12
|
-
|
|
13
|
-
**Package:** `@breadstone/archipel-platform-health`
|
|
14
|
-
|
|
15
|
-
<InstallTabs />
|
|
16
|
-
|
|
17
|
-
## Installation
|
|
18
|
-
|
|
19
|
-
```typescript
|
|
20
|
-
import {
|
|
21
|
-
HealthModule,
|
|
22
|
-
HealthOrchestrator,
|
|
23
|
-
IHealthIndicator,
|
|
24
|
-
IHealthCheckResult,
|
|
25
|
-
HEALTH_INDICATORS,
|
|
26
|
-
} from '@breadstone/archipel-platform-health';
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
## Module Registration
|
|
32
|
-
|
|
33
|
-
Register the module with one or more health indicators:
|
|
34
|
-
|
|
35
|
-
```typescript
|
|
36
|
-
import { Module } from '@nestjs/common';
|
|
37
|
-
import { HealthModule } from '@breadstone/archipel-platform-health';
|
|
38
|
-
import { DatabaseHealthIndicator } from './health/DatabaseHealthIndicator';
|
|
39
|
-
import { RedisHealthIndicator } from './health/RedisHealthIndicator';
|
|
40
|
-
|
|
41
|
-
@Module({
|
|
42
|
-
imports: [
|
|
43
|
-
HealthModule.withIndicators([DatabaseHealthIndicator, RedisHealthIndicator]),
|
|
44
|
-
],
|
|
45
|
-
})
|
|
46
|
-
export class AppModule {}
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
## Implementing a Health Indicator
|
|
50
|
-
|
|
51
|
-
Each indicator implements the `IHealthIndicator` interface:
|
|
52
|
-
|
|
53
|
-
```typescript
|
|
54
|
-
import { Injectable } from '@nestjs/common';
|
|
55
|
-
import type { IHealthIndicator, IHealthCheckResult } from '@breadstone/archipel-platform-health';
|
|
56
|
-
|
|
57
|
-
@Injectable()
|
|
58
|
-
export class DatabaseHealthIndicator implements IHealthIndicator {
|
|
59
|
-
public readonly name = 'database';
|
|
60
|
-
|
|
61
|
-
public async isHealthy(): Promise<IHealthCheckResult> {
|
|
62
|
-
try {
|
|
63
|
-
await this._prisma.$queryRaw`SELECT 1`;
|
|
64
|
-
return { status: 'up' };
|
|
65
|
-
} catch (error) {
|
|
66
|
-
return { status: 'down', details: { error: (error as Error).message } };
|
|
67
|
-
}
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
## Using the Orchestrator
|
|
73
|
-
|
|
74
|
-
The `HealthOrchestrator` runs all registered indicators and returns aggregated results:
|
|
75
|
-
|
|
76
|
-
```typescript
|
|
77
|
-
import { Controller, Get } from '@nestjs/common';
|
|
78
|
-
import { HealthOrchestrator } from '@breadstone/archipel-platform-health';
|
|
79
|
-
|
|
80
|
-
@Controller('health')
|
|
81
|
-
export class HealthController {
|
|
82
|
-
constructor(private readonly _healthOrchestrator: HealthOrchestrator) {}
|
|
83
|
-
|
|
84
|
-
@Get()
|
|
85
|
-
public async check(): Promise<unknown> {
|
|
86
|
-
return this._healthOrchestrator.check();
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
---
|
|
92
|
-
|
|
93
|
-
## Built-in Consumers
|
|
94
|
-
|
|
95
|
-
All Archipel platform libraries provide health indicators via their `/health` subpath export. Register them with `HealthModule.withIndicators()`:
|
|
96
|
-
|
|
97
|
-
| Library | Indicator | Key | Check |
|
|
98
|
-
| ------------------------ | ------------------------------ | ---------------- | --------------------------------------------------------- |
|
|
99
|
-
| `platform-database` | `DatabaseHealthIndicator` | `database` | Prisma `SELECT 1` ping |
|
|
100
|
-
| `platform-blob-storage` | `BlobHealthIndicator` | `blob` | HTTP ping to blob URL (or disabled if unconfigured) |
|
|
101
|
-
| `platform-mailing` | `MailHealthIndicator` | `mail` | Validates mail host, user, and port config |
|
|
102
|
-
| `platform-caching` | `CachingHealthIndicator` | `caching` | Always `up` |
|
|
103
|
-
| `platform-queue` | `QueueHealthIndicator` | `queue` | Always `up` |
|
|
104
|
-
| `platform-payments` | `PaymentHealthIndicator` | `payment` | `up` if `PaymentClientPort` injected, else `disabled` |
|
|
105
|
-
| `platform-esigning` | `EsigningHealthIndicator` | `esigning` | `up` if `EsigningClientPort` injected, else `disabled` |
|
|
106
|
-
| `platform-intelligence` | `IntelligenceHealthIndicator` | `intelligence` | Resolves text configuration and reports realtime providers plus active sessions; `disabled` when neither service is present |
|
|
107
|
-
| `platform-analytics` | `AnalyticsHealthIndicator` | `analytics` | `up` if `AnalyticsClientPort` injected, else `disabled` |
|
|
108
|
-
| `platform-telemetry` | `TelemetryHealthIndicator` | `telemetry` | `up` if `OtelSdkHolder` injected, else `disabled` |
|
|
109
|
-
| `platform-authentication`| `AuthenticationHealthIndicator`| `authentication` | Always `up` |
|
|
110
|
-
| `platform-mcp` | `McpHealthIndicator` | `mcp` | `up` if `McpRegistryService` injected, else `disabled` |
|
|
111
|
-
|
|
112
|
-
See the [Health Indicators guide](../../guides/health-indicators) for full setup instructions.
|
|
113
|
-
|
|
114
|
-
---
|
|
115
|
-
|
|
116
|
-
## Interfaces
|
|
117
|
-
|
|
118
|
-
| Interface | Description |
|
|
119
|
-
| ---------------------- | ----------------------------------------------------------------- |
|
|
120
|
-
| `IHealthIndicator` | Contract for health check implementations (`name` + `isHealthy`) |
|
|
121
|
-
| `IHealthCheckResult` | Result object with `status` (`'up'` or `'down'`) and optional `details` |
|
|
122
|
-
|
|
123
|
-
---
|
|
124
|
-
|
|
125
|
-
## Tokens
|
|
126
|
-
|
|
127
|
-
| Token | Description |
|
|
128
|
-
| -------------------- | -------------------------------------------------------- |
|
|
129
|
-
| `HEALTH_INDICATORS` | Multi-provider token for registering health indicators |
|
|
130
|
-
|
|
131
|
-
---
|
|
132
|
-
|
|
133
|
-
## Resource Bounds
|
|
134
|
-
|
|
135
|
-
The `HealthOrchestrator` enforces a maximum of **100** registered indicators. If the limit is exceeded, the indicator is skipped and a warning is logged.
|
|
136
|
-
|
|
137
|
-
---
|
|
138
|
-
|
|
139
|
-
## API Reference
|
|
140
|
-
|
|
141
|
-
The auto-generated API reference is published when API docs are generated for this package.
|
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Class: IntelligenceStructuredGenerator'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Class: IntelligenceStructuredGenerator
|
|
7
|
-
|
|
8
|
-
Defined in: [IntelligenceStructuredGenerator.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceStructuredGenerator.ts#L20)
|
|
9
|
-
|
|
10
|
-
Executes AI SDK structured-output generation.
|
|
11
|
-
|
|
12
|
-
## Constructors
|
|
13
|
-
|
|
14
|
-
### Constructor
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
new IntelligenceStructuredGenerator(): IntelligenceStructuredGenerator;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
#### Returns
|
|
21
|
-
|
|
22
|
-
`IntelligenceStructuredGenerator`
|
|
23
|
-
|
|
24
|
-
## Methods
|
|
25
|
-
|
|
26
|
-
### generateObject()
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
generateObject(options): Promise<GenerateObjectResult<unknown>>;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [IntelligenceStructuredGenerator.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceStructuredGenerator.ts#L42)
|
|
33
|
-
|
|
34
|
-
Generates a structured object using the native AI SDK object API.
|
|
35
|
-
|
|
36
|
-
#### Parameters
|
|
37
|
-
|
|
38
|
-
| Parameter | Type | Description |
|
|
39
|
-
| ------ | ------ | ------ |
|
|
40
|
-
| `options` | `Omit`\<`LanguageModelCallOptions`, `"stopSequences"`\> & Omit\<RequestOptions\<ToolSet\>, "timeout"\> & (Prompt & ((\{\} \| \{ schema: FlexibleSchema\<unknown\>; schemaName?: string \| undefined; schemaDescription?: string \| undefined; \} \| \{ ...; \}) & \{ ...; \})) | Native AI SDK `generateObject()` options. |
|
|
41
|
-
|
|
42
|
-
#### Returns
|
|
43
|
-
|
|
44
|
-
`Promise`\<`GenerateObjectResult`\<`unknown`\>\>
|
|
45
|
-
|
|
46
|
-
The native AI SDK object-generation result.
|
|
47
|
-
|
|
48
|
-
***
|
|
49
|
-
|
|
50
|
-
### streamObject()
|
|
51
|
-
|
|
52
|
-
```ts
|
|
53
|
-
streamObject(options): Promise<StreamObjectResult<unknown, unknown, never>>;
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
Defined in: [IntelligenceStructuredGenerator.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceStructuredGenerator.ts#L55)
|
|
57
|
-
|
|
58
|
-
Streams a structured object using the native AI SDK object API.
|
|
59
|
-
|
|
60
|
-
#### Parameters
|
|
61
|
-
|
|
62
|
-
| Parameter | Type | Description |
|
|
63
|
-
| ------ | ------ | ------ |
|
|
64
|
-
| `options` | `Omit`\<`LanguageModelCallOptions`, `"stopSequences"`\> & Omit\<RequestOptions\<ToolSet\>, "timeout"\> & (Prompt & ((\{\} \| \{ schema: FlexibleSchema\<unknown\>; schemaName?: string \| undefined; schemaDescription?: string \| undefined; \} \| \{ ...; \}) & \{ ...; \})) | Native AI SDK `streamObject()` options. |
|
|
65
|
-
|
|
66
|
-
#### Returns
|
|
67
|
-
|
|
68
|
-
`Promise`\<`StreamObjectResult`\<`unknown`, `unknown`, `never`\>\>
|
|
69
|
-
|
|
70
|
-
The native AI SDK streaming object result.
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Class: IntelligenceTelemetryRegistry'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Class: IntelligenceTelemetryRegistry
|
|
7
|
-
|
|
8
|
-
Defined in: [IntelligenceTelemetryRegistry.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTelemetryRegistry.ts#L15)
|
|
9
|
-
|
|
10
|
-
Registers AI SDK telemetry integrations for the current process.
|
|
11
|
-
|
|
12
|
-
## Constructors
|
|
13
|
-
|
|
14
|
-
### Constructor
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
new IntelligenceTelemetryRegistry(): IntelligenceTelemetryRegistry;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
#### Returns
|
|
21
|
-
|
|
22
|
-
`IntelligenceTelemetryRegistry`
|
|
23
|
-
|
|
24
|
-
## Methods
|
|
25
|
-
|
|
26
|
-
### register()
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
register(...integrations): Promise<void>;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [IntelligenceTelemetryRegistry.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTelemetryRegistry.ts#L36)
|
|
33
|
-
|
|
34
|
-
Registers one or more native AI SDK telemetry integrations.
|
|
35
|
-
|
|
36
|
-
#### Parameters
|
|
37
|
-
|
|
38
|
-
| Parameter | Type | Description |
|
|
39
|
-
| ------ | ------ | ------ |
|
|
40
|
-
| ...`integrations` | `Telemetry`[] | Native AI SDK telemetry integrations. |
|
|
41
|
-
|
|
42
|
-
#### Returns
|
|
43
|
-
|
|
44
|
-
`Promise`\<`void`\>
|
|
@@ -1,138 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Class: IntelligenceTextGenerator'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Class: IntelligenceTextGenerator
|
|
7
|
-
|
|
8
|
-
Defined in: [IntelligenceTextGenerator.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L34)
|
|
9
|
-
|
|
10
|
-
Executes text completions using the configured intelligence provider.
|
|
11
|
-
|
|
12
|
-
## Implements
|
|
13
|
-
|
|
14
|
-
- [`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator)
|
|
15
|
-
- `OnModuleInit`
|
|
16
|
-
|
|
17
|
-
## Constructors
|
|
18
|
-
|
|
19
|
-
### Constructor
|
|
20
|
-
|
|
21
|
-
```ts
|
|
22
|
-
new IntelligenceTextGenerator(
|
|
23
|
-
configService,
|
|
24
|
-
toolRegistry,
|
|
25
|
-
providerLoaders,
|
|
26
|
-
validateOnModuleInit?): IntelligenceTextGenerator;
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
Defined in: [IntelligenceTextGenerator.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L49)
|
|
30
|
-
|
|
31
|
-
#### Parameters
|
|
32
|
-
|
|
33
|
-
| Parameter | Type | Default value |
|
|
34
|
-
| ------ | ------ | ------ |
|
|
35
|
-
| `configService` | `ConfigService` | `undefined` |
|
|
36
|
-
| `toolRegistry` | [`IntelligenceToolRegistry`](Class.IntelligenceToolRegistry) | `undefined` |
|
|
37
|
-
| `providerLoaders` | [`IntelligenceLanguageModelLoaders`](TypeAlias.IntelligenceLanguageModelLoaders) | `undefined` |
|
|
38
|
-
| `validateOnModuleInit` | `boolean` | `true` |
|
|
39
|
-
|
|
40
|
-
#### Returns
|
|
41
|
-
|
|
42
|
-
`IntelligenceTextGenerator`
|
|
43
|
-
|
|
44
|
-
## Methods
|
|
45
|
-
|
|
46
|
-
### generateText()
|
|
47
|
-
|
|
48
|
-
```ts
|
|
49
|
-
generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
Defined in: [IntelligenceTextGenerator.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L90)
|
|
53
|
-
|
|
54
|
-
Generates a completion using the configured provider.
|
|
55
|
-
|
|
56
|
-
#### Parameters
|
|
57
|
-
|
|
58
|
-
| Parameter | Type | Description |
|
|
59
|
-
| ------ | ------ | ------ |
|
|
60
|
-
| `prompt` | `Prompt` | The assembled prompt payload. |
|
|
61
|
-
| `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) | Optional overrides for the text generation request. |
|
|
62
|
-
|
|
63
|
-
#### Returns
|
|
64
|
-
|
|
65
|
-
`Promise`\<[`IIntelligenceTextCompletion`](Interface.IIntelligenceTextCompletion)\>
|
|
66
|
-
|
|
67
|
-
#### Implementation of
|
|
68
|
-
|
|
69
|
-
[`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator).[`generateText`](Interface.IIntelligenceTextGenerator#generatetext)
|
|
70
|
-
|
|
71
|
-
***
|
|
72
|
-
|
|
73
|
-
### getConfiguration()
|
|
74
|
-
|
|
75
|
-
```ts
|
|
76
|
-
getConfiguration(): IIntelligenceProviderConfiguration;
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
Defined in: [IntelligenceTextGenerator.ts:270](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L270)
|
|
80
|
-
|
|
81
|
-
Returns the resolved provider configuration with the API key redacted.
|
|
82
|
-
|
|
83
|
-
#### Returns
|
|
84
|
-
|
|
85
|
-
[`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration)
|
|
86
|
-
|
|
87
|
-
#### Implementation of
|
|
88
|
-
|
|
89
|
-
[`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator).[`getConfiguration`](Interface.IIntelligenceTextGenerator#getconfiguration)
|
|
90
|
-
|
|
91
|
-
***
|
|
92
|
-
|
|
93
|
-
### onModuleInit()
|
|
94
|
-
|
|
95
|
-
```ts
|
|
96
|
-
onModuleInit(): Promise<void>;
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
Defined in: [IntelligenceTextGenerator.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L74)
|
|
100
|
-
|
|
101
|
-
Eagerly resolves configuration at startup to fail fast on missing keys.
|
|
102
|
-
|
|
103
|
-
#### Returns
|
|
104
|
-
|
|
105
|
-
`Promise`\<`void`\>
|
|
106
|
-
|
|
107
|
-
#### Implementation of
|
|
108
|
-
|
|
109
|
-
```ts
|
|
110
|
-
OnModuleInit.onModuleInit
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
***
|
|
114
|
-
|
|
115
|
-
### streamText()
|
|
116
|
-
|
|
117
|
-
```ts
|
|
118
|
-
streamText(prompt, options?): Promise<StreamTextResult<ToolSet, Context, Output<string, string, never>>>;
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
Defined in: [IntelligenceTextGenerator.ts:195](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L195)
|
|
122
|
-
|
|
123
|
-
Streams a completion using the configured provider.
|
|
124
|
-
|
|
125
|
-
#### Parameters
|
|
126
|
-
|
|
127
|
-
| Parameter | Type | Description |
|
|
128
|
-
| ------ | ------ | ------ |
|
|
129
|
-
| `prompt` | `Prompt` | The assembled prompt payload. |
|
|
130
|
-
| `options?` | [`IIntelligenceTextStreamingOptions`](Interface.IIntelligenceTextStreamingOptions) | Optional overrides for the streaming request. |
|
|
131
|
-
|
|
132
|
-
#### Returns
|
|
133
|
-
|
|
134
|
-
`Promise`\<`StreamTextResult`\<`ToolSet`, `Context`, `Output`\<`string`, `string`, `never`\>\>\>
|
|
135
|
-
|
|
136
|
-
#### Implementation of
|
|
137
|
-
|
|
138
|
-
[`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator).[`streamText`](Interface.IIntelligenceTextGenerator#streamtext)
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Function: createProviderOptions()'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Function: createProviderOptions()
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
function createProviderOptions(configuration): {
|
|
10
|
-
apiKey: string;
|
|
11
|
-
baseURL?: string;
|
|
12
|
-
};
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
Defined in: [providers/createProviderOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/createProviderOptions.ts#L14)
|
|
16
|
-
|
|
17
|
-
Creates the provider options object consumed by the AI SDK model factories.
|
|
18
|
-
|
|
19
|
-
## Parameters
|
|
20
|
-
|
|
21
|
-
| Parameter | Type | Description |
|
|
22
|
-
| ------ | ------ | ------ |
|
|
23
|
-
| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
|
|
24
|
-
|
|
25
|
-
## Returns
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
{
|
|
29
|
-
apiKey: string;
|
|
30
|
-
baseURL?: string;
|
|
31
|
-
}
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
The options record containing `apiKey` and optionally `baseURL`.
|
|
35
|
-
|
|
36
|
-
| Name | Type | Defined in |
|
|
37
|
-
| ------ | ------ | ------ |
|
|
38
|
-
| `apiKey` | `string` | [providers/createProviderOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/createProviderOptions.ts#L14) |
|
|
39
|
-
| `baseURL?` | `string` | [providers/createProviderOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/createProviderOptions.ts#L14) |
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Function: loadAnthropicLanguageModel()'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Function: loadAnthropicLanguageModel()
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
function loadAnthropicLanguageModel(configuration): Promise<LanguageModelV4>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [providers/anthropic/loadAnthropicLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/anthropic/loadAnthropicLanguageModel.ts#L17)
|
|
13
|
-
|
|
14
|
-
Creates the Anthropic language model from the resolved provider configuration.
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
| Parameter | Type | Description |
|
|
19
|
-
| ------ | ------ | ------ |
|
|
20
|
-
| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
|
|
21
|
-
|
|
22
|
-
## Returns
|
|
23
|
-
|
|
24
|
-
`Promise`\<`LanguageModelV4`\>
|
|
25
|
-
|
|
26
|
-
The configured language model instance.
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Function: loadGoogleLanguageModel()'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Function: loadGoogleLanguageModel()
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
function loadGoogleLanguageModel(configuration): Promise<LanguageModelV4>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [providers/google/loadGoogleLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/loadGoogleLanguageModel.ts#L17)
|
|
13
|
-
|
|
14
|
-
Creates the Google Gemini language model from the resolved provider configuration.
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
| Parameter | Type | Description |
|
|
19
|
-
| ------ | ------ | ------ |
|
|
20
|
-
| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
|
|
21
|
-
|
|
22
|
-
## Returns
|
|
23
|
-
|
|
24
|
-
`Promise`\<`LanguageModelV4`\>
|
|
25
|
-
|
|
26
|
-
The configured language model instance.
|
|
@@ -1,25 +0,0 @@
|
|
|
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](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/google/loadGoogleRealtimeModel.ts#L17)
|
|
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`\>
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Function: loadGrokLanguageModel()'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Function: loadGrokLanguageModel()
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
function loadGrokLanguageModel(configuration): Promise<LanguageModelV4>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [providers/grok/loadGrokLanguageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/loadGrokLanguageModel.ts#L17)
|
|
13
|
-
|
|
14
|
-
Creates the Grok language model through the native xAI provider.
|
|
15
|
-
|
|
16
|
-
## Parameters
|
|
17
|
-
|
|
18
|
-
| Parameter | Type | Description |
|
|
19
|
-
| ------ | ------ | ------ |
|
|
20
|
-
| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
|
|
21
|
-
|
|
22
|
-
## Returns
|
|
23
|
-
|
|
24
|
-
`Promise`\<`LanguageModelV4`\>
|
|
25
|
-
|
|
26
|
-
The configured language model instance.
|
|
@@ -1,25 +0,0 @@
|
|
|
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](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/grok/loadGrokRealtimeModel.ts#L17)
|
|
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`\>
|