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

    Interface ConciergusTextStreamHookReturn

    interface ConciergusTextStreamHookReturn {
        config: ConciergusStreamConfig;
        updateConfig: (updates: Partial<ConciergusStreamConfig>) => void;
        streamText: (
            prompt: string,
            options?: {
                model?: string;
                system?: string;
                temperature?: number;
                maxTokens?: number;
                tools?: Record<string, any>;
            },
        ) => Promise<string>;
        isStreaming: boolean;
        currentText: string;
        streamingSpeed: number;
        completionProgress: number;
        stopStreaming: () => void;
        pauseStreaming: () => void;
        resumeStreaming: () => void;
        onStreamStart: (callback: () => void) => void;
        onStreamUpdate: (callback: (text: string, delta: string) => void) => void;
        onStreamComplete: (callback: (finalText: string) => void) => void;
        onStreamError: (callback: (error: Error) => void) => void;
        getStreamingMetrics: () => {
            totalStreams: number;
            averageSpeed: number;
            totalCharacters: number;
            averageDuration: number;
            errorRate: number;
        };
    }
    Index

    Properties

    updateConfig: (updates: Partial<ConciergusStreamConfig>) => void
    streamText: (
        prompt: string,
        options?: {
            model?: string;
            system?: string;
            temperature?: number;
            maxTokens?: number;
            tools?: Record<string, any>;
        },
    ) => Promise<string>
    isStreaming: boolean
    currentText: string
    streamingSpeed: number
    completionProgress: number
    stopStreaming: () => void
    pauseStreaming: () => void
    resumeStreaming: () => void
    onStreamStart: (callback: () => void) => void
    onStreamUpdate: (callback: (text: string, delta: string) => void) => void
    onStreamComplete: (callback: (finalText: string) => void) => void
    onStreamError: (callback: (error: Error) => void) => void
    getStreamingMetrics: () => {
        totalStreams: number;
        averageSpeed: number;
        totalCharacters: number;
        averageDuration: number;
        errorRate: number;
    }