KnowledgeOS API Reference
    Preparing search index...

    Interface SearchQuery

    interface SearchQuery {
        execute(): Promise<SDKResponse<SearchResponseDTO>>;
        executeRaw(): Promise<ApiResponse<SearchResponseDTO>>;
        fields(fields: string[]): SearchQuery;
        fuzzy(enabled?: boolean): SearchQuery;
        highlight(enabled?: boolean): SearchQuery;
        maxResults(n: number): SearchQuery;
        offset(n: number): SearchQuery;
        orderBy(field: "score" | "relevance" | "freshness"): SearchQuery;
    }

    Hierarchy (View Summary)

    Index
    • Parameters

      • fields: string[]

      Returns SearchQuery

    • Parameters

      • Optionalenabled: boolean

      Returns SearchQuery

    • Parameters

      • Optionalenabled: boolean

      Returns SearchQuery

    • Parameters

      • n: number

      Returns SearchQuery

    • Parameters

      • n: number

      Returns SearchQuery

    • Parameters

      • field: "score" | "relevance" | "freshness"

      Returns SearchQuery