@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
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceModuleOptions
|
|
7
7
|
|
|
8
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
8
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L19)
|
|
9
9
|
|
|
10
10
|
Options for configuring the intelligence module.
|
|
11
11
|
|
|
@@ -17,19 +17,31 @@ Options for configuring the intelligence module.
|
|
|
17
17
|
readonly optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
20
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L34)
|
|
21
21
|
|
|
22
22
|
Provider-specific configuration entries to register with the config module.
|
|
23
23
|
|
|
24
24
|
***
|
|
25
25
|
|
|
26
|
+
### defaultModels?
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
readonly optional defaultModels?: Readonly<Partial<Record<IntelligenceCapability, IIntelligenceModelReference>>>;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L40)
|
|
33
|
+
|
|
34
|
+
Capability-specific default provider and model references.
|
|
35
|
+
|
|
36
|
+
***
|
|
37
|
+
|
|
26
38
|
### isGlobal?
|
|
27
39
|
|
|
28
40
|
```ts
|
|
29
41
|
readonly optional isGlobal?: boolean;
|
|
30
42
|
```
|
|
31
43
|
|
|
32
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
44
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L64)
|
|
33
45
|
|
|
34
46
|
When `true` the module is registered globally.
|
|
35
47
|
|
|
@@ -41,24 +53,21 @@ When `true` the module is registered globally.
|
|
|
41
53
|
readonly optional promptPolicyAdapter?: Type<IntelligencePromptPolicyPort>;
|
|
42
54
|
```
|
|
43
55
|
|
|
44
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
56
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L57)
|
|
45
57
|
|
|
46
58
|
Optional application policy adapter for provider-neutral prompt requirements.
|
|
47
59
|
|
|
48
60
|
***
|
|
49
61
|
|
|
50
|
-
###
|
|
62
|
+
### providerAdapters?
|
|
51
63
|
|
|
52
64
|
```ts
|
|
53
|
-
readonly optional
|
|
65
|
+
readonly optional providerAdapters?: readonly IIntelligenceProviderAdapter[];
|
|
54
66
|
```
|
|
55
67
|
|
|
56
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
57
|
-
|
|
58
|
-
Tree-shakable language model loaders keyed by provider name.
|
|
68
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L37)
|
|
59
69
|
|
|
60
|
-
|
|
61
|
-
`@breadstone/archipel-platform-intelligence/providers/openai`.
|
|
70
|
+
Provider adapters imported from tree-shakable provider subpaths.
|
|
62
71
|
|
|
63
72
|
***
|
|
64
73
|
|
|
@@ -68,37 +77,34 @@ Import these from provider-specific subpaths such as
|
|
|
68
77
|
readonly optional realtime?: IIntelligenceRealtimeModuleOptions;
|
|
69
78
|
```
|
|
70
79
|
|
|
71
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
80
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L50)
|
|
72
81
|
|
|
73
82
|
Server-owned realtime model sessions, resilience limits, and metering.
|
|
74
83
|
|
|
75
84
|
***
|
|
76
85
|
|
|
77
|
-
###
|
|
86
|
+
### requestTimeouts?
|
|
78
87
|
|
|
79
88
|
```ts
|
|
80
|
-
readonly optional
|
|
81
|
-
| IIntelligenceTool
|
|
82
|
-
| Promise<IIntelligenceTool>
|
|
83
|
-
| Type<IIntelligenceTool>
|
|
84
|
-
| Provider<IIntelligenceTool>)[];
|
|
89
|
+
readonly optional requestTimeouts?: Readonly<Partial<Record<IntelligenceCapability, number>>>;
|
|
85
90
|
```
|
|
86
91
|
|
|
87
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
92
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L43)
|
|
88
93
|
|
|
89
|
-
|
|
94
|
+
Capability-specific total request timeout overrides.
|
|
90
95
|
|
|
91
96
|
***
|
|
92
97
|
|
|
93
|
-
###
|
|
98
|
+
### tools?
|
|
94
99
|
|
|
95
100
|
```ts
|
|
96
|
-
readonly optional
|
|
101
|
+
readonly optional tools?: readonly (
|
|
102
|
+
| IIntelligenceTool
|
|
103
|
+
| Promise<IIntelligenceTool>
|
|
104
|
+
| Type<IIntelligenceTool>
|
|
105
|
+
| Provider<IIntelligenceTool>)[];
|
|
97
106
|
```
|
|
98
107
|
|
|
99
|
-
Defined in: [interfaces/IIntelligenceModuleOptions.ts:
|
|
100
|
-
|
|
101
|
-
When `true`, provider configuration is resolved during module initialization.
|
|
108
|
+
Defined in: [interfaces/IIntelligenceModuleOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceModuleOptions.ts#L27)
|
|
102
109
|
|
|
103
|
-
|
|
104
|
-
native AI SDK model through `generateText()` or `streamText()` options.
|
|
110
|
+
Tool instances, tool factory promises, class providers, or custom Nest providers registered at bootstrap.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceObjectStream\<T\>'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligenceObjectStream\<T\>
|
|
7
|
+
|
|
8
|
+
Defined in: contracts/IIntelligenceObjectStream.ts:12
|
|
9
|
+
|
|
10
|
+
Provider-neutral structured-output stream.
|
|
11
|
+
|
|
12
|
+
## Type Parameters
|
|
13
|
+
|
|
14
|
+
| Type Parameter |
|
|
15
|
+
| ------ |
|
|
16
|
+
| `T` |
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
### finishReason
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
readonly finishReason: PromiseLike<string>;
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Defined in: contracts/IIntelligenceObjectStream.ts:17
|
|
27
|
+
|
|
28
|
+
***
|
|
29
|
+
|
|
30
|
+
### output
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
readonly output: PromiseLike<T>;
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Defined in: contracts/IIntelligenceObjectStream.ts:16
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
### partialOutputStream
|
|
41
|
+
|
|
42
|
+
```ts
|
|
43
|
+
readonly partialOutputStream: AsyncIterable<Partial<T>>;
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Defined in: contracts/IIntelligenceObjectStream.ts:15
|
|
47
|
+
|
|
48
|
+
***
|
|
49
|
+
|
|
50
|
+
### usage
|
|
51
|
+
|
|
52
|
+
```ts
|
|
53
|
+
readonly usage: PromiseLike<IIntelligenceUsage | null>;
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Defined in: contracts/IIntelligenceObjectStream.ts:18
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligencePrompt'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligencePrompt
|
|
7
|
+
|
|
8
|
+
Defined in: contracts/IIntelligencePrompt.ts:12
|
|
9
|
+
|
|
10
|
+
Provider-neutral language-model prompt.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### instructions?
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly optional instructions?: string;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: contracts/IIntelligencePrompt.ts:15
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### messages?
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
readonly optional messages?: readonly IIntelligenceModelMessage[];
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Defined in: contracts/IIntelligencePrompt.ts:18
|
|
31
|
+
|
|
32
|
+
***
|
|
33
|
+
|
|
34
|
+
### prompt?
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
readonly optional prompt?: string;
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Defined in: contracts/IIntelligencePrompt.ts:17
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### system?
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly optional system?: string;
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: contracts/IIntelligencePrompt.ts:16
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligencePromptDefinition\<TInput, TOutput, TMode\>
|
|
7
7
|
|
|
8
|
-
Defined in: [prompts/IIntelligencePromptDefinition.ts:
|
|
8
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L17)
|
|
9
9
|
|
|
10
10
|
Reusable, immutable definition of an intelligence prompt.
|
|
11
11
|
|
|
@@ -25,17 +25,17 @@ Reusable, immutable definition of an intelligence prompt.
|
|
|
25
25
|
readonly optional execution?: IIntelligencePromptExecutionPolicy;
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
Defined in: [prompts/IIntelligencePromptDefinition.ts:
|
|
28
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L25)
|
|
29
29
|
|
|
30
30
|
***
|
|
31
31
|
|
|
32
32
|
### inputSchema
|
|
33
33
|
|
|
34
34
|
```ts
|
|
35
|
-
readonly inputSchema:
|
|
35
|
+
readonly inputSchema: IIntelligenceSchema<TInput>;
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Defined in: [prompts/IIntelligencePromptDefinition.ts:
|
|
38
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L23)
|
|
39
39
|
|
|
40
40
|
***
|
|
41
41
|
|
|
@@ -45,7 +45,7 @@ Defined in: [prompts/IIntelligencePromptDefinition.ts:22](https://github.com/Rue
|
|
|
45
45
|
readonly mode: TMode;
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
Defined in: [prompts/IIntelligencePromptDefinition.ts:
|
|
48
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L22)
|
|
49
49
|
|
|
50
50
|
***
|
|
51
51
|
|
|
@@ -55,17 +55,17 @@ Defined in: [prompts/IIntelligencePromptDefinition.ts:21](https://github.com/Rue
|
|
|
55
55
|
readonly name: string;
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
Defined in: [prompts/IIntelligencePromptDefinition.ts:
|
|
58
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L20)
|
|
59
59
|
|
|
60
60
|
***
|
|
61
61
|
|
|
62
62
|
### outputSchema?
|
|
63
63
|
|
|
64
64
|
```ts
|
|
65
|
-
readonly optional outputSchema?:
|
|
65
|
+
readonly optional outputSchema?: IIntelligenceSchema<TOutput>;
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
Defined in: [prompts/IIntelligencePromptDefinition.ts:
|
|
68
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L24)
|
|
69
69
|
|
|
70
70
|
***
|
|
71
71
|
|
|
@@ -75,17 +75,17 @@ Defined in: [prompts/IIntelligencePromptDefinition.ts:23](https://github.com/Rue
|
|
|
75
75
|
readonly version: number;
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
-
Defined in: [prompts/IIntelligencePromptDefinition.ts:
|
|
78
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L21)
|
|
79
79
|
|
|
80
80
|
## Methods
|
|
81
81
|
|
|
82
82
|
### messages()
|
|
83
83
|
|
|
84
84
|
```ts
|
|
85
|
-
messages(context): readonly
|
|
85
|
+
messages(context): readonly IIntelligenceModelMessage[];
|
|
86
86
|
```
|
|
87
87
|
|
|
88
|
-
Defined in: [prompts/IIntelligencePromptDefinition.ts:
|
|
88
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L32)
|
|
89
89
|
|
|
90
90
|
#### Parameters
|
|
91
91
|
|
|
@@ -95,7 +95,7 @@ Defined in: [prompts/IIntelligencePromptDefinition.ts:31](https://github.com/Rue
|
|
|
95
95
|
|
|
96
96
|
#### Returns
|
|
97
97
|
|
|
98
|
-
readonly `
|
|
98
|
+
readonly [`IIntelligenceModelMessage`](TypeAlias.IIntelligenceModelMessage)[]
|
|
99
99
|
|
|
100
100
|
***
|
|
101
101
|
|
|
@@ -105,7 +105,7 @@ readonly `ModelMessage`[]
|
|
|
105
105
|
system(context): string | readonly string[];
|
|
106
106
|
```
|
|
107
107
|
|
|
108
|
-
Defined in: [prompts/IIntelligencePromptDefinition.ts:
|
|
108
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L31)
|
|
109
109
|
|
|
110
110
|
#### Parameters
|
|
111
111
|
|
|
@@ -125,7 +125,7 @@ Defined in: [prompts/IIntelligencePromptDefinition.ts:30](https://github.com/Rue
|
|
|
125
125
|
with<TMetadata>(input, metadata?): IIntelligencePromptInvocation<TInput, TOutput, TMode, TMetadata>;
|
|
126
126
|
```
|
|
127
127
|
|
|
128
|
-
Defined in: [prompts/IIntelligencePromptDefinition.ts:
|
|
128
|
+
Defined in: [prompts/IIntelligencePromptDefinition.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptDefinition.ts#L33)
|
|
129
129
|
|
|
130
130
|
#### Type Parameters
|
|
131
131
|
|
package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptEffectivePolicy.md
CHANGED
|
@@ -24,7 +24,7 @@ Defined in: [prompts/IIntelligencePromptEffectivePolicy.ts:17](https://github.co
|
|
|
24
24
|
### options
|
|
25
25
|
|
|
26
26
|
```ts
|
|
27
|
-
readonly options:
|
|
27
|
+
readonly options: IIntelligenceLanguageGenerationOptions;
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
Defined in: [prompts/IIntelligencePromptEffectivePolicy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptEffectivePolicy.ts#L16)
|
package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionPolicy.md
CHANGED
|
@@ -34,7 +34,7 @@ Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:24](https://github.co
|
|
|
34
34
|
### options?
|
|
35
35
|
|
|
36
36
|
```ts
|
|
37
|
-
readonly optional options?:
|
|
37
|
+
readonly optional options?: IIntelligenceLanguageGenerationOptions;
|
|
38
38
|
```
|
|
39
39
|
|
|
40
40
|
Defined in: [prompts/IIntelligencePromptExecutionPolicy.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionPolicy.ts#L20)
|
package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptExecutionResult.md
CHANGED
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligencePromptExecutionResult\<TOutput, TMetadata\>
|
|
7
7
|
|
|
8
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
8
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L14)
|
|
9
9
|
|
|
10
10
|
Normalized result of an intelligence prompt execution.
|
|
11
11
|
|
|
@@ -24,17 +24,17 @@ Normalized result of an intelligence prompt execution.
|
|
|
24
24
|
readonly effectivePolicy: IIntelligencePromptEffectivePolicy;
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
27
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L26)
|
|
28
28
|
|
|
29
29
|
***
|
|
30
30
|
|
|
31
|
-
### finishReason
|
|
31
|
+
### finishReason
|
|
32
32
|
|
|
33
33
|
```ts
|
|
34
|
-
readonly
|
|
34
|
+
readonly finishReason: string;
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
37
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L24)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:26](https://github.co
|
|
|
44
44
|
readonly metadata: TMetadata | undefined;
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
47
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L27)
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
@@ -54,7 +54,7 @@ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:33](https://github.co
|
|
|
54
54
|
readonly model: string;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
57
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L21)
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
@@ -64,7 +64,7 @@ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:22](https://github.co
|
|
|
64
64
|
readonly output: TOutput;
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
67
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L17)
|
|
68
68
|
|
|
69
69
|
***
|
|
70
70
|
|
|
@@ -74,7 +74,7 @@ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:18](https://github.co
|
|
|
74
74
|
readonly promptName: string;
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
77
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L18)
|
|
78
78
|
|
|
79
79
|
***
|
|
80
80
|
|
|
@@ -84,7 +84,7 @@ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:19](https://github.co
|
|
|
84
84
|
readonly promptVersion: number;
|
|
85
85
|
```
|
|
86
86
|
|
|
87
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
87
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L19)
|
|
88
88
|
|
|
89
89
|
***
|
|
90
90
|
|
|
@@ -94,17 +94,7 @@ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:20](https://github.co
|
|
|
94
94
|
readonly provider: string;
|
|
95
95
|
```
|
|
96
96
|
|
|
97
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
98
|
-
|
|
99
|
-
***
|
|
100
|
-
|
|
101
|
-
### reasoning
|
|
102
|
-
|
|
103
|
-
```ts
|
|
104
|
-
readonly reasoning: (ReasoningOutput | ReasoningFileOutput)[] | undefined;
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L24)
|
|
97
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L20)
|
|
108
98
|
|
|
109
99
|
***
|
|
110
100
|
|
|
@@ -114,7 +104,7 @@ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:24](https://github.co
|
|
|
114
104
|
readonly optional reasoningText?: string;
|
|
115
105
|
```
|
|
116
106
|
|
|
117
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
107
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L23)
|
|
118
108
|
|
|
119
109
|
***
|
|
120
110
|
|
|
@@ -124,16 +114,14 @@ Defined in: [prompts/IIntelligencePromptExecutionResult.ts:25](https://github.co
|
|
|
124
114
|
readonly requestedPolicy: IIntelligencePromptExecutionPolicy;
|
|
125
115
|
```
|
|
126
116
|
|
|
127
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
117
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L25)
|
|
128
118
|
|
|
129
119
|
***
|
|
130
120
|
|
|
131
121
|
### usage
|
|
132
122
|
|
|
133
123
|
```ts
|
|
134
|
-
readonly usage:
|
|
135
|
-
| IIntelligenceCompletionUsage
|
|
136
|
-
| null;
|
|
124
|
+
readonly usage: IIntelligenceUsage | null;
|
|
137
125
|
```
|
|
138
126
|
|
|
139
|
-
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:
|
|
127
|
+
Defined in: [prompts/IIntelligencePromptExecutionResult.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IIntelligencePromptExecutionResult.ts#L22)
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceProviderAdapter'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IIntelligenceProviderAdapter
|
|
7
|
+
|
|
8
|
+
Defined in: providers/IIntelligenceProviderAdapter.ts:17
|
|
9
|
+
|
|
10
|
+
Provider adapter registered with the intelligence capability registry.
|
|
11
|
+
|
|
12
|
+
The loaded handle is intentionally opaque. Only Archipel's internal
|
|
13
|
+
execution adapters unwrap it into an AI SDK model or provider API.
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### capabilities
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
readonly capabilities: readonly IntelligenceCapability[];
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Defined in: providers/IIntelligenceProviderAdapter.ts:21
|
|
24
|
+
|
|
25
|
+
***
|
|
26
|
+
|
|
27
|
+
### provider
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
readonly provider: string;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: providers/IIntelligenceProviderAdapter.ts:20
|
|
34
|
+
|
|
35
|
+
## Methods
|
|
36
|
+
|
|
37
|
+
### load()
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
load(request): Promise<unknown>;
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Defined in: providers/IIntelligenceProviderAdapter.ts:27
|
|
44
|
+
|
|
45
|
+
#### Parameters
|
|
46
|
+
|
|
47
|
+
| Parameter | Type |
|
|
48
|
+
| ------ | ------ |
|
|
49
|
+
| `request` | [`IIntelligenceProviderLoadRequest`](Interface.IIntelligenceProviderLoadRequest) |
|
|
50
|
+
|
|
51
|
+
#### Returns
|
|
52
|
+
|
|
53
|
+
`Promise`\<`unknown`\>
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
57
|
+
### probe()?
|
|
58
|
+
|
|
59
|
+
```ts
|
|
60
|
+
optional probe(request): Promise<IIntelligenceProviderProbeResult>;
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Defined in: providers/IIntelligenceProviderAdapter.ts:28
|
|
64
|
+
|
|
65
|
+
#### Parameters
|
|
66
|
+
|
|
67
|
+
| Parameter | Type |
|
|
68
|
+
| ------ | ------ |
|
|
69
|
+
| `request` | [`IIntelligenceProviderLoadRequest`](Interface.IIntelligenceProviderLoadRequest) |
|
|
70
|
+
|
|
71
|
+
#### Returns
|
|
72
|
+
|
|
73
|
+
`Promise`\<[`IIntelligenceProviderProbeResult`](Interface.IIntelligenceProviderProbeResult)\>
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md
CHANGED
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceProviderConfiguration
|
|
7
7
|
|
|
8
|
-
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:
|
|
8
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L6)
|
|
9
9
|
|
|
10
10
|
Describes the resolved configuration for the intelligence provider.
|
|
11
11
|
|
|
@@ -14,10 +14,10 @@ Describes the resolved configuration for the intelligence provider.
|
|
|
14
14
|
### apiKey
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
|
-
readonly apiKey: string;
|
|
17
|
+
readonly apiKey: string | null;
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:
|
|
20
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L28)
|
|
21
21
|
|
|
22
22
|
The API key used to authenticate with the provider.
|
|
23
23
|
|
|
@@ -29,7 +29,7 @@ The API key used to authenticate with the provider.
|
|
|
29
29
|
readonly baseUrl: string | null;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:
|
|
32
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L35)
|
|
33
33
|
|
|
34
34
|
An optional base URL override for the provider API.
|
|
35
35
|
|
|
@@ -41,7 +41,7 @@ An optional base URL override for the provider API.
|
|
|
41
41
|
readonly maxOutputTokens: number;
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:
|
|
44
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L56)
|
|
45
45
|
|
|
46
46
|
The maximum number of output tokens per completion.
|
|
47
47
|
|
|
@@ -53,7 +53,7 @@ The maximum number of output tokens per completion.
|
|
|
53
53
|
readonly model: string;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:
|
|
56
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L21)
|
|
57
57
|
|
|
58
58
|
The model identifier to use for text generation.
|
|
59
59
|
|
|
@@ -62,10 +62,10 @@ The model identifier to use for text generation.
|
|
|
62
62
|
### provider
|
|
63
63
|
|
|
64
64
|
```ts
|
|
65
|
-
readonly provider:
|
|
65
|
+
readonly provider: string;
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:
|
|
68
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L14)
|
|
69
69
|
|
|
70
70
|
The resolved provider identifier.
|
|
71
71
|
|
|
@@ -77,7 +77,7 @@ The resolved provider identifier.
|
|
|
77
77
|
readonly temperature: number;
|
|
78
78
|
```
|
|
79
79
|
|
|
80
|
-
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:
|
|
80
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L42)
|
|
81
81
|
|
|
82
82
|
The sampling temperature used for text generation.
|
|
83
83
|
|
|
@@ -89,6 +89,6 @@ The sampling temperature used for text generation.
|
|
|
89
89
|
readonly topP: number;
|
|
90
90
|
```
|
|
91
91
|
|
|
92
|
-
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:
|
|
92
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L49)
|
|
93
93
|
|
|
94
94
|
The top-p (nucleus) sampling parameter.
|