/** * 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 { Field } from './Field.js'; import type { VoiceQueryModelCollectionConfig } from './VoiceQueryModelCollectionConfig.js'; /** * * @export * @interface CollectionResponse */ export interface CollectionResponse { /** * Name of the collection * @type {string} * @memberof CollectionResponse */ name: string; /** * A list of fields for querying, filtering and faceting * @type {Array} * @memberof CollectionResponse */ fields: Array; /** * The name of an int32 / float field that determines the order in which the search results are ranked when a sort_by clause is not provided during searching. This field must indicate some kind of popularity. * @type {string} * @memberof CollectionResponse */ defaultSortingField?: 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} * @memberof CollectionResponse */ tokenSeparators?: Array; /** * List of synonym set names to associate with this collection * @type {Array} * @memberof CollectionResponse */ synonymSets?: Array; /** * Enables experimental support at a collection level for nested object or object array fields. This field is only available if the Typesense server is version `0.24.0.rcn34` or later. * @type {boolean} * @memberof CollectionResponse */ enableNestedFields?: boolean; /** * List of symbols or special characters to be indexed. * * @type {Array} * @memberof CollectionResponse */ symbolsToIndex?: Array; /** * * @type {VoiceQueryModelCollectionConfig} * @memberof CollectionResponse */ voiceQueryModel?: VoiceQueryModelCollectionConfig; /** * Optional details about the collection, e.g., when it was created, who created it etc. * * @type {object} * @memberof CollectionResponse */ metadata?: object; /** * Number of documents in the collection * @type {number} * @memberof CollectionResponse */ readonly numDocuments: number; /** * Timestamp of when the collection was created (Unix epoch in seconds) * @type {number} * @memberof CollectionResponse */ readonly createdAt: number; } /** * Check if a given object implements the CollectionResponse interface. */ export declare function instanceOfCollectionResponse(value: object): value is CollectionResponse; export declare function CollectionResponseFromJSON(json: any): CollectionResponse; export declare function CollectionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CollectionResponse; export declare function CollectionResponseToJSON(json: any): CollectionResponse; export declare function CollectionResponseToJSONTyped(value?: Omit | null, ignoreDiscriminator?: boolean): any;