@breadstone/archipel-mcp 0.0.55 → 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.
Files changed (104) hide show
  1. package/data/guides/ai-image-generation.md +52 -47
  2. package/data/guides/ai-realtime-voice.md +48 -41
  3. package/data/guides/ai-text-generation.md +54 -60
  4. package/data/guides/health-indicators.md +67 -66
  5. package/data/guides/intelligence-prompts-warm-up.md +52 -63
  6. package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +57 -13
  7. package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +57 -13
  8. package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +57 -13
  9. package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +57 -13
  10. package/data/packages/platform-intelligence/api/Class.IntelligenceAgent.md +5 -5
  11. package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +4 -4
  12. package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +10 -9
  13. package/data/packages/platform-intelligence/api/Class.IntelligenceImageGenerator.md +117 -0
  14. package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +7 -7
  15. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
  16. package/data/packages/platform-intelligence/api/Class.IntelligencePromptPolicyPort.md +1 -1
  17. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderAdapterPort.md +104 -0
  18. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderDiagnostics.md +3 -3
  19. package/data/packages/platform-intelligence/api/Class.IntelligenceProviderRegistry.md +5 -5
  20. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +1 -1
  21. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +5 -5
  22. package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +15 -15
  23. package/data/packages/platform-intelligence/api/Class.IntelligenceReranker.md +3 -3
  24. package/data/packages/platform-intelligence/api/Class.IntelligenceSpeechGenerator.md +117 -0
  25. package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +5 -5
  26. package/data/packages/platform-intelligence/api/Class.IntelligenceTranscriptionGenerator.md +139 -0
  27. package/data/packages/platform-intelligence/api/Class.IntelligenceVideoGenerator.md +117 -0
  28. package/data/packages/platform-intelligence/api/Class.MiMoIntelligenceProviderAdapter.md +57 -13
  29. package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +38 -18
  30. package/data/packages/platform-intelligence/api/Function.createIntelligenceJsonSchema.md +1 -1
  31. package/data/packages/platform-intelligence/api/Function.defineIntelligenceTool.md +1 -1
  32. package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md +7 -7
  33. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md +25 -9
  34. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +7 -7
  35. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +24 -8
  36. package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +7 -7
  37. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +23 -7
  38. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadResult.md +6 -6
  39. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGeneratedFile.md +4 -4
  40. package/data/packages/platform-intelligence/api/Interface.IIntelligenceGenerationStepStartEvent.md +5 -5
  41. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationOptions.md +29 -13
  42. package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationResult.md +6 -6
  43. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageCompletion.md +13 -13
  44. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md +33 -17
  45. package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageStream.md +5 -5
  46. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelReference.md +3 -3
  47. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelRequestOptions.md +24 -4
  48. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +3 -3
  49. package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +30 -8
  50. package/data/packages/platform-intelligence/api/Interface.IIntelligenceObjectStream.md +5 -5
  51. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +5 -5
  52. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +20 -6
  53. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md +7 -7
  54. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +21 -9
  55. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +174 -10
  56. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +22 -6
  57. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +26 -10
  58. package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +4 -4
  59. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +22 -6
  60. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +8 -8
  61. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +29 -13
  62. package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +5 -5
  63. package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +25 -9
  64. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolCall.md +4 -4
  65. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolDefinition.md +7 -7
  66. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionEndEvent.md +5 -5
  67. package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionStartEvent.md +3 -3
  68. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionOptions.md +24 -8
  69. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionResult.md +8 -8
  70. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionStream.md +9 -9
  71. package/data/packages/platform-intelligence/api/Interface.IIntelligenceUsage.md +161 -4
  72. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +34 -18
  73. package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationResult.md +5 -5
  74. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceModelMessage.md +1 -1
  75. package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceSchema.md +1 -1
  76. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceCapability.md +1 -1
  77. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceDefaultModels.md +1 -1
  78. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceJsonValue.md +1 -1
  79. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
  80. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderOptions.md +1 -1
  81. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderProbeStatus.md +1 -1
  82. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderToolOptions.md +1 -1
  83. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRequestTimeouts.md +1 -1
  84. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolChoice.md +1 -1
  85. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolOutput.md +1 -1
  86. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolSet.md +1 -1
  87. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md +1 -1
  88. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_API_KEY.md +1 -1
  89. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_BASE_URL.md +1 -1
  90. package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_CONFIG_ENTRIES.md +1 -1
  91. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +1 -1
  92. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +1 -1
  93. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  94. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  95. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +1 -1
  96. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  97. package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  98. package/data/packages/platform-intelligence/api/Variable.IntelligenceCapabilityNames.md +11 -11
  99. package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +2 -2
  100. package/data/packages/platform-intelligence/api/index.md +8 -5
  101. package/data/packages/platform-intelligence/index.md +86 -0
  102. package/package.json +1 -1
  103. package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +0 -140
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderAdapter.md +0 -73
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceAgent
7
7
 
8
- Defined in: IntelligenceAgent.ts:17
8
+ Defined in: [IntelligenceAgent.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceAgent.ts#L17)
9
9
 
10
10
  Reusable provider-neutral agent backed by the language capability.
11
11
 
@@ -17,7 +17,7 @@ Reusable provider-neutral agent backed by the language capability.
17
17
  new IntelligenceAgent(configuration, languageGenerator): IntelligenceAgent;
18
18
  ```
19
19
 
20
- Defined in: IntelligenceAgent.ts:27
20
+ Defined in: [IntelligenceAgent.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceAgent.ts#L27)
21
21
 
22
22
  #### Parameters
23
23
 
@@ -40,7 +40,7 @@ Defined in: IntelligenceAgent.ts:27
40
40
  get name(): string | undefined;
41
41
  ```
42
42
 
43
- Defined in: IntelligenceAgent.ts:37
43
+ Defined in: [IntelligenceAgent.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceAgent.ts#L37)
44
44
 
45
45
  Optional stable agent name used by application observability.
46
46
 
@@ -56,7 +56,7 @@ Optional stable agent name used by application observability.
56
56
  generate(prompt, options?): Promise<IIntelligenceLanguageCompletion<string>>;
57
57
  ```
58
58
 
59
- Defined in: IntelligenceAgent.ts:46
59
+ Defined in: [IntelligenceAgent.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceAgent.ts#L46)
60
60
 
61
61
  Executes one bounded agent run.
62
62
 
@@ -79,7 +79,7 @@ Executes one bounded agent run.
79
79
  stream(prompt, options?): Promise<IIntelligenceLanguageStream>;
80
80
  ```
81
81
 
82
- Defined in: IntelligenceAgent.ts:51
82
+ Defined in: [IntelligenceAgent.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceAgent.ts#L51)
83
83
 
84
84
  Streams one agent run.
85
85
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceEmbeddingGenerator
7
7
 
8
- Defined in: [IntelligenceEmbeddingGenerator.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceEmbeddingGenerator.ts#L27)
8
+ Defined in: [generators/IntelligenceEmbeddingGenerator.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceEmbeddingGenerator.ts#L27)
9
9
 
10
10
  Provider-neutral single and batch embedding facade.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral single and batch embedding facade.
17
17
  new IntelligenceEmbeddingGenerator(modelResolver): IntelligenceEmbeddingGenerator;
18
18
  ```
19
19
 
20
- Defined in: [IntelligenceEmbeddingGenerator.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceEmbeddingGenerator.ts#L36)
20
+ Defined in: [generators/IntelligenceEmbeddingGenerator.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceEmbeddingGenerator.ts#L36)
21
21
 
22
22
  #### Parameters
23
23
 
@@ -37,7 +37,7 @@ Defined in: [IntelligenceEmbeddingGenerator.ts:36](https://github.com/RueDeRenne
37
37
  embed(options): Promise<IIntelligenceEmbeddingResult>;
38
38
  ```
39
39
 
40
- Defined in: [IntelligenceEmbeddingGenerator.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceEmbeddingGenerator.ts#L53)
40
+ Defined in: [generators/IntelligenceEmbeddingGenerator.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceEmbeddingGenerator.ts#L53)
41
41
 
42
42
  Embeds one text value.
43
43
 
@@ -59,7 +59,7 @@ Embeds one text value.
59
59
  embedMany(options): Promise<IIntelligenceEmbeddingBatchResult>;
60
60
  ```
61
61
 
62
- Defined in: [IntelligenceEmbeddingGenerator.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceEmbeddingGenerator.ts#L85)
62
+ Defined in: [generators/IntelligenceEmbeddingGenerator.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceEmbeddingGenerator.ts#L85)
63
63
 
64
64
  Embeds multiple values with bounded provider parallelism.
65
65
 
@@ -5,10 +5,11 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceHealthIndicator
7
7
 
8
- Defined in: [health/IntelligenceHealthIndicator.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L20)
8
+ Defined in: [health/IntelligenceHealthIndicator.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L21)
9
9
 
10
10
  Health indicator for the intelligence infrastructure.
11
- Verifies that the intelligence provider configuration can be resolved.
11
+ Performs a bounded remote readiness probe for the default language model and
12
+ reports the locally registered capability topology.
12
13
 
13
14
  ## Implements
14
15
 
@@ -21,18 +22,18 @@ Verifies that the intelligence provider configuration can be resolved.
21
22
  ```ts
22
23
  new IntelligenceHealthIndicator(
23
24
  providerRegistry?,
24
- languageGenerator?,
25
+ diagnostics?,
25
26
  realtimeSessionFactory?): IntelligenceHealthIndicator;
26
27
  ```
27
28
 
28
- Defined in: [health/IntelligenceHealthIndicator.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L31)
29
+ Defined in: [health/IntelligenceHealthIndicator.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L34)
29
30
 
30
31
  #### Parameters
31
32
 
32
33
  | Parameter | Type |
33
34
  | ------ | ------ |
34
35
  | `providerRegistry?` | [`IntelligenceProviderRegistry`](Class.IntelligenceProviderRegistry) |
35
- | `languageGenerator?` | [`IntelligenceLanguageGenerator`](Class.IntelligenceLanguageGenerator) |
36
+ | `diagnostics?` | [`IntelligenceProviderDiagnostics`](Class.IntelligenceProviderDiagnostics) |
36
37
  | `realtimeSessionFactory?` | [`IntelligenceRealtimeSessionFactory`](Class.IntelligenceRealtimeSessionFactory) |
37
38
 
38
39
  #### Returns
@@ -47,7 +48,7 @@ Defined in: [health/IntelligenceHealthIndicator.ts:31](https://github.com/RueDeR
47
48
  readonly key: string = 'intelligence';
48
49
  ```
49
50
 
50
- Defined in: [health/IntelligenceHealthIndicator.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L45)
51
+ Defined in: [health/IntelligenceHealthIndicator.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L48)
51
52
 
52
53
  Unique key identifying the indicator
53
54
 
@@ -62,17 +63,17 @@ IHealthIndicator.key
62
63
  ### check()
63
64
 
64
65
  ```ts
65
- check(): HealthIndicatorResult<string>;
66
+ check(): Promise<HealthIndicatorResult<string>>;
66
67
  ```
67
68
 
68
- Defined in: [health/IntelligenceHealthIndicator.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L58)
69
+ Defined in: [health/IntelligenceHealthIndicator.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/health/IntelligenceHealthIndicator.ts#L61)
69
70
 
70
71
  Verifies that the provider configuration can be resolved.
71
72
  Returns disabled status when no intelligence generator is configured.
72
73
 
73
74
  #### Returns
74
75
 
75
- `HealthIndicatorResult`\<`string`\>
76
+ `Promise`\<`HealthIndicatorResult`\<`string`\>\>
76
77
 
77
78
  The health indicator result.
78
79
 
@@ -0,0 +1,117 @@
1
+ ---
2
+ title: 'Class: IntelligenceImageGenerator'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Class: IntelligenceImageGenerator
7
+
8
+ Defined in: [generators/IntelligenceImageGenerator.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceImageGenerator.ts#L25)
9
+
10
+ Provider-neutral image generation facade.
11
+
12
+ ## Extends
13
+
14
+ - `IntelligenceGeneratorBase`
15
+
16
+ ## Constructors
17
+
18
+ ### Constructor
19
+
20
+ ```ts
21
+ new IntelligenceImageGenerator(modelResolver): IntelligenceImageGenerator;
22
+ ```
23
+
24
+ Defined in: [generators/IntelligenceImageGenerator.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceImageGenerator.ts#L32)
25
+
26
+ #### Parameters
27
+
28
+ | Parameter | Type |
29
+ | ------ | ------ |
30
+ | `modelResolver` | `IntelligenceModelResolver` |
31
+
32
+ #### Returns
33
+
34
+ `IntelligenceImageGenerator`
35
+
36
+ #### Overrides
37
+
38
+ ```ts
39
+ IntelligenceGeneratorBase.constructor
40
+ ```
41
+
42
+ ## Properties
43
+
44
+ ### modelResolver
45
+
46
+ ```ts
47
+ protected readonly modelResolver: IntelligenceModelResolver;
48
+ ```
49
+
50
+ Defined in: [generators/abstracts/IntelligenceGeneratorBase.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/abstracts/IntelligenceGeneratorBase.ts#L19)
51
+
52
+ #### Inherited from
53
+
54
+ ```ts
55
+ IntelligenceGeneratorBase.modelResolver
56
+ ```
57
+
58
+ ## Methods
59
+
60
+ ### createProviderError()
61
+
62
+ ```ts
63
+ protected createProviderError(
64
+ error,
65
+ provider,
66
+ model,
67
+ capability,
68
+ operation,
69
+ requestId,
70
+ startedAt): IntelligenceProviderError;
71
+ ```
72
+
73
+ Defined in: [generators/abstracts/IntelligenceGeneratorBase.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/abstracts/IntelligenceGeneratorBase.ts#L40)
74
+
75
+ #### Parameters
76
+
77
+ | Parameter | Type |
78
+ | ------ | ------ |
79
+ | `error` | `unknown` |
80
+ | `provider` | `string` |
81
+ | `model` | `string` |
82
+ | `capability` | [`IntelligenceCapability`](TypeAlias.IntelligenceCapability) |
83
+ | `operation` | `string` |
84
+ | `requestId` | `string` \| `undefined` |
85
+ | `startedAt` | `number` |
86
+
87
+ #### Returns
88
+
89
+ [`IntelligenceProviderError`](Class.IntelligenceProviderError)
90
+
91
+ #### Inherited from
92
+
93
+ ```ts
94
+ IntelligenceGeneratorBase.createProviderError
95
+ ```
96
+
97
+ ***
98
+
99
+ ### generate()
100
+
101
+ ```ts
102
+ generate(options): Promise<IIntelligenceImageGenerationResult>;
103
+ ```
104
+
105
+ Defined in: [generators/IntelligenceImageGenerator.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceImageGenerator.ts#L49)
106
+
107
+ Generates one or more images.
108
+
109
+ #### Parameters
110
+
111
+ | Parameter | Type |
112
+ | ------ | ------ |
113
+ | `options` | [`IIntelligenceImageGenerationOptions`](Interface.IIntelligenceImageGenerationOptions) |
114
+
115
+ #### Returns
116
+
117
+ `Promise`\<[`IIntelligenceImageGenerationResult`](Interface.IIntelligenceImageGenerationResult)\>
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceLanguageGenerator
7
7
 
8
- Defined in: IntelligenceLanguageGenerator.ts:80
8
+ Defined in: [generators/IntelligenceLanguageGenerator.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L80)
9
9
 
10
10
  Provider-neutral language generation, structured output, and streaming facade.
11
11
 
@@ -17,7 +17,7 @@ Provider-neutral language generation, structured output, and streaming facade.
17
17
  new IntelligenceLanguageGenerator(modelResolver, toolRegistry): IntelligenceLanguageGenerator;
18
18
  ```
19
19
 
20
- Defined in: IntelligenceLanguageGenerator.ts:91
20
+ Defined in: [generators/IntelligenceLanguageGenerator.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L91)
21
21
 
22
22
  #### Parameters
23
23
 
@@ -41,7 +41,7 @@ generateObject<T>(
41
41
  options?): Promise<IIntelligenceLanguageCompletion<T>>;
42
42
  ```
43
43
 
44
- Defined in: IntelligenceLanguageGenerator.ts:121
44
+ Defined in: [generators/IntelligenceLanguageGenerator.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L121)
45
45
 
46
46
  Generates a schema-constrained object through the language capability.
47
47
 
@@ -71,7 +71,7 @@ Generates a schema-constrained object through the language capability.
71
71
  generateText(prompt, options?): Promise<IIntelligenceLanguageCompletion<string>>;
72
72
  ```
73
73
 
74
- Defined in: IntelligenceLanguageGenerator.ts:109
74
+ Defined in: [generators/IntelligenceLanguageGenerator.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L109)
75
75
 
76
76
  Generates plain text and normalized tool metadata.
77
77
 
@@ -94,7 +94,7 @@ Generates plain text and normalized tool metadata.
94
94
  getDefaultModel(): IIntelligenceModelStatus;
95
95
  ```
96
96
 
97
- Defined in: IntelligenceLanguageGenerator.ts:201
97
+ Defined in: [generators/IntelligenceLanguageGenerator.ts:201](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L201)
98
98
 
99
99
  Returns the default language model without exposing credentials.
100
100
 
@@ -113,7 +113,7 @@ streamObject<T>(
113
113
  options?): Promise<IIntelligenceObjectStream<T>>;
114
114
  ```
115
115
 
116
- Defined in: IntelligenceLanguageGenerator.ts:166
116
+ Defined in: [generators/IntelligenceLanguageGenerator.ts:166](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L166)
117
117
 
118
118
  Streams partial structured output through the language capability.
119
119
 
@@ -143,7 +143,7 @@ Streams partial structured output through the language capability.
143
143
  streamText(prompt, options?): Promise<IIntelligenceLanguageStream>;
144
144
  ```
145
145
 
146
- Defined in: IntelligenceLanguageGenerator.ts:139
146
+ Defined in: [generators/IntelligenceLanguageGenerator.ts:139](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/generators/IntelligenceLanguageGenerator.ts#L139)
147
147
 
148
148
  Streams text without exposing the native AI SDK stream object.
149
149
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceModule
7
7
 
8
- Defined in: [IntelligenceModule.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L79)
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:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L90)
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
 
@@ -35,7 +35,7 @@ new IntelligencePromptPolicyPort(): IntelligencePromptPolicyPort;
35
35
  abstract resolve(request): Promise<IIntelligencePromptEffectivePolicy>;
36
36
  ```
37
37
 
38
- Defined in: [prompts/IntelligencePromptPolicyPort.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/prompts/IntelligencePromptPolicyPort.ts#L18)
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,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceProviderDiagnostics
7
7
 
8
- Defined in: IntelligenceProviderDiagnostics.ts:18
8
+ Defined in: [IntelligenceProviderDiagnostics.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderDiagnostics.ts#L18)
9
9
 
10
10
  Performs bounded, provider-neutral provider availability diagnostics.
11
11
 
@@ -17,7 +17,7 @@ Performs bounded, provider-neutral provider availability diagnostics.
17
17
  new IntelligenceProviderDiagnostics(modelResolver): IntelligenceProviderDiagnostics;
18
18
  ```
19
19
 
20
- Defined in: IntelligenceProviderDiagnostics.ts:27
20
+ Defined in: [IntelligenceProviderDiagnostics.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderDiagnostics.ts#L28)
21
21
 
22
22
  #### Parameters
23
23
 
@@ -40,7 +40,7 @@ probe(
40
40
  timeoutMs?): Promise<IIntelligenceProviderProbeResult>;
41
41
  ```
42
42
 
43
- Defined in: IntelligenceProviderDiagnostics.ts:39
43
+ Defined in: [IntelligenceProviderDiagnostics.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderDiagnostics.ts#L40)
44
44
 
45
45
  #### Parameters
46
46
 
@@ -5,7 +5,7 @@ editUrl: false
5
5
  ---
6
6
  # Class: IntelligenceProviderRegistry
7
7
 
8
- Defined in: IntelligenceProviderRegistry.ts:17
8
+ Defined in: [IntelligenceProviderRegistry.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderRegistry.ts#L17)
9
9
 
10
10
  Immutable registry of provider adapters and their supported capabilities.
11
11
 
@@ -17,13 +17,13 @@ Immutable registry of provider adapters and their supported capabilities.
17
17
  new IntelligenceProviderRegistry(adapters): IntelligenceProviderRegistry;
18
18
  ```
19
19
 
20
- Defined in: IntelligenceProviderRegistry.ts:27
20
+ Defined in: [IntelligenceProviderRegistry.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderRegistry.ts#L27)
21
21
 
22
22
  #### Parameters
23
23
 
24
24
  | Parameter | Type |
25
25
  | ------ | ------ |
26
- | `adapters` | readonly [`IIntelligenceProviderAdapter`](Interface.IIntelligenceProviderAdapter)[] |
26
+ | `adapters` | readonly [`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort)[] |
27
27
 
28
28
  #### Returns
29
29
 
@@ -37,7 +37,7 @@ Defined in: IntelligenceProviderRegistry.ts:27
37
37
  listProviders(): readonly string[];
38
38
  ```
39
39
 
40
- Defined in: IntelligenceProviderRegistry.ts:64
40
+ Defined in: [IntelligenceProviderRegistry.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderRegistry.ts#L64)
41
41
 
42
42
  Returns all registered provider identifiers.
43
43
 
@@ -53,7 +53,7 @@ readonly `string`[]
53
53
  listProvidersFor(capability): readonly string[];
54
54
  ```
55
55
 
56
- Defined in: IntelligenceProviderRegistry.ts:73
56
+ Defined in: [IntelligenceProviderRegistry.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceProviderRegistry.ts#L73)
57
57
 
58
58
  Returns providers supporting one capability.
59
59
 
@@ -32,7 +32,7 @@ new IntelligenceRealtimeMeteringPort(): IntelligenceRealtimeMeteringPort;
32
32
  abstract report(event): Promise<void>;
33
33
  ```
34
34
 
35
- Defined in: [realtime/ports/IntelligenceRealtimeMeteringPort.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeMeteringPort.ts#L23)
35
+ Defined in: [realtime/ports/IntelligenceRealtimeMeteringPort.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/ports/IntelligenceRealtimeMeteringPort.ts#L35)
36
36
 
37
37
  Persists one metering event.
38
38
 
@@ -30,7 +30,7 @@ new IntelligenceRealtimeSessionFactory(
30
30
  runtime): IntelligenceRealtimeSessionFactory;
31
31
  ```
32
32
 
33
- Defined in: [IntelligenceRealtimeSessionFactory.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L54)
33
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L55)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -56,7 +56,7 @@ Defined in: [IntelligenceRealtimeSessionFactory.ts:54](https://github.com/RueDeR
56
56
  get activeSessionCount(): number;
57
57
  ```
58
58
 
59
- Defined in: [IntelligenceRealtimeSessionFactory.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L73)
59
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L74)
60
60
 
61
61
  Number of sessions currently owned by this module instance.
62
62
 
@@ -74,7 +74,7 @@ Number of sessions currently owned by this module instance.
74
74
  get registeredProviders(): readonly string[];
75
75
  ```
76
76
 
77
- Defined in: [IntelligenceRealtimeSessionFactory.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L78)
77
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L79)
78
78
 
79
79
  Providers currently registered for server-owned realtime sessions.
80
80
 
@@ -90,7 +90,7 @@ readonly `string`[]
90
90
  createSession(options): Promise<IntelligenceRealtimeSessionPort>;
91
91
  ```
92
92
 
93
- Defined in: [IntelligenceRealtimeSessionFactory.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L92)
93
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L93)
94
94
 
95
95
  Creates an isolated realtime session without opening the upstream socket.
96
96
 
@@ -114,7 +114,7 @@ A provider-neutral session. Call `connect()` to start streaming.
114
114
  onModuleDestroy(): Promise<void>;
115
115
  ```
116
116
 
117
- Defined in: [IntelligenceRealtimeSessionFactory.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L126)
117
+ Defined in: [IntelligenceRealtimeSessionFactory.ts:141](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceRealtimeSessionFactory.ts#L141)
118
118
 
119
119
  Closes all owned upstream sessions during Nest application shutdown.
120
120