@breadstone/archipel-mcp 0.0.7 → 0.0.8
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/packages/index.md +13 -6
- package/data/packages/platform-authentication/api/Class.AppleStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -3
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +9 -9
- package/data/packages/{platform-core → platform-caching}/api/Class.MemoryLayeredCache.md +41 -33
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +158 -0
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +296 -0
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +122 -0
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +71 -0
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +199 -0
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +76 -0
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +122 -0
- package/data/packages/platform-caching/api/index.md +25 -0
- package/data/packages/platform-caching/index.md +116 -0
- package/data/packages/platform-core/api/index.md +104 -150
- package/data/packages/platform-core/index.md +5 -3
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +73 -0
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +52 -0
- package/data/packages/{platform-core → platform-cryptography}/api/Class.OtpService.md +8 -4
- package/data/packages/{platform-core → platform-cryptography}/api/Interface.IOtpService.md +8 -4
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +47 -0
- package/data/packages/{platform-core → platform-cryptography}/api/Variable.OTP_SERVICE_TOKEN.md +1 -1
- package/data/packages/{platform-core → platform-cryptography}/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
- package/data/packages/platform-cryptography/api/index.md +29 -0
- package/data/packages/platform-cryptography/index.md +132 -0
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistrarBase.md +7 -5
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistry.md +19 -15
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceModule.md +1 -1
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceTextGenerator.md +7 -7
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +32 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +72 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +79 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +73 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +36 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +59 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +95 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +61 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +54 -0
- package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +25 -0
- package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceProviderName.md +1 -1
- package/data/packages/{platform-core → platform-intelligence}/api/Variable.IntelligenceConversationMessageRoles.md +6 -6
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +29 -0
- package/data/packages/platform-intelligence/api/index.md +70 -0
- package/data/packages/platform-intelligence/index.md +131 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +15 -15
- package/package.json +1 -1
- package/data/packages/platform-core/api/Class.BcryptService.md +0 -69
- package/data/packages/platform-core/api/Class.CryptoService.md +0 -50
- package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +0 -157
- package/data/packages/platform-core/api/Class.RedisLayeredCache.md +0 -275
- package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +0 -121
- package/data/packages/platform-core/api/Interface.ICacheStats.md +0 -71
- package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +0 -62
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +0 -69
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +0 -63
- package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +0 -32
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +0 -51
- package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +0 -81
- package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +0 -53
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +0 -46
- package/data/packages/platform-core/api/Interface.ILayeredCache.md +0 -194
- package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +0 -71
- package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +0 -47
- package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +0 -108
- package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +0 -29
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceIntent'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceIntent
|
|
8
|
+
|
|
9
|
+
Defined in: [contracts/IIntelligenceIntent.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntent.ts#L12)
|
|
10
|
+
|
|
11
|
+
Represents the structured intent resolved from a user message.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### confidence
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
readonly confidence: number;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [contracts/IIntelligenceIntent.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntent.ts#L28)
|
|
22
|
+
|
|
23
|
+
The confidence score of the intent resolution (0–1).
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### entities
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
readonly entities: readonly IIntelligenceIntentEntity[];
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [contracts/IIntelligenceIntent.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntent.ts#L35)
|
|
34
|
+
|
|
35
|
+
Named entities extracted from the user message.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
### name
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
readonly name: string;
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Defined in: [contracts/IIntelligenceIntent.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntent.ts#L21)
|
|
46
|
+
|
|
47
|
+
The canonical name of the intent.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceIntentEntity'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceIntentEntity
|
|
8
|
+
|
|
9
|
+
Defined in: [contracts/IIntelligenceIntentEntity.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntentEntity.ts#L6)
|
|
10
|
+
|
|
11
|
+
Represents an entity extracted from a resolved intelligence intent.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### name
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
readonly name: string;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [contracts/IIntelligenceIntentEntity.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntentEntity.ts#L15)
|
|
22
|
+
|
|
23
|
+
The name of the extracted entity.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### value
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
readonly value: string;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [contracts/IIntelligenceIntentEntity.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntentEntity.ts#L22)
|
|
34
|
+
|
|
35
|
+
The resolved value of the entity.
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceMessageModel'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceMessageModel
|
|
8
|
+
|
|
9
|
+
Defined in: [contracts/IIntelligenceMessageModel.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L12)
|
|
10
|
+
|
|
11
|
+
Represents a normalized message stored in persistence.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### content
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
readonly content: string;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [contracts/IIntelligenceMessageModel.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L35)
|
|
22
|
+
|
|
23
|
+
The textual content of the message.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### createdAt
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
readonly createdAt: Date;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [contracts/IIntelligenceMessageModel.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L42)
|
|
34
|
+
|
|
35
|
+
The timestamp when the message was created.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
### id
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
readonly id: string;
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Defined in: [contracts/IIntelligenceMessageModel.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L21)
|
|
46
|
+
|
|
47
|
+
Unique identifier of the persisted message.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### metadata?
|
|
52
|
+
|
|
53
|
+
```ts
|
|
54
|
+
readonly optional metadata?: unknown;
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Defined in: [contracts/IIntelligenceMessageModel.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L49)
|
|
58
|
+
|
|
59
|
+
Optional metadata attached to the message.
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
### role
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
readonly role: IntelligenceConversationMessageRole;
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Defined in: [contracts/IIntelligenceMessageModel.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L28)
|
|
70
|
+
|
|
71
|
+
The role of the message author.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceMessagePayload'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceMessagePayload
|
|
8
|
+
|
|
9
|
+
Defined in: [contracts/IIntelligenceMessagePayload.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessagePayload.ts#L6)
|
|
10
|
+
|
|
11
|
+
Carries the payload submitted when messaging the intelligence entrypoint.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### conversationId
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
readonly conversationId: string | null;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [contracts/IIntelligenceMessagePayload.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessagePayload.ts#L15)
|
|
22
|
+
|
|
23
|
+
The conversation identifier, or `null` to start a new conversation.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### message
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
readonly message: string;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [contracts/IIntelligenceMessagePayload.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessagePayload.ts#L22)
|
|
34
|
+
|
|
35
|
+
The user message to process.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligencePrompt'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligencePrompt
|
|
8
|
+
|
|
9
|
+
Defined in: [contracts/IIntelligencePrompt.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L12)
|
|
10
|
+
|
|
11
|
+
Represents the input supplied to the intelligence text generator.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### messages
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
readonly messages: readonly IIntelligencePromptMessage[];
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [contracts/IIntelligencePrompt.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L28)
|
|
22
|
+
|
|
23
|
+
The ordered list of messages forming the prompt.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### systemPrompt
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
readonly systemPrompt: string | null;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [contracts/IIntelligencePrompt.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L21)
|
|
34
|
+
|
|
35
|
+
The optional system-level prompt prepended to the conversation.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligencePromptMessage'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligencePromptMessage
|
|
8
|
+
|
|
9
|
+
Defined in: [contracts/IIntelligencePromptMessage.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePromptMessage.ts#L12)
|
|
10
|
+
|
|
11
|
+
Describes a normalized message used for text generation prompts.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### content
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
readonly content: string;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [contracts/IIntelligencePromptMessage.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePromptMessage.ts#L28)
|
|
22
|
+
|
|
23
|
+
The textual content of the message.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### role
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
readonly role: IntelligenceConversationMessageRole;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [contracts/IIntelligencePromptMessage.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePromptMessage.ts#L21)
|
|
34
|
+
|
|
35
|
+
The role of the message author.
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceProviderConfiguration'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceProviderConfiguration
|
|
8
|
+
|
|
9
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L12)
|
|
10
|
+
|
|
11
|
+
Describes the resolved configuration for the intelligence provider.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### apiKey
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
readonly apiKey: string;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L35)
|
|
22
|
+
|
|
23
|
+
The API key used to authenticate with the provider.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### baseUrl
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
readonly baseUrl: string | null;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L42)
|
|
34
|
+
|
|
35
|
+
An optional base URL override for the provider API.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
### maxOutputTokens
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
readonly maxOutputTokens: number;
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L63)
|
|
46
|
+
|
|
47
|
+
The maximum number of output tokens per completion.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### model
|
|
52
|
+
|
|
53
|
+
```ts
|
|
54
|
+
readonly model: string;
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L28)
|
|
58
|
+
|
|
59
|
+
The model identifier to use for text generation.
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
### provider
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
readonly provider: IntelligenceProviderName;
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L21)
|
|
70
|
+
|
|
71
|
+
The resolved provider identifier.
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
### temperature
|
|
76
|
+
|
|
77
|
+
```ts
|
|
78
|
+
readonly temperature: number;
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L49)
|
|
82
|
+
|
|
83
|
+
The sampling temperature used for text generation.
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
### topP
|
|
88
|
+
|
|
89
|
+
```ts
|
|
90
|
+
readonly topP: number;
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
Defined in: [contracts/IIntelligenceProviderConfiguration.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceProviderConfiguration.ts#L56)
|
|
94
|
+
|
|
95
|
+
The top-p (nucleus) sampling parameter.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceResponseMessage'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceResponseMessage
|
|
8
|
+
|
|
9
|
+
Defined in: [contracts/IIntelligenceResponseMessage.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceResponseMessage.ts#L6)
|
|
10
|
+
|
|
11
|
+
Represents a single assistant message returned by a capability.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### content
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
readonly content: string;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [contracts/IIntelligenceResponseMessage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceResponseMessage.ts#L15)
|
|
22
|
+
|
|
23
|
+
The textual content of the assistant response.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### metadata?
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
readonly optional metadata?: Record<string, unknown>;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [contracts/IIntelligenceResponseMessage.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceResponseMessage.ts#L22)
|
|
34
|
+
|
|
35
|
+
Optional metadata attached to the response message.
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceTextCompletion'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceTextCompletion
|
|
8
|
+
|
|
9
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L13)
|
|
10
|
+
|
|
11
|
+
Represents the normalized completion result produced by the intelligence provider.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### model
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
readonly model: string;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L36)
|
|
22
|
+
|
|
23
|
+
The model identifier used for the completion.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### provider
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
readonly provider: IntelligenceProviderName;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L29)
|
|
34
|
+
|
|
35
|
+
The provider that produced the completion.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
### text
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
readonly text: string;
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L22)
|
|
46
|
+
|
|
47
|
+
The generated text content.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### usage
|
|
52
|
+
|
|
53
|
+
```ts
|
|
54
|
+
readonly usage:
|
|
55
|
+
| IIntelligenceCompletionUsage
|
|
56
|
+
| null;
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Defined in: [contracts/IIntelligenceTextCompletion.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextCompletion.ts#L43)
|
|
60
|
+
|
|
61
|
+
Token usage telemetry, or `null` when the provider does not report usage.
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceTextGenerationOptions'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceTextGenerationOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L6)
|
|
10
|
+
|
|
11
|
+
Options that can be supplied when generating text with the intelligence provider.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### maxOutputTokens?
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
readonly optional maxOutputTokens?: number;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L29)
|
|
22
|
+
|
|
23
|
+
Optional maximum output tokens override.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### temperature?
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
readonly optional temperature?: number;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L15)
|
|
34
|
+
|
|
35
|
+
Optional sampling temperature override.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
### topP?
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
readonly optional topP?: number;
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Defined in: [contracts/IIntelligenceTextGenerationOptions.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceTextGenerationOptions.ts#L22)
|
|
46
|
+
|
|
47
|
+
Optional top-p (nucleus) sampling override.
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceTextGenerator'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceTextGenerator
|
|
8
|
+
|
|
9
|
+
Defined in: [interfaces/IIntelligenceTextGenerator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L15)
|
|
10
|
+
|
|
11
|
+
Abstraction responsible for executing text completions using the configured provider.
|
|
12
|
+
|
|
13
|
+
## Methods
|
|
14
|
+
|
|
15
|
+
### generateText()
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [interfaces/IIntelligenceTextGenerator.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L27)
|
|
22
|
+
|
|
23
|
+
Generates a text completion using the configured intelligence provider.
|
|
24
|
+
|
|
25
|
+
#### Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type | Description |
|
|
28
|
+
| ---------- | ------------------------------------------------------------------------------------ | --------------------------------------------------- |
|
|
29
|
+
| `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) | The assembled prompt payload. |
|
|
30
|
+
| `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) | Optional overrides for the text generation request. |
|
|
31
|
+
|
|
32
|
+
#### Returns
|
|
33
|
+
|
|
34
|
+
`Promise`\<[`IIntelligenceTextCompletion`](Interface.IIntelligenceTextCompletion)\>
|
|
35
|
+
|
|
36
|
+
The normalized text completion result.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
### getConfiguration()
|
|
41
|
+
|
|
42
|
+
```ts
|
|
43
|
+
getConfiguration(): IIntelligenceProviderConfiguration;
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Defined in: [interfaces/IIntelligenceTextGenerator.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceTextGenerator.ts#L35)
|
|
47
|
+
|
|
48
|
+
Returns the currently resolved provider configuration.
|
|
49
|
+
|
|
50
|
+
#### Returns
|
|
51
|
+
|
|
52
|
+
[`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration)
|
|
53
|
+
|
|
54
|
+
The active provider configuration.
|
|
@@ -11,6 +11,6 @@ type IntelligenceConversationMessageRole =
|
|
|
11
11
|
(typeof IntelligenceConversationMessageRoles)[keyof typeof IntelligenceConversationMessageRoles];
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
-
Defined in: [
|
|
14
|
+
Defined in: [contracts/IntelligenceConversationMessageRoles.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceConversationMessageRoles.ts#L17)
|
|
15
15
|
|
|
16
16
|
Represents the union of supported conversation message roles.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: IntelligenceLanguageModelLoader'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Type Alias: IntelligenceLanguageModelLoader
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type IntelligenceLanguageModelLoader = (configuration) => Promise<LanguageModelV2>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [providers/IntelligenceLanguageModelLoader.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/providers/IntelligenceLanguageModelLoader.ts#L13)
|
|
14
|
+
|
|
15
|
+
Represents a factory responsible for resolving a configured language model instance.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type |
|
|
20
|
+
| --------------- | ------------------------------------------------------------------------------------ |
|
|
21
|
+
| `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) |
|
|
22
|
+
|
|
23
|
+
## Returns
|
|
24
|
+
|
|
25
|
+
`Promise`\<`LanguageModelV2`\>
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
type IntelligenceProviderName = (typeof IntelligenceProviderNames)[keyof typeof IntelligenceProviderNames];
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [
|
|
13
|
+
Defined in: [contracts/IntelligenceProviderNames.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L18)
|
|
14
14
|
|
|
15
15
|
Represents the union of supported intelligence provider identifiers.
|
|
@@ -14,14 +14,14 @@ const IntelligenceConversationMessageRoles: {
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [
|
|
17
|
+
Defined in: [contracts/IntelligenceConversationMessageRoles.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceConversationMessageRoles.ts#L6)
|
|
18
18
|
|
|
19
19
|
Enumerates the conversation roles used for contextual snapshots and messages.
|
|
20
20
|
|
|
21
21
|
## Type Declaration
|
|
22
22
|
|
|
23
|
-
| Name | Type | Default value | Defined in
|
|
24
|
-
| ------------------------------------------- | ------------- | ------------- |
|
|
25
|
-
| <a id="property-assistant"></a> `Assistant` | `"assistant"` | `'assistant'` | [
|
|
26
|
-
| <a id="property-system"></a> `System` | `"system"` | `'system'` | [
|
|
27
|
-
| <a id="property-user"></a> `User` | `"user"` | `'user'` | [
|
|
23
|
+
| Name | Type | Default value | Defined in |
|
|
24
|
+
| ------------------------------------------- | ------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
25
|
+
| <a id="property-assistant"></a> `Assistant` | `"assistant"` | `'assistant'` | [contracts/IntelligenceConversationMessageRoles.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceConversationMessageRoles.ts#L8) |
|
|
26
|
+
| <a id="property-system"></a> `System` | `"system"` | `'system'` | [contracts/IntelligenceConversationMessageRoles.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceConversationMessageRoles.ts#L9) |
|
|
27
|
+
| <a id="property-user"></a> `User` | `"user"` | `'user'` | [contracts/IntelligenceConversationMessageRoles.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceConversationMessageRoles.ts#L7) |
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: IntelligenceProviderNames'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: IntelligenceProviderNames
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const IntelligenceProviderNames: {
|
|
11
|
+
Anthropic: 'anthropic';
|
|
12
|
+
Google: 'google';
|
|
13
|
+
Grok: 'grok';
|
|
14
|
+
OpenAI: 'openai';
|
|
15
|
+
};
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Defined in: [contracts/IntelligenceProviderNames.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L6)
|
|
19
|
+
|
|
20
|
+
Enumerates the supported model providers powering the intelligence pipeline.
|
|
21
|
+
|
|
22
|
+
## Type Declaration
|
|
23
|
+
|
|
24
|
+
| Name | Type | Default value | Defined in |
|
|
25
|
+
| ------------------------------------------- | ------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
26
|
+
| <a id="property-anthropic"></a> `Anthropic` | `"anthropic"` | `'anthropic'` | [contracts/IntelligenceProviderNames.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L8) |
|
|
27
|
+
| <a id="property-google"></a> `Google` | `"google"` | `'google'` | [contracts/IntelligenceProviderNames.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L9) |
|
|
28
|
+
| <a id="property-grok"></a> `Grok` | `"grok"` | `'grok'` | [contracts/IntelligenceProviderNames.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L10) |
|
|
29
|
+
| <a id="property-openai"></a> `OpenAI` | `"openai"` | `'openai'` | [contracts/IntelligenceProviderNames.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IntelligenceProviderNames.ts#L7) |
|