Hiyve Components - v1.0.0
    Preparing search index...

    Interface AskOptions

    Options for RAG (ask) queries

    interface AskOptions {
        dateRange?: { end?: string | Date; start?: string | Date };
        limit?: number;
        maxContext?: number;
        model?: string;
        recordingId?: string;
        roomName?: string;
        roomNames?: string[];
        sources?: ("transcriptions" | "documents")[];
        threshold?: number;
        userId?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    dateRange? limit? maxContext? model? recordingId? roomName? roomNames? sources? threshold? userId?

    Properties

    dateRange?: { end?: string | Date; start?: string | Date }

    Filter by date range

    limit?: number

    Maximum results to return (default: 20)

    maxContext?: number

    Maximum context chunks to include (default: 10)

    model?: string

    AI model to use

    recordingId?: string

    Recording ID for scoping transcription search

    roomName?: string

    Room name for scoping

    roomNames?: string[]

    Filter by room names

    sources?: ("transcriptions" | "documents")[]

    Filter by source types

    threshold?: number

    Minimum similarity threshold 0-1 (default: 0.5)

    userId?: string

    User ID for scoping

    Settings

    Member Visibility

    On This Page

    Properties