@breadstone/archipel-mcp 0.0.54 → 0.0.56
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 +101 -0
- package/data/guides/ai-realtime-voice.md +85 -473
- package/data/guides/ai-text-generation.md +98 -635
- package/data/guides/health-indicators.md +67 -66
- package/data/guides/index.md +2 -1
- package/data/guides/intelligence-prompts-warm-up.md +81 -312
- package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +122 -0
- package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +122 -0
- package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +122 -0
- package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +122 -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 +15 -10
- package/data/packages/platform-intelligence/api/Class.IntelligenceImageGenerator.md +117 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +159 -0
- 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.IntelligencePromptPolicyPort.md +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAdapterPort.md +104 -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 +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +8 -8
- 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.IntelligenceSpeechGenerator.md +117 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceToolBase.md +14 -16
- package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +14 -18
- package/data/packages/platform-intelligence/api/Class.IntelligenceTranscriptionGenerator.md +139 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceVideoGenerator.md +117 -0
- package/data/packages/platform-intelligence/api/Class.MiMoIntelligenceProviderAdapter.md +122 -0
- package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +122 -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 +140 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +130 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +118 -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 +186 -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 +250 -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 +72 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +30 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +54 -26
- 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.IIntelligenceProviderConfiguration.md +10 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +54 -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 +23 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +174 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +114 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +156 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +110 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +80 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +180 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +50 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +155 -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 +130 -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 +197 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +245 -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 +2 -2
- package/data/packages/platform-intelligence/api/index.md +83 -32
- package/data/packages/platform-intelligence/index.md +81 -622
- 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.IntelligenceMediaGenerator.md +0 -118
- 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-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,159 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: IntelligenceLanguageGenerator'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: IntelligenceLanguageGenerator
|
|
7
|
+
|
|
8
|
+
Defined in: [generators/IntelligenceLanguageGenerator.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L80)
|
|
9
|
+
|
|
10
|
+
Provider-neutral language generation, structured output, and streaming facade.
|
|
11
|
+
|
|
12
|
+
## Constructors
|
|
13
|
+
|
|
14
|
+
### Constructor
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
new IntelligenceLanguageGenerator(modelResolver, toolRegistry): IntelligenceLanguageGenerator;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [generators/IntelligenceLanguageGenerator.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L91)
|
|
21
|
+
|
|
22
|
+
#### Parameters
|
|
23
|
+
|
|
24
|
+
| Parameter | Type |
|
|
25
|
+
| ------ | ------ |
|
|
26
|
+
| `modelResolver` | `IntelligenceModelResolver` |
|
|
27
|
+
| `toolRegistry` | [`IntelligenceToolRegistry`](Class.IntelligenceToolRegistry) |
|
|
28
|
+
|
|
29
|
+
#### Returns
|
|
30
|
+
|
|
31
|
+
`IntelligenceLanguageGenerator`
|
|
32
|
+
|
|
33
|
+
## Methods
|
|
34
|
+
|
|
35
|
+
### generateObject()
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
generateObject<T>(
|
|
39
|
+
prompt,
|
|
40
|
+
schema,
|
|
41
|
+
options?): Promise<IIntelligenceLanguageCompletion<T>>;
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Defined in: [generators/IntelligenceLanguageGenerator.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L121)
|
|
45
|
+
|
|
46
|
+
Generates a schema-constrained object through the language capability.
|
|
47
|
+
|
|
48
|
+
#### Type Parameters
|
|
49
|
+
|
|
50
|
+
| Type Parameter |
|
|
51
|
+
| ------ |
|
|
52
|
+
| `T` |
|
|
53
|
+
|
|
54
|
+
#### Parameters
|
|
55
|
+
|
|
56
|
+
| Parameter | Type |
|
|
57
|
+
| ------ | ------ |
|
|
58
|
+
| `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
|
|
59
|
+
| `schema` | [`IIntelligenceSchema`](TypeAlias.IIntelligenceSchema)\<`T`\> |
|
|
60
|
+
| `options` | [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions) |
|
|
61
|
+
|
|
62
|
+
#### Returns
|
|
63
|
+
|
|
64
|
+
`Promise`\<[`IIntelligenceLanguageCompletion`](Interface.IIntelligenceLanguageCompletion)\<`T`\>\>
|
|
65
|
+
|
|
66
|
+
***
|
|
67
|
+
|
|
68
|
+
### generateText()
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
generateText(prompt, options?): Promise<IIntelligenceLanguageCompletion<string>>;
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Defined in: [generators/IntelligenceLanguageGenerator.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L109)
|
|
75
|
+
|
|
76
|
+
Generates plain text and normalized tool metadata.
|
|
77
|
+
|
|
78
|
+
#### Parameters
|
|
79
|
+
|
|
80
|
+
| Parameter | Type |
|
|
81
|
+
| ------ | ------ |
|
|
82
|
+
| `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
|
|
83
|
+
| `options` | [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions) |
|
|
84
|
+
|
|
85
|
+
#### Returns
|
|
86
|
+
|
|
87
|
+
`Promise`\<[`IIntelligenceLanguageCompletion`](Interface.IIntelligenceLanguageCompletion)\<`string`\>\>
|
|
88
|
+
|
|
89
|
+
***
|
|
90
|
+
|
|
91
|
+
### getDefaultModel()
|
|
92
|
+
|
|
93
|
+
```ts
|
|
94
|
+
getDefaultModel(): IIntelligenceModelStatus;
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Defined in: [generators/IntelligenceLanguageGenerator.ts:201](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L201)
|
|
98
|
+
|
|
99
|
+
Returns the default language model without exposing credentials.
|
|
100
|
+
|
|
101
|
+
#### Returns
|
|
102
|
+
|
|
103
|
+
[`IIntelligenceModelStatus`](Interface.IIntelligenceModelStatus)
|
|
104
|
+
|
|
105
|
+
***
|
|
106
|
+
|
|
107
|
+
### streamObject()
|
|
108
|
+
|
|
109
|
+
```ts
|
|
110
|
+
streamObject<T>(
|
|
111
|
+
prompt,
|
|
112
|
+
schema,
|
|
113
|
+
options?): Promise<IIntelligenceObjectStream<T>>;
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
Defined in: [generators/IntelligenceLanguageGenerator.ts:166](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L166)
|
|
117
|
+
|
|
118
|
+
Streams partial structured output through the language capability.
|
|
119
|
+
|
|
120
|
+
#### Type Parameters
|
|
121
|
+
|
|
122
|
+
| Type Parameter |
|
|
123
|
+
| ------ |
|
|
124
|
+
| `T` |
|
|
125
|
+
|
|
126
|
+
#### Parameters
|
|
127
|
+
|
|
128
|
+
| Parameter | Type |
|
|
129
|
+
| ------ | ------ |
|
|
130
|
+
| `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
|
|
131
|
+
| `schema` | [`IIntelligenceSchema`](TypeAlias.IIntelligenceSchema)\<`T`\> |
|
|
132
|
+
| `options` | [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions) |
|
|
133
|
+
|
|
134
|
+
#### Returns
|
|
135
|
+
|
|
136
|
+
`Promise`\<[`IIntelligenceObjectStream`](Interface.IIntelligenceObjectStream)\<`T`\>\>
|
|
137
|
+
|
|
138
|
+
***
|
|
139
|
+
|
|
140
|
+
### streamText()
|
|
141
|
+
|
|
142
|
+
```ts
|
|
143
|
+
streamText(prompt, options?): Promise<IIntelligenceLanguageStream>;
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
Defined in: [generators/IntelligenceLanguageGenerator.ts:139](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L139)
|
|
147
|
+
|
|
148
|
+
Streams text without exposing the native AI SDK stream object.
|
|
149
|
+
|
|
150
|
+
#### Parameters
|
|
151
|
+
|
|
152
|
+
| Parameter | Type |
|
|
153
|
+
| ------ | ------ |
|
|
154
|
+
| `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
|
|
155
|
+
| `options` | [`IIntelligenceLanguageGenerationOptions`](Interface.IIntelligenceLanguageGenerationOptions) |
|
|
156
|
+
|
|
157
|
+
#### Returns
|
|
158
|
+
|
|
159
|
+
`Promise`\<[`IIntelligenceLanguageStream`](Interface.IIntelligenceLanguageStream)\>
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: IntelligenceModule
|
|
7
7
|
|
|
8
|
-
Defined in: [IntelligenceModule.ts:
|
|
8
|
+
Defined in: [IntelligenceModule.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L85)
|
|
9
9
|
|
|
10
10
|
Core module exposing the shared intelligence infrastructure.
|
|
11
11
|
|
|
@@ -29,7 +29,7 @@ new IntelligenceModule(): IntelligenceModule;
|
|
|
29
29
|
static register(options?): DynamicModule;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [IntelligenceModule.ts:
|
|
32
|
+
Defined in: [IntelligenceModule.ts:108](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L108)
|
|
33
33
|
|
|
34
34
|
Registers the intelligence module and optional class-based tools.
|
|
35
35
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: IntelligencePromptExecutor
|
|
7
7
|
|
|
8
|
-
Defined in: [prompts/IntelligencePromptExecutor.ts:
|
|
8
|
+
Defined in: [prompts/IntelligencePromptExecutor.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptExecutor.ts#L27)
|
|
9
9
|
|
|
10
10
|
Validates and executes reusable intelligence prompt invocations.
|
|
11
11
|
|
|
@@ -14,17 +14,17 @@ Validates and executes reusable intelligence prompt invocations.
|
|
|
14
14
|
### Constructor
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
|
-
new IntelligencePromptExecutor(policy,
|
|
17
|
+
new IntelligencePromptExecutor(policy, languageGenerator): IntelligencePromptExecutor;
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [prompts/IntelligencePromptExecutor.ts:
|
|
20
|
+
Defined in: [prompts/IntelligencePromptExecutor.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptExecutor.ts#L37)
|
|
21
21
|
|
|
22
22
|
#### Parameters
|
|
23
23
|
|
|
24
24
|
| Parameter | Type |
|
|
25
25
|
| ------ | ------ |
|
|
26
26
|
| `policy` | [`IntelligencePromptPolicyPort`](Class.IntelligencePromptPolicyPort) |
|
|
27
|
-
| `
|
|
27
|
+
| `languageGenerator` | [`IntelligenceLanguageGenerator`](Class.IntelligenceLanguageGenerator) |
|
|
28
28
|
|
|
29
29
|
#### Returns
|
|
30
30
|
|
|
@@ -40,7 +40,7 @@ Defined in: [prompts/IntelligencePromptExecutor.ts:35](https://github.com/RueDeR
|
|
|
40
40
|
execute<TInput, TMetadata>(invocation, context?): Promise<IIntelligencePromptExecutionResult<string, TMetadata>>;
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Defined in: [prompts/IntelligencePromptExecutor.ts:
|
|
43
|
+
Defined in: [prompts/IntelligencePromptExecutor.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptExecutor.ts#L50)
|
|
44
44
|
|
|
45
45
|
##### Type Parameters
|
|
46
46
|
|
|
@@ -66,7 +66,7 @@ Defined in: [prompts/IntelligencePromptExecutor.ts:48](https://github.com/RueDeR
|
|
|
66
66
|
execute<TInput, TOutput, TMetadata>(invocation, context?): Promise<IIntelligencePromptExecutionResult<TOutput, TMetadata>>;
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
Defined in: [prompts/IntelligencePromptExecutor.ts:
|
|
69
|
+
Defined in: [prompts/IntelligencePromptExecutor.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptExecutor.ts#L54)
|
|
70
70
|
|
|
71
71
|
##### Type Parameters
|
|
72
72
|
|
|
@@ -35,7 +35,7 @@ new IntelligencePromptPolicyPort(): IntelligencePromptPolicyPort;
|
|
|
35
35
|
abstract resolve(request): Promise<IIntelligencePromptEffectivePolicy>;
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Defined in: [prompts/IntelligencePromptPolicyPort.ts:
|
|
38
|
+
Defined in: [prompts/IntelligencePromptPolicyPort.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptPolicyPort.ts#L30)
|
|
39
39
|
|
|
40
40
|
#### Parameters
|
|
41
41
|
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Abstract Class: IntelligenceProviderAdapterPort'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Abstract Class: IntelligenceProviderAdapterPort
|
|
7
|
+
|
|
8
|
+
Defined in: [providers/IntelligenceProviderAdapterPort.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceProviderAdapterPort.ts#L19)
|
|
9
|
+
|
|
10
|
+
Port implemented by every intelligence provider adapter.
|
|
11
|
+
|
|
12
|
+
Provider implementations are registered as NestJS classes through
|
|
13
|
+
`IntelligenceModule.register()`. This keeps construction, dependency
|
|
14
|
+
injection, and lifecycle ownership inside the module instead of consumer
|
|
15
|
+
composition code.
|
|
16
|
+
|
|
17
|
+
## Extended by
|
|
18
|
+
|
|
19
|
+
- [`OpenAIIntelligenceProviderAdapter`](Class.OpenAIIntelligenceProviderAdapter)
|
|
20
|
+
- [`AnthropicIntelligenceProviderAdapter`](Class.AnthropicIntelligenceProviderAdapter)
|
|
21
|
+
- [`GoogleIntelligenceProviderAdapter`](Class.GoogleIntelligenceProviderAdapter)
|
|
22
|
+
- [`GrokIntelligenceProviderAdapter`](Class.GrokIntelligenceProviderAdapter)
|
|
23
|
+
- [`MiMoIntelligenceProviderAdapter`](Class.MiMoIntelligenceProviderAdapter)
|
|
24
|
+
- [`GatewayIntelligenceProviderAdapter`](Class.GatewayIntelligenceProviderAdapter)
|
|
25
|
+
|
|
26
|
+
## Constructors
|
|
27
|
+
|
|
28
|
+
### Constructor
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
new IntelligenceProviderAdapterPort(): IntelligenceProviderAdapterPort;
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
#### Returns
|
|
35
|
+
|
|
36
|
+
`IntelligenceProviderAdapterPort`
|
|
37
|
+
|
|
38
|
+
## Properties
|
|
39
|
+
|
|
40
|
+
### capabilities
|
|
41
|
+
|
|
42
|
+
```ts
|
|
43
|
+
abstract readonly capabilities: readonly IntelligenceCapability[];
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Defined in: [providers/IntelligenceProviderAdapterPort.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceProviderAdapterPort.ts#L31)
|
|
47
|
+
|
|
48
|
+
***
|
|
49
|
+
|
|
50
|
+
### provider
|
|
51
|
+
|
|
52
|
+
```ts
|
|
53
|
+
abstract readonly provider: string;
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Defined in: [providers/IntelligenceProviderAdapterPort.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceProviderAdapterPort.ts#L30)
|
|
57
|
+
|
|
58
|
+
## Methods
|
|
59
|
+
|
|
60
|
+
### load()
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
abstract load(request): Promise<unknown>;
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Defined in: [providers/IntelligenceProviderAdapterPort.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceProviderAdapterPort.ts#L37)
|
|
67
|
+
|
|
68
|
+
#### Parameters
|
|
69
|
+
|
|
70
|
+
| Parameter | Type |
|
|
71
|
+
| ------ | ------ |
|
|
72
|
+
| `request` | [`IIntelligenceProviderLoadRequest`](Interface.IIntelligenceProviderLoadRequest) |
|
|
73
|
+
|
|
74
|
+
#### Returns
|
|
75
|
+
|
|
76
|
+
`Promise`\<`unknown`\>
|
|
77
|
+
|
|
78
|
+
***
|
|
79
|
+
|
|
80
|
+
### probe()?
|
|
81
|
+
|
|
82
|
+
```ts
|
|
83
|
+
optional probe(request): Promise<IIntelligenceProviderProbeResult>;
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Defined in: [providers/IntelligenceProviderAdapterPort.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceProviderAdapterPort.ts#L50)
|
|
87
|
+
|
|
88
|
+
Performs an optional, lightweight remote readiness probe.
|
|
89
|
+
|
|
90
|
+
Adapters without a provider-supported probe can omit this method. The
|
|
91
|
+
diagnostics facade then reports degraded local readiness after model
|
|
92
|
+
materialization. Operational calls remain isolated behind Archipel's
|
|
93
|
+
timeout, retry, and domain-error boundary, so a circuit-breaker
|
|
94
|
+
decorator can be introduced without changing capability facades.
|
|
95
|
+
|
|
96
|
+
#### Parameters
|
|
97
|
+
|
|
98
|
+
| Parameter | Type |
|
|
99
|
+
| ------ | ------ |
|
|
100
|
+
| `request` | [`IIntelligenceProviderLoadRequest`](Interface.IIntelligenceProviderLoadRequest) |
|
|
101
|
+
|
|
102
|
+
#### Returns
|
|
103
|
+
|
|
104
|
+
`Promise`\<[`IIntelligenceProviderProbeResult`](Interface.IIntelligenceProviderProbeResult)\>
|
|
@@ -5,18 +5,26 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: IntelligenceProviderAssetUploader
|
|
7
7
|
|
|
8
|
-
Defined in: [IntelligenceProviderAssetUploader.ts:
|
|
8
|
+
Defined in: [IntelligenceProviderAssetUploader.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L25)
|
|
9
9
|
|
|
10
|
-
Uploads provider-managed files and skills
|
|
10
|
+
Uploads provider-managed files and skills behind provider-neutral contracts.
|
|
11
11
|
|
|
12
12
|
## Constructors
|
|
13
13
|
|
|
14
14
|
### Constructor
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
|
-
new IntelligenceProviderAssetUploader(): IntelligenceProviderAssetUploader;
|
|
17
|
+
new IntelligenceProviderAssetUploader(modelResolver): IntelligenceProviderAssetUploader;
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
+
Defined in: [IntelligenceProviderAssetUploader.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L32)
|
|
21
|
+
|
|
22
|
+
#### Parameters
|
|
23
|
+
|
|
24
|
+
| Parameter | Type |
|
|
25
|
+
| ------ | ------ |
|
|
26
|
+
| `modelResolver` | `IntelligenceModelResolver` |
|
|
27
|
+
|
|
20
28
|
#### Returns
|
|
21
29
|
|
|
22
30
|
`IntelligenceProviderAssetUploader`
|
|
@@ -26,10 +34,10 @@ new IntelligenceProviderAssetUploader(): IntelligenceProviderAssetUploader;
|
|
|
26
34
|
### uploadFile()
|
|
27
35
|
|
|
28
36
|
```ts
|
|
29
|
-
uploadFile(options): Promise<
|
|
37
|
+
uploadFile(options): Promise<IIntelligenceFileUploadResult>;
|
|
30
38
|
```
|
|
31
39
|
|
|
32
|
-
Defined in: [IntelligenceProviderAssetUploader.ts:
|
|
40
|
+
Defined in: [IntelligenceProviderAssetUploader.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L51)
|
|
33
41
|
|
|
34
42
|
Uploads a provider-managed file.
|
|
35
43
|
|
|
@@ -37,24 +45,23 @@ Uploads a provider-managed file.
|
|
|
37
45
|
|
|
38
46
|
| Parameter | Type | Description |
|
|
39
47
|
| ------ | ------ | ------ |
|
|
40
|
-
| `options` |
|
|
48
|
+
| `options` | [`IIntelligenceFileUploadOptions`](Interface.IIntelligenceFileUploadOptions) | Provider-neutral file upload options. |
|
|
41
49
|
|
|
42
50
|
#### Returns
|
|
43
51
|
|
|
44
|
-
`Promise
|
|
52
|
+
`Promise`\<[`IIntelligenceFileUploadResult`](Interface.IIntelligenceFileUploadResult)\>
|
|
45
53
|
|
|
46
|
-
|
|
54
|
+
A normalized provider reference.
|
|
47
55
|
|
|
48
56
|
***
|
|
49
57
|
|
|
50
58
|
### uploadSkill()
|
|
51
59
|
|
|
52
60
|
```ts
|
|
53
|
-
uploadSkill(options): Promise<
|
|
54
|
-
}>;
|
|
61
|
+
uploadSkill(options): Promise<IIntelligenceSkillUploadResult>;
|
|
55
62
|
```
|
|
56
63
|
|
|
57
|
-
Defined in: [IntelligenceProviderAssetUploader.ts:
|
|
64
|
+
Defined in: [IntelligenceProviderAssetUploader.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderAssetUploader.ts#L83)
|
|
58
65
|
|
|
59
66
|
Uploads a provider-managed skill.
|
|
60
67
|
|
|
@@ -62,11 +69,10 @@ Uploads a provider-managed skill.
|
|
|
62
69
|
|
|
63
70
|
| Parameter | Type | Description |
|
|
64
71
|
| ------ | ------ | ------ |
|
|
65
|
-
| `options` |
|
|
72
|
+
| `options` | [`IIntelligenceSkillUploadOptions`](Interface.IIntelligenceSkillUploadOptions) | Provider-neutral skill upload options. |
|
|
66
73
|
|
|
67
74
|
#### Returns
|
|
68
75
|
|
|
69
|
-
`Promise
|
|
70
|
-
\}\>
|
|
76
|
+
`Promise`\<[`IIntelligenceSkillUploadResult`](Interface.IIntelligenceSkillUploadResult)\>
|
|
71
77
|
|
|
72
|
-
|
|
78
|
+
A normalized provider reference and skill metadata.
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: IntelligenceProviderDiagnostics'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: IntelligenceProviderDiagnostics
|
|
7
|
+
|
|
8
|
+
Defined in: [IntelligenceProviderDiagnostics.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderDiagnostics.ts#L18)
|
|
9
|
+
|
|
10
|
+
Performs bounded, provider-neutral provider availability diagnostics.
|
|
11
|
+
|
|
12
|
+
## Constructors
|
|
13
|
+
|
|
14
|
+
### Constructor
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
new IntelligenceProviderDiagnostics(modelResolver): IntelligenceProviderDiagnostics;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [IntelligenceProviderDiagnostics.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderDiagnostics.ts#L28)
|
|
21
|
+
|
|
22
|
+
#### Parameters
|
|
23
|
+
|
|
24
|
+
| Parameter | Type |
|
|
25
|
+
| ------ | ------ |
|
|
26
|
+
| `modelResolver` | `IntelligenceModelResolver` |
|
|
27
|
+
|
|
28
|
+
#### Returns
|
|
29
|
+
|
|
30
|
+
`IntelligenceProviderDiagnostics`
|
|
31
|
+
|
|
32
|
+
## Methods
|
|
33
|
+
|
|
34
|
+
### probe()
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
probe(
|
|
38
|
+
capability?,
|
|
39
|
+
model?,
|
|
40
|
+
timeoutMs?): Promise<IIntelligenceProviderProbeResult>;
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Defined in: [IntelligenceProviderDiagnostics.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderDiagnostics.ts#L40)
|
|
44
|
+
|
|
45
|
+
#### Parameters
|
|
46
|
+
|
|
47
|
+
| Parameter | Type | Default value |
|
|
48
|
+
| ------ | ------ | ------ |
|
|
49
|
+
| `capability` | [`IntelligenceCapability`](TypeAlias.IntelligenceCapability) | `IntelligenceCapabilityNames.Language` |
|
|
50
|
+
| `model?` | [`IIntelligenceModelReference`](Interface.IIntelligenceModelReference) | `undefined` |
|
|
51
|
+
| `timeoutMs?` | `number` | `undefined` |
|
|
52
|
+
|
|
53
|
+
#### Returns
|
|
54
|
+
|
|
55
|
+
`Promise`\<[`IIntelligenceProviderProbeResult`](Interface.IIntelligenceProviderProbeResult)\>
|
|
@@ -26,7 +26,7 @@ new IntelligenceProviderError(
|
|
|
26
26
|
cause?): IntelligenceProviderError;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [errors/IntelligenceProviderError.ts:
|
|
29
|
+
Defined in: [errors/IntelligenceProviderError.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L18)
|
|
30
30
|
|
|
31
31
|
#### Parameters
|
|
32
32
|
|
|
@@ -50,13 +50,23 @@ Error.constructor
|
|
|
50
50
|
|
|
51
51
|
## Properties
|
|
52
52
|
|
|
53
|
+
### code
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
readonly code: "INTELLIGENCE_PROVIDER" = 'INTELLIGENCE_PROVIDER';
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Defined in: [errors/IntelligenceProviderError.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L9)
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
53
63
|
### isRetryable
|
|
54
64
|
|
|
55
65
|
```ts
|
|
56
66
|
readonly isRetryable: boolean;
|
|
57
67
|
```
|
|
58
68
|
|
|
59
|
-
Defined in: [errors/IntelligenceProviderError.ts:
|
|
69
|
+
Defined in: [errors/IntelligenceProviderError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L12)
|
|
60
70
|
|
|
61
71
|
***
|
|
62
72
|
|
|
@@ -66,7 +76,7 @@ Defined in: [errors/IntelligenceProviderError.ts:11](https://github.com/RueDeRen
|
|
|
66
76
|
readonly model: string;
|
|
67
77
|
```
|
|
68
78
|
|
|
69
|
-
Defined in: [errors/IntelligenceProviderError.ts:
|
|
79
|
+
Defined in: [errors/IntelligenceProviderError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L11)
|
|
70
80
|
|
|
71
81
|
***
|
|
72
82
|
|
|
@@ -76,4 +86,4 @@ Defined in: [errors/IntelligenceProviderError.ts:10](https://github.com/RueDeRen
|
|
|
76
86
|
readonly provider: string;
|
|
77
87
|
```
|
|
78
88
|
|
|
79
|
-
Defined in: [errors/IntelligenceProviderError.ts:
|
|
89
|
+
Defined in: [errors/IntelligenceProviderError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceProviderError.ts#L10)
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: IntelligenceProviderRegistry'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: IntelligenceProviderRegistry
|
|
7
|
+
|
|
8
|
+
Defined in: [IntelligenceProviderRegistry.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderRegistry.ts#L17)
|
|
9
|
+
|
|
10
|
+
Immutable registry of provider adapters and their supported capabilities.
|
|
11
|
+
|
|
12
|
+
## Constructors
|
|
13
|
+
|
|
14
|
+
### Constructor
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
new IntelligenceProviderRegistry(adapters): IntelligenceProviderRegistry;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [IntelligenceProviderRegistry.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderRegistry.ts#L27)
|
|
21
|
+
|
|
22
|
+
#### Parameters
|
|
23
|
+
|
|
24
|
+
| Parameter | Type |
|
|
25
|
+
| ------ | ------ |
|
|
26
|
+
| `adapters` | readonly [`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort)[] |
|
|
27
|
+
|
|
28
|
+
#### Returns
|
|
29
|
+
|
|
30
|
+
`IntelligenceProviderRegistry`
|
|
31
|
+
|
|
32
|
+
## Methods
|
|
33
|
+
|
|
34
|
+
### listProviders()
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
listProviders(): readonly string[];
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Defined in: [IntelligenceProviderRegistry.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderRegistry.ts#L64)
|
|
41
|
+
|
|
42
|
+
Returns all registered provider identifiers.
|
|
43
|
+
|
|
44
|
+
#### Returns
|
|
45
|
+
|
|
46
|
+
readonly `string`[]
|
|
47
|
+
|
|
48
|
+
***
|
|
49
|
+
|
|
50
|
+
### listProvidersFor()
|
|
51
|
+
|
|
52
|
+
```ts
|
|
53
|
+
listProvidersFor(capability): readonly string[];
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Defined in: [IntelligenceProviderRegistry.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderRegistry.ts#L73)
|
|
57
|
+
|
|
58
|
+
Returns providers supporting one capability.
|
|
59
|
+
|
|
60
|
+
#### Parameters
|
|
61
|
+
|
|
62
|
+
| Parameter | Type |
|
|
63
|
+
| ------ | ------ |
|
|
64
|
+
| `capability` | [`IntelligenceCapability`](TypeAlias.IntelligenceCapability) |
|
|
65
|
+
|
|
66
|
+
#### Returns
|
|
67
|
+
|
|
68
|
+
readonly `string`[]
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: IntelligenceRealtimeError
|
|
7
7
|
|
|
8
|
-
Defined in: [errors/IntelligenceRealtimeError.ts:
|
|
8
|
+
Defined in: [errors/IntelligenceRealtimeError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L6)
|
|
9
9
|
|
|
10
10
|
Error raised by a realtime session, transport, or metering adapter.
|
|
11
11
|
|
|
@@ -28,7 +28,7 @@ new IntelligenceRealtimeError(
|
|
|
28
28
|
cause?): IntelligenceRealtimeError;
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
Defined in: [errors/IntelligenceRealtimeError.ts:
|
|
31
|
+
Defined in: [errors/IntelligenceRealtimeError.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L19)
|
|
32
32
|
|
|
33
33
|
#### Parameters
|
|
34
34
|
|
|
@@ -36,7 +36,7 @@ Defined in: [errors/IntelligenceRealtimeError.ts:25](https://github.com/RueDeRen
|
|
|
36
36
|
| ------ | ------ |
|
|
37
37
|
| `message` | `string` |
|
|
38
38
|
| `phase` | \| `"configuration"` \| `"token"` \| `"connect"` \| `"send"` \| `"receive"` \| `"metering"` \| `"close"` |
|
|
39
|
-
| `provider` |
|
|
39
|
+
| `provider` | `string` |
|
|
40
40
|
| `model` | `string` |
|
|
41
41
|
| `sessionId` | `string` |
|
|
42
42
|
| `isRetryable` | `boolean` |
|
|
@@ -60,7 +60,7 @@ Error.constructor
|
|
|
60
60
|
readonly isRetryable: boolean;
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
Defined in: [errors/IntelligenceRealtimeError.ts:
|
|
63
|
+
Defined in: [errors/IntelligenceRealtimeError.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L13)
|
|
64
64
|
|
|
65
65
|
***
|
|
66
66
|
|
|
@@ -70,7 +70,7 @@ Defined in: [errors/IntelligenceRealtimeError.ts:19](https://github.com/RueDeRen
|
|
|
70
70
|
readonly model: string;
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
Defined in: [errors/IntelligenceRealtimeError.ts:
|
|
73
|
+
Defined in: [errors/IntelligenceRealtimeError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L11)
|
|
74
74
|
|
|
75
75
|
***
|
|
76
76
|
|
|
@@ -87,17 +87,17 @@ readonly phase:
|
|
|
87
87
|
| "close";
|
|
88
88
|
```
|
|
89
89
|
|
|
90
|
-
Defined in: [errors/IntelligenceRealtimeError.ts:
|
|
90
|
+
Defined in: [errors/IntelligenceRealtimeError.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L9)
|
|
91
91
|
|
|
92
92
|
***
|
|
93
93
|
|
|
94
94
|
### provider
|
|
95
95
|
|
|
96
96
|
```ts
|
|
97
|
-
readonly provider:
|
|
97
|
+
readonly provider: string;
|
|
98
98
|
```
|
|
99
99
|
|
|
100
|
-
Defined in: [errors/IntelligenceRealtimeError.ts:
|
|
100
|
+
Defined in: [errors/IntelligenceRealtimeError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L10)
|
|
101
101
|
|
|
102
102
|
***
|
|
103
103
|
|
|
@@ -107,4 +107,4 @@ Defined in: [errors/IntelligenceRealtimeError.ts:16](https://github.com/RueDeRen
|
|
|
107
107
|
readonly sessionId: string;
|
|
108
108
|
```
|
|
109
109
|
|
|
110
|
-
Defined in: [errors/IntelligenceRealtimeError.ts:
|
|
110
|
+
Defined in: [errors/IntelligenceRealtimeError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/errors/IntelligenceRealtimeError.ts#L12)
|