@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
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: IntelligenceProviderToolOptions'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: IntelligenceProviderToolOptions
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type IntelligenceProviderToolOptions = Readonly<Record<string, unknown>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: contracts/IntelligenceProviderToolOptions.ts:9
|
|
13
|
+
|
|
14
|
+
Opaque provider-tool configuration accepted only by provider-specific subpaths.
|
|
15
|
+
|
|
16
|
+
Applications keep the options object inside Archipel while the provider
|
|
17
|
+
adapter validates its exact shape at runtime.
|
package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeClientEvent.md
CHANGED
|
@@ -59,6 +59,6 @@ type IntelligenceRealtimeClientEvent =
|
|
|
59
59
|
};
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
Defined in: realtime/contracts/IntelligenceRealtimeClientEvent.ts:12
|
|
62
|
+
Defined in: [realtime/contracts/IntelligenceRealtimeClientEvent.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeClientEvent.ts#L12)
|
|
63
63
|
|
|
64
64
|
Provider-neutral event sent from an application to a realtime model.
|
package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMetadataValue.md
CHANGED
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
type IntelligenceRealtimeMetadataValue = string | number | boolean | null;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: realtime/contracts/IntelligenceRealtimeMetadataValue.ts:6
|
|
12
|
+
Defined in: [realtime/contracts/IntelligenceRealtimeMetadataValue.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeMetadataValue.ts#L6)
|
|
13
13
|
|
|
14
14
|
Serializable metadata copied into realtime metering events.
|
package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeMeteringEvent.md
CHANGED
|
@@ -34,7 +34,7 @@ type IntelligenceRealtimeMeteringEvent =
|
|
|
34
34
|
};
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
Defined in: realtime/contracts/IntelligenceRealtimeMeteringEvent.ts:
|
|
37
|
+
Defined in: [realtime/contracts/IntelligenceRealtimeMeteringEvent.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeMeteringEvent.ts#L43)
|
|
38
38
|
|
|
39
39
|
Durable metering event emitted by an Archipel realtime session.
|
|
40
40
|
|
package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRealtimeServerEvent.md
CHANGED
|
@@ -150,7 +150,7 @@ type IntelligenceRealtimeServerEvent =
|
|
|
150
150
|
};
|
|
151
151
|
```
|
|
152
152
|
|
|
153
|
-
Defined in: realtime/contracts/IntelligenceRealtimeServerEvent.ts:10
|
|
153
|
+
Defined in: [realtime/contracts/IntelligenceRealtimeServerEvent.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeServerEvent.ts#L10)
|
|
154
154
|
|
|
155
155
|
Provider-neutral event emitted by a realtime model.
|
|
156
156
|
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
type IntelligenceRealtimeStatus = "idle" | "connecting" | "connected" | "closing" | "closed" | "error";
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: realtime/contracts/IntelligenceRealtimeStatus.ts:6
|
|
12
|
+
Defined in: [realtime/contracts/IntelligenceRealtimeStatus.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IntelligenceRealtimeStatus.ts#L6)
|
|
13
13
|
|
|
14
14
|
Describes the lifecycle state of an upstream realtime model connection.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: IntelligenceRequestTimeouts'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: IntelligenceRequestTimeouts
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type IntelligenceRequestTimeouts = Readonly<Partial<Record<IntelligenceCapability, number>>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: contracts/IntelligenceRequestTimeouts.ts:12
|
|
13
|
+
|
|
14
|
+
Capability-specific total request timeouts in milliseconds.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: IntelligenceToolChoice'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: IntelligenceToolChoice
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type IntelligenceToolChoice =
|
|
10
|
+
| "auto"
|
|
11
|
+
| "none"
|
|
12
|
+
| "required"
|
|
13
|
+
| {
|
|
14
|
+
toolName: string;
|
|
15
|
+
type: "tool";
|
|
16
|
+
};
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Defined in: contracts/IntelligenceToolChoice.ts:6
|
|
20
|
+
|
|
21
|
+
Provider-neutral tool-selection policy.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: IntelligenceToolOutput'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: IntelligenceToolOutput
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type IntelligenceToolOutput =
|
|
10
|
+
| {
|
|
11
|
+
output: unknown;
|
|
12
|
+
type: "tool-result";
|
|
13
|
+
}
|
|
14
|
+
| {
|
|
15
|
+
error: unknown;
|
|
16
|
+
type: "tool-error";
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: contracts/IntelligenceToolOutput.ts:6
|
|
21
|
+
|
|
22
|
+
Provider-neutral tool result.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: IntelligenceToolSet'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: IntelligenceToolSet
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type IntelligenceToolSet = Readonly<Record<string, IIntelligenceToolDefinition>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: contracts/IntelligenceToolSet.ts:12
|
|
13
|
+
|
|
14
|
+
Provider-neutral named tool collection.
|
package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: IntelligenceTranscriptionStreamPart'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: IntelligenceTranscriptionStreamPart
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type IntelligenceTranscriptionStreamPart =
|
|
10
|
+
| {
|
|
11
|
+
delta: string;
|
|
12
|
+
id?: string;
|
|
13
|
+
providerMetadata?: IntelligenceProviderOptions;
|
|
14
|
+
type: "transcript-delta";
|
|
15
|
+
}
|
|
16
|
+
| {
|
|
17
|
+
channelIndex?: number;
|
|
18
|
+
durationInSeconds?: number;
|
|
19
|
+
id?: string;
|
|
20
|
+
providerMetadata?: IntelligenceProviderOptions;
|
|
21
|
+
startSecond?: number;
|
|
22
|
+
text: string;
|
|
23
|
+
type: "transcript-partial";
|
|
24
|
+
}
|
|
25
|
+
| {
|
|
26
|
+
channelIndex?: number;
|
|
27
|
+
endSecond?: number;
|
|
28
|
+
id?: string;
|
|
29
|
+
providerMetadata?: IntelligenceProviderOptions;
|
|
30
|
+
startSecond?: number;
|
|
31
|
+
text: string;
|
|
32
|
+
type: "transcript-final";
|
|
33
|
+
}
|
|
34
|
+
| {
|
|
35
|
+
rawValue: unknown;
|
|
36
|
+
type: "raw";
|
|
37
|
+
}
|
|
38
|
+
| {
|
|
39
|
+
error: unknown;
|
|
40
|
+
type: "error";
|
|
41
|
+
};
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Defined in: contracts/IntelligenceTranscriptionStreamPart.ts:12
|
|
45
|
+
|
|
46
|
+
Provider-neutral live transcription event.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AI\_GATEWAY\_API\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: AI\_GATEWAY\_API\_KEY
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const AI_GATEWAY_API_KEY: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: providers/gateway/env.ts:10
|
|
13
|
+
|
|
14
|
+
Vercel AI Gateway API key.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AI\_GATEWAY\_BASE\_URL'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: AI\_GATEWAY\_BASE\_URL
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const AI_GATEWAY_BASE_URL: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: providers/gateway/env.ts:13
|
|
13
|
+
|
|
14
|
+
Vercel AI Gateway base URL.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AI\_GATEWAY\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: AI\_GATEWAY\_CONFIG\_ENTRIES
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const AI_GATEWAY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: providers/gateway/env.ts:16
|
|
13
|
+
|
|
14
|
+
Configuration entries used by the Vercel AI Gateway provider.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_API_KEY: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L44)
|
|
13
13
|
|
|
14
14
|
Global API key override for the intelligence provider.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_BASE_URL: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L47)
|
|
13
13
|
|
|
14
14
|
Global base URL override for the intelligence provider.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_MAX_OUTPUT_TOKENS: IConfigKey<number>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L38)
|
|
13
13
|
|
|
14
14
|
Maximum number of output tokens for the AI model.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_MODEL: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L29)
|
|
13
13
|
|
|
14
14
|
AI model identifier to use for text generation.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_PROVIDER: IConfigKey<string>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L41)
|
|
13
13
|
|
|
14
|
-
Intelligence provider name (e.g. openai, anthropic, google, grok, mimo).
|
|
14
|
+
Intelligence provider name (e.g. openai, anthropic, google, grok, mimo, gateway).
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_TEMPERATURE: IConfigKey<number>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L32)
|
|
13
13
|
|
|
14
14
|
Sampling temperature for the AI model.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const INTELLIGENCE_TOP_P: IConfigKey<number>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L35)
|
|
13
13
|
|
|
14
14
|
Top-p (nucleus sampling) for the AI model.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: IntelligenceCapabilityNames'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: IntelligenceCapabilityNames
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const IntelligenceCapabilityNames: {
|
|
10
|
+
Embedding: "embedding";
|
|
11
|
+
Files: "files";
|
|
12
|
+
Image: "image";
|
|
13
|
+
Language: "language";
|
|
14
|
+
Realtime: "realtime";
|
|
15
|
+
Reranking: "reranking";
|
|
16
|
+
Skills: "skills";
|
|
17
|
+
Speech: "speech";
|
|
18
|
+
Transcription: "transcription";
|
|
19
|
+
Video: "video";
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Defined in: contracts/IntelligenceCapabilityNames.ts:6
|
|
24
|
+
|
|
25
|
+
Capability identifiers understood by the intelligence provider registry.
|
|
26
|
+
|
|
27
|
+
## Type Declaration
|
|
28
|
+
|
|
29
|
+
| Name | Type | Default value | Defined in |
|
|
30
|
+
| ------ | ------ | ------ | ------ |
|
|
31
|
+
| <a id="property-embedding"></a> `Embedding` | `"embedding"` | `'embedding'` | contracts/IntelligenceCapabilityNames.ts:8 |
|
|
32
|
+
| <a id="property-files"></a> `Files` | `"files"` | `'files'` | contracts/IntelligenceCapabilityNames.ts:15 |
|
|
33
|
+
| <a id="property-image"></a> `Image` | `"image"` | `'image'` | contracts/IntelligenceCapabilityNames.ts:9 |
|
|
34
|
+
| <a id="property-language"></a> `Language` | `"language"` | `'language'` | contracts/IntelligenceCapabilityNames.ts:7 |
|
|
35
|
+
| <a id="property-realtime"></a> `Realtime` | `"realtime"` | `'realtime'` | contracts/IntelligenceCapabilityNames.ts:14 |
|
|
36
|
+
| <a id="property-reranking"></a> `Reranking` | `"reranking"` | `'reranking'` | contracts/IntelligenceCapabilityNames.ts:13 |
|
|
37
|
+
| <a id="property-skills"></a> `Skills` | `"skills"` | `'skills'` | contracts/IntelligenceCapabilityNames.ts:16 |
|
|
38
|
+
| <a id="property-speech"></a> `Speech` | `"speech"` | `'speech'` | contracts/IntelligenceCapabilityNames.ts:10 |
|
|
39
|
+
| <a id="property-transcription"></a> `Transcription` | `"transcription"` | `'transcription'` | contracts/IntelligenceCapabilityNames.ts:11 |
|
|
40
|
+
| <a id="property-video"></a> `Video` | `"video"` | `'video'` | contracts/IntelligenceCapabilityNames.ts:12 |
|
|
@@ -8,6 +8,7 @@ editUrl: false
|
|
|
8
8
|
```ts
|
|
9
9
|
const IntelligenceProviderNames: {
|
|
10
10
|
Anthropic: "anthropic";
|
|
11
|
+
Gateway: "gateway";
|
|
11
12
|
Google: "google";
|
|
12
13
|
Grok: "grok";
|
|
13
14
|
MiMo: "mimo";
|
|
@@ -24,6 +25,7 @@ Enumerates the supported model providers powering the intelligence pipeline.
|
|
|
24
25
|
| Name | Type | Default value | Defined in |
|
|
25
26
|
| ------ | ------ | ------ | ------ |
|
|
26
27
|
| <a id="property-anthropic"></a> `Anthropic` | `"anthropic"` | `'anthropic'` | [contracts/IntelligenceProviderNames.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L8) |
|
|
28
|
+
| <a id="property-gateway"></a> `Gateway` | `"gateway"` | `'gateway'` | [contracts/IntelligenceProviderNames.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L12) |
|
|
27
29
|
| <a id="property-google"></a> `Google` | `"google"` | `'google'` | [contracts/IntelligenceProviderNames.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L9) |
|
|
28
30
|
| <a id="property-grok"></a> `Grok` | `"grok"` | `'grok'` | [contracts/IntelligenceProviderNames.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L10) |
|
|
29
31
|
| <a id="property-mimo"></a> `MiMo` | `"mimo"` | `'mimo'` | [contracts/IntelligenceProviderNames.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L11) |
|
package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md
CHANGED
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const PLATFORM_INTELLIGENCE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [env.ts:
|
|
12
|
+
Defined in: [env.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/env.ts#L54)
|
|
13
13
|
|
|
14
14
|
All configuration entries required by `platform-intelligence`.
|
|
@@ -9,32 +9,72 @@ editUrl: false
|
|
|
9
9
|
|
|
10
10
|
| Class | Description |
|
|
11
11
|
| ------ | ------ |
|
|
12
|
-
| [
|
|
12
|
+
| [AnthropicIntelligenceProviderAdapter](Class.AnthropicIntelligenceProviderAdapter) | Anthropic adapter for language, files, and skills. |
|
|
13
|
+
| [DefaultIntelligencePromptPolicyAdapter](Class.DefaultIntelligencePromptPolicyAdapter) | Default prompt policy that supports native settings and automatic model selection. |
|
|
14
|
+
| [GatewayIntelligenceProviderAdapter](Class.GatewayIntelligenceProviderAdapter) | Vercel AI Gateway adapter spanning all standardized model capabilities. |
|
|
15
|
+
| [GoogleIntelligenceProviderAdapter](Class.GoogleIntelligenceProviderAdapter) | Google adapter for language, embeddings, images, speech, video, realtime, and files. |
|
|
16
|
+
| [GrokIntelligenceProviderAdapter](Class.GrokIntelligenceProviderAdapter) | xAI Grok adapter for language, image, speech, transcription, video, realtime, and files. |
|
|
17
|
+
| [IntelligenceAgent](Class.IntelligenceAgent) | Reusable provider-neutral agent backed by the language capability. |
|
|
18
|
+
| [IntelligenceAgentFactory](Class.IntelligenceAgentFactory) | Creates reusable provider-neutral tool-loop agents. |
|
|
13
19
|
| [IntelligenceConfigurationError](Class.IntelligenceConfigurationError) | Error thrown when an intelligence provider configuration is invalid or missing. |
|
|
14
|
-
| [IntelligenceEmbeddingGenerator](Class.IntelligenceEmbeddingGenerator) |
|
|
20
|
+
| [IntelligenceEmbeddingGenerator](Class.IntelligenceEmbeddingGenerator) | Provider-neutral single and batch embedding facade. |
|
|
15
21
|
| [IntelligenceHealthIndicator](Class.IntelligenceHealthIndicator) | Health indicator for the intelligence infrastructure. Verifies that the intelligence provider configuration can be resolved. |
|
|
16
|
-
| [
|
|
22
|
+
| [IntelligenceLanguageGenerator](Class.IntelligenceLanguageGenerator) | Provider-neutral language generation, structured output, and streaming facade. |
|
|
23
|
+
| [IntelligenceMediaGenerator](Class.IntelligenceMediaGenerator) | Single provider-neutral facade for image, speech, transcription, and video. |
|
|
17
24
|
| [IntelligenceModule](Class.IntelligenceModule) | Core module exposing the shared intelligence infrastructure. |
|
|
18
|
-
| [
|
|
25
|
+
| [IntelligencePromptExecutor](Class.IntelligencePromptExecutor) | Validates and executes reusable intelligence prompt invocations. |
|
|
26
|
+
| [IntelligencePromptPolicyPort](Class.IntelligencePromptPolicyPort) | Resolves provider-neutral prompt requirements into effective generation settings. |
|
|
27
|
+
| [IntelligenceProviderAssetUploader](Class.IntelligenceProviderAssetUploader) | Uploads provider-managed files and skills behind provider-neutral contracts. |
|
|
28
|
+
| [IntelligenceProviderDiagnostics](Class.IntelligenceProviderDiagnostics) | Performs bounded, provider-neutral provider availability diagnostics. |
|
|
19
29
|
| [IntelligenceProviderError](Class.IntelligenceProviderError) | Error thrown when an intelligence provider call fails. |
|
|
30
|
+
| [IntelligenceProviderRegistry](Class.IntelligenceProviderRegistry) | Immutable registry of provider adapters and their supported capabilities. |
|
|
20
31
|
| [IntelligenceRealtimeError](Class.IntelligenceRealtimeError) | Error raised by a realtime session, transport, or metering adapter. |
|
|
21
32
|
| [IntelligenceRealtimeMeteringPort](Class.IntelligenceRealtimeMeteringPort) | Application port for idempotently persisting realtime billing and audit events. |
|
|
22
33
|
| [IntelligenceRealtimeSessionFactory](Class.IntelligenceRealtimeSessionFactory) | Creates and owns server-side, provider-neutral realtime AI sessions. |
|
|
23
34
|
| [IntelligenceRealtimeSessionPort](Class.IntelligenceRealtimeSessionPort) | Provider-neutral control surface for one realtime model connection. |
|
|
24
|
-
| [
|
|
25
|
-
| [
|
|
26
|
-
| [IntelligenceTextGenerator](Class.IntelligenceTextGenerator) | Executes text completions using the configured intelligence provider. |
|
|
27
|
-
| [IntelligenceToolBase](Class.IntelligenceToolBase) | Base class for class-based AI SDK tools. |
|
|
35
|
+
| [IntelligenceReranker](Class.IntelligenceReranker) | Provider-neutral semantic reranking facade. |
|
|
36
|
+
| [IntelligenceToolBase](Class.IntelligenceToolBase) | Base class for class-based intelligence tools. |
|
|
28
37
|
| [IntelligenceToolRegistry](Class.IntelligenceToolRegistry) | Registry for class-based intelligence tools. |
|
|
29
38
|
| [IntelligenceValidationError](Class.IntelligenceValidationError) | Error thrown when an intelligence input validation fails. |
|
|
39
|
+
| [MiMoIntelligenceProviderAdapter](Class.MiMoIntelligenceProviderAdapter) | Xiaomi MiMo OpenAI-compatible language adapter. |
|
|
40
|
+
| [OpenAIIntelligenceProviderAdapter](Class.OpenAIIntelligenceProviderAdapter) | OpenAI adapter for language, embeddings, images, audio, realtime, files, and skills. |
|
|
30
41
|
|
|
31
42
|
## Interfaces
|
|
32
43
|
|
|
33
44
|
| Interface | Description |
|
|
34
45
|
| ------ | ------ |
|
|
35
|
-
| [
|
|
46
|
+
| [IIntelligenceAgentConfiguration](Interface.IIntelligenceAgentConfiguration) | Reusable provider-neutral tool-loop agent configuration. |
|
|
47
|
+
| [IIntelligenceEmbeddingBatchOptions](Interface.IIntelligenceEmbeddingBatchOptions) | Provider-neutral batch embedding options. |
|
|
48
|
+
| [IIntelligenceEmbeddingBatchResult](Interface.IIntelligenceEmbeddingBatchResult) | Provider-neutral batch embedding result. |
|
|
49
|
+
| [IIntelligenceEmbeddingOptions](Interface.IIntelligenceEmbeddingOptions) | Provider-neutral single-value embedding options. |
|
|
50
|
+
| [IIntelligenceEmbeddingResult](Interface.IIntelligenceEmbeddingResult) | Provider-neutral embedding result. |
|
|
51
|
+
| [IIntelligenceFileUploadOptions](Interface.IIntelligenceFileUploadOptions) | Provider-neutral file upload options. |
|
|
52
|
+
| [IIntelligenceFileUploadResult](Interface.IIntelligenceFileUploadResult) | Normalized provider-managed file upload result. |
|
|
53
|
+
| [IIntelligenceGeneratedFile](Interface.IIntelligenceGeneratedFile) | Binary content generated by an intelligence capability. |
|
|
54
|
+
| [IIntelligenceGenerationStepStartEvent](Interface.IIntelligenceGenerationStepStartEvent) | Language generation step metadata. |
|
|
55
|
+
| [IIntelligenceImageGenerationOptions](Interface.IIntelligenceImageGenerationOptions) | Provider-neutral image generation options. |
|
|
56
|
+
| [IIntelligenceImageGenerationResult](Interface.IIntelligenceImageGenerationResult) | Provider-neutral image generation result. |
|
|
57
|
+
| [IIntelligenceLanguageCompletion](Interface.IIntelligenceLanguageCompletion) | Normalized language generation result. |
|
|
58
|
+
| [IIntelligenceLanguageGenerationOptions](Interface.IIntelligenceLanguageGenerationOptions) | Provider-neutral language generation controls. |
|
|
59
|
+
| [IIntelligenceLanguageStream](Interface.IIntelligenceLanguageStream) | Provider-neutral text stream. |
|
|
60
|
+
| [IIntelligenceModelReference](Interface.IIntelligenceModelReference) | Selects a provider-owned model without exposing a provider SDK model object. |
|
|
61
|
+
| [IIntelligenceModelRequestOptions](Interface.IIntelligenceModelRequestOptions) | Shared provider/model controls for intelligence operations. |
|
|
62
|
+
| [IIntelligenceModelStatus](Interface.IIntelligenceModelStatus) | Safe resolved model status that never includes credentials. |
|
|
36
63
|
| [IIntelligenceModuleOptions](Interface.IIntelligenceModuleOptions) | Options for configuring the intelligence module. |
|
|
64
|
+
| [IIntelligenceObjectStream](Interface.IIntelligenceObjectStream) | Provider-neutral structured-output stream. |
|
|
65
|
+
| [IIntelligencePrompt](Interface.IIntelligencePrompt) | Provider-neutral language-model prompt. |
|
|
66
|
+
| [IIntelligencePromptDefinition](Interface.IIntelligencePromptDefinition) | Reusable, immutable definition of an intelligence prompt. |
|
|
67
|
+
| [IIntelligencePromptEffectivePolicy](Interface.IIntelligencePromptEffectivePolicy) | Effective settings resolved for one prompt execution. |
|
|
68
|
+
| [IIntelligencePromptExecutionContext](Interface.IIntelligencePromptExecutionContext) | Application context made available to prompt policy adapters. |
|
|
69
|
+
| [IIntelligencePromptExecutionPolicy](Interface.IIntelligencePromptExecutionPolicy) | Native settings and provider-neutral requirements declared by an intelligence prompt. |
|
|
70
|
+
| [IIntelligencePromptExecutionResult](Interface.IIntelligencePromptExecutionResult) | Normalized result of an intelligence prompt execution. |
|
|
71
|
+
| [IIntelligencePromptInvocation](Interface.IIntelligencePromptInvocation) | Bound prompt definition ready for execution. |
|
|
72
|
+
| [IIntelligencePromptPolicyRequest](Interface.IIntelligencePromptPolicyRequest) | Policy resolution request for one prompt invocation. |
|
|
73
|
+
| [IIntelligencePromptRenderContext](Interface.IIntelligencePromptRenderContext) | Input exposed to pure prompt rendering functions. |
|
|
74
|
+
| [IIntelligenceProviderAdapter](Interface.IIntelligenceProviderAdapter) | Provider adapter registered with the intelligence capability registry. |
|
|
37
75
|
| [IIntelligenceProviderConfiguration](Interface.IIntelligenceProviderConfiguration) | Describes the resolved configuration for the intelligence provider. |
|
|
76
|
+
| [IIntelligenceProviderLoadRequest](Interface.IIntelligenceProviderLoadRequest) | Internal model/API load request passed to a provider adapter. |
|
|
77
|
+
| [IIntelligenceProviderProbeResult](Interface.IIntelligenceProviderProbeResult) | Provider-neutral result of a bounded provider availability probe. |
|
|
38
78
|
| [IIntelligenceRealtimeAudioFormat](Interface.IIntelligenceRealtimeAudioFormat) | Provider-neutral audio format configuration. |
|
|
39
79
|
| [IIntelligenceRealtimeCloseEvent](Interface.IIntelligenceRealtimeCloseEvent) | Describes why an upstream realtime connection closed. |
|
|
40
80
|
| [IIntelligenceRealtimeModuleOptions](Interface.IIntelligenceRealtimeModuleOptions) | Module-level resilience and resource limits for realtime intelligence. |
|
|
@@ -44,33 +84,66 @@ editUrl: false
|
|
|
44
84
|
| [IIntelligenceRealtimeTranscriptionConfiguration](Interface.IIntelligenceRealtimeTranscriptionConfiguration) | Provider-neutral transcription configuration. |
|
|
45
85
|
| [IIntelligenceRealtimeTurnDetectionConfiguration](Interface.IIntelligenceRealtimeTurnDetectionConfiguration) | Provider-neutral voice activity detection configuration. |
|
|
46
86
|
| [IIntelligenceRealtimeUsage](Interface.IIntelligenceRealtimeUsage) | Normalized token usage reported by a realtime provider. |
|
|
47
|
-
| [
|
|
48
|
-
| [
|
|
49
|
-
| [
|
|
50
|
-
| [
|
|
87
|
+
| [IIntelligenceRequestOptions](Interface.IIntelligenceRequestOptions) | Shared execution controls for bounded intelligence requests. |
|
|
88
|
+
| [IIntelligenceRerankingOptions](Interface.IIntelligenceRerankingOptions) | Provider-neutral reranking options. |
|
|
89
|
+
| [IIntelligenceRerankingResult](Interface.IIntelligenceRerankingResult) | Provider-neutral reranking result. |
|
|
90
|
+
| [IIntelligenceSkillUploadOptions](Interface.IIntelligenceSkillUploadOptions) | Provider-neutral skill bundle upload options. |
|
|
91
|
+
| [IIntelligenceSkillUploadResult](Interface.IIntelligenceSkillUploadResult) | Normalized provider-managed skill upload result. |
|
|
92
|
+
| [IIntelligenceSpeechGenerationOptions](Interface.IIntelligenceSpeechGenerationOptions) | Provider-neutral speech generation options. |
|
|
93
|
+
| [IIntelligenceSpeechGenerationResult](Interface.IIntelligenceSpeechGenerationResult) | Provider-neutral speech generation result. |
|
|
94
|
+
| [IIntelligenceStreamingTranscriptionOptions](Interface.IIntelligenceStreamingTranscriptionOptions) | Provider-neutral live transcription options. |
|
|
51
95
|
| [IIntelligenceTool](Interface.IIntelligenceTool) | Minimal shape required by the intelligence tool registry. |
|
|
96
|
+
| [IIntelligenceToolCall](Interface.IIntelligenceToolCall) | Tool call selected by a language model. |
|
|
97
|
+
| [IIntelligenceToolDefinition](Interface.IIntelligenceToolDefinition) | Provider-neutral application tool definition. |
|
|
98
|
+
| [IIntelligenceToolExecutionEndEvent](Interface.IIntelligenceToolExecutionEndEvent) | Tool execution completion event. |
|
|
99
|
+
| [IIntelligenceToolExecutionStartEvent](Interface.IIntelligenceToolExecutionStartEvent) | Tool execution start event. |
|
|
52
100
|
| [IIntelligenceToolRegistry](Interface.IIntelligenceToolRegistry) | Contract for the intelligence tool registry. |
|
|
101
|
+
| [IIntelligenceTranscriptionOptions](Interface.IIntelligenceTranscriptionOptions) | Provider-neutral transcription options. |
|
|
102
|
+
| [IIntelligenceTranscriptionResult](Interface.IIntelligenceTranscriptionResult) | Provider-neutral transcription result. |
|
|
103
|
+
| [IIntelligenceTranscriptionStream](Interface.IIntelligenceTranscriptionStream) | Provider-neutral live transcription result. |
|
|
104
|
+
| [IIntelligenceUsage](Interface.IIntelligenceUsage) | Provider-neutral usage counters. |
|
|
105
|
+
| [IIntelligenceVideoGenerationOptions](Interface.IIntelligenceVideoGenerationOptions) | Provider-neutral video generation options. |
|
|
106
|
+
| [IIntelligenceVideoGenerationResult](Interface.IIntelligenceVideoGenerationResult) | Provider-neutral video generation result. |
|
|
53
107
|
|
|
54
108
|
## Type Aliases
|
|
55
109
|
|
|
56
110
|
| Type Alias | Description |
|
|
57
111
|
| ------ | ------ |
|
|
58
|
-
| [
|
|
59
|
-
| [
|
|
112
|
+
| [IIntelligenceModelMessage](TypeAlias.IIntelligenceModelMessage) | Provider-neutral conversation message. |
|
|
113
|
+
| [IIntelligencePromptModelRequirement](TypeAlias.IIntelligencePromptModelRequirement) | Model selection requested by a reusable intelligence prompt. |
|
|
114
|
+
| [IIntelligenceSchema](TypeAlias.IIntelligenceSchema) | Provider-neutral schema accepted by prompts, structured outputs, and tools. |
|
|
115
|
+
| [IntelligenceCapability](TypeAlias.IntelligenceCapability) | Intelligence capability identifier. |
|
|
116
|
+
| [IntelligenceDefaultModels](TypeAlias.IntelligenceDefaultModels) | Capability-specific default provider and model references. |
|
|
117
|
+
| [IntelligenceJsonValue](TypeAlias.IntelligenceJsonValue) | JSON-compatible value used by provider-neutral intelligence contracts. |
|
|
118
|
+
| [IntelligencePromptCapability](TypeAlias.IntelligencePromptCapability) | Provider-neutral capability required by an intelligence prompt. |
|
|
119
|
+
| [IntelligencePromptDefinitionConfiguration](TypeAlias.IntelligencePromptDefinitionConfiguration) | Configuration accepted by [intelligencePrompt](Function.intelligencePrompt). |
|
|
120
|
+
| [IntelligencePromptGenerationOptions](TypeAlias.IntelligencePromptGenerationOptions) | Native generation settings that can be stored on a prompt definition. |
|
|
121
|
+
| [IntelligencePromptLatency](TypeAlias.IntelligencePromptLatency) | Latency profile requested by an intelligence prompt. |
|
|
122
|
+
| [IntelligencePromptMode](TypeAlias.IntelligencePromptMode) | Supported execution modes for reusable intelligence prompts. |
|
|
123
|
+
| [IntelligencePromptQuality](TypeAlias.IntelligencePromptQuality) | Provider-neutral model quality requested by an intelligence prompt. |
|
|
124
|
+
| [IntelligencePromptReasoning](TypeAlias.IntelligencePromptReasoning) | Provider-neutral reasoning effort requested by an intelligence prompt. |
|
|
60
125
|
| [IntelligenceProviderName](TypeAlias.IntelligenceProviderName) | Represents the union of supported intelligence provider identifiers. |
|
|
126
|
+
| [IntelligenceProviderOptions](TypeAlias.IntelligenceProviderOptions) | Provider-specific request options kept behind an explicit escape hatch. |
|
|
127
|
+
| [IntelligenceProviderProbeStatus](TypeAlias.IntelligenceProviderProbeStatus) | Normalized provider availability state. |
|
|
128
|
+
| [IntelligenceProviderToolOptions](TypeAlias.IntelligenceProviderToolOptions) | Opaque provider-tool configuration accepted only by provider-specific subpaths. |
|
|
61
129
|
| [IntelligenceRealtimeClientEvent](TypeAlias.IntelligenceRealtimeClientEvent) | Provider-neutral event sent from an application to a realtime model. |
|
|
62
130
|
| [IntelligenceRealtimeMetadataValue](TypeAlias.IntelligenceRealtimeMetadataValue) | Serializable metadata copied into realtime metering events. |
|
|
63
131
|
| [IntelligenceRealtimeMeteringEvent](TypeAlias.IntelligenceRealtimeMeteringEvent) | Durable metering event emitted by an Archipel realtime session. |
|
|
64
|
-
| [IntelligenceRealtimeModelLoader](TypeAlias.IntelligenceRealtimeModelLoader) | Creates a configured Vercel AI SDK realtime model behind the Archipel facade. |
|
|
65
|
-
| [IntelligenceRealtimeModelLoaders](TypeAlias.IntelligenceRealtimeModelLoaders) | Maps configured intelligence providers to tree-shakable realtime model loaders. |
|
|
66
132
|
| [IntelligenceRealtimeServerEvent](TypeAlias.IntelligenceRealtimeServerEvent) | Provider-neutral event emitted by a realtime model. |
|
|
67
133
|
| [IntelligenceRealtimeStatus](TypeAlias.IntelligenceRealtimeStatus) | Describes the lifecycle state of an upstream realtime model connection. |
|
|
68
|
-
| [
|
|
134
|
+
| [IntelligenceRequestTimeouts](TypeAlias.IntelligenceRequestTimeouts) | Capability-specific total request timeouts in milliseconds. |
|
|
135
|
+
| [IntelligenceToolChoice](TypeAlias.IntelligenceToolChoice) | Provider-neutral tool-selection policy. |
|
|
136
|
+
| [IntelligenceToolOutput](TypeAlias.IntelligenceToolOutput) | Provider-neutral tool result. |
|
|
137
|
+
| [IntelligenceToolSet](TypeAlias.IntelligenceToolSet) | Provider-neutral named tool collection. |
|
|
138
|
+
| [IntelligenceTranscriptionStreamPart](TypeAlias.IntelligenceTranscriptionStreamPart) | Provider-neutral live transcription event. |
|
|
69
139
|
|
|
70
140
|
## Variables
|
|
71
141
|
|
|
72
142
|
| Variable | Description |
|
|
73
143
|
| ------ | ------ |
|
|
144
|
+
| [AI\_GATEWAY\_API\_KEY](Variable.AI_GATEWAY_API_KEY) | Vercel AI Gateway API key. |
|
|
145
|
+
| [AI\_GATEWAY\_BASE\_URL](Variable.AI_GATEWAY_BASE_URL) | Vercel AI Gateway base URL. |
|
|
146
|
+
| [AI\_GATEWAY\_CONFIG\_ENTRIES](Variable.AI_GATEWAY_CONFIG_ENTRIES) | Configuration entries used by the Vercel AI Gateway provider. |
|
|
74
147
|
| [ANTHROPIC\_API\_KEY](Variable.ANTHROPIC_API_KEY) | Anthropic-specific API key. |
|
|
75
148
|
| [ANTHROPIC\_BASE\_URL](Variable.ANTHROPIC_BASE_URL) | Anthropic-specific base URL. |
|
|
76
149
|
| [ANTHROPIC\_CONFIG\_ENTRIES](Variable.ANTHROPIC_CONFIG_ENTRIES) | Configuration entries used by the Anthropic intelligence provider. |
|
|
@@ -88,9 +161,10 @@ editUrl: false
|
|
|
88
161
|
| [INTELLIGENCE\_BASE\_URL](Variable.INTELLIGENCE_BASE_URL) | Global base URL override for the intelligence provider. |
|
|
89
162
|
| [INTELLIGENCE\_MAX\_OUTPUT\_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model. |
|
|
90
163
|
| [INTELLIGENCE\_MODEL](Variable.INTELLIGENCE_MODEL) | AI model identifier to use for text generation. |
|
|
91
|
-
| [INTELLIGENCE\_PROVIDER](Variable.INTELLIGENCE_PROVIDER) | Intelligence provider name (e.g. openai, anthropic, google, grok, mimo). |
|
|
164
|
+
| [INTELLIGENCE\_PROVIDER](Variable.INTELLIGENCE_PROVIDER) | Intelligence provider name (e.g. openai, anthropic, google, grok, mimo, gateway). |
|
|
92
165
|
| [INTELLIGENCE\_TEMPERATURE](Variable.INTELLIGENCE_TEMPERATURE) | Sampling temperature for the AI model. |
|
|
93
166
|
| [INTELLIGENCE\_TOP\_P](Variable.INTELLIGENCE_TOP_P) | Top-p (nucleus sampling) for the AI model. |
|
|
167
|
+
| [IntelligenceCapabilityNames](Variable.IntelligenceCapabilityNames) | Capability identifiers understood by the intelligence provider registry. |
|
|
94
168
|
| [IntelligenceProviderNames](Variable.IntelligenceProviderNames) | Enumerates the supported model providers powering the intelligence pipeline. |
|
|
95
169
|
| [MIMO\_API\_KEY](Variable.MIMO_API_KEY) | MiMo-specific API key. |
|
|
96
170
|
| [MIMO\_BASE\_URL](Variable.MIMO_BASE_URL) | MiMo-specific base URL. |
|
|
@@ -141,8 +215,9 @@ editUrl: false
|
|
|
141
215
|
| [createGrokViewXVideoTool](Function.createGrokViewXVideoTool) | Creates a Grok X-video understanding tool registration. |
|
|
142
216
|
| [createGrokWebSearchTool](Function.createGrokWebSearchTool) | Creates a Grok web-search tool registration. |
|
|
143
217
|
| [createGrokXSearchTool](Function.createGrokXSearchTool) | Creates a Grok X-search tool registration. |
|
|
144
|
-
| [
|
|
145
|
-
| [
|
|
218
|
+
| [createIntelligenceJsonSchema](Function.createIntelligenceJsonSchema) | Creates a provider-neutral JSON Schema wrapper. |
|
|
219
|
+
| [createIntelligenceTool](Function.createIntelligenceTool) | Creates an Archipel intelligence tool registration. |
|
|
220
|
+
| [createMimoCustomTool](Function.createMimoCustomTool) | Creates a provider-neutral function tool for MiMo. |
|
|
146
221
|
| [createOpenAIApplyPatchTool](Function.createOpenAIApplyPatchTool) | Creates an OpenAI apply-patch tool registration. |
|
|
147
222
|
| [createOpenAICodeInterpreterTool](Function.createOpenAICodeInterpreterTool) | Creates an OpenAI code-interpreter tool registration. |
|
|
148
223
|
| [createOpenAICustomTool](Function.createOpenAICustomTool) | Creates an OpenAI custom provider-defined tool registration. |
|
|
@@ -154,12 +229,5 @@ editUrl: false
|
|
|
154
229
|
| [createOpenAIToolSearchTool](Function.createOpenAIToolSearchTool) | Creates an OpenAI tool-search tool registration. |
|
|
155
230
|
| [createOpenAIWebSearchPreviewTool](Function.createOpenAIWebSearchPreviewTool) | Creates an OpenAI web-search-preview tool registration. |
|
|
156
231
|
| [createOpenAIWebSearchTool](Function.createOpenAIWebSearchTool) | Creates an OpenAI web-search tool registration. |
|
|
157
|
-
| [
|
|
158
|
-
| [
|
|
159
|
-
| [loadGoogleLanguageModel](Function.loadGoogleLanguageModel) | Creates the Google Gemini language model from the resolved provider configuration. |
|
|
160
|
-
| [loadGoogleRealtimeModel](Function.loadGoogleRealtimeModel) | Creates a Google Gemini Live model exclusively through the Vercel AI SDK provider. |
|
|
161
|
-
| [loadGrokLanguageModel](Function.loadGrokLanguageModel) | Creates the Grok language model through the native xAI provider. |
|
|
162
|
-
| [loadGrokRealtimeModel](Function.loadGrokRealtimeModel) | Creates an xAI Grok voice model exclusively through the Vercel AI SDK provider. |
|
|
163
|
-
| [loadMimoLanguageModel](Function.loadMimoLanguageModel) | Creates the Xiaomi MiMo language model from the resolved provider configuration. |
|
|
164
|
-
| [loadOpenAILanguageModel](Function.loadOpenAILanguageModel) | Creates the OpenAI language model from the resolved provider configuration. |
|
|
165
|
-
| [loadOpenAIRealtimeModel](Function.loadOpenAIRealtimeModel) | Creates an OpenAI realtime model exclusively through the Vercel AI SDK provider. |
|
|
232
|
+
| [defineIntelligenceTool](Function.defineIntelligenceTool) | Defines a provider-neutral intelligence tool while preserving its input and output types. |
|
|
233
|
+
| [intelligencePrompt](Function.intelligencePrompt) | Creates a reusable intelligence prompt definition. |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@breadstone/archipel-mcp",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.55",
|
|
4
4
|
"description": "MCP server providing Archipel platform knowledge - documentation, query patterns, and coding conventions - to AI development tools.",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"main": "./src/main.js",
|