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

    Interface ConciergusObjectStreamHookReturn

    interface ConciergusObjectStreamHookReturn {
        config: ConciergusStreamConfig;
        updateConfig: (updates: Partial<ConciergusStreamConfig>) => void;
        streamObject: <T>(
            schema: any,
            prompt: string,
            options?: {
                model?: string;
                output?: "object" | "array" | "no-schema";
                system?: string;
                temperature?: number;
            },
        ) => Promise<T>;
        isStreaming: boolean;
        currentObject: any;
        partialObject: any;
        arrayElements: any[];
        streamProgress: number;
        stopStreaming: () => void;
        onObjectStart: (callback: () => void) => void;
        onObjectUpdate: (callback: (partial: any) => void) => void;
        onObjectComplete: (callback: (final: any) => void) => void;
        onElementReceived: (
            callback: (element: any, index: number) => void,
        ) => void;
        onObjectError: (callback: (error: Error) => void) => void;
        getObjectStreamMetrics: () => {
            totalObjects: number;
            averageSize: number;
            averageDuration: number;
            errorRate: number;
        };
    }
    Index

    Properties

    updateConfig: (updates: Partial<ConciergusStreamConfig>) => void
    streamObject: <T>(
        schema: any,
        prompt: string,
        options?: {
            model?: string;
            output?: "object" | "array" | "no-schema";
            system?: string;
            temperature?: number;
        },
    ) => Promise<T>
    isStreaming: boolean
    currentObject: any
    partialObject: any
    arrayElements: any[]
    streamProgress: number
    stopStreaming: () => void
    onObjectStart: (callback: () => void) => void
    onObjectUpdate: (callback: (partial: any) => void) => void
    onObjectComplete: (callback: (final: any) => void) => void
    onElementReceived: (callback: (element: any, index: number) => void) => void
    onObjectError: (callback: (error: Error) => void) => void
    getObjectStreamMetrics: () => {
        totalObjects: number;
        averageSize: number;
        averageDuration: number;
        errorRate: number;
    }