@breadstone/archipel-mcp 0.0.55 → 0.0.57
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 +52 -47
- package/data/guides/ai-realtime-voice.md +48 -41
- package/data/guides/ai-text-generation.md +54 -60
- package/data/guides/health-indicators.md +67 -66
- package/data/guides/intelligence-prompts-warm-up.md +52 -63
- package/data/packages/platform-intelligence/api/Class.AnthropicIntelligenceProviderAdapter.md +57 -13
- package/data/packages/platform-intelligence/api/Class.GatewayIntelligenceProviderAdapter.md +57 -13
- package/data/packages/platform-intelligence/api/Class.GoogleIntelligenceProviderAdapter.md +57 -13
- package/data/packages/platform-intelligence/api/Class.GrokIntelligenceProviderAdapter.md +57 -13
- package/data/packages/platform-intelligence/api/Class.IntelligenceAgent.md +5 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceEmbeddingGenerator.md +4 -4
- package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +10 -9
- package/data/packages/platform-intelligence/api/Class.IntelligenceImageGenerator.md +117 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceLanguageGenerator.md +7 -7
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +2 -2
- 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.IntelligenceProviderDiagnostics.md +3 -3
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderRegistry.md +5 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeMeteringPort.md +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionFactory.md +5 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceRealtimeSessionPort.md +15 -15
- package/data/packages/platform-intelligence/api/Class.IntelligenceReranker.md +3 -3
- package/data/packages/platform-intelligence/api/Class.IntelligenceSpeechGenerator.md +117 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceToolRegistry.md +5 -5
- 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 +57 -13
- package/data/packages/platform-intelligence/api/Class.OpenAIIntelligenceProviderAdapter.md +38 -18
- package/data/packages/platform-intelligence/api/Function.createIntelligenceJsonSchema.md +1 -1
- package/data/packages/platform-intelligence/api/Function.defineIntelligenceTool.md +1 -1
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md +7 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md +25 -9
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md +7 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingOptions.md +24 -8
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingResult.md +7 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadOptions.md +23 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFileUploadResult.md +6 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceGeneratedFile.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceGenerationStepStartEvent.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationOptions.md +29 -13
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceImageGenerationResult.md +6 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageCompletion.md +13 -13
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageGenerationOptions.md +33 -17
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceLanguageStream.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelReference.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelRequestOptions.md +24 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModelStatus.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceModuleOptions.md +30 -8
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceObjectStream.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderLoadRequest.md +20 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderProbeResult.md +7 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md +21 -9
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeUsage.md +174 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRequestOptions.md +22 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingOptions.md +26 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceRerankingResult.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md +22 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadResult.md +8 -8
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationOptions.md +29 -13
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceSpeechGenerationResult.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceStreamingTranscriptionOptions.md +25 -9
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolCall.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolDefinition.md +7 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionEndEvent.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceToolExecutionStartEvent.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionOptions.md +24 -8
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionResult.md +8 -8
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTranscriptionStream.md +9 -9
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceUsage.md +161 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationOptions.md +34 -18
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceVideoGenerationResult.md +5 -5
- package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceModelMessage.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IIntelligenceSchema.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceCapability.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceDefaultModels.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceJsonValue.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderOptions.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderProbeStatus.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderToolOptions.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceRequestTimeouts.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolChoice.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolOutput.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceToolSet.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceTranscriptionStreamPart.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_API_KEY.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_BASE_URL.md +1 -1
- package/data/packages/platform-intelligence/api/Variable.AI_GATEWAY_CONFIG_ENTRIES.md +1 -1
- 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 +1 -1
- 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 +11 -11
- package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +2 -2
- package/data/packages/platform-intelligence/api/index.md +8 -5
- package/data/packages/platform-intelligence/index.md +92 -0
- package/package.json +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceMediaGenerator.md +0 -140
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderAdapter.md +0 -73
|
@@ -5,26 +5,38 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: MiMoIntelligenceProviderAdapter
|
|
7
7
|
|
|
8
|
-
Defined in: providers/mimo/MiMoIntelligenceProviderAdapter.ts:
|
|
8
|
+
Defined in: [providers/mimo/MiMoIntelligenceProviderAdapter.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/mimo/MiMoIntelligenceProviderAdapter.ts#L24)
|
|
9
9
|
|
|
10
10
|
Xiaomi MiMo OpenAI-compatible language adapter.
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## Extends
|
|
13
13
|
|
|
14
|
-
- [`
|
|
14
|
+
- [`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort)
|
|
15
15
|
|
|
16
16
|
## Constructors
|
|
17
17
|
|
|
18
18
|
### Constructor
|
|
19
19
|
|
|
20
20
|
```ts
|
|
21
|
-
new MiMoIntelligenceProviderAdapter(): MiMoIntelligenceProviderAdapter;
|
|
21
|
+
new MiMoIntelligenceProviderAdapter(configService): MiMoIntelligenceProviderAdapter;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
+
Defined in: [providers/mimo/MiMoIntelligenceProviderAdapter.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/mimo/MiMoIntelligenceProviderAdapter.ts#L33)
|
|
25
|
+
|
|
26
|
+
#### Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `configService` | `ConfigService` |
|
|
31
|
+
|
|
24
32
|
#### Returns
|
|
25
33
|
|
|
26
34
|
`MiMoIntelligenceProviderAdapter`
|
|
27
35
|
|
|
36
|
+
#### Overrides
|
|
37
|
+
|
|
38
|
+
[`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort).[`constructor`](Class.IntelligenceProviderAdapterPort#constructor)
|
|
39
|
+
|
|
28
40
|
## Properties
|
|
29
41
|
|
|
30
42
|
### capabilities
|
|
@@ -33,11 +45,11 @@ new MiMoIntelligenceProviderAdapter(): MiMoIntelligenceProviderAdapter;
|
|
|
33
45
|
readonly capabilities: readonly ["language"];
|
|
34
46
|
```
|
|
35
47
|
|
|
36
|
-
Defined in: providers/mimo/MiMoIntelligenceProviderAdapter.ts:
|
|
48
|
+
Defined in: [providers/mimo/MiMoIntelligenceProviderAdapter.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/mimo/MiMoIntelligenceProviderAdapter.ts#L43)
|
|
37
49
|
|
|
38
|
-
####
|
|
50
|
+
#### Overrides
|
|
39
51
|
|
|
40
|
-
[`
|
|
52
|
+
[`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort).[`capabilities`](Class.IntelligenceProviderAdapterPort#capabilities)
|
|
41
53
|
|
|
42
54
|
***
|
|
43
55
|
|
|
@@ -47,11 +59,11 @@ Defined in: providers/mimo/MiMoIntelligenceProviderAdapter.ts:31
|
|
|
47
59
|
readonly provider: "mimo" = IntelligenceProviderNames.MiMo;
|
|
48
60
|
```
|
|
49
61
|
|
|
50
|
-
Defined in: providers/mimo/MiMoIntelligenceProviderAdapter.ts:
|
|
62
|
+
Defined in: [providers/mimo/MiMoIntelligenceProviderAdapter.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/mimo/MiMoIntelligenceProviderAdapter.ts#L42)
|
|
51
63
|
|
|
52
|
-
####
|
|
64
|
+
#### Overrides
|
|
53
65
|
|
|
54
|
-
[`
|
|
66
|
+
[`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort).[`provider`](Class.IntelligenceProviderAdapterPort#provider)
|
|
55
67
|
|
|
56
68
|
## Methods
|
|
57
69
|
|
|
@@ -61,7 +73,7 @@ Defined in: providers/mimo/MiMoIntelligenceProviderAdapter.ts:30
|
|
|
61
73
|
load(request): Promise<unknown>;
|
|
62
74
|
```
|
|
63
75
|
|
|
64
|
-
Defined in: providers/mimo/MiMoIntelligenceProviderAdapter.ts:
|
|
76
|
+
Defined in: [providers/mimo/MiMoIntelligenceProviderAdapter.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/mimo/MiMoIntelligenceProviderAdapter.ts#L49)
|
|
65
77
|
|
|
66
78
|
#### Parameters
|
|
67
79
|
|
|
@@ -73,6 +85,38 @@ Defined in: providers/mimo/MiMoIntelligenceProviderAdapter.ts:37
|
|
|
73
85
|
|
|
74
86
|
`Promise`\<`unknown`\>
|
|
75
87
|
|
|
76
|
-
####
|
|
88
|
+
#### Overrides
|
|
89
|
+
|
|
90
|
+
[`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort).[`load`](Class.IntelligenceProviderAdapterPort#load)
|
|
91
|
+
|
|
92
|
+
***
|
|
93
|
+
|
|
94
|
+
### probe()?
|
|
95
|
+
|
|
96
|
+
```ts
|
|
97
|
+
optional probe(request): Promise<IIntelligenceProviderProbeResult>;
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Defined in: [providers/IntelligenceProviderAdapterPort.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceProviderAdapterPort.ts#L50)
|
|
101
|
+
|
|
102
|
+
Performs an optional, lightweight remote readiness probe.
|
|
103
|
+
|
|
104
|
+
Adapters without a provider-supported probe can omit this method. The
|
|
105
|
+
diagnostics facade then reports degraded local readiness after model
|
|
106
|
+
materialization. Operational calls remain isolated behind Archipel's
|
|
107
|
+
timeout, retry, and domain-error boundary, so a circuit-breaker
|
|
108
|
+
decorator can be introduced without changing capability facades.
|
|
109
|
+
|
|
110
|
+
#### Parameters
|
|
111
|
+
|
|
112
|
+
| Parameter | Type |
|
|
113
|
+
| ------ | ------ |
|
|
114
|
+
| `request` | [`IIntelligenceProviderLoadRequest`](Interface.IIntelligenceProviderLoadRequest) |
|
|
115
|
+
|
|
116
|
+
#### Returns
|
|
117
|
+
|
|
118
|
+
`Promise`\<[`IIntelligenceProviderProbeResult`](Interface.IIntelligenceProviderProbeResult)\>
|
|
119
|
+
|
|
120
|
+
#### Inherited from
|
|
77
121
|
|
|
78
|
-
[`
|
|
122
|
+
[`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort).[`probe`](Class.IntelligenceProviderAdapterPort#probe)
|
|
@@ -5,39 +5,51 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: OpenAIIntelligenceProviderAdapter
|
|
7
7
|
|
|
8
|
-
Defined in: providers/openai/OpenAIIntelligenceProviderAdapter.ts:
|
|
8
|
+
Defined in: [providers/openai/OpenAIIntelligenceProviderAdapter.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceProviderAdapter.ts#L26)
|
|
9
9
|
|
|
10
|
-
OpenAI adapter for language, embeddings, images, audio, realtime, files, and skills.
|
|
10
|
+
OpenAI adapter for language, embeddings, images, audio, video, realtime, files, and skills.
|
|
11
11
|
|
|
12
|
-
##
|
|
12
|
+
## Extends
|
|
13
13
|
|
|
14
|
-
- [`
|
|
14
|
+
- [`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort)
|
|
15
15
|
|
|
16
16
|
## Constructors
|
|
17
17
|
|
|
18
18
|
### Constructor
|
|
19
19
|
|
|
20
20
|
```ts
|
|
21
|
-
new OpenAIIntelligenceProviderAdapter(): OpenAIIntelligenceProviderAdapter;
|
|
21
|
+
new OpenAIIntelligenceProviderAdapter(configService): OpenAIIntelligenceProviderAdapter;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
+
Defined in: [providers/openai/OpenAIIntelligenceProviderAdapter.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceProviderAdapter.ts#L36)
|
|
25
|
+
|
|
26
|
+
#### Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `configService` | `ConfigService` |
|
|
31
|
+
|
|
24
32
|
#### Returns
|
|
25
33
|
|
|
26
34
|
`OpenAIIntelligenceProviderAdapter`
|
|
27
35
|
|
|
36
|
+
#### Overrides
|
|
37
|
+
|
|
38
|
+
[`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort).[`constructor`](Class.IntelligenceProviderAdapterPort#constructor)
|
|
39
|
+
|
|
28
40
|
## Properties
|
|
29
41
|
|
|
30
42
|
### capabilities
|
|
31
43
|
|
|
32
44
|
```ts
|
|
33
|
-
readonly capabilities: readonly ["language", "embedding", "image", "speech", "transcription", "realtime", "files", "skills"];
|
|
45
|
+
readonly capabilities: readonly ["language", "embedding", "image", "speech", "transcription", "video", "realtime", "files", "skills"];
|
|
34
46
|
```
|
|
35
47
|
|
|
36
|
-
Defined in: providers/openai/OpenAIIntelligenceProviderAdapter.ts:
|
|
48
|
+
Defined in: [providers/openai/OpenAIIntelligenceProviderAdapter.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceProviderAdapter.ts#L46)
|
|
37
49
|
|
|
38
|
-
####
|
|
50
|
+
#### Overrides
|
|
39
51
|
|
|
40
|
-
[`
|
|
52
|
+
[`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort).[`capabilities`](Class.IntelligenceProviderAdapterPort#capabilities)
|
|
41
53
|
|
|
42
54
|
***
|
|
43
55
|
|
|
@@ -47,11 +59,11 @@ Defined in: providers/openai/OpenAIIntelligenceProviderAdapter.ts:32
|
|
|
47
59
|
readonly provider: "openai" = IntelligenceProviderNames.OpenAI;
|
|
48
60
|
```
|
|
49
61
|
|
|
50
|
-
Defined in: providers/openai/OpenAIIntelligenceProviderAdapter.ts:
|
|
62
|
+
Defined in: [providers/openai/OpenAIIntelligenceProviderAdapter.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceProviderAdapter.ts#L45)
|
|
51
63
|
|
|
52
|
-
####
|
|
64
|
+
#### Overrides
|
|
53
65
|
|
|
54
|
-
[`
|
|
66
|
+
[`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort).[`provider`](Class.IntelligenceProviderAdapterPort#provider)
|
|
55
67
|
|
|
56
68
|
## Methods
|
|
57
69
|
|
|
@@ -61,7 +73,7 @@ Defined in: providers/openai/OpenAIIntelligenceProviderAdapter.ts:31
|
|
|
61
73
|
load(request): Promise<unknown>;
|
|
62
74
|
```
|
|
63
75
|
|
|
64
|
-
Defined in: providers/openai/OpenAIIntelligenceProviderAdapter.ts:
|
|
76
|
+
Defined in: [providers/openai/OpenAIIntelligenceProviderAdapter.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceProviderAdapter.ts#L62)
|
|
65
77
|
|
|
66
78
|
#### Parameters
|
|
67
79
|
|
|
@@ -73,9 +85,9 @@ Defined in: providers/openai/OpenAIIntelligenceProviderAdapter.ts:47
|
|
|
73
85
|
|
|
74
86
|
`Promise`\<`unknown`\>
|
|
75
87
|
|
|
76
|
-
####
|
|
88
|
+
#### Overrides
|
|
77
89
|
|
|
78
|
-
[`
|
|
90
|
+
[`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort).[`load`](Class.IntelligenceProviderAdapterPort#load)
|
|
79
91
|
|
|
80
92
|
***
|
|
81
93
|
|
|
@@ -85,7 +97,15 @@ Defined in: providers/openai/OpenAIIntelligenceProviderAdapter.ts:47
|
|
|
85
97
|
probe(request): Promise<IIntelligenceProviderProbeResult>;
|
|
86
98
|
```
|
|
87
99
|
|
|
88
|
-
Defined in: providers/openai/OpenAIIntelligenceProviderAdapter.ts:
|
|
100
|
+
Defined in: [providers/openai/OpenAIIntelligenceProviderAdapter.ts:104](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/openai/OpenAIIntelligenceProviderAdapter.ts#L104)
|
|
101
|
+
|
|
102
|
+
Performs an optional, lightweight remote readiness probe.
|
|
103
|
+
|
|
104
|
+
Adapters without a provider-supported probe can omit this method. The
|
|
105
|
+
diagnostics facade then reports degraded local readiness after model
|
|
106
|
+
materialization. Operational calls remain isolated behind Archipel's
|
|
107
|
+
timeout, retry, and domain-error boundary, so a circuit-breaker
|
|
108
|
+
decorator can be introduced without changing capability facades.
|
|
89
109
|
|
|
90
110
|
#### Parameters
|
|
91
111
|
|
|
@@ -97,6 +117,6 @@ Defined in: providers/openai/OpenAIIntelligenceProviderAdapter.ts:77
|
|
|
97
117
|
|
|
98
118
|
`Promise`\<[`IIntelligenceProviderProbeResult`](Interface.IIntelligenceProviderProbeResult)\>
|
|
99
119
|
|
|
100
|
-
####
|
|
120
|
+
#### Overrides
|
|
101
121
|
|
|
102
|
-
[`
|
|
122
|
+
[`IntelligenceProviderAdapterPort`](Class.IntelligenceProviderAdapterPort).[`probe`](Class.IntelligenceProviderAdapterPort#probe)
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
function createIntelligenceJsonSchema<T>(jsonSchema, validate?): IIntelligenceSchema<T>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: contracts/createIntelligenceJsonSchema.ts:12
|
|
12
|
+
Defined in: [contracts/createIntelligenceJsonSchema.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/createIntelligenceJsonSchema.ts#L12)
|
|
13
13
|
|
|
14
14
|
Creates a provider-neutral JSON Schema wrapper.
|
|
15
15
|
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
function defineIntelligenceTool<TInput, TOutput>(definition): IIntelligenceToolDefinition<TInput, TOutput>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: contracts/defineIntelligenceTool.ts:12
|
|
12
|
+
Defined in: [contracts/defineIntelligenceTool.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/defineIntelligenceTool.ts#L12)
|
|
13
13
|
|
|
14
14
|
Defines a provider-neutral intelligence tool while preserving its input and output types.
|
|
15
15
|
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceAgentConfiguration.md
CHANGED
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceAgentConfiguration
|
|
7
7
|
|
|
8
|
-
Defined in: contracts/IIntelligenceAgentConfiguration.ts:13
|
|
8
|
+
Defined in: [contracts/IIntelligenceAgentConfiguration.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceAgentConfiguration.ts#L13)
|
|
9
9
|
|
|
10
10
|
Reusable provider-neutral tool-loop agent configuration.
|
|
11
11
|
|
|
@@ -17,7 +17,7 @@ Reusable provider-neutral tool-loop agent configuration.
|
|
|
17
17
|
readonly optional activeToolNames?: readonly string[];
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: contracts/IIntelligenceAgentConfiguration.ts:20
|
|
20
|
+
Defined in: [contracts/IIntelligenceAgentConfiguration.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceAgentConfiguration.ts#L20)
|
|
21
21
|
|
|
22
22
|
***
|
|
23
23
|
|
|
@@ -27,7 +27,7 @@ Defined in: contracts/IIntelligenceAgentConfiguration.ts:20
|
|
|
27
27
|
readonly instructions: string;
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
Defined in: contracts/IIntelligenceAgentConfiguration.ts:17
|
|
30
|
+
Defined in: [contracts/IIntelligenceAgentConfiguration.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceAgentConfiguration.ts#L17)
|
|
31
31
|
|
|
32
32
|
***
|
|
33
33
|
|
|
@@ -37,7 +37,7 @@ Defined in: contracts/IIntelligenceAgentConfiguration.ts:17
|
|
|
37
37
|
readonly optional maxSteps?: number;
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
Defined in: contracts/IIntelligenceAgentConfiguration.ts:21
|
|
40
|
+
Defined in: [contracts/IIntelligenceAgentConfiguration.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceAgentConfiguration.ts#L21)
|
|
41
41
|
|
|
42
42
|
***
|
|
43
43
|
|
|
@@ -47,7 +47,7 @@ Defined in: contracts/IIntelligenceAgentConfiguration.ts:21
|
|
|
47
47
|
readonly optional model?: IIntelligenceModelReference;
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Defined in: contracts/IIntelligenceAgentConfiguration.ts:18
|
|
50
|
+
Defined in: [contracts/IIntelligenceAgentConfiguration.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceAgentConfiguration.ts#L18)
|
|
51
51
|
|
|
52
52
|
***
|
|
53
53
|
|
|
@@ -57,7 +57,7 @@ Defined in: contracts/IIntelligenceAgentConfiguration.ts:18
|
|
|
57
57
|
readonly optional name?: string;
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
Defined in: contracts/IIntelligenceAgentConfiguration.ts:16
|
|
60
|
+
Defined in: [contracts/IIntelligenceAgentConfiguration.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceAgentConfiguration.ts#L16)
|
|
61
61
|
|
|
62
62
|
***
|
|
63
63
|
|
|
@@ -67,4 +67,4 @@ Defined in: contracts/IIntelligenceAgentConfiguration.ts:16
|
|
|
67
67
|
readonly optional tools?: Readonly<Record<string, IIntelligenceToolDefinition<unknown, unknown>>>;
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
Defined in: contracts/IIntelligenceAgentConfiguration.ts:19
|
|
70
|
+
Defined in: [contracts/IIntelligenceAgentConfiguration.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceAgentConfiguration.ts#L19)
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchOptions.md
CHANGED
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceEmbeddingBatchOptions
|
|
7
7
|
|
|
8
|
-
Defined in: contracts/IIntelligenceEmbeddingBatchOptions.ts:12
|
|
8
|
+
Defined in: [contracts/IIntelligenceEmbeddingBatchOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchOptions.ts#L12)
|
|
9
9
|
|
|
10
10
|
Provider-neutral batch embedding options.
|
|
11
11
|
|
|
@@ -21,7 +21,7 @@ Provider-neutral batch embedding options.
|
|
|
21
21
|
readonly optional abortSignal?: AbortSignal;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: contracts/IIntelligenceRequestOptions.ts:16
|
|
24
|
+
Defined in: [contracts/IIntelligenceRequestOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L16)
|
|
25
25
|
|
|
26
26
|
Caller-driven cancellation signal.
|
|
27
27
|
|
|
@@ -37,7 +37,7 @@ Caller-driven cancellation signal.
|
|
|
37
37
|
readonly optional headers?: Readonly<Record<string, string>>;
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
Defined in: contracts/IIntelligenceRequestOptions.ts:19
|
|
40
|
+
Defined in: [contracts/IIntelligenceRequestOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L19)
|
|
41
41
|
|
|
42
42
|
Additional outbound request headers.
|
|
43
43
|
|
|
@@ -53,7 +53,7 @@ Additional outbound request headers.
|
|
|
53
53
|
readonly optional maxParallelCalls?: number;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: contracts/IIntelligenceEmbeddingBatchOptions.ts:17
|
|
56
|
+
Defined in: [contracts/IIntelligenceEmbeddingBatchOptions.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchOptions.ts#L17)
|
|
57
57
|
|
|
58
58
|
***
|
|
59
59
|
|
|
@@ -63,7 +63,7 @@ Defined in: contracts/IIntelligenceEmbeddingBatchOptions.ts:17
|
|
|
63
63
|
readonly optional maxRetries?: number;
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
Defined in: contracts/IIntelligenceEmbeddingBatchOptions.ts:16
|
|
66
|
+
Defined in: [contracts/IIntelligenceEmbeddingBatchOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchOptions.ts#L16)
|
|
67
67
|
|
|
68
68
|
***
|
|
69
69
|
|
|
@@ -73,7 +73,7 @@ Defined in: contracts/IIntelligenceEmbeddingBatchOptions.ts:16
|
|
|
73
73
|
readonly optional model?: IIntelligenceModelReference;
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
76
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
|
|
77
77
|
|
|
78
78
|
Optional provider/model override.
|
|
79
79
|
|
|
@@ -89,7 +89,7 @@ Optional provider/model override.
|
|
|
89
89
|
readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
|
|
90
90
|
```
|
|
91
91
|
|
|
92
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
92
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
|
|
93
93
|
|
|
94
94
|
Optional provider-specific settings.
|
|
95
95
|
|
|
@@ -99,13 +99,29 @@ Optional provider-specific settings.
|
|
|
99
99
|
|
|
100
100
|
***
|
|
101
101
|
|
|
102
|
+
### requestId?
|
|
103
|
+
|
|
104
|
+
```ts
|
|
105
|
+
readonly optional requestId?: string;
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
|
|
109
|
+
|
|
110
|
+
Correlation identifier included in structured Archipel logs.
|
|
111
|
+
|
|
112
|
+
#### Inherited from
|
|
113
|
+
|
|
114
|
+
[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`requestId`](Interface.IIntelligenceRequestOptions#requestid)
|
|
115
|
+
|
|
116
|
+
***
|
|
117
|
+
|
|
102
118
|
### timeoutMs?
|
|
103
119
|
|
|
104
120
|
```ts
|
|
105
121
|
readonly optional timeoutMs?: number;
|
|
106
122
|
```
|
|
107
123
|
|
|
108
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
124
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
|
|
109
125
|
|
|
110
126
|
Total provider-operation timeout in milliseconds.
|
|
111
127
|
|
|
@@ -121,4 +137,4 @@ Total provider-operation timeout in milliseconds.
|
|
|
121
137
|
readonly values: readonly string[];
|
|
122
138
|
```
|
|
123
139
|
|
|
124
|
-
Defined in: contracts/IIntelligenceEmbeddingBatchOptions.ts:15
|
|
140
|
+
Defined in: [contracts/IIntelligenceEmbeddingBatchOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchOptions.ts#L15)
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceEmbeddingBatchResult.md
CHANGED
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceEmbeddingBatchResult
|
|
7
7
|
|
|
8
|
-
Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:12
|
|
8
|
+
Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L12)
|
|
9
9
|
|
|
10
10
|
Provider-neutral batch embedding result.
|
|
11
11
|
|
|
@@ -17,7 +17,7 @@ Provider-neutral batch embedding result.
|
|
|
17
17
|
readonly embeddings: readonly readonly number[][];
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:16
|
|
20
|
+
Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L16)
|
|
21
21
|
|
|
22
22
|
***
|
|
23
23
|
|
|
@@ -27,7 +27,7 @@ Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:16
|
|
|
27
27
|
readonly model: string;
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:18
|
|
30
|
+
Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L18)
|
|
31
31
|
|
|
32
32
|
***
|
|
33
33
|
|
|
@@ -37,7 +37,7 @@ Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:18
|
|
|
37
37
|
readonly provider: string;
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:17
|
|
40
|
+
Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L17)
|
|
41
41
|
|
|
42
42
|
***
|
|
43
43
|
|
|
@@ -47,7 +47,7 @@ Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:17
|
|
|
47
47
|
readonly usage: IIntelligenceUsage | null;
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:20
|
|
50
|
+
Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L20)
|
|
51
51
|
|
|
52
52
|
***
|
|
53
53
|
|
|
@@ -57,7 +57,7 @@ Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:20
|
|
|
57
57
|
readonly values: readonly string[];
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:15
|
|
60
|
+
Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L15)
|
|
61
61
|
|
|
62
62
|
***
|
|
63
63
|
|
|
@@ -67,4 +67,4 @@ Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:15
|
|
|
67
67
|
readonly warnings: readonly string[];
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
Defined in: contracts/IIntelligenceEmbeddingBatchResult.ts:19
|
|
70
|
+
Defined in: [contracts/IIntelligenceEmbeddingBatchResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingBatchResult.ts#L19)
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceEmbeddingOptions
|
|
7
7
|
|
|
8
|
-
Defined in: contracts/IIntelligenceEmbeddingOptions.ts:12
|
|
8
|
+
Defined in: [contracts/IIntelligenceEmbeddingOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingOptions.ts#L12)
|
|
9
9
|
|
|
10
10
|
Provider-neutral single-value embedding options.
|
|
11
11
|
|
|
@@ -21,7 +21,7 @@ Provider-neutral single-value embedding options.
|
|
|
21
21
|
readonly optional abortSignal?: AbortSignal;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: contracts/IIntelligenceRequestOptions.ts:16
|
|
24
|
+
Defined in: [contracts/IIntelligenceRequestOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L16)
|
|
25
25
|
|
|
26
26
|
Caller-driven cancellation signal.
|
|
27
27
|
|
|
@@ -37,7 +37,7 @@ Caller-driven cancellation signal.
|
|
|
37
37
|
readonly optional headers?: Readonly<Record<string, string>>;
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
Defined in: contracts/IIntelligenceRequestOptions.ts:19
|
|
40
|
+
Defined in: [contracts/IIntelligenceRequestOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L19)
|
|
41
41
|
|
|
42
42
|
Additional outbound request headers.
|
|
43
43
|
|
|
@@ -53,7 +53,7 @@ Additional outbound request headers.
|
|
|
53
53
|
readonly optional maxRetries?: number;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: contracts/IIntelligenceEmbeddingOptions.ts:16
|
|
56
|
+
Defined in: [contracts/IIntelligenceEmbeddingOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingOptions.ts#L16)
|
|
57
57
|
|
|
58
58
|
***
|
|
59
59
|
|
|
@@ -63,7 +63,7 @@ Defined in: contracts/IIntelligenceEmbeddingOptions.ts:16
|
|
|
63
63
|
readonly optional model?: IIntelligenceModelReference;
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
66
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
|
|
67
67
|
|
|
68
68
|
Optional provider/model override.
|
|
69
69
|
|
|
@@ -79,7 +79,7 @@ Optional provider/model override.
|
|
|
79
79
|
readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
82
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
|
|
83
83
|
|
|
84
84
|
Optional provider-specific settings.
|
|
85
85
|
|
|
@@ -89,13 +89,29 @@ Optional provider-specific settings.
|
|
|
89
89
|
|
|
90
90
|
***
|
|
91
91
|
|
|
92
|
+
### requestId?
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
readonly optional requestId?: string;
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
|
|
99
|
+
|
|
100
|
+
Correlation identifier included in structured Archipel logs.
|
|
101
|
+
|
|
102
|
+
#### Inherited from
|
|
103
|
+
|
|
104
|
+
[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`requestId`](Interface.IIntelligenceRequestOptions#requestid)
|
|
105
|
+
|
|
106
|
+
***
|
|
107
|
+
|
|
92
108
|
### timeoutMs?
|
|
93
109
|
|
|
94
110
|
```ts
|
|
95
111
|
readonly optional timeoutMs?: number;
|
|
96
112
|
```
|
|
97
113
|
|
|
98
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
114
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
|
|
99
115
|
|
|
100
116
|
Total provider-operation timeout in milliseconds.
|
|
101
117
|
|
|
@@ -111,4 +127,4 @@ Total provider-operation timeout in milliseconds.
|
|
|
111
127
|
readonly value: string;
|
|
112
128
|
```
|
|
113
129
|
|
|
114
|
-
Defined in: contracts/IIntelligenceEmbeddingOptions.ts:15
|
|
130
|
+
Defined in: [contracts/IIntelligenceEmbeddingOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingOptions.ts#L15)
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceEmbeddingResult
|
|
7
7
|
|
|
8
|
-
Defined in: contracts/IIntelligenceEmbeddingResult.ts:12
|
|
8
|
+
Defined in: [contracts/IIntelligenceEmbeddingResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L12)
|
|
9
9
|
|
|
10
10
|
Provider-neutral embedding result.
|
|
11
11
|
|
|
@@ -17,7 +17,7 @@ Provider-neutral embedding result.
|
|
|
17
17
|
readonly embedding: readonly number[];
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: contracts/IIntelligenceEmbeddingResult.ts:16
|
|
20
|
+
Defined in: [contracts/IIntelligenceEmbeddingResult.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L16)
|
|
21
21
|
|
|
22
22
|
***
|
|
23
23
|
|
|
@@ -27,7 +27,7 @@ Defined in: contracts/IIntelligenceEmbeddingResult.ts:16
|
|
|
27
27
|
readonly model: string;
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
Defined in: contracts/IIntelligenceEmbeddingResult.ts:18
|
|
30
|
+
Defined in: [contracts/IIntelligenceEmbeddingResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L18)
|
|
31
31
|
|
|
32
32
|
***
|
|
33
33
|
|
|
@@ -37,7 +37,7 @@ Defined in: contracts/IIntelligenceEmbeddingResult.ts:18
|
|
|
37
37
|
readonly provider: string;
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
Defined in: contracts/IIntelligenceEmbeddingResult.ts:17
|
|
40
|
+
Defined in: [contracts/IIntelligenceEmbeddingResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L17)
|
|
41
41
|
|
|
42
42
|
***
|
|
43
43
|
|
|
@@ -47,7 +47,7 @@ Defined in: contracts/IIntelligenceEmbeddingResult.ts:17
|
|
|
47
47
|
readonly usage: IIntelligenceUsage | null;
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Defined in: contracts/IIntelligenceEmbeddingResult.ts:20
|
|
50
|
+
Defined in: [contracts/IIntelligenceEmbeddingResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L20)
|
|
51
51
|
|
|
52
52
|
***
|
|
53
53
|
|
|
@@ -57,7 +57,7 @@ Defined in: contracts/IIntelligenceEmbeddingResult.ts:20
|
|
|
57
57
|
readonly value: string;
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
Defined in: contracts/IIntelligenceEmbeddingResult.ts:15
|
|
60
|
+
Defined in: [contracts/IIntelligenceEmbeddingResult.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L15)
|
|
61
61
|
|
|
62
62
|
***
|
|
63
63
|
|
|
@@ -67,4 +67,4 @@ Defined in: contracts/IIntelligenceEmbeddingResult.ts:15
|
|
|
67
67
|
readonly warnings: readonly string[];
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
Defined in: contracts/IIntelligenceEmbeddingResult.ts:19
|
|
70
|
+
Defined in: [contracts/IIntelligenceEmbeddingResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceEmbeddingResult.ts#L19)
|