@breadstone/archipel-mcp 0.0.6 → 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-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +1 -1
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +1 -1
- package/data/packages/platform-authentication/api/index.md +4 -0
- 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
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceCapabilityRegistry'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceCapabilityRegistry
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/IIntelligenceCapabilityRegistry.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceCapabilityRegistry.ts#L14)
|
|
10
|
-
|
|
11
|
-
Registry abstraction responsible for resolving capabilities.
|
|
12
|
-
|
|
13
|
-
## Methods
|
|
14
|
-
|
|
15
|
-
### list()
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
list(): readonly IIntelligenceCapability[];
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/IIntelligenceCapabilityRegistry.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceCapabilityRegistry.ts#L22)
|
|
22
|
-
|
|
23
|
-
#### Returns
|
|
24
|
-
|
|
25
|
-
readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
### register()
|
|
30
|
-
|
|
31
|
-
```ts
|
|
32
|
-
register(capability): void;
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
Defined in: [intelligence/IIntelligenceCapabilityRegistry.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceCapabilityRegistry.ts#L18)
|
|
36
|
-
|
|
37
|
-
#### Parameters
|
|
38
|
-
|
|
39
|
-
| Parameter | Type |
|
|
40
|
-
| ------------ | -------------------------------------------------------------- |
|
|
41
|
-
| `capability` | [`IIntelligenceCapability`](Interface.IIntelligenceCapability) |
|
|
42
|
-
|
|
43
|
-
#### Returns
|
|
44
|
-
|
|
45
|
-
`void`
|
|
46
|
-
|
|
47
|
-
---
|
|
48
|
-
|
|
49
|
-
### resolve()
|
|
50
|
-
|
|
51
|
-
```ts
|
|
52
|
-
resolve(intent, context):
|
|
53
|
-
| IIntelligenceCapability
|
|
54
|
-
| null;
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
Defined in: [intelligence/IIntelligenceCapabilityRegistry.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceCapabilityRegistry.ts#L20)
|
|
58
|
-
|
|
59
|
-
#### Parameters
|
|
60
|
-
|
|
61
|
-
| Parameter | Type |
|
|
62
|
-
| --------- | -------------------------------------------------------- |
|
|
63
|
-
| `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) |
|
|
64
|
-
| `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) |
|
|
65
|
-
|
|
66
|
-
#### Returns
|
|
67
|
-
|
|
68
|
-
\| [`IIntelligenceCapability`](Interface.IIntelligenceCapability)
|
|
69
|
-
\| `null`
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceCapabilityResult'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceCapabilityResult
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceCapabilityResult.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityResult.ts#L14)
|
|
10
|
-
|
|
11
|
-
Represents the outcome produced by a capability execution.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### artifacts
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
readonly artifacts: readonly IIntelligenceArtifact[];
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/contracts/IIntelligenceCapabilityResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityResult.ts#L18)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### followUps
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly followUps: readonly IIntelligenceFollowUpQuestion[];
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceCapabilityResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityResult.ts#L19)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
### messages
|
|
36
|
-
|
|
37
|
-
```ts
|
|
38
|
-
readonly messages: readonly IIntelligenceResponseMessage[];
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Defined in: [intelligence/contracts/IIntelligenceCapabilityResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCapabilityResult.ts#L17)
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceCompletionUsage'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceCompletionUsage
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceCompletionUsage.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCompletionUsage.ts#L10)
|
|
10
|
-
|
|
11
|
-
Captures usage telemetry returned by the intelligence provider.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### completionTokens
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
readonly completionTokens: number | null;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/contracts/IIntelligenceCompletionUsage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCompletionUsage.ts#L14)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### promptTokens
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly promptTokens: number | null;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceCompletionUsage.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCompletionUsage.ts#L13)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
### totalTokens
|
|
36
|
-
|
|
37
|
-
```ts
|
|
38
|
-
readonly totalTokens: number | null;
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Defined in: [intelligence/contracts/IIntelligenceCompletionUsage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceCompletionUsage.ts#L15)
|
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceContext'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceContext
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceContext.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L12)
|
|
10
|
-
|
|
11
|
-
Describes the context aggregated before routing a request to a capability.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### conversationId
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
readonly conversationId: string | null;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/contracts/IIntelligenceContext.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L16)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### conversationPreview
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly conversationPreview:
|
|
29
|
-
| IIntelligenceConversationSnapshot
|
|
30
|
-
| null;
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
Defined in: [intelligence/contracts/IIntelligenceContext.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L17)
|
|
34
|
-
|
|
35
|
-
---
|
|
36
|
-
|
|
37
|
-
### nutritionSnapshot?
|
|
38
|
-
|
|
39
|
-
```ts
|
|
40
|
-
readonly optional nutritionSnapshot?: Record<string, unknown> | null;
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Defined in: [intelligence/contracts/IIntelligenceContext.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L19)
|
|
44
|
-
|
|
45
|
-
---
|
|
46
|
-
|
|
47
|
-
### userId
|
|
48
|
-
|
|
49
|
-
```ts
|
|
50
|
-
readonly userId: string;
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
Defined in: [intelligence/contracts/IIntelligenceContext.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L15)
|
|
54
|
-
|
|
55
|
-
---
|
|
56
|
-
|
|
57
|
-
### workoutSummary?
|
|
58
|
-
|
|
59
|
-
```ts
|
|
60
|
-
readonly optional workoutSummary?: Record<string, unknown> | null;
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
Defined in: [intelligence/contracts/IIntelligenceContext.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContext.ts#L18)
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceContextBuilder'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceContextBuilder
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceContextBuilder.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContextBuilder.ts#L12)
|
|
10
|
-
|
|
11
|
-
Responsible for composing the context supplied to capabilities.
|
|
12
|
-
|
|
13
|
-
## Methods
|
|
14
|
-
|
|
15
|
-
### build()
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
build(userId, conversationId): Promise<IIntelligenceContext>;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/contracts/IIntelligenceContextBuilder.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceContextBuilder.ts#L15)
|
|
22
|
-
|
|
23
|
-
#### Parameters
|
|
24
|
-
|
|
25
|
-
| Parameter | Type |
|
|
26
|
-
| ---------------- | ------------------ |
|
|
27
|
-
| `userId` | `string` |
|
|
28
|
-
| `conversationId` | `string` \| `null` |
|
|
29
|
-
|
|
30
|
-
#### Returns
|
|
31
|
-
|
|
32
|
-
`Promise`\<[`IIntelligenceContext`](Interface.IIntelligenceContext)\>
|
package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md
DELETED
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceConversationMessageSnapshot'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceConversationMessageSnapshot
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts#L12)
|
|
10
|
-
|
|
11
|
-
Represents a single message returned within a conversation snapshot.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### content
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
readonly content: string;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts#L17)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### createdAt
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly createdAt: Date;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts#L18)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
### id
|
|
36
|
-
|
|
37
|
-
```ts
|
|
38
|
-
readonly id: string;
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Defined in: [intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts#L15)
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
### metadata?
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
readonly optional metadata?: unknown;
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
Defined in: [intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts#L19)
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
### role
|
|
56
|
-
|
|
57
|
-
```ts
|
|
58
|
-
readonly role: IntelligenceConversationMessageRole;
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
Defined in: [intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceConversationMessageSnapshot.ts#L16)
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceConversationSnapshot'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceConversationSnapshot
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceConversationSnapshot.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceConversationSnapshot.ts#L12)
|
|
10
|
-
|
|
11
|
-
Represents a lightweight snapshot of a conversation used for context building.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### conversationId
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
readonly conversationId: string;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/contracts/IIntelligenceConversationSnapshot.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceConversationSnapshot.ts#L15)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### lastActivityAt
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly lastActivityAt: Date;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceConversationSnapshot.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceConversationSnapshot.ts#L18)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
### lastMessages
|
|
36
|
-
|
|
37
|
-
```ts
|
|
38
|
-
readonly lastMessages: readonly IIntelligenceConversationMessageSnapshot[];
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Defined in: [intelligence/contracts/IIntelligenceConversationSnapshot.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceConversationSnapshot.ts#L17)
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
### title
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
readonly title: string | null;
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
Defined in: [intelligence/contracts/IIntelligenceConversationSnapshot.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceConversationSnapshot.ts#L16)
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceFollowUpQuestion'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceFollowUpQuestion
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceFollowUpQuestion.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceFollowUpQuestion.ts#L10)
|
|
10
|
-
|
|
11
|
-
Represents a follow-up question suggested to keep the dialogue active.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### id
|
|
16
|
-
|
|
17
|
-
```ts
|
|
18
|
-
readonly id: string;
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
Defined in: [intelligence/contracts/IIntelligenceFollowUpQuestion.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceFollowUpQuestion.ts#L13)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### label
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly label: string;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceFollowUpQuestion.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceFollowUpQuestion.ts#L14)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
### payload
|
|
36
|
-
|
|
37
|
-
```ts
|
|
38
|
-
readonly payload: Record<string, unknown>;
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Defined in: [intelligence/contracts/IIntelligenceFollowUpQuestion.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceFollowUpQuestion.ts#L15)
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceIntent'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceIntent
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceIntent.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/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: [intelligence/contracts/IIntelligenceIntent.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceIntent.ts#L16)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### entities
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly entities: readonly IIntelligenceIntentEntity[];
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceIntent.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceIntent.ts#L17)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
### name
|
|
36
|
-
|
|
37
|
-
```ts
|
|
38
|
-
readonly name: string;
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Defined in: [intelligence/contracts/IIntelligenceIntent.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceIntent.ts#L15)
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceIntentEntity'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceIntentEntity
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceIntentEntity.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceIntentEntity.ts#L10)
|
|
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: [intelligence/contracts/IIntelligenceIntentEntity.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceIntentEntity.ts#L13)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### value
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly value: string;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceIntentEntity.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceIntentEntity.ts#L14)
|
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceMessageModel'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceMessageModel
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceMessageModel.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/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: [intelligence/contracts/IIntelligenceMessageModel.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceMessageModel.ts#L17)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### createdAt
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly createdAt: Date;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceMessageModel.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceMessageModel.ts#L18)
|
|
32
|
-
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
### id
|
|
36
|
-
|
|
37
|
-
```ts
|
|
38
|
-
readonly id: string;
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
Defined in: [intelligence/contracts/IIntelligenceMessageModel.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceMessageModel.ts#L15)
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
### metadata?
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
readonly optional metadata?: unknown;
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
Defined in: [intelligence/contracts/IIntelligenceMessageModel.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceMessageModel.ts#L19)
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
### role
|
|
56
|
-
|
|
57
|
-
```ts
|
|
58
|
-
readonly role: IntelligenceConversationMessageRole;
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
Defined in: [intelligence/contracts/IIntelligenceMessageModel.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceMessageModel.ts#L16)
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligenceMessagePayload'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligenceMessagePayload
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligenceMessagePayload.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceMessagePayload.ts#L10)
|
|
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: [intelligence/contracts/IIntelligenceMessagePayload.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceMessagePayload.ts#L13)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### message
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly message: string;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligenceMessagePayload.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceMessagePayload.ts#L14)
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligencePrompt'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligencePrompt
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligencePrompt.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/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: [intelligence/contracts/IIntelligencePrompt.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligencePrompt.ts#L16)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### systemPrompt
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly systemPrompt: string | null;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligencePrompt.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligencePrompt.ts#L15)
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIntelligencePromptMessage'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Interface: IIntelligencePromptMessage
|
|
8
|
-
|
|
9
|
-
Defined in: [intelligence/contracts/IIntelligencePromptMessage.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/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: [intelligence/contracts/IIntelligencePromptMessage.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligencePromptMessage.ts#L16)
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
### role
|
|
26
|
-
|
|
27
|
-
```ts
|
|
28
|
-
readonly role: IntelligenceConversationMessageRole;
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Defined in: [intelligence/contracts/IIntelligencePromptMessage.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligencePromptMessage.ts#L15)
|