@breadstone/archipel-mcp 0.0.8 → 0.0.9
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/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +7 -7
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +7 -7
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +7 -7
- package/data/packages/platform-authentication/api/{Class.AppleStrategy.md → Class.AppleConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -3
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +6 -6
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +79 -0
- package/data/packages/platform-authentication/api/{Class.GoogleStrategy.md → Class.GoogleConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.MfaService.md +11 -11
- package/data/packages/platform-authentication/api/{Class.MicrosoftStrategy.md → Class.MicrosoftConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +145 -0
- package/data/packages/platform-authentication/api/Class.VerificationService.md +7 -7
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +47 -17
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +12 -12
- 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 +1 -1
- 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 +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +1 -1
- 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 +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +1 -1
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.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/Variable.TOTP_MFA_PROVIDERS.md +30 -0
- package/data/packages/platform-authentication/api/index.md +7 -4
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -2
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -5
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +1 -1
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +10 -10
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +5 -5
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +8 -8
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +5 -5
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +5 -5
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +8 -8
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +5 -5
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +7 -7
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +3 -3
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +5 -5
- package/data/packages/platform-core/api/Class.HostService.md +8 -8
- package/data/packages/platform-core/api/Class.ResourceManager.md +19 -19
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +10 -10
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +10 -10
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +4 -4
- package/data/packages/platform-core/api/Variable.APP_NAME.md +15 -0
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +1 -1
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-core/api/index.md +2 -0
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +2 -2
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +2 -2
- package/data/packages/platform-cryptography/api/Class.OtpService.md +4 -4
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +4 -4
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +4 -4
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +1 -1
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +4 -4
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +3 -3
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +1 -1
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +7 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +2 -2
- package/data/packages/platform-mailing/api/Class.MailService.md +4 -4
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +4 -4
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +3 -3
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +1 -1
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +6 -6
- package/data/packages/platform-payments/api/Class.MollieClient.md +6 -6
- package/data/packages/platform-payments/api/Class.PaddleClient.md +6 -6
- package/data/packages/platform-payments/api/Class.StripeClient.md +6 -6
- package/package.json +1 -1
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +0 -73
|
@@ -10,7 +10,7 @@ editUrl: false
|
|
|
10
10
|
const TOTP_EPOCH_TOLERANCE: 30 = 30;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [OtpService.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/OtpService.ts#L30)
|
|
13
|
+
Defined in: [otp/OtpService.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-cryptography/src/otp/OtpService.ts#L30)
|
|
14
14
|
|
|
15
15
|
TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`).
|
|
16
16
|
|
package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md
CHANGED
|
@@ -23,7 +23,7 @@ capabilities to the global intelligence registry while keeping their implementat
|
|
|
23
23
|
protected new IntelligenceCapabilityRegistrarBase(registry): IntelligenceCapabilityRegistrarBase;
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:
|
|
26
|
+
Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L30)
|
|
27
27
|
|
|
28
28
|
Initializes a new instance of the IntelligenceCapabilityRegistrarBase class.
|
|
29
29
|
|
|
@@ -47,7 +47,7 @@ Initializes a new instance of the IntelligenceCapabilityRegistrarBase class.
|
|
|
47
47
|
get protected registry(): IntelligenceCapabilityRegistry;
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:
|
|
50
|
+
Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L44)
|
|
51
51
|
|
|
52
52
|
Gets the registry instance that should be used to register capabilities.
|
|
53
53
|
|
|
@@ -63,7 +63,7 @@ Gets the registry instance that should be used to register capabilities.
|
|
|
63
63
|
abstract protected getCapabilities(): readonly IIntelligenceCapability[];
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:
|
|
66
|
+
Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L74)
|
|
67
67
|
|
|
68
68
|
Returns the capabilities that should be registered for the module.
|
|
69
69
|
|
|
@@ -79,7 +79,7 @@ readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
|
|
|
79
79
|
onModuleInit(): void;
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:
|
|
82
|
+
Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L58)
|
|
83
83
|
|
|
84
84
|
Template method invoked by NestJS once the provider has been instantiated.
|
|
85
85
|
Registers all capabilities returned by [getCapabilities](#getcapabilities).
|
|
@@ -34,7 +34,7 @@ new IntelligenceCapabilityRegistry(): IntelligenceCapabilityRegistry;
|
|
|
34
34
|
list(): readonly IIntelligenceCapability[];
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
Defined in: [IntelligenceCapabilityRegistry.ts:
|
|
37
|
+
Defined in: [IntelligenceCapabilityRegistry.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L36)
|
|
38
38
|
|
|
39
39
|
Returns a read-only snapshot of all registered capabilities.
|
|
40
40
|
|
|
@@ -56,7 +56,7 @@ A defensive copy of the registered capabilities.
|
|
|
56
56
|
register(capability): void;
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
Defined in: [IntelligenceCapabilityRegistry.ts:
|
|
59
|
+
Defined in: [IntelligenceCapabilityRegistry.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L25)
|
|
60
60
|
|
|
61
61
|
Registers a capability in the registry.
|
|
62
62
|
|
|
@@ -84,7 +84,7 @@ resolve(intent, context):
|
|
|
84
84
|
| null;
|
|
85
85
|
```
|
|
86
86
|
|
|
87
|
-
Defined in: [IntelligenceCapabilityRegistry.ts:
|
|
87
|
+
Defined in: [IntelligenceCapabilityRegistry.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L31)
|
|
88
88
|
|
|
89
89
|
Resolves the most suitable capability for the given intent and context.
|
|
90
90
|
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: IntelligenceModule
|
|
8
8
|
|
|
9
|
-
Defined in: [IntelligenceModule.ts:
|
|
9
|
+
Defined in: [IntelligenceModule.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L18)
|
|
10
10
|
|
|
11
11
|
Core module exposing the shared intelligence infrastructure to feature modules.
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: IntelligenceTextGenerator
|
|
8
8
|
|
|
9
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
9
|
+
Defined in: [IntelligenceTextGenerator.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L31)
|
|
10
10
|
|
|
11
11
|
Executes text completions using the configured intelligence provider.
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Executes text completions using the configured intelligence provider.
|
|
|
22
22
|
new IntelligenceTextGenerator(configService): IntelligenceTextGenerator;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
25
|
+
Defined in: [IntelligenceTextGenerator.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L44)
|
|
26
26
|
|
|
27
27
|
#### Parameters
|
|
28
28
|
|
|
@@ -42,7 +42,7 @@ Defined in: [IntelligenceTextGenerator.ts:37](https://github.com/RueDeRennes/arc
|
|
|
42
42
|
generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
45
|
+
Defined in: [IntelligenceTextGenerator.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L64)
|
|
46
46
|
|
|
47
47
|
Generates a completion using the configured provider.
|
|
48
48
|
|
|
@@ -69,7 +69,7 @@ Generates a completion using the configured provider.
|
|
|
69
69
|
getConfiguration(): IIntelligenceProviderConfiguration;
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
Defined in: [IntelligenceTextGenerator.ts:
|
|
72
|
+
Defined in: [IntelligenceTextGenerator.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L97)
|
|
73
73
|
|
|
74
74
|
Returns the resolved provider configuration.
|
|
75
75
|
|
|
@@ -18,7 +18,7 @@ Represents a structured artifact returned by a capability.
|
|
|
18
18
|
readonly data: Record<string, unknown>;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceArtifact.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceArtifact.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceArtifact.ts#L21)
|
|
22
22
|
|
|
23
23
|
The structured data payload of the artifact.
|
|
24
24
|
|
|
@@ -30,6 +30,6 @@ The structured data payload of the artifact.
|
|
|
30
30
|
readonly type: string;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceArtifact.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceArtifact.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceArtifact.ts#L14)
|
|
34
34
|
|
|
35
35
|
The artifact type discriminator.
|
|
@@ -18,7 +18,7 @@ Abstraction implemented by all capability providers.
|
|
|
18
18
|
readonly metadata: IIntelligenceCapabilityMetadata;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceCapability.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceCapability.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L24)
|
|
22
22
|
|
|
23
23
|
Metadata describing the capability for orchestration and analytics purposes.
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Metadata describing the capability for orchestration and analytics purposes.
|
|
|
30
30
|
canHandle(intent, context): boolean;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceCapability.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceCapability.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L38)
|
|
34
34
|
|
|
35
35
|
Determines whether this capability can handle the given intent and context.
|
|
36
36
|
|
|
@@ -55,7 +55,7 @@ Determines whether this capability can handle the given intent and context.
|
|
|
55
55
|
execute(payload): Promise<IIntelligenceCapabilityResult>;
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
Defined in: [contracts/IIntelligenceCapability.ts:
|
|
58
|
+
Defined in: [contracts/IIntelligenceCapability.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L47)
|
|
59
59
|
|
|
60
60
|
Executes the capability with the given payload.
|
|
61
61
|
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md
CHANGED
|
@@ -18,7 +18,7 @@ Metadata describing a capability for orchestration and analytics purposes.
|
|
|
18
18
|
readonly description: string;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L28)
|
|
22
22
|
|
|
23
23
|
A brief description of what the capability does.
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ A brief description of what the capability does.
|
|
|
30
30
|
readonly id: string;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L14)
|
|
34
34
|
|
|
35
35
|
Unique identifier for the capability.
|
|
36
36
|
|
|
@@ -42,7 +42,7 @@ Unique identifier for the capability.
|
|
|
42
42
|
readonly intentName: string;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:
|
|
45
|
+
Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L42)
|
|
46
46
|
|
|
47
47
|
The intent name this capability is designed to handle.
|
|
48
48
|
|
|
@@ -54,7 +54,7 @@ The intent name this capability is designed to handle.
|
|
|
54
54
|
readonly name: string;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:
|
|
57
|
+
Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L21)
|
|
58
58
|
|
|
59
59
|
Human-readable name of the capability.
|
|
60
60
|
|
|
@@ -66,6 +66,6 @@ Human-readable name of the capability.
|
|
|
66
66
|
readonly priority: number;
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:
|
|
69
|
+
Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L35)
|
|
70
70
|
|
|
71
71
|
Evaluation priority (lower values are evaluated first).
|
|
@@ -18,7 +18,7 @@ Payload forwarded to capabilities for execution.
|
|
|
18
18
|
readonly context: IIntelligenceContext;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceCapabilityPayload.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceCapabilityPayload.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityPayload.ts#L28)
|
|
22
22
|
|
|
23
23
|
The aggregated context for the request.
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ The aggregated context for the request.
|
|
|
30
30
|
readonly intent: IIntelligenceIntent;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceCapabilityPayload.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceCapabilityPayload.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityPayload.ts#L21)
|
|
34
34
|
|
|
35
35
|
The structured intent resolved from the user message.
|
|
36
36
|
|
|
@@ -42,6 +42,6 @@ The structured intent resolved from the user message.
|
|
|
42
42
|
readonly userMessage: string;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [contracts/IIntelligenceCapabilityPayload.ts:
|
|
45
|
+
Defined in: [contracts/IIntelligenceCapabilityPayload.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityPayload.ts#L35)
|
|
46
46
|
|
|
47
47
|
The raw user message that triggered the capability.
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md
CHANGED
|
@@ -18,7 +18,7 @@ Registry abstraction responsible for resolving capabilities.
|
|
|
18
18
|
list(): readonly IIntelligenceCapability[];
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:
|
|
21
|
+
Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceCapabilityRegistry.ts#L41)
|
|
22
22
|
|
|
23
23
|
Returns a read-only snapshot of all registered capabilities.
|
|
24
24
|
|
|
@@ -36,7 +36,7 @@ A defensive copy of the registered capabilities.
|
|
|
36
36
|
register(capability): void;
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:
|
|
39
|
+
Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceCapabilityRegistry.ts#L23)
|
|
40
40
|
|
|
41
41
|
Registers a capability in the registry.
|
|
42
42
|
|
|
@@ -60,7 +60,7 @@ resolve(intent, context):
|
|
|
60
60
|
| null;
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:
|
|
63
|
+
Defined in: [interfaces/IIntelligenceCapabilityRegistry.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/interfaces/IIntelligenceCapabilityRegistry.ts#L33)
|
|
64
64
|
|
|
65
65
|
Resolves the most suitable capability for the given intent and context.
|
|
66
66
|
|
|
@@ -18,7 +18,7 @@ Represents the outcome produced by a capability execution.
|
|
|
18
18
|
readonly artifacts: readonly IIntelligenceArtifact[];
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceCapabilityResult.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceCapabilityResult.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityResult.ts#L29)
|
|
22
22
|
|
|
23
23
|
Structured artifacts produced alongside the messages.
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Structured artifacts produced alongside the messages.
|
|
|
30
30
|
readonly followUps: readonly IIntelligenceFollowUpQuestion[];
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceCapabilityResult.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceCapabilityResult.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityResult.ts#L36)
|
|
34
34
|
|
|
35
35
|
Suggested follow-up questions to continue the dialogue.
|
|
36
36
|
|
|
@@ -42,6 +42,6 @@ Suggested follow-up questions to continue the dialogue.
|
|
|
42
42
|
readonly messages: readonly IIntelligenceResponseMessage[];
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [contracts/IIntelligenceCapabilityResult.ts:
|
|
45
|
+
Defined in: [contracts/IIntelligenceCapabilityResult.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityResult.ts#L22)
|
|
46
46
|
|
|
47
47
|
The assistant messages produced by the capability.
|
|
@@ -18,7 +18,7 @@ Captures usage telemetry returned by the intelligence provider.
|
|
|
18
18
|
readonly completionTokens: number | null;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceCompletionUsage.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceCompletionUsage.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L21)
|
|
22
22
|
|
|
23
23
|
The number of tokens generated in the completion.
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ The number of tokens generated in the completion.
|
|
|
30
30
|
readonly promptTokens: number | null;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceCompletionUsage.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceCompletionUsage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L14)
|
|
34
34
|
|
|
35
35
|
The number of tokens consumed by the prompt.
|
|
36
36
|
|
|
@@ -42,6 +42,6 @@ The number of tokens consumed by the prompt.
|
|
|
42
42
|
readonly totalTokens: number | null;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [contracts/IIntelligenceCompletionUsage.ts:
|
|
45
|
+
Defined in: [contracts/IIntelligenceCompletionUsage.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCompletionUsage.ts#L28)
|
|
46
46
|
|
|
47
47
|
The total number of tokens (prompt + completion).
|
|
@@ -18,7 +18,7 @@ Describes the context aggregated before routing a request to a capability.
|
|
|
18
18
|
readonly conversationId: string | null;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceContext.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceContext.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L27)
|
|
22
22
|
|
|
23
23
|
The conversation identifier, or `null` for a new conversation.
|
|
24
24
|
|
|
@@ -32,7 +32,7 @@ readonly conversationPreview:
|
|
|
32
32
|
| null;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [contracts/IIntelligenceContext.ts:
|
|
35
|
+
Defined in: [contracts/IIntelligenceContext.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L34)
|
|
36
36
|
|
|
37
37
|
A lightweight preview of the conversation history, or `null` when unavailable.
|
|
38
38
|
|
|
@@ -44,7 +44,7 @@ A lightweight preview of the conversation history, or `null` when unavailable.
|
|
|
44
44
|
readonly optional nutritionSnapshot?: Record<string, unknown> | null;
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
Defined in: [contracts/IIntelligenceContext.ts:
|
|
47
|
+
Defined in: [contracts/IIntelligenceContext.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L48)
|
|
48
48
|
|
|
49
49
|
Optional nutrition snapshot for context enrichment.
|
|
50
50
|
|
|
@@ -56,7 +56,7 @@ Optional nutrition snapshot for context enrichment.
|
|
|
56
56
|
readonly userId: string;
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
Defined in: [contracts/IIntelligenceContext.ts:
|
|
59
|
+
Defined in: [contracts/IIntelligenceContext.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L20)
|
|
60
60
|
|
|
61
61
|
The identifier of the requesting user.
|
|
62
62
|
|
|
@@ -68,6 +68,6 @@ The identifier of the requesting user.
|
|
|
68
68
|
readonly optional workoutSummary?: Record<string, unknown> | null;
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
Defined in: [contracts/IIntelligenceContext.ts:
|
|
71
|
+
Defined in: [contracts/IIntelligenceContext.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContext.ts#L41)
|
|
72
72
|
|
|
73
73
|
Optional workout summary for context enrichment.
|
|
@@ -18,7 +18,7 @@ Responsible for composing the context supplied to capabilities.
|
|
|
18
18
|
build(userId, conversationId): Promise<IIntelligenceContext>;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceContextBuilder.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceContextBuilder.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceContextBuilder.ts#L23)
|
|
22
22
|
|
|
23
23
|
Builds the aggregated context for the given user and conversation.
|
|
24
24
|
|
|
@@ -18,7 +18,7 @@ Represents a single message returned within a conversation snapshot.
|
|
|
18
18
|
readonly content: string;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationMessageSnapshot.ts#L34)
|
|
22
22
|
|
|
23
23
|
The textual content of the message.
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ The textual content of the message.
|
|
|
30
30
|
readonly createdAt: Date;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationMessageSnapshot.ts#L41)
|
|
34
34
|
|
|
35
35
|
The timestamp when the message was created.
|
|
36
36
|
|
|
@@ -42,7 +42,7 @@ The timestamp when the message was created.
|
|
|
42
42
|
readonly id: string;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:
|
|
45
|
+
Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationMessageSnapshot.ts#L20)
|
|
46
46
|
|
|
47
47
|
Unique identifier of the message.
|
|
48
48
|
|
|
@@ -54,7 +54,7 @@ Unique identifier of the message.
|
|
|
54
54
|
readonly optional metadata?: unknown;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:
|
|
57
|
+
Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationMessageSnapshot.ts#L48)
|
|
58
58
|
|
|
59
59
|
Optional metadata attached to the message.
|
|
60
60
|
|
|
@@ -66,6 +66,6 @@ Optional metadata attached to the message.
|
|
|
66
66
|
readonly role: IntelligenceConversationMessageRole;
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:
|
|
69
|
+
Defined in: [contracts/IIntelligenceConversationMessageSnapshot.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationMessageSnapshot.ts#L27)
|
|
70
70
|
|
|
71
71
|
The role of the message author.
|
package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md
CHANGED
|
@@ -18,7 +18,7 @@ Represents a lightweight snapshot of a conversation used for context building.
|
|
|
18
18
|
readonly conversationId: string;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceConversationSnapshot.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceConversationSnapshot.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationSnapshot.ts#L20)
|
|
22
22
|
|
|
23
23
|
The unique conversation identifier.
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ The unique conversation identifier.
|
|
|
30
30
|
readonly lastActivityAt: Date;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceConversationSnapshot.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceConversationSnapshot.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationSnapshot.ts#L41)
|
|
34
34
|
|
|
35
35
|
The timestamp of the last activity in the conversation.
|
|
36
36
|
|
|
@@ -42,7 +42,7 @@ The timestamp of the last activity in the conversation.
|
|
|
42
42
|
readonly lastMessages: readonly IIntelligenceConversationMessageSnapshot[];
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [contracts/IIntelligenceConversationSnapshot.ts:
|
|
45
|
+
Defined in: [contracts/IIntelligenceConversationSnapshot.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationSnapshot.ts#L34)
|
|
46
46
|
|
|
47
47
|
The most recent messages in the conversation.
|
|
48
48
|
|
|
@@ -54,6 +54,6 @@ The most recent messages in the conversation.
|
|
|
54
54
|
readonly title: string | null;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [contracts/IIntelligenceConversationSnapshot.ts:
|
|
57
|
+
Defined in: [contracts/IIntelligenceConversationSnapshot.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceConversationSnapshot.ts#L27)
|
|
58
58
|
|
|
59
59
|
The optional title of the conversation.
|
|
@@ -18,7 +18,7 @@ Represents a follow-up question suggested to keep the dialogue active.
|
|
|
18
18
|
readonly id: string;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceFollowUpQuestion.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceFollowUpQuestion.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFollowUpQuestion.ts#L14)
|
|
22
22
|
|
|
23
23
|
Unique identifier of the follow-up question.
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Unique identifier of the follow-up question.
|
|
|
30
30
|
readonly label: string;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceFollowUpQuestion.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceFollowUpQuestion.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFollowUpQuestion.ts#L21)
|
|
34
34
|
|
|
35
35
|
The human-readable label displayed to the user.
|
|
36
36
|
|
|
@@ -42,6 +42,6 @@ The human-readable label displayed to the user.
|
|
|
42
42
|
readonly payload: Record<string, unknown>;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [contracts/IIntelligenceFollowUpQuestion.ts:
|
|
45
|
+
Defined in: [contracts/IIntelligenceFollowUpQuestion.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceFollowUpQuestion.ts#L28)
|
|
46
46
|
|
|
47
47
|
The payload submitted when the follow-up is selected.
|
|
@@ -18,7 +18,7 @@ Represents the structured intent resolved from a user message.
|
|
|
18
18
|
readonly confidence: number;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceIntent.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceIntent.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntent.ts#L27)
|
|
22
22
|
|
|
23
23
|
The confidence score of the intent resolution (0–1).
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ The confidence score of the intent resolution (0–1).
|
|
|
30
30
|
readonly entities: readonly IIntelligenceIntentEntity[];
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceIntent.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceIntent.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntent.ts#L34)
|
|
34
34
|
|
|
35
35
|
Named entities extracted from the user message.
|
|
36
36
|
|
|
@@ -42,6 +42,6 @@ Named entities extracted from the user message.
|
|
|
42
42
|
readonly name: string;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [contracts/IIntelligenceIntent.ts:
|
|
45
|
+
Defined in: [contracts/IIntelligenceIntent.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntent.ts#L20)
|
|
46
46
|
|
|
47
47
|
The canonical name of the intent.
|
|
@@ -18,7 +18,7 @@ Represents an entity extracted from a resolved intelligence intent.
|
|
|
18
18
|
readonly name: string;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceIntentEntity.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceIntentEntity.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntentEntity.ts#L14)
|
|
22
22
|
|
|
23
23
|
The name of the extracted entity.
|
|
24
24
|
|
|
@@ -30,6 +30,6 @@ The name of the extracted entity.
|
|
|
30
30
|
readonly value: string;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceIntentEntity.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceIntentEntity.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceIntentEntity.ts#L21)
|
|
34
34
|
|
|
35
35
|
The resolved value of the entity.
|
|
@@ -18,7 +18,7 @@ Represents a normalized message stored in persistence.
|
|
|
18
18
|
readonly content: string;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceMessageModel.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceMessageModel.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L34)
|
|
22
22
|
|
|
23
23
|
The textual content of the message.
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ The textual content of the message.
|
|
|
30
30
|
readonly createdAt: Date;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceMessageModel.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceMessageModel.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L41)
|
|
34
34
|
|
|
35
35
|
The timestamp when the message was created.
|
|
36
36
|
|
|
@@ -42,7 +42,7 @@ The timestamp when the message was created.
|
|
|
42
42
|
readonly id: string;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [contracts/IIntelligenceMessageModel.ts:
|
|
45
|
+
Defined in: [contracts/IIntelligenceMessageModel.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L20)
|
|
46
46
|
|
|
47
47
|
Unique identifier of the persisted message.
|
|
48
48
|
|
|
@@ -54,7 +54,7 @@ Unique identifier of the persisted message.
|
|
|
54
54
|
readonly optional metadata?: unknown;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [contracts/IIntelligenceMessageModel.ts:
|
|
57
|
+
Defined in: [contracts/IIntelligenceMessageModel.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L48)
|
|
58
58
|
|
|
59
59
|
Optional metadata attached to the message.
|
|
60
60
|
|
|
@@ -66,6 +66,6 @@ Optional metadata attached to the message.
|
|
|
66
66
|
readonly role: IntelligenceConversationMessageRole;
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
Defined in: [contracts/IIntelligenceMessageModel.ts:
|
|
69
|
+
Defined in: [contracts/IIntelligenceMessageModel.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessageModel.ts#L27)
|
|
70
70
|
|
|
71
71
|
The role of the message author.
|
|
@@ -18,7 +18,7 @@ Carries the payload submitted when messaging the intelligence entrypoint.
|
|
|
18
18
|
readonly conversationId: string | null;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligenceMessagePayload.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligenceMessagePayload.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessagePayload.ts#L14)
|
|
22
22
|
|
|
23
23
|
The conversation identifier, or `null` to start a new conversation.
|
|
24
24
|
|
|
@@ -30,6 +30,6 @@ The conversation identifier, or `null` to start a new conversation.
|
|
|
30
30
|
readonly message: string;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligenceMessagePayload.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligenceMessagePayload.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceMessagePayload.ts#L21)
|
|
34
34
|
|
|
35
35
|
The user message to process.
|
|
@@ -18,7 +18,7 @@ Represents the input supplied to the intelligence text generator.
|
|
|
18
18
|
readonly messages: readonly IIntelligencePromptMessage[];
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [contracts/IIntelligencePrompt.ts:
|
|
21
|
+
Defined in: [contracts/IIntelligencePrompt.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L27)
|
|
22
22
|
|
|
23
23
|
The ordered list of messages forming the prompt.
|
|
24
24
|
|
|
@@ -30,6 +30,6 @@ The ordered list of messages forming the prompt.
|
|
|
30
30
|
readonly systemPrompt: string | null;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [contracts/IIntelligencePrompt.ts:
|
|
33
|
+
Defined in: [contracts/IIntelligencePrompt.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligencePrompt.ts#L20)
|
|
34
34
|
|
|
35
35
|
The optional system-level prompt prepended to the conversation.
|