/**
 * Typesense API
 * An open source search engine for building delightful search experiences.
 *
 * The version of the OpenAPI document: 30.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { SearchRequestParams } from './SearchRequestParams.js';
import type { SearchGroupedHit } from './SearchGroupedHit.js';
import type { SearchResultConversation } from './SearchResultConversation.js';
import type { SearchResultHit } from './SearchResultHit.js';
import type { FacetCounts } from './FacetCounts.js';
/**
 *
 * @export
 * @interface SearchResult
 */
export interface SearchResult {
    /**
     *
     * @type {Array<FacetCounts>}
     * @memberof SearchResult
     */
    facetCounts?: Array<FacetCounts>;
    /**
     * The number of documents found
     * @type {number}
     * @memberof SearchResult
     */
    found?: number;
    /**
     *
     * @type {number}
     * @memberof SearchResult
     */
    foundDocs?: number;
    /**
     * The number of milliseconds the search took
     * @type {number}
     * @memberof SearchResult
     */
    searchTimeMs?: number;
    /**
     * The total number of documents in the collection
     * @type {number}
     * @memberof SearchResult
     */
    outOf?: number;
    /**
     * Whether the search was cut off
     * @type {boolean}
     * @memberof SearchResult
     */
    searchCutoff?: boolean;
    /**
     * The search result page number
     * @type {number}
     * @memberof SearchResult
     */
    page?: number;
    /**
     *
     * @type {Array<SearchGroupedHit>}
     * @memberof SearchResult
     */
    groupedHits?: Array<SearchGroupedHit>;
    /**
     * The documents that matched the search query
     * @type {Array<SearchResultHit>}
     * @memberof SearchResult
     */
    hits?: Array<SearchResultHit>;
    /**
     *
     * @type {SearchRequestParams}
     * @memberof SearchResult
     */
    requestParams?: SearchRequestParams;
    /**
     *
     * @type {SearchResultConversation}
     * @memberof SearchResult
     */
    conversation?: SearchResultConversation;
    /**
     * Returned only for union query response.
     * @type {Array<SearchRequestParams>}
     * @memberof SearchResult
     */
    unionRequestParams?: Array<SearchRequestParams>;
    /**
     * Custom JSON object that can be returned in the search response
     * @type {{ [key: string]: any; }}
     * @memberof SearchResult
     */
    metadata?: {
        [key: string]: any;
    };
}
/**
 * Check if a given object implements the SearchResult interface.
 */
export declare function instanceOfSearchResult(value: object): value is SearchResult;
export declare function SearchResultFromJSON(json: any): SearchResult;
export declare function SearchResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchResult;
export declare function SearchResultToJSON(json: any): SearchResult;
export declare function SearchResultToJSONTyped(value?: SearchResult | null, ignoreDiscriminator?: boolean): any;