@cpod/sdk - v0.2.7
    Preparing search index...

    Interface SearchRequest

    Request parameters for document search

    interface SearchRequest {
        query: string;
        viewMode?: ViewMode;
        sources?: string[] | null;
        entities?: string[] | null;
        fileHashes?: string[] | null;
        chunkIds?: string[] | null;
        page?: number;
        limit?: number;
        sortBy?: "relevance" | "date" | "source" | "chunk_index";
        sortOrder?: "asc" | "desc";
        includeContent?: boolean;
        includeEntities?: boolean;
        includeSummary?: boolean;
        userIds?: string[] | null;
        bypassPermissions?: boolean;
        exactMatch?: boolean;
    }
    Index

    Properties

    query viewMode? sources? entities? fileHashes? chunkIds? page? limit? sortBy? sortOrder? includeContent? includeEntities? includeSummary? userIds? bypassPermissions? exactMatch?

    Properties

    query: string

    Search query string (required)

    viewMode?: ViewMode

    View mode: files or projects

    sources?: string[] | null

    Filter by specific sources

    entities?: string[] | null

    Filter by entity names

    fileHashes?: string[] | null

    Filter by specific file hashes

    chunkIds?: string[] | null

    Filter by specific chunk IDs

    Optionalpage

    page?: number

    Page number (1-indexed, default: 1)

    limit?: number

    Maximum results to return (1-100, default: 10)

    sortBy?: "relevance" | "date" | "source" | "chunk_index"

    Sort order: "relevance" | "date" | "source" | "chunk_index" (default: "relevance")

    sortOrder?: "asc" | "desc"

    Sort direction

    includeContent?: boolean

    Include full content in results (default: true)

    includeEntities?: boolean

    Include entities in results (default: true)

    includeSummary?: boolean

    Include AI summary in results

    userIds?: string[] | null

    Filter results to specific users' data (admin only)

    bypassPermissions?: boolean

    Bypass source permission checks (admin only)

    exactMatch?: boolean

    Return only exact phrase matches (case-insensitive). Default: false

    Settings

    Member Visibility

    On This Page

    Properties