/** * 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 MultiSearchResultItem */ export interface MultiSearchResultItem { /** * * @type {Array} * @memberof MultiSearchResultItem */ facetCounts?: Array; /** * The number of documents found * @type {number} * @memberof MultiSearchResultItem */ found?: number; /** * * @type {number} * @memberof MultiSearchResultItem */ foundDocs?: number; /** * The number of milliseconds the search took * @type {number} * @memberof MultiSearchResultItem */ searchTimeMs?: number; /** * The total number of documents in the collection * @type {number} * @memberof MultiSearchResultItem */ outOf?: number; /** * Whether the search was cut off * @type {boolean} * @memberof MultiSearchResultItem */ searchCutoff?: boolean; /** * The search result page number * @type {number} * @memberof MultiSearchResultItem */ page?: number; /** * * @type {Array} * @memberof MultiSearchResultItem */ groupedHits?: Array; /** * The documents that matched the search query * @type {Array} * @memberof MultiSearchResultItem */ hits?: Array; /** * * @type {SearchRequestParams} * @memberof MultiSearchResultItem */ requestParams?: SearchRequestParams; /** * * @type {SearchResultConversation} * @memberof MultiSearchResultItem */ conversation?: SearchResultConversation; /** * Returned only for union query response. * @type {Array} * @memberof MultiSearchResultItem */ unionRequestParams?: Array; /** * Custom JSON object that can be returned in the search response * @type {{ [key: string]: any; }} * @memberof MultiSearchResultItem */ metadata?: { [key: string]: any; }; /** * HTTP error code * @type {number} * @memberof MultiSearchResultItem */ code?: number; /** * Error description * @type {string} * @memberof MultiSearchResultItem */ error?: string; } /** * Check if a given object implements the MultiSearchResultItem interface. */ export declare function instanceOfMultiSearchResultItem(value: object): value is MultiSearchResultItem; export declare function MultiSearchResultItemFromJSON(json: any): MultiSearchResultItem; export declare function MultiSearchResultItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): MultiSearchResultItem; export declare function MultiSearchResultItemToJSON(json: any): MultiSearchResultItem; export declare function MultiSearchResultItemToJSONTyped(value?: MultiSearchResultItem | null, ignoreDiscriminator?: boolean): any;