/** * 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 { SearchResultHitTextMatchInfo } from './SearchResultHitTextMatchInfo.js'; import type { SearchResultHitHybridSearchInfo } from './SearchResultHitHybridSearchInfo.js'; import type { SearchHighlight } from './SearchHighlight.js'; /** * * @export * @interface SearchResultHit */ export interface SearchResultHit { /** * (Deprecated) Contains highlighted portions of the search fields * @type {Array} * @memberof SearchResultHit */ highlights?: Array; /** * Highlighted version of the matching document * @type {{ [key: string]: any; }} * @memberof SearchResultHit */ highlight?: { [key: string]: any; }; /** * Can be any key-value pair * @type {{ [key: string]: object; }} * @memberof SearchResultHit */ document?: { [key: string]: object; }; /** * * @type {number} * @memberof SearchResultHit */ textMatch?: number; /** * * @type {SearchResultHitTextMatchInfo} * @memberof SearchResultHit */ textMatchInfo?: SearchResultHitTextMatchInfo; /** * Can be any key-value pair * @type {{ [key: string]: number; }} * @memberof SearchResultHit */ geoDistanceMeters?: { [key: string]: number; }; /** * Distance between the query vector and matching document's vector value * @type {number} * @memberof SearchResultHit */ vectorDistance?: number; /** * * @type {SearchResultHitHybridSearchInfo} * @memberof SearchResultHit */ hybridSearchInfo?: SearchResultHitHybridSearchInfo; /** * Returned only for union query response. Indicates the index of the query which this document matched to. * @type {number} * @memberof SearchResultHit */ searchIndex?: number; } /** * Check if a given object implements the SearchResultHit interface. */ export declare function instanceOfSearchResultHit(value: object): value is SearchResultHit; export declare function SearchResultHitFromJSON(json: any): SearchResultHit; export declare function SearchResultHitFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchResultHit; export declare function SearchResultHitToJSON(json: any): SearchResultHit; export declare function SearchResultHitToJSONTyped(value?: SearchResultHit | null, ignoreDiscriminator?: boolean): any;