@conciergus/chat - v0.3.1
    Preparing search index...

    Interface ConciergusConfig

    Enhanced configuration options for the Conciergus assistant with AI SDK 5 Alpha support

    interface ConciergusConfig {
        defaultModel?: string;
        fallbackModels?: string[];
        aiGatewayConfig?: AIGatewayConfig;
        chatStoreConfig?: ChatStoreConfig;
        telemetryConfig?: TelemetryConfig;
        aiSDKTelemetryConfig?: ConciergusAISDKTelemetryConfig;
        analyticsConfig?: {
            enabled: boolean;
            realTimeUpdates?: boolean;
            retentionPeriod?: number;
            alerting?: {
                enabled: boolean;
                emailNotifications?: boolean;
                webhookUrl?: string;
            };
        };
        performanceMonitorConfig?: {
            enabled: boolean;
            samplingRate?: number;
            aggregationInterval?: number;
            retentionPeriod?: number;
            alerting?: {
                enabled: boolean;
                webhookUrl?: string;
                quietHours?: { start: string; end: string; timezone: string };
            };
            autoRecovery?: {
                enabled: boolean;
                circuitBreakerThreshold: number;
                autoScalingEnabled?: boolean;
            };
        };
        abTestingConfig?: {
            enabled: boolean;
            defaultSignificanceLevel?: number;
            defaultPower?: number;
            defaultMinimumSampleSize?: number;
            maxConcurrentTests?: number;
            autoAnalysisInterval?: number;
            compliance?: {
                trackUserConsent: boolean;
                anonymizeData: boolean;
                auditLogging: boolean;
            };
        };
        complianceConfig?: {
            enabled: boolean;
            frameworks?: ("GDPR" | "CCPA" | "HIPAA" | "SOX" | "EU_AI_ACT")[];
            anonymization?: { enabled: boolean; delay?: number };
            retention?: {
                defaultPeriod?: number;
                deleteAfterExpiry?: boolean;
                archiveAfterExpiry?: boolean;
            };
            monitoring?: { realTimeAlerts: boolean; webhookUrl?: string };
            automation?: {
                autoRespond: boolean;
                autoDelete: boolean;
                autoAnonymize: boolean;
            };
        };
        middleware?: MiddlewareArray;
        rateLimitConfig?: RateLimitConfig;
        defaultTTSVoice?: string;
        isTTSEnabledByDefault?: boolean;
        ttsApiEndpoint?: string;
        onTextToAudio?: (text: string) => Promise<string | Blob>;
        onProcessRecordedAudio?: (blob: Blob) => Promise<string>;
        enableObjectStreaming?: boolean;
        enableGenerativeUI?: boolean;
        enableAgentWorkflows?: boolean;
        enableRAG?: boolean;
        proactiveRules?: ProactiveRule[];
        showMessageMetadata?: boolean;
        showReasoningTraces?: boolean;
        showSourceCitations?: boolean;
        enableDebug?: boolean;
        errorBoundary?: ComponentType<{ error: Error; errorInfo?: ErrorInfo }>;
        onModelChange?: (model: string) => void;
        onTelemetryEvent?: (event: TelemetryEvent) => void;
        onError?: (error: Error, source?: string) => void;
        onCostThreshold?: (cost: number, threshold?: number) => void;
    }
    Index

    Properties

    defaultModel? fallbackModels? aiGatewayConfig? chatStoreConfig? telemetryConfig? aiSDKTelemetryConfig? analyticsConfig? performanceMonitorConfig? abTestingConfig? complianceConfig? middleware? rateLimitConfig? defaultTTSVoice? isTTSEnabledByDefault? ttsApiEndpoint? onTextToAudio? onProcessRecordedAudio? enableObjectStreaming? enableGenerativeUI? enableAgentWorkflows? enableRAG? proactiveRules? showMessageMetadata? showReasoningTraces? showSourceCitations? enableDebug? errorBoundary? onModelChange? onTelemetryEvent? onError? onCostThreshold?

    Properties

    defaultModel?: string

    Default AI model to use

    fallbackModels?: string[]

    Fallback models for when primary model fails

    aiGatewayConfig?: AIGatewayConfig

    AI Gateway configuration for unified model access

    chatStoreConfig?: ChatStoreConfig

    ChatStore configuration for advanced state management

    telemetryConfig?: TelemetryConfig

    Telemetry and observability configuration

    aiSDKTelemetryConfig?: ConciergusAISDKTelemetryConfig

    AI SDK 5 telemetry configuration for experimental_telemetry

    analyticsConfig?: {
        enabled: boolean;
        realTimeUpdates?: boolean;
        retentionPeriod?: number;
        alerting?: {
            enabled: boolean;
            emailNotifications?: boolean;
            webhookUrl?: string;
        };
    }

    Analytics configuration for usage tracking and cost monitoring

    performanceMonitorConfig?: {
        enabled: boolean;
        samplingRate?: number;
        aggregationInterval?: number;
        retentionPeriod?: number;
        alerting?: {
            enabled: boolean;
            webhookUrl?: string;
            quietHours?: { start: string; end: string; timezone: string };
        };
        autoRecovery?: {
            enabled: boolean;
            circuitBreakerThreshold: number;
            autoScalingEnabled?: boolean;
        };
    }

    Performance monitoring configuration for real-time alerting

    abTestingConfig?: {
        enabled: boolean;
        defaultSignificanceLevel?: number;
        defaultPower?: number;
        defaultMinimumSampleSize?: number;
        maxConcurrentTests?: number;
        autoAnalysisInterval?: number;
        compliance?: {
            trackUserConsent: boolean;
            anonymizeData: boolean;
            auditLogging: boolean;
        };
    }

    A/B testing configuration for experimentation

    complianceConfig?: {
        enabled: boolean;
        frameworks?: ("GDPR" | "CCPA" | "HIPAA" | "SOX" | "EU_AI_ACT")[];
        anonymization?: { enabled: boolean; delay?: number };
        retention?: {
            defaultPeriod?: number;
            deleteAfterExpiry?: boolean;
            archiveAfterExpiry?: boolean;
        };
        monitoring?: { realTimeAlerts: boolean; webhookUrl?: string };
        automation?: {
            autoRespond: boolean;
            autoDelete: boolean;
            autoAnonymize: boolean;
        };
    }

    Compliance logging configuration for regulatory requirements

    middleware?: MiddlewareArray

    Middleware for request/response processing

    rateLimitConfig?: RateLimitConfig

    Rate limiting configuration

    defaultTTSVoice?: string

    Default voice to use for text-to-speech functionality

    isTTSEnabledByDefault?: boolean

    Whether text-to-speech is enabled by default

    ttsApiEndpoint?: string

    API endpoint for text-to-speech service

    onTextToAudio?: (text: string) => Promise<string | Blob>

    Function to convert text to audio

    Type declaration

      • (text: string): Promise<string | Blob>

      • Parameters

        • text: string

          The text to convert to audio

        Returns Promise<string | Blob>

        Promise resolving to audio as string URL or Blob

    onProcessRecordedAudio?: (blob: Blob) => Promise<string>

    Function to process recorded audio and convert to text

    Type declaration

      • (blob: Blob): Promise<string>

      • Parameters

        • blob: Blob

          The audio blob to process

        Returns Promise<string>

        Promise resolving to the transcribed text

    enableObjectStreaming?: boolean

    Enable structured object streaming

    enableGenerativeUI?: boolean

    Enable generative UI capabilities

    enableAgentWorkflows?: boolean

    Enable multi-step agent workflows

    enableRAG?: boolean

    Enable RAG (Retrieval Augmented Generation)

    proactiveRules?: ProactiveRule[]

    Rules for proactive engagement with the user

    showMessageMetadata?: boolean

    Enable metadata display in messages

    showReasoningTraces?: boolean

    Enable reasoning trace display

    showSourceCitations?: boolean

    Enable source citations display

    enableDebug?: boolean

    Enable debug mode for verbose logging

    errorBoundary?: ComponentType<{ error: Error; errorInfo?: ErrorInfo }>

    Custom error boundary component

    onModelChange?: (model: string) => void

    Callback when model is changed

    onTelemetryEvent?: (event: TelemetryEvent) => void

    Callback when telemetry event occurs

    onError?: (error: Error, source?: string) => void

    Callback when error occurs

    onCostThreshold?: (cost: number, threshold?: number) => void

    Callback when cost threshold is reached

    Settings

    Member Visibility

    On This Page

    Properties