Member Junction
    Preparing search index...

    Interface SearchStreamClientEvent

    One event of a streaming search (GraphQLSearchClient.StreamSearch), as the SearchStreamEvents subscription delivers it.

    interface SearchStreamClientEvent {
        DurationMs?: number;
        ElapsedMs?: number;
        ErrorMessage?: string;
        Phase: string;
        ProviderName?: string;
        ResultCount?: number;
        Results?: SearchClientResultItem[];
        SourceCounts?: {
            Entity: number;
            FullText: number;
            Storage: number;
            Vector: number;
        };
        StreamID: string;
    }
    Index

    Properties

    DurationMs? ElapsedMs? ErrorMessage? Phase ProviderName? ResultCount? Results? SourceCounts? StreamID

    Properties

    DurationMs?: number

    Set on provider events.

    ElapsedMs?: number

    Set on final events.

    ErrorMessage?: string

    Set on error events.

    Phase: string

    'provider' | 'fused' | 'reranked' | 'final' | 'error'

    ProviderName?: string

    Set on provider events (and on reranked, as the reranker's name).

    ResultCount?: number

    Set on provider events: how many hits that provider returned, capped at MaxResults.

    Results?: SearchClientResultItem[]

    Set on fused, reranked and final events. Always empty on a provider event: a provider's hits arrive before the server's permission pass, so they are never streamed.

    SourceCounts?: {
        Entity: number;
        FullText: number;
        Storage: number;
        Vector: number;
    }

    Set on final events.

    StreamID: string

    Settings

    Member Visibility

    On This Page

    Properties