@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
package/data/packages/platform-intelligence/api/Interface.IIntelligenceRealtimeSessionOptions.md
CHANGED
|
@@ -17,7 +17,7 @@ Options used to create one server-owned realtime model connection.
|
|
|
17
17
|
readonly optional activeToolNames?: readonly string[];
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:
|
|
20
|
+
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L34)
|
|
21
21
|
|
|
22
22
|
Optional allow-list of registered Archipel tools exposed to this session.
|
|
23
23
|
|
|
@@ -29,7 +29,7 @@ Optional allow-list of registered Archipel tools exposed to this session.
|
|
|
29
29
|
readonly optional metadata?: Readonly<Record<string, IntelligenceRealtimeMetadataValue>>;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:
|
|
32
|
+
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L37)
|
|
33
33
|
|
|
34
34
|
Bounded, non-sensitive correlation metadata copied to metering events.
|
|
35
35
|
|
|
@@ -41,7 +41,7 @@ Bounded, non-sensitive correlation metadata copied to metering events.
|
|
|
41
41
|
readonly model: string;
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:
|
|
44
|
+
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L25)
|
|
45
45
|
|
|
46
46
|
Realtime model identifier such as `gpt-realtime`.
|
|
47
47
|
|
|
@@ -53,7 +53,7 @@ Realtime model identifier such as `gpt-realtime`.
|
|
|
53
53
|
readonly optional onClose?: (event) => void | Promise<void>;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:
|
|
56
|
+
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L46)
|
|
57
57
|
|
|
58
58
|
Receives the terminal upstream connection state.
|
|
59
59
|
|
|
@@ -75,7 +75,7 @@ Receives the terminal upstream connection state.
|
|
|
75
75
|
readonly optional onError?: (error) => void | Promise<void>;
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
-
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:
|
|
78
|
+
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L43)
|
|
79
79
|
|
|
80
80
|
Receives transport, provider, parsing, and metering adapter failures.
|
|
81
81
|
|
|
@@ -97,7 +97,7 @@ Receives transport, provider, parsing, and metering adapter failures.
|
|
|
97
97
|
readonly optional onEvent?: (event) => void | Promise<void>;
|
|
98
98
|
```
|
|
99
99
|
|
|
100
|
-
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:
|
|
100
|
+
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L40)
|
|
101
101
|
|
|
102
102
|
Receives normalized provider events in wire order.
|
|
103
103
|
|
|
@@ -119,19 +119,31 @@ Receives normalized provider events in wire order.
|
|
|
119
119
|
readonly optional provider?: string;
|
|
120
120
|
```
|
|
121
121
|
|
|
122
|
-
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:
|
|
122
|
+
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L28)
|
|
123
123
|
|
|
124
124
|
Optional provider override. Defaults to the configured intelligence provider.
|
|
125
125
|
|
|
126
126
|
***
|
|
127
127
|
|
|
128
|
+
### requestId?
|
|
129
|
+
|
|
130
|
+
```ts
|
|
131
|
+
readonly optional requestId?: string;
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L19)
|
|
135
|
+
|
|
136
|
+
Correlation identifier included in structured Archipel logs.
|
|
137
|
+
|
|
138
|
+
***
|
|
139
|
+
|
|
128
140
|
### sessionConfiguration?
|
|
129
141
|
|
|
130
142
|
```ts
|
|
131
143
|
readonly optional sessionConfiguration?: IIntelligenceRealtimeSessionConfiguration;
|
|
132
144
|
```
|
|
133
145
|
|
|
134
|
-
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:
|
|
146
|
+
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L31)
|
|
135
147
|
|
|
136
148
|
Provider-neutral realtime session configuration.
|
|
137
149
|
|
|
@@ -143,6 +155,6 @@ Provider-neutral realtime session configuration.
|
|
|
143
155
|
readonly sessionId: string;
|
|
144
156
|
```
|
|
145
157
|
|
|
146
|
-
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:
|
|
158
|
+
Defined in: [realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/interfaces/IIntelligenceRealtimeSessionOptions.ts#L22)
|
|
147
159
|
|
|
148
160
|
Application-owned identifier used for persistence, billing, and audit correlation.
|
|
@@ -5,22 +5,96 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceRealtimeUsage
|
|
7
7
|
|
|
8
|
-
Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:
|
|
8
|
+
Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L15)
|
|
9
9
|
|
|
10
10
|
Normalized token usage reported by a realtime provider.
|
|
11
11
|
|
|
12
12
|
Null values mean the provider did not expose that dimension. Applications
|
|
13
13
|
can therefore distinguish missing data from an actual zero-token count.
|
|
14
14
|
|
|
15
|
+
## Extends
|
|
16
|
+
|
|
17
|
+
- [`IIntelligenceUsage`](Interface.IIntelligenceUsage)
|
|
18
|
+
|
|
15
19
|
## Properties
|
|
16
20
|
|
|
21
|
+
### cachedInputAudioTokens
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
readonly cachedInputAudioTokens: number | null;
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Defined in: [contracts/IIntelligenceUsage.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L27)
|
|
28
|
+
|
|
29
|
+
Cached input tokens attributed to audio.
|
|
30
|
+
|
|
31
|
+
#### Inherited from
|
|
32
|
+
|
|
33
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`cachedInputAudioTokens`](Interface.IIntelligenceUsage#cachedinputaudiotokens)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### cachedInputImageTokens
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
readonly cachedInputImageTokens: number | null;
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Defined in: [contracts/IIntelligenceUsage.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L25)
|
|
44
|
+
|
|
45
|
+
Cached input tokens attributed to images.
|
|
46
|
+
|
|
47
|
+
#### Inherited from
|
|
48
|
+
|
|
49
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`cachedInputImageTokens`](Interface.IIntelligenceUsage#cachedinputimagetokens)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### cachedInputTextTokens
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
readonly cachedInputTextTokens: number | null;
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Defined in: [contracts/IIntelligenceUsage.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L23)
|
|
60
|
+
|
|
61
|
+
Cached input tokens attributed to text.
|
|
62
|
+
|
|
63
|
+
#### Inherited from
|
|
64
|
+
|
|
65
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`cachedInputTextTokens`](Interface.IIntelligenceUsage#cachedinputtexttokens)
|
|
66
|
+
|
|
67
|
+
***
|
|
68
|
+
|
|
17
69
|
### cachedInputTokens
|
|
18
70
|
|
|
19
71
|
```ts
|
|
20
72
|
readonly cachedInputTokens: number | null;
|
|
21
73
|
```
|
|
22
74
|
|
|
23
|
-
Defined in: [
|
|
75
|
+
Defined in: [contracts/IIntelligenceUsage.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L19)
|
|
76
|
+
|
|
77
|
+
Input tokens read from a provider cache.
|
|
78
|
+
|
|
79
|
+
#### Inherited from
|
|
80
|
+
|
|
81
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`cachedInputTokens`](Interface.IIntelligenceUsage#cachedinputtokens)
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
85
|
+
### cacheWriteInputTokens
|
|
86
|
+
|
|
87
|
+
```ts
|
|
88
|
+
readonly cacheWriteInputTokens: number | null;
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Defined in: [contracts/IIntelligenceUsage.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L21)
|
|
92
|
+
|
|
93
|
+
Input tokens written to a provider cache.
|
|
94
|
+
|
|
95
|
+
#### Inherited from
|
|
96
|
+
|
|
97
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`cacheWriteInputTokens`](Interface.IIntelligenceUsage#cachewriteinputtokens)
|
|
24
98
|
|
|
25
99
|
***
|
|
26
100
|
|
|
@@ -30,7 +104,29 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:15](https://github
|
|
|
30
104
|
readonly inputAudioTokens: number | null;
|
|
31
105
|
```
|
|
32
106
|
|
|
33
|
-
Defined in: [
|
|
107
|
+
Defined in: [contracts/IIntelligenceUsage.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L33)
|
|
108
|
+
|
|
109
|
+
Input tokens attributed to audio.
|
|
110
|
+
|
|
111
|
+
#### Inherited from
|
|
112
|
+
|
|
113
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`inputAudioTokens`](Interface.IIntelligenceUsage#inputaudiotokens)
|
|
114
|
+
|
|
115
|
+
***
|
|
116
|
+
|
|
117
|
+
### inputImageTokens
|
|
118
|
+
|
|
119
|
+
```ts
|
|
120
|
+
readonly inputImageTokens: number | null;
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
Defined in: [contracts/IIntelligenceUsage.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L31)
|
|
124
|
+
|
|
125
|
+
Input tokens attributed to images.
|
|
126
|
+
|
|
127
|
+
#### Inherited from
|
|
128
|
+
|
|
129
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`inputImageTokens`](Interface.IIntelligenceUsage#inputimagetokens)
|
|
34
130
|
|
|
35
131
|
***
|
|
36
132
|
|
|
@@ -40,7 +136,13 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:17](https://github
|
|
|
40
136
|
readonly inputTextTokens: number | null;
|
|
41
137
|
```
|
|
42
138
|
|
|
43
|
-
Defined in: [
|
|
139
|
+
Defined in: [contracts/IIntelligenceUsage.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L29)
|
|
140
|
+
|
|
141
|
+
Input tokens attributed to text.
|
|
142
|
+
|
|
143
|
+
#### Inherited from
|
|
144
|
+
|
|
145
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`inputTextTokens`](Interface.IIntelligenceUsage#inputtexttokens)
|
|
44
146
|
|
|
45
147
|
***
|
|
46
148
|
|
|
@@ -50,7 +152,13 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:16](https://github
|
|
|
50
152
|
readonly inputTokens: number | null;
|
|
51
153
|
```
|
|
52
154
|
|
|
53
|
-
Defined in: [
|
|
155
|
+
Defined in: [contracts/IIntelligenceUsage.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L13)
|
|
156
|
+
|
|
157
|
+
All uncached and cached input tokens reported for the operation.
|
|
158
|
+
|
|
159
|
+
#### Inherited from
|
|
160
|
+
|
|
161
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`inputTokens`](Interface.IIntelligenceUsage#inputtokens)
|
|
54
162
|
|
|
55
163
|
***
|
|
56
164
|
|
|
@@ -60,7 +168,29 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:12](https://github
|
|
|
60
168
|
readonly outputAudioTokens: number | null;
|
|
61
169
|
```
|
|
62
170
|
|
|
63
|
-
Defined in: [
|
|
171
|
+
Defined in: [contracts/IIntelligenceUsage.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L39)
|
|
172
|
+
|
|
173
|
+
Output tokens attributed to generated audio.
|
|
174
|
+
|
|
175
|
+
#### Inherited from
|
|
176
|
+
|
|
177
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`outputAudioTokens`](Interface.IIntelligenceUsage#outputaudiotokens)
|
|
178
|
+
|
|
179
|
+
***
|
|
180
|
+
|
|
181
|
+
### outputImageTokens
|
|
182
|
+
|
|
183
|
+
```ts
|
|
184
|
+
readonly outputImageTokens: number | null;
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
Defined in: [contracts/IIntelligenceUsage.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L37)
|
|
188
|
+
|
|
189
|
+
Output tokens attributed to generated images.
|
|
190
|
+
|
|
191
|
+
#### Inherited from
|
|
192
|
+
|
|
193
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`outputImageTokens`](Interface.IIntelligenceUsage#outputimagetokens)
|
|
64
194
|
|
|
65
195
|
***
|
|
66
196
|
|
|
@@ -70,7 +200,13 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:19](https://github
|
|
|
70
200
|
readonly outputTextTokens: number | null;
|
|
71
201
|
```
|
|
72
202
|
|
|
73
|
-
Defined in: [
|
|
203
|
+
Defined in: [contracts/IIntelligenceUsage.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L35)
|
|
204
|
+
|
|
205
|
+
Output tokens attributed to text, including reasoning when the provider does so.
|
|
206
|
+
|
|
207
|
+
#### Inherited from
|
|
208
|
+
|
|
209
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`outputTextTokens`](Interface.IIntelligenceUsage#outputtexttokens)
|
|
74
210
|
|
|
75
211
|
***
|
|
76
212
|
|
|
@@ -80,7 +216,13 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:18](https://github
|
|
|
80
216
|
readonly outputTokens: number | null;
|
|
81
217
|
```
|
|
82
218
|
|
|
83
|
-
Defined in: [
|
|
219
|
+
Defined in: [contracts/IIntelligenceUsage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L15)
|
|
220
|
+
|
|
221
|
+
All output tokens, including any reasoning tokens, reported for the operation.
|
|
222
|
+
|
|
223
|
+
#### Inherited from
|
|
224
|
+
|
|
225
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`outputTokens`](Interface.IIntelligenceUsage#outputtokens)
|
|
84
226
|
|
|
85
227
|
***
|
|
86
228
|
|
|
@@ -90,7 +232,23 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:13](https://github
|
|
|
90
232
|
readonly rawUsage: unknown;
|
|
91
233
|
```
|
|
92
234
|
|
|
93
|
-
Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:
|
|
235
|
+
Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/realtime/contracts/IIntelligenceRealtimeUsage.ts#L18)
|
|
236
|
+
|
|
237
|
+
***
|
|
238
|
+
|
|
239
|
+
### reasoningTokens
|
|
240
|
+
|
|
241
|
+
```ts
|
|
242
|
+
readonly reasoningTokens: number | null;
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
Defined in: [contracts/IIntelligenceUsage.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L41)
|
|
246
|
+
|
|
247
|
+
Reasoning tokens included in the provider's output total.
|
|
248
|
+
|
|
249
|
+
#### Inherited from
|
|
250
|
+
|
|
251
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`reasoningTokens`](Interface.IIntelligenceUsage#reasoningtokens)
|
|
94
252
|
|
|
95
253
|
***
|
|
96
254
|
|
|
@@ -100,4 +258,10 @@ Defined in: [realtime/contracts/IIntelligenceRealtimeUsage.ts:20](https://github
|
|
|
100
258
|
readonly totalTokens: number | null;
|
|
101
259
|
```
|
|
102
260
|
|
|
103
|
-
Defined in: [
|
|
261
|
+
Defined in: [contracts/IIntelligenceUsage.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceUsage.ts#L17)
|
|
262
|
+
|
|
263
|
+
Provider-reported total input and output tokens.
|
|
264
|
+
|
|
265
|
+
#### Inherited from
|
|
266
|
+
|
|
267
|
+
[`IIntelligenceUsage`](Interface.IIntelligenceUsage).[`totalTokens`](Interface.IIntelligenceUsage#totaltokens)
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceRequestOptions
|
|
7
7
|
|
|
8
|
-
Defined in: contracts/IIntelligenceRequestOptions.ts:12
|
|
8
|
+
Defined in: [contracts/IIntelligenceRequestOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L12)
|
|
9
9
|
|
|
10
10
|
Shared execution controls for bounded intelligence requests.
|
|
11
11
|
|
|
@@ -33,7 +33,7 @@ Shared execution controls for bounded intelligence requests.
|
|
|
33
33
|
readonly optional abortSignal?: AbortSignal;
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
Defined in: contracts/IIntelligenceRequestOptions.ts:16
|
|
36
|
+
Defined in: [contracts/IIntelligenceRequestOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L16)
|
|
37
37
|
|
|
38
38
|
Caller-driven cancellation signal.
|
|
39
39
|
|
|
@@ -45,7 +45,7 @@ Caller-driven cancellation signal.
|
|
|
45
45
|
readonly optional headers?: Readonly<Record<string, string>>;
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
Defined in: contracts/IIntelligenceRequestOptions.ts:19
|
|
48
|
+
Defined in: [contracts/IIntelligenceRequestOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L19)
|
|
49
49
|
|
|
50
50
|
Additional outbound request headers.
|
|
51
51
|
|
|
@@ -57,7 +57,7 @@ Additional outbound request headers.
|
|
|
57
57
|
readonly optional model?: IIntelligenceModelReference;
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
60
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
|
|
61
61
|
|
|
62
62
|
Optional provider/model override.
|
|
63
63
|
|
|
@@ -73,7 +73,7 @@ Optional provider/model override.
|
|
|
73
73
|
readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
76
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
|
|
77
77
|
|
|
78
78
|
Optional provider-specific settings.
|
|
79
79
|
|
|
@@ -83,13 +83,29 @@ Optional provider-specific settings.
|
|
|
83
83
|
|
|
84
84
|
***
|
|
85
85
|
|
|
86
|
+
### requestId?
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
readonly optional requestId?: string;
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
|
|
93
|
+
|
|
94
|
+
Correlation identifier included in structured Archipel logs.
|
|
95
|
+
|
|
96
|
+
#### Inherited from
|
|
97
|
+
|
|
98
|
+
[`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`requestId`](Interface.IIntelligenceModelRequestOptions#requestid)
|
|
99
|
+
|
|
100
|
+
***
|
|
101
|
+
|
|
86
102
|
### timeoutMs?
|
|
87
103
|
|
|
88
104
|
```ts
|
|
89
105
|
readonly optional timeoutMs?: number;
|
|
90
106
|
```
|
|
91
107
|
|
|
92
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
108
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
|
|
93
109
|
|
|
94
110
|
Total provider-operation timeout in milliseconds.
|
|
95
111
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceRerankingOptions\<TDocument\>
|
|
7
7
|
|
|
8
|
-
Defined in: contracts/IIntelligenceRerankingOptions.ts:13
|
|
8
|
+
Defined in: [contracts/IIntelligenceRerankingOptions.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingOptions.ts#L13)
|
|
9
9
|
|
|
10
10
|
Provider-neutral reranking options.
|
|
11
11
|
|
|
@@ -27,7 +27,7 @@ Provider-neutral reranking options.
|
|
|
27
27
|
readonly optional abortSignal?: AbortSignal;
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
Defined in: contracts/IIntelligenceRequestOptions.ts:16
|
|
30
|
+
Defined in: [contracts/IIntelligenceRequestOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L16)
|
|
31
31
|
|
|
32
32
|
Caller-driven cancellation signal.
|
|
33
33
|
|
|
@@ -43,7 +43,7 @@ Caller-driven cancellation signal.
|
|
|
43
43
|
readonly documents: readonly TDocument[];
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
Defined in: contracts/IIntelligenceRerankingOptions.ts:19
|
|
46
|
+
Defined in: [contracts/IIntelligenceRerankingOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingOptions.ts#L19)
|
|
47
47
|
|
|
48
48
|
***
|
|
49
49
|
|
|
@@ -53,7 +53,7 @@ Defined in: contracts/IIntelligenceRerankingOptions.ts:19
|
|
|
53
53
|
readonly optional headers?: Readonly<Record<string, string>>;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: contracts/IIntelligenceRequestOptions.ts:19
|
|
56
|
+
Defined in: [contracts/IIntelligenceRequestOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRequestOptions.ts#L19)
|
|
57
57
|
|
|
58
58
|
Additional outbound request headers.
|
|
59
59
|
|
|
@@ -69,7 +69,7 @@ Additional outbound request headers.
|
|
|
69
69
|
readonly optional maxRetries?: number;
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
Defined in: contracts/IIntelligenceRerankingOptions.ts:20
|
|
72
|
+
Defined in: [contracts/IIntelligenceRerankingOptions.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingOptions.ts#L20)
|
|
73
73
|
|
|
74
74
|
***
|
|
75
75
|
|
|
@@ -79,7 +79,7 @@ Defined in: contracts/IIntelligenceRerankingOptions.ts:20
|
|
|
79
79
|
readonly optional model?: IIntelligenceModelReference;
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
82
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
|
|
83
83
|
|
|
84
84
|
Optional provider/model override.
|
|
85
85
|
|
|
@@ -95,7 +95,7 @@ Optional provider/model override.
|
|
|
95
95
|
readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
|
|
96
96
|
```
|
|
97
97
|
|
|
98
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
98
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
|
|
99
99
|
|
|
100
100
|
Optional provider-specific settings.
|
|
101
101
|
|
|
@@ -111,7 +111,23 @@ Optional provider-specific settings.
|
|
|
111
111
|
readonly query: string;
|
|
112
112
|
```
|
|
113
113
|
|
|
114
|
-
Defined in: contracts/IIntelligenceRerankingOptions.ts:18
|
|
114
|
+
Defined in: [contracts/IIntelligenceRerankingOptions.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingOptions.ts#L18)
|
|
115
|
+
|
|
116
|
+
***
|
|
117
|
+
|
|
118
|
+
### requestId?
|
|
119
|
+
|
|
120
|
+
```ts
|
|
121
|
+
readonly optional requestId?: string;
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
|
|
125
|
+
|
|
126
|
+
Correlation identifier included in structured Archipel logs.
|
|
127
|
+
|
|
128
|
+
#### Inherited from
|
|
129
|
+
|
|
130
|
+
[`IIntelligenceRequestOptions`](Interface.IIntelligenceRequestOptions).[`requestId`](Interface.IIntelligenceRequestOptions#requestid)
|
|
115
131
|
|
|
116
132
|
***
|
|
117
133
|
|
|
@@ -121,7 +137,7 @@ Defined in: contracts/IIntelligenceRerankingOptions.ts:18
|
|
|
121
137
|
readonly optional timeoutMs?: number;
|
|
122
138
|
```
|
|
123
139
|
|
|
124
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
140
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
|
|
125
141
|
|
|
126
142
|
Total provider-operation timeout in milliseconds.
|
|
127
143
|
|
|
@@ -137,4 +153,4 @@ Total provider-operation timeout in milliseconds.
|
|
|
137
153
|
readonly optional topN?: number;
|
|
138
154
|
```
|
|
139
155
|
|
|
140
|
-
Defined in: contracts/IIntelligenceRerankingOptions.ts:21
|
|
156
|
+
Defined in: [contracts/IIntelligenceRerankingOptions.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingOptions.ts#L21)
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceRerankingResult\<TDocument\>
|
|
7
7
|
|
|
8
|
-
Defined in: contracts/IIntelligenceRerankingResult.ts:12
|
|
8
|
+
Defined in: [contracts/IIntelligenceRerankingResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingResult.ts#L12)
|
|
9
9
|
|
|
10
10
|
Provider-neutral reranking result.
|
|
11
11
|
|
|
@@ -23,7 +23,7 @@ Provider-neutral reranking result.
|
|
|
23
23
|
readonly model: string;
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Defined in: contracts/IIntelligenceRerankingResult.ts:21
|
|
26
|
+
Defined in: [contracts/IIntelligenceRerankingResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingResult.ts#L21)
|
|
27
27
|
|
|
28
28
|
***
|
|
29
29
|
|
|
@@ -33,7 +33,7 @@ Defined in: contracts/IIntelligenceRerankingResult.ts:21
|
|
|
33
33
|
readonly provider: string;
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
Defined in: contracts/IIntelligenceRerankingResult.ts:20
|
|
36
|
+
Defined in: [contracts/IIntelligenceRerankingResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingResult.ts#L20)
|
|
37
37
|
|
|
38
38
|
***
|
|
39
39
|
|
|
@@ -47,4 +47,4 @@ readonly ranking: readonly {
|
|
|
47
47
|
}[];
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Defined in: contracts/IIntelligenceRerankingResult.ts:15
|
|
50
|
+
Defined in: [contracts/IIntelligenceRerankingResult.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceRerankingResult.ts#L15)
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceSkillUploadOptions.md
CHANGED
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IIntelligenceSkillUploadOptions
|
|
7
7
|
|
|
8
|
-
Defined in: contracts/IIntelligenceSkillUploadOptions.ts:12
|
|
8
|
+
Defined in: [contracts/IIntelligenceSkillUploadOptions.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceSkillUploadOptions.ts#L12)
|
|
9
9
|
|
|
10
10
|
Provider-neutral skill bundle upload options.
|
|
11
11
|
|
|
@@ -21,7 +21,7 @@ Provider-neutral skill bundle upload options.
|
|
|
21
21
|
readonly optional displayTitle?: string;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: contracts/IIntelligenceSkillUploadOptions.ts:19
|
|
24
|
+
Defined in: [contracts/IIntelligenceSkillUploadOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceSkillUploadOptions.ts#L19)
|
|
25
25
|
|
|
26
26
|
***
|
|
27
27
|
|
|
@@ -43,7 +43,7 @@ readonly files: readonly {
|
|
|
43
43
|
}[];
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
Defined in: contracts/IIntelligenceSkillUploadOptions.ts:15
|
|
46
|
+
Defined in: [contracts/IIntelligenceSkillUploadOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceSkillUploadOptions.ts#L15)
|
|
47
47
|
|
|
48
48
|
***
|
|
49
49
|
|
|
@@ -53,7 +53,7 @@ Defined in: contracts/IIntelligenceSkillUploadOptions.ts:15
|
|
|
53
53
|
readonly optional model?: IIntelligenceModelReference;
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
56
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L24)
|
|
57
57
|
|
|
58
58
|
Optional provider/model override.
|
|
59
59
|
|
|
@@ -69,7 +69,7 @@ Optional provider/model override.
|
|
|
69
69
|
readonly optional providerOptions?: Readonly<Record<string, Readonly<Record<string, IntelligenceJsonValue>>>>;
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
72
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L33)
|
|
73
73
|
|
|
74
74
|
Optional provider-specific settings.
|
|
75
75
|
|
|
@@ -79,13 +79,29 @@ Optional provider-specific settings.
|
|
|
79
79
|
|
|
80
80
|
***
|
|
81
81
|
|
|
82
|
+
### requestId?
|
|
83
|
+
|
|
84
|
+
```ts
|
|
85
|
+
readonly optional requestId?: string;
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L27)
|
|
89
|
+
|
|
90
|
+
Correlation identifier included in structured Archipel logs.
|
|
91
|
+
|
|
92
|
+
#### Inherited from
|
|
93
|
+
|
|
94
|
+
[`IIntelligenceModelRequestOptions`](Interface.IIntelligenceModelRequestOptions).[`requestId`](Interface.IIntelligenceModelRequestOptions#requestid)
|
|
95
|
+
|
|
96
|
+
***
|
|
97
|
+
|
|
82
98
|
### timeoutMs?
|
|
83
99
|
|
|
84
100
|
```ts
|
|
85
101
|
readonly optional timeoutMs?: number;
|
|
86
102
|
```
|
|
87
103
|
|
|
88
|
-
Defined in: contracts/IIntelligenceModelRequestOptions.ts:
|
|
104
|
+
Defined in: [contracts/IIntelligenceModelRequestOptions.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceModelRequestOptions.ts#L30)
|
|
89
105
|
|
|
90
106
|
Total provider-operation timeout in milliseconds.
|
|
91
107
|
|