weaviate-ts-client/dist/index.d.ts

TypeScript client for Weaviate

import { Variables } from 'graphql-request';

interface NearMediaBase {
    certainty?: number;
    distance?: number;
    targetVectors?: string[];
}
interface NearAudioArgs extends NearMediaBase {
    audio: string;
}
interface NearVideoArgs extends NearMediaBase {
    video: string;
}
interface NearThermalArgs extends NearMediaBase {
    thermal: string;
}
interface NearDepthArgs extends NearMediaBase {
    depth: string;
}
interface NearIMUArgs extends NearMediaBase {
    imu: string;
}

interface NearTextArgs {
    autocorrect?: boolean;
    certainty?: number;
    concepts: string[];
    distance?: number;
    moveAwayFrom?: Move;
    moveTo?: Move;
    targetVectors?: string[];
}
interface Move {
    objects?: MoveObject[];
    concepts?: string[];
    force?: number;
}
interface MoveObject {
    beacon?: string;
    id?: string;
}

interface NearVectorArgs {
    certainty?: number;
    distance?: number;
    vector: number[];
    targetVectors?: string[];
}

interface NearObjectArgs {
    beacon?: string;
    certainty?: number;
    distance?: number;
    id?: string;
    targetVectors?: string[];
}

interface HttpClient {
    patch: (path: string, payload: any, bearerToken?: string) => any;
    head: (path: string, payload: any, bearerToken?: string) => any;
    post: (path: string, payload: any, expectReturnContent?: boolean, bearerToken?: string) => any;
    get: (path: string, expectReturnContent?: boolean, bearerToken?: string) => any;
    externalPost: (externalUrl: string, body: any, contentType: any) => any;
    getRaw: (path: string, bearerToken?: string) => any;
    delete: (path: string, payload: any, expectReturnContent?: boolean, bearerToken?: string) => any;
    put: (path: string, payload: any, expectReturnContent?: boolean, bearerToken?: string) => any;
    externalGet: (externalUrl: string) => Promise<any>;
}

interface AuthenticatorResult {
    accessToken: string;
    expiresAt: number;
    refreshToken: string;
}
interface OidcCredentials {
    silentRefresh: boolean;
}
interface OidcAuthFlow {
    refresh: () => Promise<AuthenticatorResult>;
}
declare class OidcAuthenticator {
    private readonly http;
    private readonly creds;
    private accessToken;
    private refreshToken?;
    private expiresAt;
    private refreshRunning;
    private refreshInterval;
    constructor(http: HttpClient, creds: any);
    refresh: (localConfig: any) => Promise<void>;
    getOpenidConfig: (localConfig: any) => Promise<{
        clientId: any;
        provider: any;
        scopes: any;
    }>;
    startTokenRefresh: (authenticator: {
        refresh: () => any;
    }) => void;
    stopTokenRefresh: () => void;
    refreshTokenProvided: () => boolean | "" | undefined;
    getAccessToken: () => string;
    getExpiresAt: () => number;
    resetExpiresAt(): void;
}
interface UserPasswordCredentialsInput {
    username: string;
    password?: string;
    scopes?: any[];
    silentRefresh?: boolean;
}
declare class AuthUserPasswordCredentials implements OidcCredentials {
    private username;
    private password?;
    private scopes?;
    readonly silentRefresh: boolean;
    constructor(creds: UserPasswordCredentialsInput);
}
interface AccessTokenCredentialsInput {
    accessToken: string;
    expiresIn: number;
    refreshToken?: string;
    silentRefresh?: boolean;
}
declare class AuthAccessTokenCredentials implements OidcCredentials {
    readonly accessToken: string;
    readonly expiresAt: number;
    readonly refreshToken?: string;
    readonly silentRefresh: boolean;
    constructor(creds: AccessTokenCredentialsInput);
    validate: (creds: AccessTokenCredentialsInput) => void;
}
interface ClientCredentialsInput {
    clientSecret: string;
    scopes?: any[];
    silentRefresh?: boolean;
}
declare class AuthClientCredentials implements OidcCredentials {
    private clientSecret;
    private scopes?;
    readonly silentRefresh: boolean;
    constructor(creds: ClientCredentialsInput);
}
declare class ApiKey {
    readonly apiKey: string;
    constructor(apiKey: string);
}

declare class Connection {
    private apiKey?;
    private authEnabled;
    private gql;
    readonly host: string;
    readonly http: HttpClient;
    oidcAuth?: OidcAuthenticator;
    constructor(params: ConnectionParams);
    private parseAuthParams;
    private sanitizeParams;
    post: (path: string, payload: any, expectReturnContent?: boolean) => any;
    put: (path: string, payload: any, expectReturnContent?: boolean) => any;
    patch: (path: string, payload: any) => any;
    delete: (path: string, payload: any, expectReturnContent?: boolean) => any;
    head: (path: string, payload: any) => any;
    get: (path: string, expectReturnContent?: boolean) => any;
    query: (query: any, variables?: Variables) => Promise<{
        data: any;
    }>;
    login: () => Promise<string>;
}

interface ICommandBase {
    /**
     * The client's connection
     */
    client: Connection;
    /**
     * An array of validation errors
     */
    errors: string[];
    /**
     * Execute the command
     */
    do: () => Promise<any>;
    /**
     * Optional method to build the payload of an actual call
     */
    payload?: () => any;
    /**
     * validate that all the required parameters were feed to the builder
     */
    validate: () => void;
}
declare abstract class CommandBase implements ICommandBase {
    private _errors;
    readonly client: Connection;
    protected constructor(client: Connection);
    get errors(): string[];
    addError(error: string): void;
    addErrors(errors: string[]): void;
    abstract do(): Promise<any>;
    abstract validate(): void;
}

interface definitions {
    Link: {
        /** @description target of the link */
        href?: string;
        /** @description relationship if both resources are related, e.g. 'next', 'previous', 'parent', etc. */
        rel?: string;
        /** @description human readable name of the resource group */
        name?: string;
        /** @description weaviate documentation about this resource group */
        documentationHref?: string;
    };
    Principal: {
        /** @description The username that was extracted either from the authentication information */
        username?: string;
        groups?: string[];
    };
    /** @description An array of available words and contexts. */
    C11yWordsResponse: {
        /** @description Weighted results for all words */
        concatenatedWord?: {
            concatenatedWord?: string;
            singleWords?: unknown[];
            concatenatedVector?: definitions['C11yVector'];
            concatenatedNearestNeighbors?: definitions['C11yNearestNeighbors'];
        };
        /** @description Weighted results for per individual word */
        individualWords?: {
            word?: string;
            present?: boolean;
            info?: {
                vector?: definitions['C11yVector'];
                nearestNeighbors?: definitions['C11yNearestNeighbors'];
            };
        }[];
    };
    /** @description A resource describing an extension to the contextinoary, containing both the identifier and the definition of the extension */
    C11yExtension: {
        /**
         * @description The new concept you want to extend. Must be an all-lowercase single word, or a space delimited compound word. Examples: 'foobarium', 'my custom concept'
         * @example foobarium
         */
        concept?: string;
        /** @description A list of space-delimited words or a sentence describing what the custom concept is about. Avoid using the custom concept itself. An Example definition for the custom concept 'foobarium': would be 'a naturally occurring element which can only be seen by programmers' */
        definition?: string;
        /**
         * Format: float
         * @description Weight of the definition of the new concept where 1='override existing definition entirely' and 0='ignore custom definition'. Note that if the custom concept is not present in the contextionary yet, the weight cannot be less than 1.
         */
        weight?: number;
    };
    /** @description C11y function to show the nearest neighbors to a word. */
    C11yNearestNeighbors: {
        word?: string;
        /** Format: float */
        distance?: number;
    }[];
    /** @description A Vector in the Contextionary */
    C11yVector: number[];
    /** @description A Vector object */
    Vector: number[];
    /** @description A Multi Vector map of named vectors */
    Vectors: {
        [key: string]: definitions['Vector'];
    };
    /** @description Receive question based on array of classes, properties and values. */
    C11yVectorBasedQuestion: {
        /** @description Vectorized classname. */
        classVectors?: number[];
        /** @description Vectorized properties. */
        classProps?: {
            propsVectors?: number[];
            /** @description String with valuename. */
            value?: string;
        }[];
    }[];
    Deprecation: {
        /** @description The id that uniquely identifies this particular deprecations (mostly used internally) */
        id?: string;
        /** @description Whether the problematic API functionality is deprecated (planned to be removed) or already removed */
        status?: string;
        /** @description Describes which API is effected, usually one of: REST, GraphQL */
        apiType?: string;
        /** @description What this deprecation is about */
        msg?: string;
        /** @description User-required object to not be affected by the (planned) removal */
        mitigation?: string;
        /** @description The deprecation was introduced in this version */
        sinceVersion?: string;
        /** @description A best-effort guess of which upcoming version will remove the feature entirely */
        plannedRemovalVersion?: string;
        /** @description If the feature has already been removed, it was removed in this version */
        removedIn?: string;
        /**
         * Format: date-time
         * @description If the feature has already been removed, it was removed at this timestamp
         */
        removedTime?: string;
        /**
         * Format: date-time
         * @description The deprecation was introduced in this version
         */
        sinceTime?: string;
        /** @description The locations within the specified API affected by this deprecation */
        locations?: string[];
    };
    /** @description An error response given by Weaviate end-points. */
    ErrorResponse: {
        error?: {
            message?: string;
        }[];
    };
    /** @description An error response caused by a GraphQL query. */
    GraphQLError: {
        locations?: {
            /** Format: int64 */
            column?: number;
            /** Format: int64 */
            line?: number;
        }[];
        message?: string;
        path?: string[];
    };
    /** @description GraphQL query based on: http://facebook.github.io/graphql/. */
    GraphQLQuery: {
        /** @description The name of the operation if multiple exist in the query. */
        operationName?: string;
        /** @description Query based on GraphQL syntax. */
        query?: string;
        /** @description Additional variables for the query. */
        variables?: {
            [key: string]: unknown;
        };
    };
    /** @description A list of GraphQL queries. */
    GraphQLQueries: definitions['GraphQLQuery'][];
    /** @description GraphQL based response: http://facebook.github.io/graphql/. */
    GraphQLResponse: {
        /** @description GraphQL data object. */
        data?: {
            [key: string]: definitions['JsonObject'];
        };
        /** @description Array with errors. */
        errors?: definitions['GraphQLError'][];
    };
    /** @description A list of GraphQL responses. */
    GraphQLResponses: definitions['GraphQLResponse'][];
    /** @description Configure the inverted index built into Weaviate */
    InvertedIndexConfig: {
        /**
         * Format: int
         * @description Asynchronous index clean up happens every n seconds
         */
        cleanupIntervalSeconds?: number;
        bm25?: definitions['BM25Config'];
        stopwords?: definitions['StopwordConfig'];
        /** @description Index each object by its internal timestamps */
        indexTimestamps?: boolean;
        /** @description Index each object with the null state */
        indexNullState?: boolean;
        /** @description Index length of properties */
        indexPropertyLength?: boolean;
    };
    /** @description Configure how replication is executed in a cluster */
    ReplicationConfig: {
        /** @description Number of times a class is replicated */
        factor?: number;
    };
    /** @description tuning parameters for the BM25 algorithm */
    BM25Config: {
        /**
         * Format: float
         * @description calibrates term-weight scaling based on the term frequency within a document
         */
        k1?: number;
        /**
         * Format: float
         * @description calibrates term-weight scaling based on the document length
         */
        b?: number;
    };
    /** @description fine-grained control over stopword list usage */
    StopwordConfig: {
        /** @description pre-existing list of common words by language */
        preset?: string;
        /** @description stopwords to be considered additionally */
        additions?: string[];
        /** @description stopwords to be removed from consideration */
        removals?: string[];
    };
    /** @description Configuration related to multi-tenancy within a class */
    MultiTenancyConfig: {
        /** @description Whether or not multi-tenancy is enabled for this class */
        enabled?: boolean;
        /** @description Nonexistent tenants should (not) be created implicitly */
        autoTenantCreation?: boolean;
    };
    /** @description JSON object value. */
    JsonObject: {
        [key: string]: unknown;
    };
    /** @description Contains meta information of the current Weaviate instance. */
    Meta: {
        /**
         * Format: url
         * @description The url of the host.
         */
        hostname?: string;
        /** @description Version of weaviate you are currently running */
        version?: string;
        /** @description Module-specific meta information */
        modules?: {
            [key: string]: unknown;
        };
    };
    /** @description Multiple instances of references to other objects. */
    MultipleRef: definitions['SingleRef'][];
    /** @description Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396). */
    PatchDocumentObject: {
        /** @description A string containing a JSON Pointer value. */
        from?: string;
        /**
         * @description The operation to be performed.
         * @enum {string}
         */
        op: 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test';
        /** @description A JSON-Pointer. */
        path: string;
        /** @description The value to be used within the operations. */
        value?: {
            [key: string]: unknown;
        };
        merge?: definitions['Object'];
    };
    /** @description Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396). */
    PatchDocumentAction: {
        /** @description A string containing a JSON Pointer value. */
        from?: string;
        /**
         * @description The operation to be performed.
         * @enum {string}
         */
        op: 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test';
        /** @description A JSON-Pointer. */
        path: string;
        /** @description The value to be used within the operations. */
        value?: {
            [key: string]: unknown;
        };
        merge?: definitions['Object'];
    };
    /** @description A single peer in the network. */
    PeerUpdate: {
        /**
         * Format: uuid
         * @description The session ID of the peer.
         */
        id?: string;
        /** @description Human readable name. */
        name?: string;
        /**
         * Format: uri
         * @description The location where the peer is exposed to the internet.
         */
        uri?: string;
        /** @description The latest known hash of the peer's schema. */
        schemaHash?: string;
    };
    /** @description List of known peers. */
    PeerUpdateList: definitions['PeerUpdate'][];
    /** @description Allow custom overrides of vector weights as math expressions. E.g. "pancake": "7" will set the weight for the word pancake to 7 in the vectorization, whereas "w * 3" would triple the originally calculated word. This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value (string/string) object. */
    VectorWeights: {
        [key: string]: unknown;
    };
    /** @description This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value OR a SingleRef definition. */
    PropertySchema: {
        [key: string]: unknown;
    };
    /** @description This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value OR a SingleRef definition. */
    SchemaHistory: {
        [key: string]: unknown;
    };
    /** @description Definitions of semantic schemas (also see: https://github.com/weaviate/weaviate-semantic-schemas). */
    Schema: {
        /** @description Semantic classes that are available. */
        classes?: definitions['Class'][];
        /**
         * Format: email
         * @description Email of the maintainer.
         */
        maintainer?: string;
        /** @description Name of the schema. */
        name?: string;
    };
    /** @description Indicates the health of the schema in a cluster. */
    SchemaClusterStatus: {
        /** @description True if the cluster is in sync, false if there is an issue (see error). */
        healthy?: boolean;
        /** @description Contains the sync check error if one occurred */
        error?: string;
        /** @description Hostname of the coordinating node, i.e. the one that received the cluster. This can be useful information if the error message contains phrases such as 'other nodes agree, but local does not', etc. */
        hostname?: string;
        /**
         * Format: int
         * @description Number of nodes that participated in the sync check
         */
        nodeCount?: number;
        /** @description The cluster check at startup can be ignored (to recover from an out-of-sync situation). */
        ignoreSchemaSync?: boolean;
    };
    Class: {
        /** @description Name of the class as URI relative to the schema URL. */
        class?: string;
        vectorConfig?: {
            [key: string]: definitions['VectorConfig'];
        };
        /** @description Name of the vector index to use, eg. (HNSW) */
        vectorIndexType?: string;
        /** @description Vector-index config, that is specific to the type of index selected in vectorIndexType */
        vectorIndexConfig?: {
            [key: string]: unknown;
        };
        /** @description Manage how the index should be sharded and distributed in the cluster */
        shardingConfig?: {
            [key: string]: unknown;
        };
        replicationConfig?: definitions['ReplicationConfig'];
        invertedIndexConfig?: definitions['InvertedIndexConfig'];
        multiTenancyConfig?: definitions['MultiTenancyConfig'];
        /** @description Specify how the vectors for this class should be determined. The options are either 'none' - this means you have to import a vector with each object yourself - or the name of a module that provides vectorization capabilities, such as 'text2vec-contextionary'. If left empty, it will use the globally configured default which can itself either be 'none' or a specific module. */
        vectorizer?: string;
        /** @description Configuration specific to modules this Weaviate instance has installed */
        moduleConfig?: {
            [key: string]: unknown;
        };
        /** @description Description of the class. */
        description?: string;
        /** @description The properties of the class. */
        properties?: definitions['Property'][];
    };
    Property: {
        /** @description Can be a reference to another type when it starts with a capital (for example Person), otherwise "string" or "int". */
        dataType?: string[];
        /** @description Description of the property. */
        description?: string;
        /** @description Configuration specific to modules this Weaviate instance has installed */
        moduleConfig?: {
            [key: string]: unknown;
        };
        /** @description Name of the property as URI relative to the schema URL. */
        name?: string;
        /** @description Optional. Should this property be indexed in the inverted index. Defaults to true. If you choose false, you will not be able to use this property in where filters, bm25 or hybrid search. This property has no affect on vectorization decisions done by modules (deprecated as of v1.19; use indexFilterable or/and indexSearchable instead) */
        indexInverted?: boolean;
        /** @description Optional. Should this property be indexed in the inverted index. Defaults to true. If you choose false, you will not be able to use this property in where filters. This property has no affect on vectorization decisions done by modules */
        indexFilterable?: boolean;
        /** @description Optional. Should this property be indexed in the inverted index. Defaults to true. Applicable only to properties of data type text and text[]. If you choose false, you will not be able to use this property in bm25 or hybrid search. This property has no affect on vectorization decisions done by modules */
        indexSearchable?: boolean;
        /**
         * @description Determines tokenization of the property as separate words or whole field. Optional. Applies to text and text[] data types. Allowed values are `word` (default; splits on any non-alphanumerical, lowercases), `lowercase` (splits on white spaces, lowercases), `whitespace` (splits on white spaces), `field` (trims). Not supported for remaining data types
         * @enum {string}
         */
        tokenization?: 'word' | 'lowercase' | 'whitespace' | 'field' | 'trigram' | 'gse';
        /** @description The properties of the nested object(s). Applies to object and object[] data types. */
        nestedProperties?: definitions['NestedProperty'][];
    };
    VectorConfig: {
        /** @description Configuration of a specific vectorizer used by this vector */
        vectorizer?: {
            [key: string]: unknown;
        };
        /** @description Name of the vector index to use, eg. (HNSW) */
        vectorIndexType?: string;
        /** @description Vector-index config, that is specific to the type of index selected in vectorIndexType */
        vectorIndexConfig?: {
            [key: string]: unknown;
        };
    };
    NestedProperty: {
        dataType?: string[];
        description?: string;
        name?: string;
        indexFilterable?: boolean;
        indexSearchable?: boolean;
        /** @enum {string} */
        tokenization?: 'word' | 'lowercase' | 'whitespace' | 'field';
        nestedProperties?: definitions['NestedProperty'][];
    };
    /** @description The status of all the shards of a Class */
    ShardStatusList: definitions['ShardStatusGetResponse'][];
    /** @description Response body of shard status get request */
    ShardStatusGetResponse: {
        /** @description Name of the shard */
        name?: string;
        /** @description Status of the shard */
        status?: string;
        /** @description Size of the vector queue of the shard */
        vectorQueueSize?: number;
    };
    /** @description The status of a single shard */
    ShardStatus: {
        /** @description Status of the shard */
        status?: string;
    };
    /** @description The definition of a backup create metadata */
    BackupCreateStatusResponse: {
        /** @description The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed. */
        id?: string;
        /** @description Backup backend name e.g. filesystem, gcs, s3. */
        backend?: string;
        /** @description destination path of backup files proper to selected backend */
        path?: string;
        /** @description error message if creation failed */
        error?: string;
        /**
         * @description phase of backup creation process
         * @default STARTED
         * @enum {string}
         */
        status?: 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'SUCCESS' | 'FAILED';
    };
    /** @description The definition of a backup restore metadata */
    BackupRestoreStatusResponse: {
        /** @description The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed. */
        id?: string;
        /** @description Backup backend name e.g. filesystem, gcs, s3. */
        backend?: string;
        /** @description destination path of backup files proper to selected backup backend */
        path?: string;
        /** @description error message if restoration failed */
        error?: string;
        /**
         * @description phase of backup restoration process
         * @default STARTED
         * @enum {string}
         */
        status?: 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'SUCCESS' | 'FAILED';
    };
    /** @description Backup custom configuration */
    BackupConfig: {
        /**
         * @description Desired CPU core utilization ranging from 1%-80%
         * @default 50
         */
        CPUPercentage?: number;
        /**
         * @description Weaviate will attempt to come close the specified size, with a minimum of 2MB, default of 128MB, and a maximum of 512MB
         * @default 128
         */
        ChunkSize?: number;
        /**
         * @description compression level used by compression algorithm
         * @default DefaultCompression
         * @enum {string}
         */
        CompressionLevel?: 'DefaultCompression' | 'BestSpeed' | 'BestCompression';
    };
    /** @description Backup custom configuration */
    RestoreConfig: {
        /**
         * @description Desired CPU core utilization ranging from 1%-80%
         * @default 50
         */
        CPUPercentage?: number;
    };
    /** @description Request body for creating a backup of a set of classes */
    BackupCreateRequest: {
        /** @description The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed. */
        id?: string;
        /** @description Custom configuration for the backup creation process */
        config?: definitions['BackupConfig'];
        /** @description List of classes to include in the backup creation process */
        include?: string[];
        /** @description List of classes to exclude from the backup creation process */
        exclude?: string[];
    };
    /** @description The definition of a backup create response body */
    BackupCreateResponse: {
        /** @description The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed. */
        id?: string;
        /** @description The list of classes for which the backup creation process was started */
        classes?: string[];
        /** @description Backup backend name e.g. filesystem, gcs, s3. */
        backend?: string;
        /** @description destination path of backup files proper to selected backend */
        path?: string;
        /** @description error message if creation failed */
        error?: string;
        /**
         * @description phase of backup creation process
         * @default STARTED
         * @enum {string}
         */
        status?: 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'SUCCESS' | 'FAILED';
    };
    /** @description Request body for restoring a backup for a set of classes */
    BackupRestoreRequest: {
        /** @description Custom configuration for the backup restoration process */
        config?: definitions['RestoreConfig'];
        /** @description List of classes to include in the backup restoration process */
        include?: string[];
        /** @description List of classes to exclude from the backup restoration process */
        exclude?: string[];
        /** @description Allows overriding the node names stored in the backup with different ones. Useful when restoring backups to a different environment. */
        node_mapping?: {
            [key: string]: string;
        };
    };
    /** @description The definition of a backup restore response body */
    BackupRestoreResponse: {
        /** @description The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed. */
        id?: string;
        /** @description The list of classes for which the backup restoration process was started */
        classes?: string[];
        /** @description Backup backend name e.g. filesystem, gcs, s3. */
        backend?: string;
        /** @description destination path of backup files proper to selected backend */
        path?: string;
        /** @description error message if restoration failed */
        error?: string;
        /**
         * @description phase of backup restoration process
         * @default STARTED
         * @enum {string}
         */
        status?: 'STARTED' | 'TRANSFERRING' | 'TRANSFERRED' | 'SUCCESS' | 'FAILED';
    };
    /** @description The summary of Weaviate's statistics. */
    NodeStats: {
        /**
         * Format: int
         * @description The count of Weaviate's shards.
         */
        shardCount?: number;
        /**
         * Format: int64
         * @description The total number of objects in DB.
         */
        objectCount?: number;
    };
    /** @description The summary of a nodes batch queue congestion status. */
    BatchStats: {
        /**
         * Format: int
         * @description How many objects are currently in the batch queue.
         */
        queueLength?: number;
        /**
         * Format: int
         * @description How many objects are approximately processed from the batch queue per second.
         */
        ratePerSecond?: number;
    };
    /** @description The definition of a node shard status response body */
    NodeShardStatus: {
        /** @description The name of the shard. */
        name?: string;
        /** @description The name of shard's class. */
        class?: string;
        /**
         * Format: int64
         * @description The number of objects in shard.
         */
        objectCount?: number;
        /**
         * Format: string
         * @description The status of the vector indexing process.
         */
        vectorIndexingStatus?: unknown;
        /**
         * Format: boolean
         * @description The status of vector compression/quantization.
         */
        compressed?: unknown;
        /**
         * Format: int64
         * @description The length of the vector indexing queue.
         */
        vectorQueueLength?: number;
        /** @description The load status of the shard. */
        loaded?: boolean;
    };
    /** @description The definition of a backup node status response body */
    NodeStatus: {
        /** @description The name of the node. */
        name?: string;
        /**
         * @description Node's status.
         * @default HEALTHY
         * @enum {string}
         */
        status?: 'HEALTHY' | 'UNHEALTHY' | 'UNAVAILABLE' | 'TIMEOUT';
        /** @description The version of Weaviate. */
        version?: string;
        /** @description The gitHash of Weaviate. */
        gitHash?: string;
        /** @description Weaviate overall statistics. */
        stats?: definitions['NodeStats'];
        /** @description Weaviate batch statistics. */
        batchStats?: definitions['BatchStats'];
        /** @description The list of the shards with it's statistics. */
        shards?: definitions['NodeShardStatus'][];
    };
    /** @description The status of all of the Weaviate nodes */
    NodesStatusResponse: {
        nodes?: definitions['NodeStatus'][];
    };
    /** @description The definition of Raft statistics. */
    RaftStatistics: {
        appliedIndex?: string;
        commitIndex?: string;
        fsmPending?: string;
        lastContact?: string;
        lastLogIndex?: string;
        lastLogTerm?: string;
        lastSnapshotIndex?: string;
        lastSnapshotTerm?: string;
        /** @description Weaviate Raft nodes. */
        latestConfiguration?: {
            [key: string]: unknown;
        };
        latestConfigurationIndex?: string;
        numPeers?: string;
        protocolVersion?: string;
        protocolVersionMax?: string;
        protocolVersionMin?: string;
        snapshotVersionMax?: string;
        snapshotVersionMin?: string;
        state?: string;
        term?: string;
    };
    /** @description The definition of node statistics. */
    Statistics: {
        /** @description The name of the node. */
        name?: string;
        /**
         * @description Node's status.
         * @default HEALTHY
         * @enum {string}
         */
        status?: 'HEALTHY' | 'UNHEALTHY' | 'UNAVAILABLE' | 'TIMEOUT';
        bootstrapped?: boolean;
        dbLoaded?: boolean;
        /** Format: uint64 */
        initialLastAppliedIndex?: number;
        lastAppliedIndex?: number;
        isVoter?: boolean;
        leaderId?: {
            [key: string]: unknown;
        };
        leaderAddress?: {
            [key: string]: unknown;
        };
        open?: boolean;
        ready?: boolean;
        candidates?: {
            [key: string]: unknown;
        };
        /** @description Weaviate Raft statistics. */
        raft?: definitions['RaftStatistics'];
    };
    /** @description The cluster statistics of all of the Weaviate nodes */
    ClusterStatisticsResponse: {
        statistics?: definitions['Statistics'][];
        synchronized?: boolean;
    };
    /** @description Either set beacon (direct reference) or set class and schema (concept reference) */
    SingleRef: {
        /**
         * Format: uri
         * @description If using a concept reference (rather than a direct reference), specify the desired class name here
         */
        class?: string;
        /** @description If using a concept reference (rather than a direct reference), specify the desired properties here */
        schema?: definitions['PropertySchema'];
        /**
         * Format: uri
         * @description If using a direct reference, specify the URI to point to the cross-ref here. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-ref to an object
         */
        beacon?: string;
        /**
         * Format: uri
         * @description If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise.
         */
        href?: string;
        /** @description Additional Meta information about classifications if the item was part of one */
        classification?: definitions['ReferenceMetaClassification'];
    };
    /** @description Additional Meta information about a single object object. */
    AdditionalProperties: {
        [key: string]: {
            [key: string]: unknown;
        };
    };
    /** @description This meta field contains additional info about the classified reference property */
    ReferenceMetaClassification: {
        /**
         * Format: int64
         * @description overall neighbors checked as part of the classification. In most cases this will equal k, but could be lower than k - for example if not enough data was present
         */
        overallCount?: number;
        /**
         * Format: int64
         * @description size of the winning group, a number between 1..k
         */
        winningCount?: number;
        /**
         * Format: int64
         * @description size of the losing group, can be 0 if the winning group size equals k
         */
        losingCount?: number;
        /**
         * Format: float32
         * @description The lowest distance of any neighbor, regardless of whether they were in the winning or losing group
         */
        closestOverallDistance?: number;
        /**
         * Format: float32
         * @description deprecated - do not use, to be removed in 0.23.0
         */
        winningDistance?: number;
        /**
         * Format: float32
         * @description Mean distance of all neighbors from the winning group
         */
        meanWinningDistance?: number;
        /**
         * Format: float32
         * @description Closest distance of a neighbor from the winning group
         */
        closestWinningDistance?: number;
        /**
         * Format: float32
         * @description The lowest distance of a neighbor in the losing group. Optional. If k equals the size of the winning group, there is no losing group
         */
        closestLosingDistance?: number;
        /**
         * Format: float32
         * @description deprecated - do not use, to be removed in 0.23.0
         */
        losingDistance?: number;
        /**
         * Format: float32
         * @description Mean distance of all neighbors from the losing group. Optional. If k equals the size of the winning group, there is no losing group.
         */
        meanLosingDistance?: number;
    };
    BatchReference: {
        /**
         * Format: uri
         * @description Long-form beacon-style URI to identify the source of the cross-ref including the property name. Should be in the form of weaviate://localhost/<kinds>/<uuid>/<className>/<propertyName>, where <kinds> must be one of 'objects', 'objects' and <className> and <propertyName> must represent the cross-ref property of source class to be used.
         * @example weaviate://localhost/Zoo/a5d09582-4239-4702-81c9-92a6e0122bb4/hasAnimals
         */
        from?: string;
        /**
         * Format: uri
         * @description Short-form URI to point to the cross-ref. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-ref to an object
         * @example weaviate://localhost/97525810-a9a5-4eb0-858a-71449aeb007f
         */
        to?: string;
        /** @description Name of the reference tenant. */
        tenant?: string;
    };
    BatchReferenceResponse: definitions['BatchReference'] & {
        /**
         * Format: object
         * @description Results for this specific reference.
         */
        result?: {
            /**
             * @default SUCCESS
             * @enum {string}
             */
            status?: 'SUCCESS' | 'PENDING' | 'FAILED';
            errors?: definitions['ErrorResponse'];
        };
    };
    GeoCoordinates: {
        /**
         * Format: float
         * @description The latitude of the point on earth in decimal form
         */
        latitude?: number;
        /**
         * Format: float
         * @description The longitude of the point on earth in decimal form
         */
        longitude?: number;
    };
    PhoneNumber: {
        /** @description The raw input as the phone number is present in your raw data set. It will be parsed into the standardized formats if valid. */
        input?: string;
        /** @description Read-only. Parsed result in the international format (e.g. +49 123 ...) */
        internationalFormatted?: string;
        /** @description Optional. The ISO 3166-1 alpha-2 country code. This is used to figure out the correct countryCode and international format if only a national number (e.g. 0123 4567) is provided */
        defaultCountry?: string;
        /**
         * Format: uint64
         * @description Read-only. The numerical country code (e.g. 49)
         */
        countryCode?: number;
        /**
         * Format: uint64
         * @description Read-only. The numerical representation of the national part
         */
        national?: number;
        /** @description Read-only. Parsed result in the national format (e.g. 0123 456789) */
        nationalFormatted?: string;
        /** @description Read-only. Indicates whether the parsed number is a valid phone number */
        valid?: boolean;
    };
    Object: {
        /** @description Class of the Object, defined in the schema. */
        class?: string;
        vectorWeights?: definitions['VectorWeights'];
        properties?: definitions['PropertySchema'];
        /**
         * Format: uuid
         * @description ID of the Object.
         */
        id?: string;
        /**
         * Format: int64
         * @description Timestamp of creation of this Object in milliseconds since epoch UTC.
         */
        creationTimeUnix?: number;
        /**
         * Format: int64
         * @description Timestamp of the last Object update in milliseconds since epoch UTC.
         */
        lastUpdateTimeUnix?: number;
        /** @description This field returns vectors associated with the Object. C11yVector, Vector or Vectors values are possible. */
        vector?: definitions['C11yVector'];
        /** @description This field returns vectors associated with the Object. */
        vectors?: definitions['Vectors'];
        /** @description Name of the Objects tenant. */
        tenant?: string;
        additional?: definitions['AdditionalProperties'];
    };
    ObjectsGetResponse: definitions['Object'] & {
        deprecations?: definitions['Deprecation'][];
    } & {
        /**
         * Format: object
         * @description Results for this specific Object.
         */
        result?: {
            /**
             * @default SUCCESS
             * @enum {string}
             */
            status?: 'SUCCESS' | 'PENDING' | 'FAILED';
            errors?: definitions['ErrorResponse'];
        };
    };
    BatchDelete: {
        /** @description Outlines how to find the objects to be deleted. */
        match?: {
            /**
             * @description Class (name) which objects will be deleted.
             * @example City
             */
            class?: string;
            /** @description Filter to limit the objects to be deleted. */
            where?: definitions['WhereFilter'];
        };
        /**
         * @description Controls the verbosity of the output, possible values are: "minimal", "verbose". Defaults to "minimal".
         * @default minimal
         */
        output?: string;
        /**
         * @description If true, objects will not be deleted yet, but merely listed. Defaults to false.
         * @default false
         */
        dryRun?: boolean;
    };
    /** @description Delete Objects response. */
    BatchDeleteResponse: {
        /** @description Outlines how to find the objects to be deleted. */
        match?: {
            /**
             * @description Class (name) which objects will be deleted.
             * @example City
             */
            class?: string;
            /** @description Filter to limit the objects to be deleted. */
            where?: definitions['WhereFilter'];
        };
        /**
         * @description Controls the verbosity of the output, possible values are: "minimal", "verbose". Defaults to "minimal".
         * @default minimal
         */
        output?: string;
        /**
         * @description If true, objects will not be deleted yet, but merely listed. Defaults to false.
         * @default false
         */
        dryRun?: boolean;
        results?: {
            /**
             * Format: int64
             * @description How many objects were matched by the filter.
             */
            matches?: number;
            /**
             * Format: int64
             * @description The most amount of objects that can be deleted in a single query, equals QUERY_MAXIMUM_RESULTS.
             */
            limit?: number;
            /**
             * Format: int64
             * @description How many objects were successfully deleted in this round.
             */
            successful?: number;
            /**
             * Format: int64
             * @description How many objects should have been deleted but could not be deleted.
             */
            failed?: number;
            /** @description With output set to "minimal" only objects with error occurred will the be described. Successfully deleted objects would be omitted. Output set to "verbose" will list all of the objets with their respective statuses. */
            objects?: {
                /**
                 * Format: uuid
                 * @description ID of the Object.
                 */
                id?: string;
                /**
                 * @default SUCCESS
                 * @enum {string}
                 */
                status?: 'SUCCESS' | 'DRYRUN' | 'FAILED';
                errors?: definitions['ErrorResponse'];
            }[];
        };
    };
    /** @description List of Objects. */
    ObjectsListResponse: {
        /** @description The actual list of Objects. */
        objects?: definitions['Object'][];
        deprecations?: definitions['Deprecation'][];
        /**
         * Format: int64
         * @description The total number of Objects for the query. The number of items in a response may be smaller due to paging.
         */
        totalResults?: number;
    };
    /** @description Manage classifications, trigger them and view status of past classifications. */
    Classification: {
        /**
         * Format: uuid
         * @description ID to uniquely identify this classification run
         * @example ee722219-b8ec-4db1-8f8d-5150bb1a9e0c
         */
        id?: string;
        /**
         * @description class (name) which is used in this classification
         * @example City
         */
        class?: string;
        /**
         * @description which ref-property to set as part of the classification
         * @example [
         *   "inCountry"
         * ]
         */
        classifyProperties?: string[];
        /**
         * @description base the text-based classification on these fields (of type text)
         * @example [
         *   "description"
         * ]
         */
        basedOnProperties?: string[];
        /**
         * @description status of this classification
         * @example running
         * @enum {string}
         */
        status?: 'running' | 'completed' | 'failed';
        /** @description additional meta information about the classification */
        meta?: definitions['ClassificationMeta'];
        /** @description which algorithm to use for classifications */
        type?: string;
        /** @description classification-type specific settings */
        settings?: {
            [key: string]: unknown;
        };
        /**
         * @description error message if status == failed
         * @default
         * @example classify xzy: something went wrong
         */
        error?: string;
        filters?: {
            /** @description limit the objects to be classified */
            sourceWhere?: definitions['WhereFilter'];
            /** @description Limit the training objects to be considered during the classification. Can only be used on types with explicit training sets, such as 'knn' */
            trainingSetWhere?: definitions['WhereFilter'];
            /** @description Limit the possible sources when using an algorithm which doesn't really on training data, e.g. 'contextual'. When using an algorithm with a training set, such as 'knn', limit the training set instead */
            targetWhere?: definitions['WhereFilter'];
        };
    };
    /** @description Additional information to a specific classification */
    ClassificationMeta: {
        /**
         * Format: date-time
         * @description time when this classification was started
         * @example 2017-07-21T17:32:28Z
         */
        started?: string;
        /**
         * Format: date-time
         * @description time when this classification finished
         * @example 2017-07-21T17:32:28Z
         */
        completed?: string;
        /**
         * @description number of objects which were taken into consideration for classification
         * @example 147
         */
        count?: number;
        /**
         * @description number of objects successfully classified
         * @example 140
         */
        countSucceeded?: number;
        /**
         * @description number of objects which could not be classified - see error message for details
         * @example 7
         */
        countFailed?: number;
    };
    /** @description Filter search results using a where filter */
    WhereFilter: {
        /** @description combine multiple where filters, requires 'And' or 'Or' operator */
        operands?: definitions['WhereFilter'][];
        /**
         * @description operator to use
         * @example GreaterThanEqual
         * @enum {string}
         */
        operator?: 'And' | 'Or' | 'Equal' | 'Like' | 'NotEqual' | 'GreaterThan' | 'GreaterThanEqual' | 'LessThan' | 'LessThanEqual' | 'WithinGeoRange' | 'IsN