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

    Interface ConciergusChatWidgetProps

    interface ConciergusChatWidgetProps {
        isOpen: boolean;
        onOpenChange: (open: boolean) => void;
        className?: string;
        children?: ReactNode;
        triggerComponent?: ReactNode;
        headerComponent?: ReactNode;
        footerComponent?: ReactNode;
        chatStore?: ChatStore;
        chatId?: string;
        enableObjectStreaming?: boolean;
        generativeUIConfig?: GenerativeUIConfig;
        agentWorkflowConfig?: AgentWorkflowConfig;
        ragConfig?: RAGConfig;
        config?: ConciergusConfig;
        enableModelSwitching?: boolean;
        showTelemetry?: boolean;
        showMessageMetadata?: boolean;
        enableDebug?: boolean;
        errorBoundary?: ComponentType<{ error: Error; errorInfo?: ErrorInfo }>;
        middleware?: MiddlewareArray;
        rateLimitingConfig?: RateLimitingConfig;
        gatewayConfig?: GatewayConfig;
        enableGatewayFallbacks?: boolean;
        defaultFallbackChain?: string;
        enableAutoModelSwitching?: boolean;
        maxRetryAttempts?: number;
        enableEnhancedErrorHandling?: boolean;
        autoHandleErrorCategories?: ErrorCategory[];
        errorReportingEndpoint?: string;
        enableErrorTelemetry?: boolean;
        accessibilityConfig?: AccessibilityConfig;
        enableResponsiveDesign?: boolean;
        enableTouchOptimizations?: boolean;
        customBreakpoints?: { mobile?: number; tablet?: number; desktop?: number };
        onModelChange?: (model: string) => void;
        onTelemetryEvent?: (event: TelemetryEvent) => void;
        onError?: (error: Error, source?: string) => void;
        onCostThreshold?: (cost: number, threshold?: number) => void;
        onWorkflowStep?: (step: any, result: any) => void;
        onRAGRetrieval?: (query: string, results: any[]) => void;
        onGatewayFallback?: (
            fromModel: string,
            toModel: string,
            reason: string,
        ) => void;
        onGatewayAuthFailure?: (error: Error) => void;
        onGatewayRateLimit?: (modelId: string, retryAfter?: number) => void;
    }
    Index

    Properties

    isOpen onOpenChange className? children? triggerComponent? headerComponent? footerComponent? chatStore? chatId? enableObjectStreaming? generativeUIConfig? agentWorkflowConfig? ragConfig? config? enableModelSwitching? showTelemetry? showMessageMetadata? enableDebug? errorBoundary? middleware? rateLimitingConfig? gatewayConfig? enableGatewayFallbacks? defaultFallbackChain? enableAutoModelSwitching? maxRetryAttempts? enableEnhancedErrorHandling? autoHandleErrorCategories? errorReportingEndpoint? enableErrorTelemetry? accessibilityConfig? enableResponsiveDesign? enableTouchOptimizations? customBreakpoints? onModelChange? onTelemetryEvent? onError? onCostThreshold? onWorkflowStep? onRAGRetrieval? onGatewayFallback? onGatewayAuthFailure? onGatewayRateLimit?

    Properties

    isOpen: boolean
    onOpenChange: (open: boolean) => void
    className?: string
    children?: ReactNode
    triggerComponent?: ReactNode
    headerComponent?: ReactNode
    footerComponent?: ReactNode
    chatStore?: ChatStore

    ChatStore instance for AI SDK 5 state management

    chatId?: string

    Chat session ID for multiple chat support

    enableObjectStreaming?: boolean

    Enable structured object streaming

    generativeUIConfig?: GenerativeUIConfig

    Generative UI configuration

    agentWorkflowConfig?: AgentWorkflowConfig

    Agent workflow configuration

    ragConfig?: RAGConfig

    RAG (Retrieval Augmented Generation) configuration

    config?: ConciergusConfig

    Conciergus configuration for AI SDK 5 features

    enableModelSwitching?: boolean

    Enable model switching UI

    showTelemetry?: boolean

    Enable telemetry display

    showMessageMetadata?: boolean

    Enable metadata display in messages

    enableDebug?: boolean

    Enable debug mode for verbose logging

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

    Custom error boundary component

    middleware?: MiddlewareArray

    Middleware configuration for request/response processing

    rateLimitingConfig?: RateLimitingConfig

    Rate limiting configuration

    gatewayConfig?: GatewayConfig

    AI Gateway configuration for unified model access

    enableGatewayFallbacks?: boolean

    Enable AI Gateway fallback chains

    defaultFallbackChain?: string

    Default fallback chain to use (premium, reasoning, vision, budget)

    enableAutoModelSwitching?: boolean

    Enable automatic model switching on failures

    maxRetryAttempts?: number

    Maximum retry attempts for failed requests

    enableEnhancedErrorHandling?: boolean

    Enable enhanced error boundary with gateway integration

    autoHandleErrorCategories?: ErrorCategory[]

    Error categories to handle automatically

    errorReportingEndpoint?: string

    Custom error reporting endpoint

    enableErrorTelemetry?: boolean

    Enable error telemetry reporting

    accessibilityConfig?: AccessibilityConfig

    Accessibility configuration

    enableResponsiveDesign?: boolean

    Enable enhanced responsive design

    enableTouchOptimizations?: boolean

    Enable touch optimizations for mobile

    customBreakpoints?: { mobile?: number; tablet?: number; desktop?: number }

    Custom breakpoints for responsive design

    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

    onWorkflowStep?: (step: any, result: any) => void

    Callback when workflow step completes

    onRAGRetrieval?: (query: string, results: any[]) => void

    Callback when RAG retrieval occurs

    onGatewayFallback?: (fromModel: string, toModel: string, reason: string) => void

    Callback when gateway model fallback occurs

    onGatewayAuthFailure?: (error: Error) => void

    Callback when gateway authentication fails

    onGatewayRateLimit?: (modelId: string, retryAfter?: number) => void

    Callback when gateway rate limit is hit

    Settings

    Member Visibility

    On This Page

    Properties