@breadstone/archipel-mcp 0.0.1
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/README.md +80 -0
- package/data/packages/index.md +42 -0
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +45 -0
- package/data/packages/platform-authentication/api/Class.AuthModule.md +72 -0
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +100 -0
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +64 -0
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +136 -0
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +45 -0
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +45 -0
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +116 -0
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +76 -0
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +45 -0
- package/data/packages/platform-authentication/api/Class.MfaService.md +257 -0
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +75 -0
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +65 -0
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +65 -0
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +170 -0
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +157 -0
- package/data/packages/platform-authentication/api/Class.SessionService.md +167 -0
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +66 -0
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +53 -0
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +52 -0
- package/data/packages/platform-authentication/api/Class.VerificationService.md +159 -0
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +121 -0
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +89 -0
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +112 -0
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +87 -0
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +123 -0
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +27 -0
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +63 -0
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +136 -0
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +96 -0
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +165 -0
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +87 -0
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +63 -0
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +75 -0
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +76 -0
- package/data/packages/platform-authentication/api/_media/ENVIRONMENT_VARIABLES.md +151 -0
- package/data/packages/platform-authentication/api/index.md +508 -0
- package/data/packages/platform-authentication/index.md +635 -0
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +84 -0
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +54 -0
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +80 -0
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +253 -0
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +56 -0
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +202 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +43 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +53 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +69 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +53 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +143 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +119 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +53 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +103 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +33 -0
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +33 -0
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +73 -0
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +33 -0
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +17 -0
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +17 -0
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +17 -0
- package/data/packages/platform-blob-storage/api/index.md +111 -0
- package/data/packages/platform-blob-storage/index.md +280 -0
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +51 -0
- package/data/packages/platform-core/api/Class.BcryptService.md +69 -0
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +196 -0
- package/data/packages/platform-core/api/Class.BooleanUtils.md +83 -0
- package/data/packages/platform-core/api/Class.CUIDGenerator.md +121 -0
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +84 -0
- package/data/packages/platform-core/api/Class.CatchUtils.md +94 -0
- package/data/packages/platform-core/api/Class.ConfigModule.md +70 -0
- package/data/packages/platform-core/api/Class.ConfigRegistry.md +116 -0
- package/data/packages/platform-core/api/Class.ConfigService.md +139 -0
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +110 -0
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +64 -0
- package/data/packages/platform-core/api/Class.CryptoService.md +50 -0
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +102 -0
- package/data/packages/platform-core/api/Class.DeviceParserService.md +53 -0
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +216 -0
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +144 -0
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +110 -0
- package/data/packages/platform-core/api/Class.EventHub.md +164 -0
- package/data/packages/platform-core/api/Class.EventModule.md +23 -0
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +150 -0
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +193 -0
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +86 -0
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +67 -0
- package/data/packages/platform-core/api/Class.HealthModule.md +43 -0
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +65 -0
- package/data/packages/platform-core/api/Class.HostModule.md +33 -0
- package/data/packages/platform-core/api/Class.HostService.md +150 -0
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +60 -0
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +88 -0
- package/data/packages/platform-core/api/Class.IdentifierModule.md +41 -0
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +39 -0
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistry.md +103 -0
- package/data/packages/platform-core/api/Class.IntelligenceModule.md +23 -0
- package/data/packages/platform-core/api/Class.IntelligenceTextGenerator.md +82 -0
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +60 -0
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +43 -0
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +43 -0
- package/data/packages/platform-core/api/Class.MappingBuilder.md +111 -0
- package/data/packages/platform-core/api/Class.MappingModule.md +47 -0
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +57 -0
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +53 -0
- package/data/packages/platform-core/api/Class.MappingService.md +285 -0
- package/data/packages/platform-core/api/Class.MemoryLayeredCache.md +251 -0
- package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +157 -0
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +149 -0
- package/data/packages/platform-core/api/Class.OtpService.md +106 -0
- package/data/packages/platform-core/api/Class.PageableRequest.md +43 -0
- package/data/packages/platform-core/api/Class.PageableResponse.md +63 -0
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +62 -0
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +85 -0
- package/data/packages/platform-core/api/Class.QuantityResponse.md +43 -0
- package/data/packages/platform-core/api/Class.RedisLayeredCache.md +275 -0
- package/data/packages/platform-core/api/Class.ResourceManager.md +566 -0
- package/data/packages/platform-core/api/Class.ResourceModule.md +47 -0
- package/data/packages/platform-core/api/Class.ResponseReturn.md +504 -0
- package/data/packages/platform-core/api/Class.SseHub.md +184 -0
- package/data/packages/platform-core/api/Class.SseModule.md +43 -0
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +43 -0
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +58 -0
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +86 -0
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +48 -0
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +65 -0
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +29 -0
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +41 -0
- package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +121 -0
- package/data/packages/platform-core/api/Interface.ICacheStats.md +71 -0
- package/data/packages/platform-core/api/Interface.IConfigKey.md +64 -0
- package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +41 -0
- package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +80 -0
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +81 -0
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +154 -0
- package/data/packages/platform-core/api/Interface.IEventKey.md +58 -0
- package/data/packages/platform-core/api/Interface.IEventMap.md +17 -0
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +73 -0
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +47 -0
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +42 -0
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +233 -0
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +58 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +62 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +61 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +69 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +63 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +32 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +61 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +51 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +61 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +81 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +53 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +46 -0
- package/data/packages/platform-core/api/Interface.ILayeredCache.md +194 -0
- package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +71 -0
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +77 -0
- package/data/packages/platform-core/api/Interface.IMappingKey.md +59 -0
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +33 -0
- package/data/packages/platform-core/api/Interface.IOtpService.md +78 -0
- package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +47 -0
- package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +108 -0
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +72 -0
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +95 -0
- package/data/packages/platform-core/api/Interface.IResourceResult.md +35 -0
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +135 -0
- package/data/packages/platform-core/api/Interface.ISseEventData.md +37 -0
- package/data/packages/platform-core/api/Interface.ISseHub.md +92 -0
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +34 -0
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +19 -0
- package/data/packages/platform-core/api/TypeAlias.IntelligenceConversationMessageRole.md +16 -0
- package/data/packages/platform-core/api/TypeAlias.IntelligenceProviderName.md +15 -0
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +29 -0
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +26 -0
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +22 -0
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +13 -0
- package/data/packages/platform-core/api/index.md +645 -0
- package/data/packages/platform-core/index.md +483 -0
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +80 -0
- package/data/packages/platform-database/api/Class.DatabaseModule.md +75 -0
- package/data/packages/platform-database/api/Class.DatabaseService.md +165 -0
- package/data/packages/platform-database/api/Class.PrismaService.md +116 -0
- package/data/packages/platform-database/api/Class.RepositoryBase.md +526 -0
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +60 -0
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +27 -0
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +33 -0
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +82 -0
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +56 -0
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +55 -0
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +23 -0
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +23 -0
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +36 -0
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +32 -0
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +31 -0
- package/data/packages/platform-database/api/index.md +183 -0
- package/data/packages/platform-database/index.md +300 -0
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +103 -0
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +85 -0
- package/data/packages/platform-documents/api/Class.DocumentModule.md +52 -0
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +136 -0
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +100 -0
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +75 -0
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +123 -0
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +52 -0
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +63 -0
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +100 -0
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +69 -0
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +63 -0
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +19 -0
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +19 -0
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +19 -0
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +19 -0
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +19 -0
- package/data/packages/platform-documents/api/index.md +91 -0
- package/data/packages/platform-documents/index.md +219 -0
- package/data/packages/platform-logging/api/Class.AnalyticsService.md +113 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +25 -0
- package/data/packages/platform-logging/api/index.md +42 -0
- package/data/packages/platform-logging/index.md +92 -0
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +67 -0
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +55 -0
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +65 -0
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +83 -0
- package/data/packages/platform-mailing/api/Class.MailModule.md +27 -0
- package/data/packages/platform-mailing/api/Class.MailService.md +101 -0
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +98 -0
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +90 -0
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +42 -0
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +71 -0
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +35 -0
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +19 -0
- package/data/packages/platform-mailing/api/index.md +404 -0
- package/data/packages/platform-mailing/index.md +335 -0
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +65 -0
- package/data/packages/platform-mcp/api/Class.McpModule.md +83 -0
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +147 -0
- package/data/packages/platform-mcp/api/Class.McpServerService.md +197 -0
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +47 -0
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +76 -0
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +126 -0
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +28 -0
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +59 -0
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +73 -0
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +83 -0
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +41 -0
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +41 -0
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +41 -0
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +23 -0
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +39 -0
- package/data/packages/platform-mcp/api/index.md +123 -0
- package/data/packages/platform-mcp/index.md +299 -0
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +71 -0
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +104 -0
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +82 -0
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +51 -0
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +73 -0
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +73 -0
- package/data/packages/platform-openapi/api/index.md +209 -0
- package/data/packages/platform-openapi/index.md +170 -0
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +79 -0
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +73 -0
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +74 -0
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +168 -0
- package/data/packages/platform-payments/api/Class.MollieClient.md +168 -0
- package/data/packages/platform-payments/api/Class.PaddleClient.md +168 -0
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +147 -0
- package/data/packages/platform-payments/api/Class.PaymentModule.md +53 -0
- package/data/packages/platform-payments/api/Class.StripeClient.md +168 -0
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +75 -0
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +75 -0
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +85 -0
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +105 -0
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +89 -0
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +65 -0
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +27 -0
- package/data/packages/platform-payments/api/index.md +243 -0
- package/data/packages/platform-payments/index.md +532 -0
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +57 -0
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +41 -0
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +85 -0
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +23 -0
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +62 -0
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +83 -0
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +71 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +61 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +41 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +61 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +31 -0
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +13 -0
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +13 -0
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +15 -0
- package/data/packages/platform-reporting/api/index.md +90 -0
- package/data/packages/platform-reporting/index.md +229 -0
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +118 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +180 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +132 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +231 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +45 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +53 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +90 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +43 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +141 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +43 -0
- package/data/packages/platform-telemetry/api/index.md +81 -0
- package/data/packages/platform-telemetry/index.md +234 -0
- package/package.json +39 -0
- package/src/DocsLoader.d.ts +14 -0
- package/src/DocsLoader.js +103 -0
- package/src/knowledge/configPattern.d.ts +5 -0
- package/src/knowledge/configPattern.js +211 -0
- package/src/knowledge/dtoPattern.d.ts +5 -0
- package/src/knowledge/dtoPattern.js +286 -0
- package/src/knowledge/errorHandlingPattern.d.ts +5 -0
- package/src/knowledge/errorHandlingPattern.js +219 -0
- package/src/knowledge/guardPattern.d.ts +5 -0
- package/src/knowledge/guardPattern.js +256 -0
- package/src/knowledge/mappingPattern.d.ts +6 -0
- package/src/knowledge/mappingPattern.js +322 -0
- package/src/knowledge/modulePattern.d.ts +6 -0
- package/src/knowledge/modulePattern.js +283 -0
- package/src/knowledge/queryPattern.d.ts +6 -0
- package/src/knowledge/queryPattern.js +215 -0
- package/src/knowledge/repositoryPattern.d.ts +6 -0
- package/src/knowledge/repositoryPattern.js +367 -0
- package/src/knowledge/testingPattern.d.ts +5 -0
- package/src/knowledge/testingPattern.js +356 -0
- package/src/main.d.ts +2 -0
- package/src/main.js +226 -0
- package/src/models/IPackageDoc.d.ts +19 -0
- package/src/models/IPackageDoc.js +3 -0
|
@@ -0,0 +1,32 @@
|
|
|
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)\>
|
|
@@ -0,0 +1,61 @@
|
|
|
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)
|
|
@@ -0,0 +1,51 @@
|
|
|
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)
|
|
@@ -0,0 +1,41 @@
|
|
|
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)
|
|
@@ -0,0 +1,41 @@
|
|
|
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)
|
|
@@ -0,0 +1,31 @@
|
|
|
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)
|
|
@@ -0,0 +1,61 @@
|
|
|
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)
|
|
@@ -0,0 +1,31 @@
|
|
|
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)
|
|
@@ -0,0 +1,31 @@
|
|
|
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)
|
|
@@ -0,0 +1,31 @@
|
|
|
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)
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceProviderConfiguration'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceProviderConfiguration
|
|
8
|
+
|
|
9
|
+
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/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: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L17)
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
### baseUrl
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
readonly baseUrl: string | null;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L18)
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
### maxOutputTokens
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
readonly maxOutputTokens: number;
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L21)
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
### model
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
readonly model: string;
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L16)
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
### provider
|
|
56
|
+
|
|
57
|
+
```ts
|
|
58
|
+
readonly provider: IntelligenceProviderName;
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L15)
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
### temperature
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
readonly temperature: number;
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L19)
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
### topP
|
|
76
|
+
|
|
77
|
+
```ts
|
|
78
|
+
readonly topP: number;
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Defined in: [intelligence/contracts/IIntelligenceProviderConfiguration.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceProviderConfiguration.ts#L20)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceResponseMessage'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceResponseMessage
|
|
8
|
+
|
|
9
|
+
Defined in: [intelligence/contracts/IIntelligenceResponseMessage.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceResponseMessage.ts#L10)
|
|
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: [intelligence/contracts/IIntelligenceResponseMessage.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceResponseMessage.ts#L13)
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
### metadata?
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
readonly optional metadata?: Record<string, unknown>;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Defined in: [intelligence/contracts/IIntelligenceResponseMessage.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceResponseMessage.ts#L14)
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceTextCompletion'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceTextCompletion
|
|
8
|
+
|
|
9
|
+
Defined in: [intelligence/contracts/IIntelligenceTextCompletion.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/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: [intelligence/contracts/IIntelligenceTextCompletion.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextCompletion.ts#L18)
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
### provider
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
readonly provider: IntelligenceProviderName;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Defined in: [intelligence/contracts/IIntelligenceTextCompletion.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextCompletion.ts#L17)
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
### text
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
readonly text: string;
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Defined in: [intelligence/contracts/IIntelligenceTextCompletion.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextCompletion.ts#L16)
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
### usage
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
readonly usage:
|
|
49
|
+
| IIntelligenceCompletionUsage
|
|
50
|
+
| null;
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Defined in: [intelligence/contracts/IIntelligenceTextCompletion.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextCompletion.ts#L19)
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceTextGenerationOptions'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceTextGenerationOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [intelligence/contracts/IIntelligenceTextGenerationOptions.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextGenerationOptions.ts#L10)
|
|
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: [intelligence/contracts/IIntelligenceTextGenerationOptions.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextGenerationOptions.ts#L15)
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
### temperature?
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
readonly optional temperature?: number;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Defined in: [intelligence/contracts/IIntelligenceTextGenerationOptions.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextGenerationOptions.ts#L13)
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
### topP?
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
readonly optional topP?: number;
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Defined in: [intelligence/contracts/IIntelligenceTextGenerationOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IIntelligenceTextGenerationOptions.ts#L14)
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IIntelligenceTextGenerator'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IIntelligenceTextGenerator
|
|
8
|
+
|
|
9
|
+
Defined in: [intelligence/IIntelligenceTextGenerator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/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: [intelligence/IIntelligenceTextGenerator.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceTextGenerator.ts#L19)
|
|
22
|
+
|
|
23
|
+
#### Parameters
|
|
24
|
+
|
|
25
|
+
| Parameter | Type |
|
|
26
|
+
| ---------- | ------------------------------------------------------------------------------------ |
|
|
27
|
+
| `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
|
|
28
|
+
| `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) |
|
|
29
|
+
|
|
30
|
+
#### Returns
|
|
31
|
+
|
|
32
|
+
`Promise`\<[`IIntelligenceTextCompletion`](Interface.IIntelligenceTextCompletion)\>
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
### getConfiguration()
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
getConfiguration(): IIntelligenceProviderConfiguration;
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Defined in: [intelligence/IIntelligenceTextGenerator.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceTextGenerator.ts#L21)
|
|
43
|
+
|
|
44
|
+
#### Returns
|
|
45
|
+
|
|
46
|
+
[`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration)
|