/**
 * 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 { FieldEmbed } from './FieldEmbed.js';
/**
 *
 * @export
 * @interface Field
 */
export interface Field {
    /**
     *
     * @type {string}
     * @memberof Field
     */
    name: string;
    /**
     *
     * @type {string}
     * @memberof Field
     */
    type: string;
    /**
     *
     * @type {boolean}
     * @memberof Field
     */
    optional?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof Field
     */
    facet?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof Field
     */
    index?: boolean;
    /**
     *
     * @type {string}
     * @memberof Field
     */
    locale?: string;
    /**
     *
     * @type {boolean}
     * @memberof Field
     */
    sort?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof Field
     */
    infix?: boolean;
    /**
     * Name of a field in another collection that should be linked to this collection so that it can be joined during query.
     *
     * @type {string}
     * @memberof Field
     */
    reference?: string;
    /**
     * Allow documents to be indexed successfully even when the referenced document doesn't exist yet.
     *
     * @type {boolean}
     * @memberof Field
     */
    asyncReference?: boolean;
    /**
     *
     * @type {number}
     * @memberof Field
     */
    numDim?: number;
    /**
     *
     * @type {boolean}
     * @memberof Field
     */
    drop?: boolean;
    /**
     * When set to false, the field value will not be stored on disk. Default: true.
     *
     * @type {boolean}
     * @memberof Field
     */
    store?: boolean;
    /**
     * The distance metric to be used for vector search. Default: `cosine`. You can also use `ip` for inner product.
     *
     * @type {string}
     * @memberof Field
     */
    vecDist?: string;
    /**
     * Enables an index optimized for range filtering on numerical fields (e.g. rating:>3.5). Default: false.
     *
     * @type {boolean}
     * @memberof Field
     */
    rangeIndex?: boolean;
    /**
     * Values are stemmed before indexing in-memory. Default: false.
     *
     * @type {boolean}
     * @memberof Field
     */
    stem?: boolean;
    /**
     * Name of the stemming dictionary to use for this field
     * @type {string}
     * @memberof Field
     */
    stemDictionary?: string;
    /**
     * List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters.
     *
     * @type {Array<string>}
     * @memberof Field
     */
    tokenSeparators?: Array<string>;
    /**
     * List of symbols or special characters to be indexed.
     *
     * @type {Array<string>}
     * @memberof Field
     */
    symbolsToIndex?: Array<string>;
    /**
     *
     * @type {FieldEmbed}
     * @memberof Field
     */
    embed?: FieldEmbed;
}
/**
 * Check if a given object implements the Field interface.
 */
export declare function instanceOfField(value: object): value is Field;
export declare function FieldFromJSON(json: any): Field;
export declare function FieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): Field;
export declare function FieldToJSON(json: any): Field;
export declare function FieldToJSONTyped(value?: Field | null, ignoreDiscriminator?: boolean): any;