/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ /** OneOf type helpers */ type Without = { [P in Exclude]?: never; }; type XOR = (T | U) extends object ? (Without & U) | (Without & T) : T | U; type OneOf = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? OneOf<[XOR, ...Rest]> : never; export interface paths { "/collections/{collection_name}/shards": { /** List shard keys */ get: operations["list_shard_keys"]; /** Create shard key */ put: operations["create_shard_key"]; }; "/collections/{collection_name}/shards/delete": { /** Delete shard key */ post: operations["delete_shard_key"]; }; "/": { /** * Returns information about the running Qdrant instance * @description Returns information about the running Qdrant instance like version and commit id */ get: operations["root"]; }; "/telemetry": { /** * Collect telemetry data * @description Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics */ get: operations["telemetry"]; }; "/metrics": { /** * Collect Prometheus metrics data * @description Collect metrics data including app info, collections info, cluster info and statistics */ get: operations["metrics"]; }; "/healthz": { /** * Kubernetes healthz endpoint * @description Liveness-style health check. Returns 200 as soon as the HTTP API is serving requests. It does not inspect collections, shards or consensus state, and is identical to `/livez`. Use it only to detect whether the process is up and responsive. */ get: operations["healthz"]; }; "/livez": { /** * Kubernetes livez endpoint * @description Kubernetes liveness probe. Returns 200 as soon as the HTTP API is serving requests. It does not inspect collections, shards or consensus state, and is identical to `/healthz`. A failure indicates the process is unresponsive and should be restarted. */ get: operations["livez"]; }; "/readyz": { /** * Kubernetes readyz endpoint * @description Kubernetes readiness probe. Checks the instance and waits out pending data operations to see when it can start accepting traffic. In a distributed deployment it returns 200 only once the node has caught up with the cluster consensus commit and its local shards are healthy; otherwise it returns 503. In a single-node deployment it always returns 200 once the API is up. Use it to decide when to route traffic to the instance. */ get: operations["readyz"]; }; "/issues": { /** * Get issues * @description Get a report of performance issues and configuration suggestions */ get: operations["get_issues"]; /** * Clear issues * @description Removes all issues reported so far */ delete: operations["clear_issues"]; }; "/cluster": { /** * Get cluster status info * @description Get information about the current state and composition of the cluster */ get: operations["cluster_status"]; }; "/cluster/telemetry": { /** * Collect cluster telemetry data * @description Get telemetry data, from the point of view of the cluster. This includes peers info, collections info, shard transfers, and resharding status */ get: operations["cluster_telemetry"]; }; "/cluster/recover": { /** Tries to recover current peer Raft state. */ post: operations["recover_current_peer"]; }; "/cluster/peer/{peer_id}": { /** * Remove peer from the cluster * @description Tries to remove peer from the cluster. Will return an error if peer has shards on it. */ delete: operations["remove_peer"]; }; "/quotas": { /** * Get global quotas * @description Get the cluster-wide resource quota configuration, together with the current utilization it is measured against. * The configuration is the same on every peer, but the reported utilization is for the node serving this request only - * memory and disk are node-local, so query each peer to see where the whole cluster stands. */ get: operations["get_quotas"]; /** * Set global quotas * @description Replace the cluster-wide resource quota configuration. The new configuration is propagated to every peer through consensus and persisted, so it survives restarts */ put: operations["update_quotas"]; }; "/collections": { /** * List collections * @description Get list name of all existing collections */ get: operations["get_collections"]; }; "/collections/{collection_name}": { /** * Collection info * @description Get detailed information about specified existing collection */ get: operations["get_collection"]; /** * Create collection * @description Create new collection with given parameters */ put: operations["create_collection"]; /** * Delete collection * @description Drop collection and all associated data */ delete: operations["delete_collection"]; /** * Update collection parameters * @description Update parameters of the existing collection */ patch: operations["update_collection"]; }; "/collections/aliases": { /** Update aliases of the collections */ post: operations["update_aliases"]; }; "/collections/{collection_name}/index": { /** * Create index for field in collection * @description Create index for field in collection */ put: operations["create_field_index"]; }; "/collections/{collection_name}/exists": { /** * Check the existence of a collection * @description Returns "true" if the given collection name exists, and "false" otherwise */ get: operations["collection_exists"]; }; "/collections/{collection_name}/index/{field_name}": { /** * Delete index for field in collection * @description Delete field index for collection */ delete: operations["delete_field_index"]; }; "/collections/{collection_name}/vectors/{vector_name}": { /** * Create named vector * @description Create a new named vector on an existing collection */ put: operations["create_vector_name"]; /** * Delete named vector * @description Delete a named vector from a collection */ delete: operations["delete_vector_name"]; }; "/collections/{collection_name}/cluster": { /** * Collection cluster info * @description Get cluster information for a collection */ get: operations["collection_cluster_info"]; /** Update collection cluster setup */ post: operations["update_collection_cluster"]; }; "/collections/{collection_name}/optimizations": { /** * Get optimization progress * @description Get progress of ongoing and completed optimizations for a collection */ get: operations["get_optimizations"]; }; "/collections/{collection_name}/aliases": { /** * List aliases for collection * @description Get list of all aliases for a collection */ get: operations["get_collection_aliases"]; }; "/aliases": { /** * List collections aliases * @description Get list of all existing collections aliases */ get: operations["get_collections_aliases"]; }; "/collections/{collection_name}/snapshots/upload": { /** * Recover from an uploaded snapshot * @description Recover local collection data from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created. */ post: operations["recover_from_uploaded_snapshot"]; }; "/collections/{collection_name}/snapshots/recover": { /** * Recover from a snapshot * @description Recover local collection data from a snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created. */ put: operations["recover_from_snapshot"]; }; "/collections/{collection_name}/snapshots": { /** * List collection snapshots * @description Get list of snapshots for a collection */ get: operations["list_snapshots"]; /** * Create collection snapshot * @description Create new snapshot for a collection */ post: operations["create_snapshot"]; }; "/collections/{collection_name}/snapshots/{snapshot_name}": { /** * Download collection snapshot * @description Download specified snapshot from a collection as a file */ get: operations["get_snapshot"]; /** * Delete collection snapshot * @description Delete snapshot for a collection */ delete: operations["delete_snapshot"]; }; "/snapshots": { /** * List of storage snapshots * @description Get list of snapshots of the whole storage */ get: operations["list_full_snapshots"]; /** * Create storage snapshot * @description Create new snapshot of the whole storage */ post: operations["create_full_snapshot"]; }; "/snapshots/{snapshot_name}": { /** * Download storage snapshot * @description Download specified snapshot of the whole storage as a file */ get: operations["get_full_snapshot"]; /** * Delete storage snapshot * @description Delete snapshot of the whole storage */ delete: operations["delete_full_snapshot"]; }; "/collections/{collection_name}/shards/{shard_id}/snapshot": { /** * Download shard snapshot * @description Stream the current state of a shard as a snapshot file */ get: operations["stream_shard_snapshot"]; }; "/collections/{collection_name}/shards/{shard_id}/snapshots/upload": { /** * Recover shard from an uploaded snapshot * @description Recover shard of a local collection from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection shard. */ post: operations["recover_shard_from_uploaded_snapshot"]; }; "/collections/{collection_name}/shards/{shard_id}/snapshots/recover": { /** * Recover from a snapshot * @description Recover shard of a local collection data from a snapshot. This will overwrite any data, stored in this shard, for the collection. */ put: operations["recover_shard_from_snapshot"]; }; "/collections/{collection_name}/shards/{shard_id}/snapshots": { /** * List shards snapshots for a collection * @description Get list of snapshots for a shard of a collection */ get: operations["list_shard_snapshots"]; /** * Create shard snapshot * @description Create new snapshot of a shard for a collection */ post: operations["create_shard_snapshot"]; }; "/collections/{collection_name}/shards/{shard_id}/snapshots/{snapshot_name}": { /** * Download collection snapshot * @description Download specified snapshot of a shard from a collection as a file */ get: operations["get_shard_snapshot"]; /** * Delete shard snapshot * @description Delete snapshot of a shard for a collection */ delete: operations["delete_shard_snapshot"]; }; "/collections/{collection_name}/points/{id}": { /** * Get point * @description Retrieve full information of single point by id */ get: operations["get_point"]; }; "/collections/{collection_name}/points": { /** * Upsert points * @description Perform insert + updates on points. If point with given ID already exists - it will be overwritten. */ put: operations["upsert_points"]; /** * Get points * @description Retrieve multiple points by specified IDs */ post: operations["get_points"]; }; "/collections/{collection_name}/points/delete": { /** * Delete points * @description Delete points */ post: operations["delete_points"]; }; "/collections/{collection_name}/points/vectors": { /** * Update vectors * @description Update specified named vectors on points, keep unspecified vectors intact. */ put: operations["update_vectors"]; }; "/collections/{collection_name}/points/vectors/delete": { /** * Delete vectors * @description Delete named vectors from the given points. */ post: operations["delete_vectors"]; }; "/collections/{collection_name}/points/payload": { /** * Overwrite payload * @description Replace full payload of points with new one */ put: operations["overwrite_payload"]; /** * Set payload * @description Set payload values for points */ post: operations["set_payload"]; }; "/collections/{collection_name}/points/payload/delete": { /** * Delete payload * @description Delete specified key payload for points */ post: operations["delete_payload"]; }; "/collections/{collection_name}/points/payload/clear": { /** * Clear payload * @description Remove all payload for specified points */ post: operations["clear_payload"]; }; "/collections/{collection_name}/points/batch": { /** * Batch update points * @description Apply a series of update operations for points, vectors and payloads */ post: operations["batch_update"]; }; "/collections/{collection_name}/points/scroll": { /** * Scroll points * @description Scroll request - paginate over all points which matches given filtering condition */ post: operations["scroll_points"]; }; "/collections/{collection_name}/points/count": { /** * Count points * @description Count points which matches given filtering condition */ post: operations["count_points"]; }; "/collections/{collection_name}/facet": { /** * Facet a payload key with a given filter. * @description Count points that satisfy the given filter for each unique value of a payload key. */ post: operations["facet"]; }; "/collections/{collection_name}/points/query": { /** * Query points * @description Universally query points. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries. */ post: operations["query_points"]; }; "/collections/{collection_name}/points/query/batch": { /** * Query points in batch * @description Universally query points in batch. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries. */ post: operations["query_batch_points"]; }; "/collections/{collection_name}/points/query/groups": { /** * Query points, grouped by a given payload field * @description Universally query points, grouped by a given payload field */ post: operations["query_points_groups"]; }; "/collections/{collection_name}/points/search/matrix/pairs": { /** * Search points matrix distance pairs * @description Compute distance matrix for sampled points with a pair based output format */ post: operations["search_matrix_pairs"]; }; "/collections/{collection_name}/points/search/matrix/offsets": { /** * Search points matrix distance offsets * @description Compute distance matrix for sampled points with an offset based output format */ post: operations["search_matrix_offsets"]; }; } export type webhooks = Record; export interface components { schemas: { ErrorResponse: { /** * Format: float * @description Time spent to process this request */ time?: number; status?: { /** @description Description of the occurred error. */ error?: string; }; result?: Record | null; }; /** * @example { * "collections": [ * { * "name": "arxiv-title" * }, * { * "name": "arxiv-abstract" * }, * { * "name": "medium-title" * }, * { * "name": "medium-text" * } * ] * } */ CollectionsResponse: { collections: (components["schemas"]["CollectionDescription"])[]; }; CollectionDescription: { name: string; }; /** @description Current statistics and configuration of the collection */ CollectionInfo: { status: components["schemas"]["CollectionStatus"]; optimizer_status: components["schemas"]["OptimizersStatus"]; /** @description Warnings related to the collection */ warnings?: (components["schemas"]["CollectionWarning"])[]; /** * Format: uint * @description Approximate number of indexed vectors in the collection. Indexed vectors in large segments are faster to query, as it is stored in a specialized vector index. */ indexed_vectors_count?: number | null; /** * Format: uint * @description Approximate number of points (vectors + payloads) in collection. Each point could be accessed by unique id. */ points_count?: number | null; /** * Format: uint * @description Number of segments in collection. Each segment has independent vector as payload indexes */ segments_count: number; config: components["schemas"]["CollectionConfig"]; /** @description Types of stored payload */ payload_schema: { [key: string]: components["schemas"]["PayloadIndexInfo"] | undefined; }; /** @description Update queue info */ update_queue?: components["schemas"]["UpdateQueueInfo"] | (Record | null); }; /** * @description Current state of the collection. `Green` - all good. `Yellow` - optimization is running, 'Grey' - optimizations are possible but not triggered, `Red` - some operations failed and was not recovered * @enum {string} */ CollectionStatus: "green" | "yellow" | "grey" | "red"; /** @description Current state of the collection */ OptimizersStatus: OneOf<[ "ok", { error: string; } ]>; CollectionWarning: { /** @description Warning message */ message: string; }; /** @description Information about the collection configuration */ CollectionConfig: { params: components["schemas"]["CollectionParams"]; hnsw_config: components["schemas"]["HnswConfig"]; optimizer_config: components["schemas"]["OptimizersConfig"]; wal_config?: components["schemas"]["WalConfig"] | (Record | null); /** @default null */ quantization_config?: components["schemas"]["QuantizationConfig"] | (Record | null); strict_mode_config?: components["schemas"]["StrictModeConfigOutput"] | (Record | null); /** @description Arbitrary JSON metadata for the collection This can be used to store application-specific information such as creation time, migration data, inference model info, etc. */ metadata?: components["schemas"]["Payload"] | (Record | null); }; CollectionParams: { vectors?: components["schemas"]["VectorsConfig"]; /** * Format: uint32 * @description Number of shards the collection has * @default 1 */ shard_number?: number; /** @description Sharding method Default is Auto - points are distributed across all available shards Custom - points are distributed across shards according to shard key */ sharding_method?: components["schemas"]["ShardingMethod"] | (Record | null); /** * Format: uint32 * @description Number of replicas for each shard * @default 1 */ replication_factor?: number; /** * Format: uint32 * @description Defines how many replicas should apply the operation for us to consider it successful. Increasing this number will make the collection more resilient to inconsistencies, but will also make it fail if not enough replicas are available. Does not have any performance impact. * @default 1 */ write_consistency_factor?: number; /** * Format: uint32 * @description Defines how many additional replicas should be processing read request at the same time. Default value is Auto, which means that fan-out will be determined automatically based on the busyness of the local replica. Having more than 0 might be useful to smooth latency spikes of individual nodes. */ read_fan_out_factor?: number | null; /** * Format: uint64 * @description Define number of milliseconds to wait before attempting to read from another replica. This setting can help to reduce latency spikes in case of occasional slow replicas. Default is 0, which means delayed fan out request is disabled. */ read_fan_out_delay_ms?: number | null; /** * @deprecated * @description Deprecated: use `payload.memory` instead. If true - point's payload will not be stored in memory. It will be read from the disk every time it is requested. This setting saves RAM by (slightly) increasing the response time. Note: those payload values that are involved in filtering and are indexed - remain in RAM. * * Default: true * @default true */ on_disk_payload?: boolean | null; /** @description Configuration of the payload storage */ payload?: components["schemas"]["PayloadStorageParams"] | (Record | null); /** @description Configuration of the sparse vector storage */ sparse_vectors?: ({ [key: string]: components["schemas"]["SparseVectorParams"] | undefined; }) | null; }; /** * @description Vector params separator for single and multiple vector modes Single mode: * * { "size": 128, "distance": "Cosine" } * * or multiple mode: * * { "default": { "size": 128, "distance": "Cosine" } } */ VectorsConfig: components["schemas"]["VectorParams"] | ({ [key: string]: components["schemas"]["VectorParams"] | undefined; }); /** @description Params of single vector data storage */ VectorParams: { /** * Format: uint64 * @description Size of a vectors used */ size: number; distance: components["schemas"]["Distance"]; /** @description Custom params for HNSW index. If none - values from collection configuration are used. */ hnsw_config?: components["schemas"]["HnswConfigDiff"] | (Record | null); /** @description Custom params for quantization. If none - values from collection configuration are used. */ quantization_config?: components["schemas"]["QuantizationConfig"] | (Record | null); /** * @deprecated * @description Deprecated: use `memory` instead. If true, vectors are served from disk, improving RAM usage at the cost of latency Default: false */ on_disk?: boolean | null; /** @description Memory placement of the original vector storage. Overrides the deprecated `on_disk` flag if both are set. `pinned` is not supported for dense vector storage. Default: `cached` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** * @description Defines which datatype should be used to represent vectors in the storage. Choosing different datatypes allows to optimize memory usage and performance vs accuracy. * * - For `float32` datatype - vectors are stored as single-precision floating point numbers, 4 bytes. - For `float16` datatype - vectors are stored as half-precision floating point numbers, 2 bytes. - For `uint8` datatype - vectors are stored as unsigned 8-bit integers, 1 byte. It expects vector elements to be in range `[0, 255]`. - For `turbo4` datatype - vectors are quantized to 4 bits per element using the TurboQuant algorithm. */ datatype?: components["schemas"]["Datatype"] | (Record | null); multivector_config?: components["schemas"]["MultiVectorConfig"] | (Record | null); }; /** * @description Type of internal tags, build from payload Distance function types used to compare vectors * @enum {string} */ Distance: "Cosine" | "Euclid" | "Dot" | "Manhattan"; HnswConfigDiff: { /** * Format: uint * @description Number of edges per node in the index graph. Larger the value - more accurate the search, more space required. */ m?: number | null; /** * Format: uint * @description Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index. */ ef_construct?: number | null; /** * Format: uint * @description Minimal size threshold (in KiloBytes) below which full-scan is preferred over HNSW search. This measures the total size of vectors being queried against. When the maximum estimated amount of points that a condition satisfies is smaller than `full_scan_threshold_kb`, the query planner will use full-scan search instead of HNSW index traversal for better performance. Note: 1Kb = 1 vector of size 256 */ full_scan_threshold?: number | null; /** * Format: uint * @description Number of parallel threads used for background index building. If 0 - automatically select from 8 to 16. Best to keep between 8 and 16 to prevent likelihood of building broken/inefficient HNSW graphs. On small CPUs, less threads are used. */ max_indexing_threads?: number | null; /** * @deprecated * @description Deprecated: use `memory` instead. Store HNSW index on disk. If set to false, the index will be stored in RAM. Default: false */ on_disk?: boolean | null; /** @description Memory placement of the HNSW graph. Overrides the deprecated `on_disk` flag if both are set. Default: `cached` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** * Format: uint * @description Custom M param for additional payload-aware HNSW links. If not set, default M will be used. */ payload_m?: number | null; /** @description Store copies of original and quantized vectors within the HNSW index file. Default: false. Enabling this option will trade the search speed for disk usage by reducing amount of random seeks during the search. Requires quantized vectors to be enabled. Multi-vectors are not supported. */ inline_storage?: boolean | null; }; /** * @description Memory placement of a component's data. * * Data is always persisted on disk regardless of this setting; it only controls how the data is held in RAM. * * Options: * * * `Cold` - Data is not pre-loaded from disk to RAM. Preferred for rarely queried components or components larger than RAM size. First request might be slow, but data is cached with usage. * * * `Cached` - Data is pre-loaded into disk-cache RAM on start. First request is fast, but data may be evicted if there is not enough memory and some other component's data is used more frequently. * * * `Pinned` - Data is loaded in RAM and never evicted. First request is fast, but the component must fit in RAM at all times. Recommended for frequently queried small components like quantized vectors or primary indexes. * @enum {string} */ Memory: "cold" | "cached" | "pinned"; QuantizationConfig: components["schemas"]["ScalarQuantization"] | components["schemas"]["ProductQuantization"] | components["schemas"]["BinaryQuantization"] | components["schemas"]["TurboQuantization"]; ScalarQuantization: { scalar: components["schemas"]["ScalarQuantizationConfig"]; }; ScalarQuantizationConfig: { type: components["schemas"]["ScalarType"]; /** * Format: float * @description Quantile for quantization. Expected value range in [0.5, 1.0]. If not set - use the whole range of values */ quantile?: number | null; /** * @deprecated * @description Deprecated: use `memory` instead. If true - quantized vectors always will be stored in RAM, ignoring the config of main storage */ always_ram?: boolean | null; /** @description Memory placement of quantized vectors. Overrides the deprecated `always_ram` flag if both are set. Default: follow the memory placement of the original vector storage. */ memory?: components["schemas"]["Memory"] | (Record | null); }; /** @enum {string} */ ScalarType: "int8"; ProductQuantization: { product: components["schemas"]["ProductQuantizationConfig"]; }; ProductQuantizationConfig: { compression: components["schemas"]["CompressionRatio"]; /** * @deprecated * @description Deprecated: use `memory` instead. */ always_ram?: boolean | null; /** @description Memory placement of quantized vectors. Overrides the deprecated `always_ram` flag if both are set. Default: follow the memory placement of the original vector storage. */ memory?: components["schemas"]["Memory"] | (Record | null); }; /** @enum {string} */ CompressionRatio: "x4" | "x8" | "x16" | "x32" | "x64"; BinaryQuantization: { binary: components["schemas"]["BinaryQuantizationConfig"]; }; BinaryQuantizationConfig: { /** * @deprecated * @description Deprecated: use `memory` instead. */ always_ram?: boolean | null; /** @description Memory placement of quantized vectors. Overrides the deprecated `always_ram` flag if both are set. Default: follow the memory placement of the original vector storage. */ memory?: components["schemas"]["Memory"] | (Record | null); encoding?: components["schemas"]["BinaryQuantizationEncoding"] | (Record | null); /** @description Asymmetric quantization configuration allows a query to have different quantization than stored vectors. It can increase the accuracy of search at the cost of performance. */ query_encoding?: components["schemas"]["BinaryQuantizationQueryEncoding"] | (Record | null); }; /** @enum {string} */ BinaryQuantizationEncoding: "one_bit" | "two_bits" | "one_and_half_bits"; /** @enum {string} */ BinaryQuantizationQueryEncoding: "default" | "binary" | "scalar4bits" | "scalar8bits"; TurboQuantization: { turbo: components["schemas"]["TurboQuantQuantizationConfig"]; }; TurboQuantQuantizationConfig: { /** * @deprecated * @description Deprecated: use `memory` instead. */ always_ram?: boolean | null; /** @description Memory placement of quantized vectors. Overrides the deprecated `always_ram` flag if both are set. Default: follow the memory placement of the original vector storage. */ memory?: components["schemas"]["Memory"] | (Record | null); bits?: components["schemas"]["TurboQuantBitSize"] | (Record | null); }; /** @enum {string} */ TurboQuantBitSize: "bits1" | "bits1_5" | "bits2" | "bits4"; /** @enum {string} */ Datatype: "float32" | "uint8" | "float16" | "turbo4"; MultiVectorConfig: { comparator: components["schemas"]["MultiVectorComparator"]; }; /** @enum {string} */ MultiVectorComparator: "max_sim"; /** @enum {string} */ ShardingMethod: "auto" | "custom"; /** @description Params of the payload storage */ PayloadStorageParams: { /** @description Memory placement of the payload storage. Overrides the deprecated `on_disk_payload` flag if both are set. `pinned` is not supported for payload storage. Default: `cold` (`cached` if `on_disk_payload` is set to false). */ memory?: components["schemas"]["Memory"] | (Record | null); }; /** @description Params of single sparse vector data storage */ SparseVectorParams: { /** @description Custom params for index. If none - values from collection configuration are used. */ index?: components["schemas"]["SparseIndexParams"] | (Record | null); /** @description Configures addition value modifications for sparse vectors. Default: none */ modifier?: components["schemas"]["Modifier"] | (Record | null); }; /** @description Configuration for sparse inverted index. */ SparseIndexParams: { /** * Format: uint * @description We prefer a full scan search upto (excluding) this number of vectors. * * Note: this is number of vectors, not KiloBytes. */ full_scan_threshold?: number | null; /** * @deprecated * @description Deprecated: use `memory` instead. Store index on disk. If set to false, the index will be stored in RAM. Default: false */ on_disk?: boolean | null; /** @description Memory placement of the index. Overrides the deprecated `on_disk` flag if both are set. Default: `pinned` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** * @description Defines which datatype should be used for the index. Choosing different datatypes allows to optimize memory usage and performance vs accuracy. * * - For `float32` datatype - vectors are stored as single-precision floating point numbers, 4 bytes. - For `float16` datatype - vectors are stored as half-precision floating point numbers, 2 bytes. - For `uint8` datatype - vectors are quantized to unsigned 8-bit integers, 1 byte. Quantization to fit byte range `[0, 255]` happens during indexing automatically, so the actual vector data does not need to conform to this range. */ datatype?: components["schemas"]["Datatype"] | (Record | null); }; /** * @description If used, include weight modification, which will be applied to sparse vectors at query time: None - no modification (default) Idf - inverse document frequency, based on statistics of the collection * @enum {string} */ Modifier: "none" | "idf"; /** @description Config of HNSW index */ HnswConfig: { /** * Format: uint * @description Number of edges per node in the index graph. Larger the value - more accurate the search, more space required. */ m: number; /** * Format: uint * @description Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build index. */ ef_construct: number; /** * Format: uint * @description Minimal size threshold (in KiloBytes) below which full-scan is preferred over HNSW search. This measures the total size of vectors being queried against. When the maximum estimated amount of points that a condition satisfies is smaller than `full_scan_threshold_kb`, the query planner will use full-scan search instead of HNSW index traversal for better performance. Note: 1Kb = 1 vector of size 256 */ full_scan_threshold: number; /** * Format: uint * @description Number of parallel threads used for background index building. If 0 - automatically select from 8 to 16. Best to keep between 8 and 16 to prevent likelihood of slow building or broken/inefficient HNSW graphs. On small CPUs, less threads are used. * @default 0 */ max_indexing_threads?: number; /** * @deprecated * @description Deprecated: use `memory` instead. Store HNSW index on disk. If set to false, index will be stored in RAM. Default: false */ on_disk?: boolean | null; /** @description Memory placement of the HNSW graph. Overrides the deprecated `on_disk` flag if both are set. Default: `cached` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** * Format: uint * @description Custom M param for hnsw graph built for payload index. If not set, default M will be used. */ payload_m?: number | null; /** @description Store copies of original and quantized vectors within the HNSW index file. Default: false. Enabling this option will trade the search speed for disk usage by reducing amount of random seeks during the search. Requires quantized vectors to be enabled. Multi-vectors are not supported. */ inline_storage?: boolean | null; }; OptimizersConfig: { /** * Format: double * @description The minimal fraction of deleted vectors in a segment, required to perform segment optimization * @default 0.2 */ deleted_threshold?: number; /** * Format: uint * @description The minimal number of vectors in a segment, required to perform segment optimization * @default 1000 */ vacuum_min_vector_number?: number; /** * Format: uint * @description Target amount of segments optimizer will try to keep. Real amount of segments may vary depending on multiple parameters: - Amount of stored points - Current write RPS * * It is recommended to select default number of segments as a factor of the number of search threads, so that each segment would be handled evenly by one of the threads. If `default_segment_number = 0`, will be automatically selected by the number of available CPUs. */ default_segment_number: number; /** * Format: uint * @description Do not create segments larger this size (in kilobytes). Large segments might require disproportionately long indexation times, therefore it makes sense to limit the size of segments. * * If indexing speed is more important - make this parameter lower. If search speed is more important - make this parameter higher. Note: 1Kb = 1 vector of size 256 If not set, will be automatically selected considering the number of available CPUs. * @default null */ max_segment_size?: number | null; /** * Format: uint * @deprecated * @description Maximum size (in kilobytes) of vectors to store in-memory per segment. Segments larger than this threshold will be stored as read-only memmapped file. * * Memmap storage is disabled by default, to enable it, set this threshold to a reasonable value. * * To disable memmap storage, set this to `0`. Internally it will use the largest threshold possible. * * Note: 1Kb = 1 vector of size 256 * @default null */ memmap_threshold?: number | null; /** * Format: uint * @description Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing * * Default value is 10,000, based on experiments and observations. * * To disable vector indexing, set to `0`. * * Note: 1kB = 1 vector of size 256. * @default null */ indexing_threshold?: number | null; /** * Format: uint64 * @description Minimum interval between forced flushes. */ flush_interval_sec: number; /** * Format: uint * @description Max number of threads (jobs) for running optimizations per shard. Note: each optimization job will also use `max_indexing_threads` threads by itself for index building. If null - have no limit and choose dynamically to saturate CPU. If 0 - no optimization threads, optimizations will be disabled. * @default null */ max_optimization_threads?: number | null; /** * @description If enabled, the service will try to prevent the creation of large unoptimized segments. When enabled, new points written to segments larger than the indexing threshold are stored as "deferred points": they are persisted in the WAL and segments, but excluded from read/search results until the corresponding segments are optimized (e.g. indexed, quantized, or moved to mmap storage). Update requests with `wait=true` will only return after the deferred points become visible, which may significantly increase the perceived latency between submitting an update and its completion. Update requests with `wait=false` are not affected. Default is disabled. * @default null */ prevent_unoptimized?: boolean | null; }; WalConfig: { /** * Format: uint * @description Size of a single WAL segment in MB */ wal_capacity_mb: number; /** * Format: uint * @description Number of WAL segments to create ahead of actually used ones */ wal_segments_ahead: number; /** * Format: uint * @description Number of closed WAL segments to keep * @default 1 */ wal_retain_closed?: number; }; StrictModeConfigOutput: { /** @description Whether strict mode is enabled for a collection or not. */ enabled?: boolean | null; /** * Format: uint * @description Max allowed `limit` parameter for all APIs that don't have their own max limit. */ max_query_limit?: number | null; /** * Format: uint * @description Max allowed `timeout` parameter. */ max_timeout?: number | null; /** @description Allow usage of unindexed fields in retrieval based (e.g. search) filters. */ unindexed_filtering_retrieve?: boolean | null; /** @description Allow usage of unindexed fields in filtered updates (e.g. delete by payload). */ unindexed_filtering_update?: boolean | null; /** * Format: uint * @description Max HNSW value allowed in search parameters. */ search_max_hnsw_ef?: number | null; /** @description Whether exact search is allowed or not. */ search_allow_exact?: boolean | null; /** * Format: double * @description Max oversampling value allowed in search. */ search_max_oversampling?: number | null; /** * Format: uint * @description Max batchsize when upserting */ upsert_max_batchsize?: number | null; /** * Format: uint * @description Max batchsize when searching */ search_max_batchsize?: number | null; /** * Format: uint * @description Max size of a collections vector storage in bytes, ignoring replicas. */ max_collection_vector_size_bytes?: number | null; /** * Format: uint * @description Max number of read operations per minute per replica */ read_rate_limit?: number | null; /** * Format: uint * @description Max number of write operations per minute per replica */ write_rate_limit?: number | null; /** * Format: uint * @description Max size of a collections payload storage in bytes */ max_collection_payload_size_bytes?: number | null; /** * Format: uint * @description Max number of points estimated in a collection */ max_points_count?: number | null; /** * Format: uint * @description Max conditions a filter can have. */ filter_max_conditions?: number | null; /** * Format: uint * @description Max size of a condition, eg. items in `MatchAny`. */ condition_max_size?: number | null; /** @description Multivector configuration */ multivector_config?: components["schemas"]["StrictModeMultivectorConfigOutput"] | (Record | null); /** @description Sparse vector configuration */ sparse_config?: components["schemas"]["StrictModeSparseConfigOutput"] | (Record | null); /** * Format: uint * @description Max number of payload indexes in a collection */ max_payload_index_count?: number | null; /** * Format: uint8 * @deprecated * @description Deprecated: use the node-wide quota config instead. Reject memory-consuming update operations when resident memory exceeds this percentage of total RAM (1-100) */ max_resident_memory_percent?: number | null; }; StrictModeMultivectorConfigOutput: { [key: string]: components["schemas"]["StrictModeMultivectorOutput"] | undefined; }; StrictModeMultivectorOutput: { /** * Format: uint * @description Max number of vectors in a multivector */ max_vectors?: number | null; }; StrictModeSparseConfigOutput: { [key: string]: components["schemas"]["StrictModeSparseOutput"] | undefined; }; StrictModeSparseOutput: { /** * Format: uint * @description Max length of sparse vector */ max_length?: number | null; }; /** * @example { * "city": "London", * "color": "green" * } */ Payload: { [key: string]: unknown; }; /** @description Display payload field type & index information */ PayloadIndexInfo: { data_type: components["schemas"]["PayloadSchemaType"]; params?: components["schemas"]["PayloadSchemaParams"] | (Record | null); /** * Format: uint * @description Number of points indexed with this index */ points: number; }; /** * @description All possible names of payload types * @enum {string} */ PayloadSchemaType: "keyword" | "integer" | "float" | "geo" | "text" | "bool" | "datetime" | "uuid"; /** @description Payload type with parameters */ PayloadSchemaParams: components["schemas"]["KeywordIndexParams"] | components["schemas"]["IntegerIndexParams"] | components["schemas"]["FloatIndexParams"] | components["schemas"]["GeoIndexParams"] | components["schemas"]["TextIndexParams"] | components["schemas"]["BoolIndexParams"] | components["schemas"]["DatetimeIndexParams"] | components["schemas"]["UuidIndexParams"]; KeywordIndexParams: { type: components["schemas"]["KeywordIndexType"]; /** @description If true - used for tenant optimization. Default: false. */ is_tenant?: boolean | null; /** * @deprecated * @description Deprecated: use `memory` instead. If true, store the index on disk. Default: false. */ on_disk?: boolean | null; /** @description Memory placement of the index. Overrides the deprecated `on_disk` flag if both are set. Default: `pinned` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** @description Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true. */ enable_hnsw?: boolean | null; /** @description If true, enable prefix matching (`match: { "prefix": ... }`) on this field. Default: false. */ prefix?: boolean | null; }; /** @enum {string} */ KeywordIndexType: "keyword"; IntegerIndexParams: { type: components["schemas"]["IntegerIndexType"]; /** @description If true - support direct lookups. Default is true. */ lookup?: boolean | null; /** @description If true - support ranges filters. Default is true. */ range?: boolean | null; /** @description If true - use this key to organize storage of the collection data. This option assumes that this key will be used in majority of filtered requests. Default is false. */ is_principal?: boolean | null; /** * @deprecated * @description Deprecated: use `memory` instead. If true, store the index on disk. Default: false. */ on_disk?: boolean | null; /** @description Memory placement of the index. Overrides the deprecated `on_disk` flag if both are set. Default: `pinned` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** @description Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true. */ enable_hnsw?: boolean | null; }; /** @enum {string} */ IntegerIndexType: "integer"; FloatIndexParams: { type: components["schemas"]["FloatIndexType"]; /** @description If true - use this key to organize storage of the collection data. This option assumes that this key will be used in majority of filtered requests. */ is_principal?: boolean | null; /** * @deprecated * @description Deprecated: use `memory` instead. If true, store the index on disk. Default: false. */ on_disk?: boolean | null; /** @description Memory placement of the index. Overrides the deprecated `on_disk` flag if both are set. Default: `pinned` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** @description Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true. */ enable_hnsw?: boolean | null; }; /** @enum {string} */ FloatIndexType: "float"; GeoIndexParams: { type: components["schemas"]["GeoIndexType"]; /** * @deprecated * @description Deprecated: use `memory` instead. If true, store the index on disk. Default: false. */ on_disk?: boolean | null; /** @description Memory placement of the index. Overrides the deprecated `on_disk` flag if both are set. Default: `pinned` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** @description Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true. */ enable_hnsw?: boolean | null; }; /** @enum {string} */ GeoIndexType: "geo"; TextIndexParams: { type: components["schemas"]["TextIndexType"]; tokenizer?: components["schemas"]["TokenizerType"]; /** * Format: uint * @description Minimum characters to be tokenized. */ min_token_len?: number | null; /** * Format: uint * @description Maximum characters to be tokenized. */ max_token_len?: number | null; /** @description If true, lowercase all tokens. Default: true. */ lowercase?: boolean | null; /** @description If true, normalize tokens by folding accented characters to ASCII (e.g., "ação" -> "acao"). Default: false. */ ascii_folding?: boolean | null; /** @description If true, support phrase matching. Default: false. */ phrase_matching?: boolean | null; /** @description Ignore this set of tokens. Can select from predefined languages and/or provide a custom set. */ stopwords?: components["schemas"]["StopwordsInterface"] | (Record | null); /** * @deprecated * @description Deprecated: use `memory` instead. If true, store the index on disk. Default: false. */ on_disk?: boolean | null; /** @description Memory placement of the index. Overrides the deprecated `on_disk` flag if both are set. Default: `pinned` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** @description Algorithm for stemming. Default: disabled. */ stemmer?: components["schemas"]["StemmingAlgorithm"] | (Record | null); /** @description Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true. */ enable_hnsw?: boolean | null; }; /** @enum {string} */ TextIndexType: "text"; /** @enum {string} */ TokenizerType: "prefix" | "whitespace" | "word" | "multilingual"; StopwordsInterface: components["schemas"]["Language"] | components["schemas"]["StopwordsSet"]; /** @enum {string} */ Language: "arabic" | "azerbaijani" | "basque" | "bengali" | "catalan" | "chinese" | "danish" | "dutch" | "english" | "finnish" | "french" | "german" | "greek" | "hebrew" | "hinglish" | "hungarian" | "indonesian" | "italian" | "japanese" | "kazakh" | "nepali" | "norwegian" | "portuguese" | "romanian" | "russian" | "slovene" | "spanish" | "swedish" | "tajik" | "turkish"; StopwordsSet: { /** @description Set of languages to use for stopwords. Multiple pre-defined lists of stopwords can be combined. */ languages?: (components["schemas"]["Language"])[] | null; /** @description Custom stopwords set. Will be merged with the languages set. */ custom?: (string)[] | null; }; /** @description Different stemming algorithms with their configs. */ StemmingAlgorithm: components["schemas"]["SnowballParams"] | components["schemas"]["DisabledStemmerParams"]; SnowballParams: { type: components["schemas"]["Snowball"]; language: components["schemas"]["SnowballLanguage"]; }; /** @enum {string} */ Snowball: "snowball"; /** * @description Languages supported by snowball stemmer. * @enum {string} */ SnowballLanguage: "arabic" | "armenian" | "danish" | "dutch" | "english" | "finnish" | "french" | "german" | "greek" | "hungarian" | "italian" | "norwegian" | "portuguese" | "romanian" | "russian" | "spanish" | "swedish" | "tamil" | "turkish"; DisabledStemmerParams: { type: components["schemas"]["NoStemmer"]; }; /** * @description Tag selecting the explicit "no stemming" algorithm. * @enum {string} */ NoStemmer: "none"; BoolIndexParams: { type: components["schemas"]["BoolIndexType"]; /** * @deprecated * @description Deprecated: use `memory` instead. If true, store the index on disk. Default: false. */ on_disk?: boolean | null; /** @description Memory placement of the index. Overrides the deprecated `on_disk` flag if both are set. Default: `pinned` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** @description Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true. */ enable_hnsw?: boolean | null; }; /** @enum {string} */ BoolIndexType: "bool"; DatetimeIndexParams: { type: components["schemas"]["DatetimeIndexType"]; /** @description If true - use this key to organize storage of the collection data. This option assumes that this key will be used in majority of filtered requests. */ is_principal?: boolean | null; /** * @deprecated * @description Deprecated: use `memory` instead. If true, store the index on disk. Default: false. */ on_disk?: boolean | null; /** @description Memory placement of the index. Overrides the deprecated `on_disk` flag if both are set. Default: `pinned` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** @description Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true. */ enable_hnsw?: boolean | null; }; /** @enum {string} */ DatetimeIndexType: "datetime"; UuidIndexParams: { type: components["schemas"]["UuidIndexType"]; /** @description If true - used for tenant optimization. */ is_tenant?: boolean | null; /** * @deprecated * @description Deprecated: use `memory` instead. If true, store the index on disk. Default: false. */ on_disk?: boolean | null; /** @description Memory placement of the index. Overrides the deprecated `on_disk` flag if both are set. Default: `pinned` (`cold` if `on_disk` is set to true). */ memory?: components["schemas"]["Memory"] | (Record | null); /** @description Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true. */ enable_hnsw?: boolean | null; }; /** @enum {string} */ UuidIndexType: "uuid"; UpdateQueueInfo: { /** * Format: uint * @description Number of elements in the queue */ length: number; /** * Format: uint * @description Number of points that are deferred (i.e hidden from search as they're not yet optimized). */ deferred_points?: number | null; }; PointRequest: { /** @description Specify in which shards to look for the points, if not specified - look in all shards */ shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); /** @description Look for points with ids */ ids: (components["schemas"]["ExtendedPointId"])[]; /** @description Select which payload to return with the response. Default is true. */ with_payload?: components["schemas"]["WithPayloadInterface"] | (Record | null); with_vector?: components["schemas"]["WithVector"]; }; ShardKeySelector: components["schemas"]["ShardKey"] | (components["schemas"]["ShardKey"])[] | components["schemas"]["ShardKeyWithFallback"]; ShardKey: string | number; ShardKeyWithFallback: { target: components["schemas"]["ShardKey"]; fallback: components["schemas"]["ShardKey"]; }; /** @description Type, used for specifying point ID in user interface */ ExtendedPointId: number | string; /** @description Options for specifying which payload to include or not */ WithPayloadInterface: boolean | (string)[] | components["schemas"]["PayloadSelector"]; /** @description Specifies how to treat payload selector */ PayloadSelector: components["schemas"]["PayloadSelectorInclude"] | components["schemas"]["PayloadSelectorExclude"]; PayloadSelectorInclude: { /** @description Only include this payload keys */ include: (string)[]; }; PayloadSelectorExclude: { /** @description Exclude this fields from returning payload */ exclude: (string)[]; }; /** @description Options for specifying which vector to include */ WithVector: boolean | (string)[]; /** @description Point data */ Record: { id: components["schemas"]["ExtendedPointId"]; /** @description Payload - values assigned to the point */ payload?: components["schemas"]["Payload"] | (Record | null); /** @description Vector of the point */ vector?: components["schemas"]["VectorStructOutput"] | (Record | null); /** @description Shard Key */ shard_key?: components["schemas"]["ShardKey"] | (Record | null); order_value?: components["schemas"]["OrderValue"] | (Record | null); }; /** @description Vector data stored in Point */ VectorStructOutput: (number)[] | ((number)[])[] | ({ [key: string]: components["schemas"]["VectorOutput"] | undefined; }); /** @description Vector Data stored in Point */ VectorOutput: (number)[] | components["schemas"]["SparseVector"] | ((number)[])[]; /** @description Sparse vector structure */ SparseVector: { /** @description Indices must be unique */ indices: (number)[]; /** @description Values and indices must be the same length */ values: (number)[]; }; OrderValue: number; /** @description Search result */ ScoredPoint: { id: components["schemas"]["ExtendedPointId"]; /** * Format: uint64 * @description Point version * @example 3 */ version: number; /** * Format: float * @description Points vector distance to the query vector * @example 0.75 */ score: number; /** @description Payload - values assigned to the point */ payload?: components["schemas"]["Payload"] | (Record | null); /** @description Vector of the point */ vector?: components["schemas"]["VectorStructOutput"] | (Record | null); /** @description Shard Key */ shard_key?: components["schemas"]["ShardKey"] | (Record | null); /** @description Order-by value */ order_value?: components["schemas"]["OrderValue"] | (Record | null); }; UpdateResult: { /** * Format: uint64 * @description Sequential number of the operation */ operation_id?: number | null; status: components["schemas"]["UpdateStatus"]; }; /** * @description `Acknowledged` - Request is saved to WAL and will be process in a queue. `Completed` - Request is completed, changes are actual. `WaitTimeout` - Request is waiting for timeout. * @enum {string} */ UpdateStatus: "acknowledged" | "completed" | "wait_timeout"; /** @description Scroll request - paginate over all points which matches given condition */ ScrollRequest: { /** @description Specify in which shards to look for the points, if not specified - look in all shards */ shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); /** @description Start ID to read points from. */ offset?: components["schemas"]["ExtendedPointId"] | (Record | null); /** * Format: uint * @description Page size. Default: 10 */ limit?: number | null; /** @description Look only for points which satisfies this conditions. If not provided - all points. */ filter?: components["schemas"]["Filter"] | (Record | null); /** @description Select which payload to return with the response. Default is true. */ with_payload?: components["schemas"]["WithPayloadInterface"] | (Record | null); with_vector?: components["schemas"]["WithVector"]; /** @description Order the records by a payload field. */ order_by?: components["schemas"]["OrderByInterface"] | (Record | null); }; Filter: { /** @description At least one of those conditions should match */ should?: components["schemas"]["Condition"] | (components["schemas"]["Condition"])[] | (Record | null); /** @description At least minimum amount of given conditions should match */ min_should?: components["schemas"]["MinShould"] | (Record | null); /** @description All conditions must match */ must?: components["schemas"]["Condition"] | (components["schemas"]["Condition"])[] | (Record | null); /** @description All conditions must NOT match */ must_not?: components["schemas"]["Condition"] | (components["schemas"]["Condition"])[] | (Record | null); }; Condition: components["schemas"]["FieldCondition"] | components["schemas"]["IsEmptyCondition"] | components["schemas"]["IsNullCondition"] | components["schemas"]["HasIdCondition"] | components["schemas"]["HasVectorCondition"] | components["schemas"]["SliceCondition"] | components["schemas"]["NestedCondition"] | components["schemas"]["Filter"]; /** @description All possible payload filtering conditions */ FieldCondition: { /** @description Payload key */ key: string; /** @description Check if point has field with a given value */ match?: components["schemas"]["Match"] | (Record | null); /** @description Check if points value lies in a given range */ range?: components["schemas"]["RangeInterface"] | (Record | null); /** @description Check if points geolocation lies in a given area */ geo_bounding_box?: components["schemas"]["GeoBoundingBox"] | (Record | null); /** @description Check if geo point is within a given radius */ geo_radius?: components["schemas"]["GeoRadius"] | (Record | null); /** @description Check if geo point is within a given polygon */ geo_polygon?: components["schemas"]["GeoPolygon"] | (Record | null); /** @description Check number of values of the field */ values_count?: components["schemas"]["ValuesCount"] | (Record | null); /** @description Check that the field is empty, alternative syntax for `is_empty: "field_name"` */ is_empty?: boolean | null; /** @description Check that the field is null, alternative syntax for `is_null: "field_name"` */ is_null?: boolean | null; }; /** @description Match filter request */ Match: components["schemas"]["MatchValue"] | components["schemas"]["MatchText"] | components["schemas"]["MatchTextAny"] | components["schemas"]["MatchPhrase"] | components["schemas"]["MatchPrefix"] | components["schemas"]["MatchAny"] | components["schemas"]["MatchExcept"]; /** @description Exact match of the given value */ MatchValue: { value: components["schemas"]["ValueVariants"]; }; ValueVariants: string | number | boolean; /** @description Full-text match of the strings. */ MatchText: { text: string; }; /** @description Full-text match of at least one token of the string. */ MatchTextAny: { text_any: string; }; /** @description Full-text phrase match of the string. */ MatchPhrase: { phrase: string; }; /** * @description Match keyword values that start with the given string. * * Byte-wise (hence, for valid UTF-8, character-wise) and case-sensitive, consistent with exact keyword matching. Served efficiently by a keyword index created with the `prefix` option. */ MatchPrefix: { prefix: string; }; /** @description Exact match on any of the given values */ MatchAny: { any: components["schemas"]["AnyVariants"]; }; AnyVariants: (string)[] | (number)[]; /** @description Should have at least one value not matching the any given values */ MatchExcept: { except: components["schemas"]["AnyVariants"]; }; RangeInterface: components["schemas"]["Range"] | components["schemas"]["DatetimeRange"]; /** @description Range filter request */ Range: { /** * Format: double * @description point.key < range.lt */ lt?: number | null; /** * Format: double * @description point.key > range.gt */ gt?: number | null; /** * Format: double * @description point.key >= range.gte */ gte?: number | null; /** * Format: double * @description point.key <= range.lte */ lte?: number | null; }; /** @description Range filter request */ DatetimeRange: { /** * Format: date-time * @description point.key < range.lt */ lt?: string | null; /** * Format: date-time * @description point.key > range.gt */ gt?: string | null; /** * Format: date-time * @description point.key >= range.gte */ gte?: string | null; /** * Format: date-time * @description point.key <= range.lte */ lte?: string | null; }; /** * @description Geo filter request * * Matches coordinates inside the rectangle, described by coordinates of lop-left and bottom-right edges */ GeoBoundingBox: { top_left: components["schemas"]["GeoPoint"]; bottom_right: components["schemas"]["GeoPoint"]; }; /** @description Geo point payload schema */ GeoPoint: { /** Format: double */ lon: number; /** Format: double */ lat: number; }; /** * @description Geo filter request * * Matches coordinates inside the circle of `radius` and center with coordinates `center` */ GeoRadius: { center: components["schemas"]["GeoPoint"]; /** * Format: double * @description Radius of the area in meters */ radius: number; }; /** * @description Geo filter request * * Matches coordinates inside the polygon, defined by `exterior` and `interiors` */ GeoPolygon: { exterior: components["schemas"]["GeoLineString"]; /** @description Interior lines (if present) bound holes within the surface each GeoLineString must consist of a minimum of 4 points, and the first and last points must be the same. */ interiors?: (components["schemas"]["GeoLineString"])[] | null; }; /** @description Ordered sequence of GeoPoints representing the line */ GeoLineString: { points: (components["schemas"]["GeoPoint"])[]; }; /** @description Values count filter request */ ValuesCount: { /** * Format: uint * @description point.key.length() < values_count.lt */ lt?: number | null; /** * Format: uint * @description point.key.length() > values_count.gt */ gt?: number | null; /** * Format: uint * @description point.key.length() >= values_count.gte */ gte?: number | null; /** * Format: uint * @description point.key.length() <= values_count.lte */ lte?: number | null; }; /** @description Select points with empty payload for a specified field */ IsEmptyCondition: { is_empty: components["schemas"]["PayloadField"]; }; /** @description Payload field */ PayloadField: { /** @description Payload field name */ key: string; }; /** @description Select points with null payload for a specified field */ IsNullCondition: { is_null: components["schemas"]["PayloadField"]; }; /** @description ID-based filtering condition */ HasIdCondition: { has_id: (components["schemas"]["ExtendedPointId"])[]; }; /** @description Filter points which have specific vector assigned */ HasVectorCondition: { has_vector: string; }; /** @description Select points that fall into one of `total` disjoint deterministic slices of the id space, for parallel scans and reproducible sampling. */ SliceCondition: { slice: components["schemas"]["Slice"]; }; /** * @description One of `total` disjoint deterministic slices of the id space. * * A point belongs to the slice iff `hash(id) % total == index`, where `hash` is SipHash-2-4 with a zero key over the canonical id bytes: 8 little-endian bytes for numeric ids, the 16 RFC 4122 bytes for UUIDs. For a fixed `total`, slices `0..total` are disjoint and together cover all points; membership is uniform regardless of the id scheme and stable across queries, segments, platforms and Qdrant versions. * * Slices with different `total` values are correlated (same hash, no salt): e.g. slice `0` of `total: 4` is a strict subset of slice `0` of `total: 2`. This keeps a smaller sample contained in a larger one. */ Slice: { /** * Format: uint32 * @description Total number of disjoint slices the id space is split into */ total: number; /** * Format: uint32 * @description Which slice to select, must be in `0..total` */ index: number; }; NestedCondition: { nested: components["schemas"]["Nested"]; }; /** @description Select points with payload for a specified nested field */ Nested: { key: string; filter: components["schemas"]["Filter"]; }; MinShould: { conditions: (components["schemas"]["Condition"])[]; /** Format: uint */ min_count: number; }; OrderByInterface: string | components["schemas"]["OrderBy"]; OrderBy: { /** @description Payload key to order by */ key: string; /** @description Direction of ordering: `asc` or `desc`. Default is ascending. */ direction?: components["schemas"]["Direction"] | (Record | null); /** @description Which payload value to start scrolling from. Default is the lowest value for `asc` and the highest for `desc` */ start_from?: components["schemas"]["StartFrom"] | (Record | null); }; /** @enum {string} */ Direction: "asc" | "desc"; StartFrom: number | string; /** @description Result of the points read request */ ScrollResult: { /** * @description List of retrieved points * @example [ * { * "id": 40, * "payload": { * "city": "London", * "color": "green" * }, * "vector": [ * 0.875, * 0.140625, * 0.897599995136261 * ], * "shard_key": "region_1" * }, * { * "id": 41, * "payload": { * "city": "Paris", * "color": "red" * }, * "vector": [ * 0.75, * 0.640625, * 0.8945000171661377 * ], * "shard_key": "region_1" * } * ] */ points: (components["schemas"]["Record"])[]; /** @description Offset which should be used to retrieve a next page result */ next_page_offset?: components["schemas"]["ExtendedPointId"] | (Record | null); }; /** @description Operation for creating new collection and (optionally) specify index params */ CreateCollection: { vectors?: components["schemas"]["VectorsConfig"]; /** * Format: uint32 * @description For auto sharding: Number of shards in collection. - Default is 1 for standalone, otherwise equal to the number of nodes - Minimum is 1 * * For custom sharding: Number of shards in collection per shard group. - Default is 1, meaning that each shard key will be mapped to a single shard - Minimum is 1 * @default null */ shard_number?: number | null; /** * @description Sharding method Default is Auto - points are distributed across all available shards Custom - points are distributed across shards according to shard key * @default null */ sharding_method?: components["schemas"]["ShardingMethod"] | (Record | null); /** * Format: uint32 * @description Number of shards replicas. Default is 1 Minimum is 1 * @default null */ replication_factor?: number | null; /** * Format: uint32 * @description Defines how many replicas should apply the operation for us to consider it successful. Increasing this number will make the collection more resilient to inconsistencies, but will also make it fail if not enough replicas are available. Does not have any performance impact. * @default null */ write_consistency_factor?: number | null; /** * @deprecated * @description Deprecated: use `payload.memory` instead. If true - point's payload will not be stored in memory. It will be read from the disk every time it is requested. This setting saves RAM by (slightly) increasing the response time. Note: those payload values that are involved in filtering and are indexed - remain in RAM. * * Default: true * @default null */ on_disk_payload?: boolean | null; /** * @description Configuration of the payload storage * @default null */ payload?: components["schemas"]["PayloadStorageParams"] | (Record | null); /** @description Custom params for HNSW index. If none - values from service configuration file are used. */ hnsw_config?: components["schemas"]["HnswConfigDiff"] | (Record | null); /** @description Custom params for WAL. If none - values from service configuration file are used. */ wal_config?: components["schemas"]["WalConfigDiff"] | (Record | null); /** @description Custom params for Optimizers. If none - values from service configuration file are used. */ optimizers_config?: components["schemas"]["OptimizersConfigDiff"] | (Record | null); /** * @description Quantization parameters. If none - quantization is disabled. * @default null */ quantization_config?: components["schemas"]["QuantizationConfig"] | (Record | null); /** @description Sparse vector data config. */ sparse_vectors?: ({ [key: string]: components["schemas"]["SparseVectorParams"] | undefined; }) | null; /** @description Strict-mode config. */ strict_mode_config?: components["schemas"]["StrictModeConfig"] | (Record | null); /** @description Arbitrary JSON metadata for the collection This can be used to store application-specific information such as creation time, migration data, inference model info, etc. */ metadata?: components["schemas"]["Payload"] | (Record | null); }; WalConfigDiff: { /** * Format: uint * @description Size of a single WAL segment in MB */ wal_capacity_mb?: number | null; /** * Format: uint * @description Number of WAL segments to create ahead of actually used ones */ wal_segments_ahead?: number | null; /** * Format: uint * @description Number of closed WAL segments to retain */ wal_retain_closed?: number | null; }; OptimizersConfigDiff: { /** * Format: double * @description The minimal fraction of deleted vectors in a segment, required to perform segment optimization */ deleted_threshold?: number | null; /** * Format: uint * @description The minimal number of vectors in a segment, required to perform segment optimization */ vacuum_min_vector_number?: number | null; /** * Format: uint * @description Target amount of segments optimizer will try to keep. Real amount of segments may vary depending on multiple parameters: - Amount of stored points - Current write RPS * * It is recommended to select default number of segments as a factor of the number of search threads, so that each segment would be handled evenly by one of the threads If `default_segment_number = 0`, will be automatically selected by the number of available CPUs */ default_segment_number?: number | null; /** * Format: uint * @description Do not create segments larger this size (in kilobytes). Large segments might require disproportionately long indexation times, therefore it makes sense to limit the size of segments. * * If indexation speed have more priority for your - make this parameter lower. If search speed is more important - make this parameter higher. Note: 1Kb = 1 vector of size 256 */ max_segment_size?: number | null; /** * Format: uint * @deprecated * @description Maximum size (in kilobytes) of vectors to store in-memory per segment. Segments larger than this threshold will be stored as read-only memmapped file. * * Memmap storage is disabled by default, to enable it, set this threshold to a reasonable value. * * To disable memmap storage, set this to `0`. * * Note: 1Kb = 1 vector of size 256 * * Deprecated since Qdrant 1.15.0 */ memmap_threshold?: number | null; /** * Format: uint * @description Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing * * Default value is 20,000, based on . * * To disable vector indexing, set to `0`. * * Note: 1kB = 1 vector of size 256. */ indexing_threshold?: number | null; /** * Format: uint64 * @description Minimum interval between forced flushes. */ flush_interval_sec?: number | null; /** @description Max number of threads (jobs) for running optimizations per shard. Note: each optimization job will also use `max_indexing_threads` threads by itself for index building. If "auto" - have no limit and choose dynamically to saturate CPU. If 0 - no optimization threads, optimizations will be disabled. */ max_optimization_threads?: components["schemas"]["MaxOptimizationThreads"] | (Record | null); /** * @description If enabled, the service will try to prevent the creation of large unoptimized segments. When enabled, new points written to segments larger than the indexing threshold are stored as "deferred points": they are persisted in the WAL and segments, but excluded from read/search results until the corresponding segments are optimized (e.g. indexed, quantized, or moved to mmap storage). Update requests with `wait=true` will only return after the deferred points become visible, which may significantly increase the perceived latency between submitting an update and its completion. Update requests with `wait=false` are not affected. Default is disabled. * @default null */ prevent_unoptimized?: boolean | null; }; MaxOptimizationThreads: components["schemas"]["MaxOptimizationThreadsSetting"] | number; /** @enum {string} */ MaxOptimizationThreadsSetting: "auto"; StrictModeConfig: { /** @description Whether strict mode is enabled for a collection or not. */ enabled?: boolean | null; /** * Format: uint * @description Max allowed `limit` parameter for all APIs that don't have their own max limit. */ max_query_limit?: number | null; /** * Format: uint * @description Max allowed `timeout` parameter. */ max_timeout?: number | null; /** @description Allow usage of unindexed fields in retrieval based (e.g. search) filters. */ unindexed_filtering_retrieve?: boolean | null; /** @description Allow usage of unindexed fields in filtered updates (e.g. delete by payload). */ unindexed_filtering_update?: boolean | null; /** * Format: uint * @description Max HNSW ef value allowed in search parameters. */ search_max_hnsw_ef?: number | null; /** @description Whether exact search is allowed. */ search_allow_exact?: boolean | null; /** * Format: double * @description Max oversampling value allowed in search. */ search_max_oversampling?: number | null; /** * Format: uint * @description Max batchsize when upserting */ upsert_max_batchsize?: number | null; /** * Format: uint * @description Max batchsize when searching */ search_max_batchsize?: number | null; /** * Format: uint * @description Max size of a collections vector storage in bytes, ignoring replicas. */ max_collection_vector_size_bytes?: number | null; /** * Format: uint * @description Max number of read operations per minute per replica */ read_rate_limit?: number | null; /** * Format: uint * @description Max number of write operations per minute per replica */ write_rate_limit?: number | null; /** * Format: uint * @description Max size of a collections payload storage in bytes */ max_collection_payload_size_bytes?: number | null; /** * Format: uint * @description Max number of points estimated in a collection */ max_points_count?: number | null; /** * Format: uint * @description Max conditions a filter can have. */ filter_max_conditions?: number | null; /** * Format: uint * @description Max size of a condition, eg. items in `MatchAny`. */ condition_max_size?: number | null; /** @description Multivector strict mode configuration */ multivector_config?: components["schemas"]["StrictModeMultivectorConfig"] | (Record | null); /** @description Sparse vector strict mode configuration */ sparse_config?: components["schemas"]["StrictModeSparseConfig"] | (Record | null); /** * Format: uint * @description Max number of payload indexes in a collection */ max_payload_index_count?: number | null; /** * Format: uint8 * @deprecated * @description Deprecated: use the node-wide quota config (`PUT /quotas`) instead, which caps the same resource for every collection. Scheduled for removal in 1.21. * * Reject memory-consuming update operations (e.g. upsert, set payload) when the process resident memory exceeds this percentage of total system memory (or cgroup limit). Value in [1, 100]. Memory is a node-wide resource, so this only tightens the quota for one collection; it cannot lift it. Delete operations are not affected, so callers can still free memory. */ max_resident_memory_percent?: number | null; }; StrictModeMultivectorConfig: { [key: string]: components["schemas"]["StrictModeMultivector"] | undefined; }; StrictModeMultivector: { /** * Format: uint * @description Max number of vectors in a multivector */ max_vectors?: number | null; }; StrictModeSparseConfig: { [key: string]: components["schemas"]["StrictModeSparse"] | undefined; }; StrictModeSparse: { /** * Format: uint * @description Max length of sparse vector */ max_length?: number | null; }; /** @description Operation for updating parameters of the existing collection */ UpdateCollection: { /** @description Map of vector data parameters to update for each named vector. To update parameters in a collection having a single unnamed vector, use an empty string as name. */ vectors?: components["schemas"]["VectorsConfigDiff"] | (Record | null); /** @description Custom params for Optimizers. If none - it is left unchanged. This operation is blocking, it will only proceed once all current optimizations are complete */ optimizers_config?: components["schemas"]["OptimizersConfigDiff"] | (Record | null); /** @description Collection base params. If none - it is left unchanged. */ params?: components["schemas"]["CollectionParamsDiff"] | (Record | null); /** @description HNSW parameters to update for the collection index. If none - it is left unchanged. */ hnsw_config?: components["schemas"]["HnswConfigDiff"] | (Record | null); /** * @description Quantization parameters to update. If none - it is left unchanged. * @default null */ quantization_config?: components["schemas"]["QuantizationConfigDiff"] | (Record | null); /** @description Map of sparse vector data parameters to update for each sparse vector. */ sparse_vectors?: components["schemas"]["SparseVectorsConfig"] | (Record | null); strict_mode_config?: components["schemas"]["StrictModeConfig"] | (Record | null); /** @description Metadata to update for the collection. If provided, this will merge with existing metadata. Individual keys can be removed by setting their value to `null`. */ metadata?: components["schemas"]["Payload"] | (Record | null); }; /** * @description Vector update params for multiple vectors * * { "vector_name": { "hnsw_config": { "m": 8 } } } */ VectorsConfigDiff: { [key: string]: components["schemas"]["VectorParamsDiff"] | undefined; }; VectorParamsDiff: { /** @description Update params for HNSW index. If empty object - it will be unset. */ hnsw_config?: components["schemas"]["HnswConfigDiff"] | (Record | null); /** @description Update params for quantization. If none - it is left unchanged. */ quantization_config?: components["schemas"]["QuantizationConfigDiff"] | (Record | null); /** * @deprecated * @description Deprecated: use `memory` instead. If true, vectors are served from disk, improving RAM usage at the cost of latency */ on_disk?: boolean | null; /** @description Memory placement of the original vector storage. Overrides the deprecated `on_disk` flag if both are set. `pinned` is not supported for dense vector storage. */ memory?: components["schemas"]["Memory"] | (Record | null); }; QuantizationConfigDiff: components["schemas"]["ScalarQuantization"] | components["schemas"]["ProductQuantization"] | components["schemas"]["BinaryQuantization"] | components["schemas"]["TurboQuantization"] | components["schemas"]["Disabled"]; /** @enum {string} */ Disabled: "Disabled"; CollectionParamsDiff: { /** * Format: uint32 * @description Number of replicas for each shard */ replication_factor?: number | null; /** * Format: uint32 * @description Minimal number successful responses from replicas to consider operation successful */ write_consistency_factor?: number | null; /** * Format: uint32 * @description Fan-out every read request to these many additional remote nodes (and return first available response) */ read_fan_out_factor?: number | null; /** * Format: uint64 * @description Delay in milliseconds before sending read requests to remote nodes */ read_fan_out_delay_ms?: number | null; /** * @deprecated * @description Deprecated: use `payload.memory` instead. If true - point's payload will not be stored in memory. It will be read from the disk every time it is requested. This setting saves RAM by (slightly) increasing the response time. Note: those payload values that are involved in filtering and are indexed - remain in RAM. * @default null */ on_disk_payload?: boolean | null; /** @description Update params of the payload storage. If none - it is left unchanged. */ payload?: components["schemas"]["PayloadStorageParams"] | (Record | null); }; SparseVectorsConfig: { [key: string]: components["schemas"]["SparseVectorParams"] | undefined; }; /** @description Operation for performing changes of collection aliases. Alias changes are atomic, meaning that no collection modifications can happen between alias operations. */ ChangeAliasesOperation: { actions: (components["schemas"]["AliasOperations"])[]; }; /** @description Group of all the possible operations related to collection aliases */ AliasOperations: components["schemas"]["CreateAliasOperation"] | components["schemas"]["DeleteAliasOperation"] | components["schemas"]["RenameAliasOperation"]; CreateAliasOperation: { create_alias: components["schemas"]["CreateAlias"]; }; /** @description Create alternative name for a collection. Collection will be available under both names for search, retrieve, */ CreateAlias: { collection_name: string; alias_name: string; }; /** @description Delete alias if exists */ DeleteAliasOperation: { delete_alias: components["schemas"]["DeleteAlias"]; }; /** @description Delete alias if exists */ DeleteAlias: { alias_name: string; }; /** @description Change alias to a new one */ RenameAliasOperation: { rename_alias: components["schemas"]["RenameAlias"]; }; /** @description Change alias to a new one */ RenameAlias: { old_alias_name: string; new_alias_name: string; }; CreateFieldIndex: { field_name: string; field_schema?: components["schemas"]["PayloadFieldSchema"] | (Record | null); }; PayloadFieldSchema: components["schemas"]["PayloadSchemaType"] | components["schemas"]["PayloadSchemaParams"]; PointsSelector: components["schemas"]["PointIdsList"] | components["schemas"]["FilterSelector"]; PointIdsList: { points: (components["schemas"]["ExtendedPointId"])[]; shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); }; FilterSelector: { filter: components["schemas"]["Filter"]; shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); }; PointInsertOperations: components["schemas"]["PointsBatch"] | components["schemas"]["PointsList"]; PointsBatch: { batch: components["schemas"]["Batch"]; shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); /** @description Filter to apply when updating existing points. Only points matching this filter will be updated. Points that don't match will keep their current state. New points will be inserted regardless of the filter. */ update_filter?: components["schemas"]["Filter"] | (Record | null); /** @description Mode of the upsert operation: insert_only, upsert (default), update_only */ update_mode?: components["schemas"]["UpdateMode"] | (Record | null); }; Batch: { ids: (components["schemas"]["ExtendedPointId"])[]; vectors: components["schemas"]["BatchVectorStruct"]; payloads?: ((components["schemas"]["Payload"] | (Record | null))[]) | null; }; BatchVectorStruct: ((number)[])[] | (((number)[])[])[] | ({ [key: string]: (components["schemas"]["Vector"])[] | undefined; }) | (components["schemas"]["Document"])[] | (components["schemas"]["Image"])[] | (components["schemas"]["InferenceObject"])[]; /** @description Vector Data Vectors can be described directly with values Or specified with source "objects" for inference */ Vector: (number)[] | components["schemas"]["SparseVector"] | ((number)[])[] | components["schemas"]["Document"] | components["schemas"]["Image"] | components["schemas"]["InferenceObject"]; /** * @description WARN: Work-in-progress, unimplemented * * Text document for embedding. Requires inference infrastructure, unimplemented. */ Document: { /** * @description Text of the document. This field will be used as input for the embedding model. * @example This is a document text */ text: string; /** * @description Name of the model used to generate the vector. List of available models depends on a provider. * @example jinaai/jina-embeddings-v2-base-en */ model: string; /** @description Additional options for the model, will be passed to the inference service as-is. See model cards for available options. */ options?: components["schemas"]["DocumentOptions"] | (Record | null); }; /** @description Option variants for text documents. Ether general-purpose options or BM25-specific options. BM25-specific will only take effect if the `qdrant/bm25` is specified as a model. */ DocumentOptions: { [key: string]: unknown; } | components["schemas"]["Bm25Config"]; /** @description Configuration of the local bm25 models. */ Bm25Config: { /** * Format: double * @description Controls term frequency saturation. Higher values mean term frequency has more impact. Default is 1.2 * @default 1.2 */ k?: number; /** * Format: double * @description Controls document length normalization. Ranges from 0 (no normalization) to 1 (full normalization). Higher values mean longer documents have less impact. Default is 0.75. * @default 0.75 */ b?: number; /** * Format: double * @description Expected average document length in the collection. Default is 256. * @default 256 */ avg_len?: number; tokenizer?: components["schemas"]["TokenizerType"]; /** @description Defines which language to use for text preprocessing. This parameter is used to construct default stopwords filter and stemmer. To disable language-specific processing, set `stemmer` to `{"type": "none"}` and configure an empty stopword set. The legacy `"language": "none"` hack is deprecated and may be rejected in a future release. If not specified, English is assumed. */ language?: string | null; /** @description Lowercase the text before tokenization. Default is `true`. */ lowercase?: boolean | null; /** @description If true, normalize tokens by folding accented characters to ASCII (e.g., "ação" -> "acao"). Default is `false`. */ ascii_folding?: boolean | null; /** @description Configuration of the stopwords filter. Supports list of pre-defined languages and custom stopwords. Default: initialized for specified `language` or English if not specified. */ stopwords?: components["schemas"]["StopwordsInterface"] | (Record | null); /** @description Configuration of the stemmer. Processes tokens to their root form. Default: initialized Snowball stemmer for specified `language` or English if not specified. */ stemmer?: components["schemas"]["StemmingAlgorithm"] | (Record | null); /** * Format: uint * @description Minimum token length to keep. If token is shorter than this, it will be discarded. Default is `None`, which means no minimum length. */ min_token_len?: number | null; /** * Format: uint * @description Maximum token length to keep. If token is longer than this, it will be discarded. Default is `None`, which means no maximum length. */ max_token_len?: number | null; }; /** * @description WARN: Work-in-progress, unimplemented * * Image object for embedding. Requires inference infrastructure, unimplemented. */ Image: { /** * @description Image data: base64 encoded image or an URL * @example https://example.com/image.jpg */ image: unknown; /** * @description Name of the model used to generate the vector. List of available models depends on a provider. * @example Qdrant/clip-ViT-B-32-vision */ model: string; /** @description Parameters for the model Values of the parameters are model-specific */ options?: { [key: string]: unknown; } | null; }; /** * @description WARN: Work-in-progress, unimplemented * * Custom object for embedding. Requires inference infrastructure, unimplemented. */ InferenceObject: { /** @description Arbitrary data, used as input for the embedding model. Used if the model requires more than one input or a custom input. */ object: unknown; /** * @description Name of the model used to generate the vector. List of available models depends on a provider. * @example jinaai/jina-embeddings-v2-base-en */ model: string; /** @description Parameters for the model Values of the parameters are model-specific */ options?: { [key: string]: unknown; } | null; }; /** * @description Defines the mode of the upsert operation * * * `upsert` - default mode, insert new points, update existing points * `insert_only` - only insert new points, do not update existing points * `update_only` - only update existing points, do not insert new points * @enum {string} */ UpdateMode: "upsert" | "insert_only" | "update_only"; PointsList: { points: (components["schemas"]["PointStruct"])[]; shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); /** @description Filter to apply when updating existing points. Only points matching this filter will be updated. Points that don't match will keep their current state. New points will be inserted regardless of the filter. */ update_filter?: components["schemas"]["Filter"] | (Record | null); /** @description Mode of the upsert operation: insert_only, upsert (default), update_only */ update_mode?: components["schemas"]["UpdateMode"] | (Record | null); }; PointStruct: { id: components["schemas"]["ExtendedPointId"]; vector: components["schemas"]["VectorStruct"]; /** @description Payload values (optional) */ payload?: components["schemas"]["Payload"] | (Record | null); }; /** @description Full vector data per point separator with single and multiple vector modes */ VectorStruct: (number)[] | ((number)[])[] | ({ [key: string]: components["schemas"]["Vector"] | undefined; }) | components["schemas"]["Document"] | components["schemas"]["Image"] | components["schemas"]["InferenceObject"]; /** @description This data structure is used in API interface and applied across multiple shards */ SetPayload: { payload: components["schemas"]["Payload"]; /** @description Assigns payload to each point in this list */ points?: (components["schemas"]["ExtendedPointId"])[] | null; /** @description Assigns payload to each point that satisfy this filter condition */ filter?: components["schemas"]["Filter"] | (Record | null); shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); /** @description Assigns payload to each point that satisfy this path of property */ key?: string | null; }; /** @description This data structure is used in API interface and applied across multiple shards */ DeletePayload: { /** @description List of payload keys to remove from payload */ keys: (string)[]; /** @description Deletes values from each point in this list */ points?: (components["schemas"]["ExtendedPointId"])[] | null; /** @description Deletes values from points that satisfy this filter condition */ filter?: components["schemas"]["Filter"] | (Record | null); shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); }; /** @description Information about current cluster status and structure */ ClusterStatus: OneOf<[ { /** @enum {string} */ status: "disabled"; }, { /** @enum {string} */ status: "enabled"; /** * Format: uint64 * @description ID of this peer */ peer_id: number; /** @description Peers composition of the cluster with main information */ peers: { [key: string]: components["schemas"]["PeerInfo"] | undefined; }; raft_info: components["schemas"]["RaftInfo"]; consensus_thread_status: components["schemas"]["ConsensusThreadStatus"]; /** @description Consequent failures of message send operations in consensus by peer address. On the first success to send to that peer - entry is removed from this hashmap. */ message_send_failures: { [key: string]: components["schemas"]["MessageSendErrors"] | undefined; }; } ]>; /** @description Information of a peer in the cluster */ PeerInfo: { uri: string; }; /** @description Summary information about the current raft state */ RaftInfo: { /** * Format: uint64 * @description Raft divides time into terms of arbitrary length, each beginning with an election. If a candidate wins the election, it remains the leader for the rest of the term. The term number increases monotonically. Each server stores the current term number which is also exchanged in every communication. */ term: number; /** * Format: uint64 * @description The index of the latest committed (finalized) operation that this peer is aware of. */ commit: number; /** * Format: uint * @description Number of consensus operations pending to be applied on this peer */ pending_operations: number; /** * Format: uint64 * @description Leader of the current term */ leader?: number | null; /** @description Role of this peer in the current term */ role?: components["schemas"]["StateRole"] | (Record | null); /** @description Is this peer a voter or a learner */ is_voter: boolean; }; /** * @description Role of the peer in the consensus * @enum {string} */ StateRole: "Follower" | "Candidate" | "Leader" | "PreCandidate"; /** @description Information about current consensus thread status */ ConsensusThreadStatus: OneOf<[ { /** @enum {string} */ consensus_thread_status: "working"; /** Format: date-time */ last_update: string; }, { /** @enum {string} */ consensus_thread_status: "stopped"; }, { /** @enum {string} */ consensus_thread_status: "stopped_with_err"; err: string; } ]>; /** @description Message send failures for a particular peer */ MessageSendErrors: { /** Format: uint */ count: number; latest_error?: string | null; /** * Format: date-time * @description Timestamp of the latest error */ latest_error_timestamp?: string | null; }; /** * @example { * "name": "my-collection-3766212330831337-2024-07-22-08-31-55.snapshot", * "creation_time": "2022-08-04T10:49:10", * "size": 1000000, * "checksum": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0" * } */ SnapshotDescription: { name: string; /** Format: partial-date-time */ creation_time?: string | null; /** Format: uint64 */ size: number; checksum?: string | null; }; /** @description Count Request Counts the number of points which satisfy the given filter. If filter is not provided, the count of all points in the collection will be returned. */ CountRequest: { /** @description Specify in which shards to look for the points, if not specified - look in all shards */ shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); /** @description Look only for points which satisfies this conditions */ filter?: components["schemas"]["Filter"] | (Record | null); /** * @description If true, count exact number of points. If false, count approximate number of points faster. Approximate count might be unreliable during the indexing process. Default: true * @default true */ exact?: boolean; }; CountResult: { /** * Format: uint * @description Number of points which satisfy the conditions */ count: number; }; /** @description Current clustering distribution for the collection */ CollectionClusterInfo: { /** * Format: uint64 * @description ID of this peer */ peer_id: number; /** * Format: uint * @description Total number of shards */ shard_count: number; /** @description Local shards */ local_shards: (components["schemas"]["LocalShardInfo"])[]; /** @description Remote shards */ remote_shards: (components["schemas"]["RemoteShardInfo"])[]; /** @description Shard transfers */ shard_transfers: (components["schemas"]["ShardTransferInfo"])[]; /** @description Resharding operations */ resharding_operations?: (components["schemas"]["ReshardingInfo"])[] | null; }; LocalShardInfo: { /** * Format: uint32 * @description Local shard id */ shard_id: number; /** @description User-defined sharding key */ shard_key?: components["schemas"]["ShardKey"] | (Record | null); /** * Format: uint * @description Number of points in the shard */ points_count: number; state: components["schemas"]["ReplicaState"]; }; /** * @description State of the single shard within a replica set. * @enum {string} */ ReplicaState: "Active" | "Dead" | "Partial" | "Initializing" | "Listener" | "PartialSnapshot" | "Recovery" | "Resharding" | "ReshardingScaleDown" | "ActiveRead" | "ManualRecovery"; RemoteShardInfo: { /** * Format: uint32 * @description Remote shard id */ shard_id: number; /** @description User-defined sharding key */ shard_key?: components["schemas"]["ShardKey"] | (Record | null); /** * Format: uint64 * @description Remote peer id */ peer_id: number; state: components["schemas"]["ReplicaState"]; }; ShardTransferInfo: { /** Format: uint32 */ shard_id: number; /** * Format: uint32 * @description Target shard ID if different than source shard ID * * Used exclusively with `ReshardingStreamRecords` transfer method. */ to_shard_id?: number | null; /** * Format: uint64 * @description Source peer id */ from: number; /** * Format: uint64 * @description Destination peer id */ to: number; /** @description If `true` transfer is a synchronization of a replicas If `false` transfer is a moving of a shard from one peer to another */ sync: boolean; method?: components["schemas"]["ShardTransferMethod"] | (Record | null); /** @description A human-readable report of the transfer progress. Available only on the source peer. */ comment?: string | null; }; /** * @description Methods for transferring a shard from one node to another. * * - `stream_records` - Stream all shard records in batches until the whole shard is transferred. * * - `snapshot` - Snapshot the shard, transfer and restore it on the receiver. * * - `wal_delta` - Attempt to transfer shard difference by WAL delta. * * - `resharding_stream_records` - Shard transfer for resharding: stream all records in batches until all points are transferred. * @enum {string} */ ShardTransferMethod: "stream_records" | "snapshot" | "wal_delta" | "resharding_stream_records"; ReshardingInfo: { direction: components["schemas"]["ReshardingDirection"]; /** Format: uint32 */ shard_id: number; /** Format: uint64 */ peer_id: number; shard_key?: components["schemas"]["ShardKey"] | (Record | null); }; /** * @description Resharding direction, scale up or down in number of shards * * - `up` - Scale up, add a new shard * * - `down` - Scale down, remove a shard * @enum {string} */ ReshardingDirection: "up" | "down"; TelemetryData: { id: string; app?: components["schemas"]["AppBuildTelemetry"] | (Record | null); collections: components["schemas"]["CollectionsTelemetry"]; cluster?: components["schemas"]["ClusterTelemetry"] | (Record | null); requests?: components["schemas"]["RequestsTelemetry"] | (Record | null); memory?: components["schemas"]["MemoryTelemetry"] | (Record | null); hardware?: components["schemas"]["HardwareTelemetry"] | (Record | null); search_pool?: components["schemas"]["SearchThreadPoolTelemetry"] | (Record | null); /** @description Resource quota this node is enforcing, and whether it is currently over it. The config is whatever this node last persisted, so a peer that missed a consensus update reports what it is actually applying rather than what the cluster agreed on. Absent for a token without global access, which `GET /quotas` requires as well. */ quota?: components["schemas"]["QuotaTelemetry"] | (Record | null); }; AppBuildTelemetry: { name: string; version: string; features?: components["schemas"]["AppFeaturesTelemetry"] | (Record | null); runtime_features?: components["schemas"]["FeatureFlags"] | (Record | null); low_memory_mode?: components["schemas"]["LowMemoryMode"] | (Record | null); hnsw_global_config?: components["schemas"]["HnswGlobalConfig"] | (Record | null); system?: components["schemas"]["RunningEnvironmentTelemetry"] | (Record | null); jwt_rbac?: boolean | null; hide_jwt_dashboard?: boolean | null; audit?: components["schemas"]["AuditTelemetry"] | (Record | null); /** Format: date-time */ startup: string; }; AppFeaturesTelemetry: { debug: boolean; service_debug_feature: boolean; recovery_mode: boolean; gpu: boolean; rocksdb: boolean; staging: boolean; }; FeatureFlags: { /** * @description Magic feature flag that enables all features. * * Note that this will only be applied to all flags when passed into [`init_feature_flags`]. * @default false */ all?: boolean; /** * @description Use incremental HNSW building. * * Enabled by default in Qdrant 1.14.1. * @default true */ incremental_hnsw_building?: boolean; /** * @description Use appendable quantization in appendable plain segments. * * Enabled by default in Qdrant 1.16.0. * @default true */ appendable_quantization?: boolean; /** * @description Use single-file mmap in-ram vector storage (InRamMmap) * * Enabled by default in Qdrant 1.18.3+ * @default true */ single_file_mmap_vector_storage?: boolean; /** * @description Allow the io_uring-based payload storage implementation. When disabled, io_uring payload storage is *never* used. When enabled, payload storage backend is decided based on `storage.performance.io_uring` option and payload storage type. * @default true */ async_payload_storage?: boolean; /** * @description Write a segment manifest (`segments_manifest.json`, next to the `segments/` directory) listing the shard's segments and their state, so out-of-process readers can discover segments without scanning the filesystem. * @default false */ write_segment_manifest?: boolean; /** * @description Build new segments in append-only mode: in-place point mutations become clone-and-tombstone appends instead. Intended for testing the append-only storage path. * @default false */ append_only_mutations?: boolean; /** * @description Persist write-once bitmasks in the compact `StoredBitmask` format instead of raw dense bitslices. Only gates writing: both formats are always readable. * @default false */ compact_bitmask?: boolean; /** * @description Serverless-compatible deployment mode. Automatically enables [`Self::write_segment_manifest`], [`Self::append_only_mutations`] and [`Self::compact_bitmask`]. * * Note that this will only be applied when passed into [`init_feature_flags`]. * @default false */ serverless_compatible?: boolean; }; /** * @description Controls how segments are loaded on startup to reduce memory pressure. * * Configured via `storage.low_memory_mode` in the configuration file. * * This setting only affects *loading* — it never modifies the persisted configuration of any segment. The same data directory will behave differently depending on how this mode is set at startup, which makes it safe to toggle for recovery from out-of-memory crash loops. */ LowMemoryMode: "disabled" | "no_resident" | "no_populate"; HnswGlobalConfig: { /** * Format: double * @description Enable HNSW healing if the ratio of missing points is no more than this value. To disable healing completely, set this value to `0.0`. * @default 0.3 */ healing_threshold?: number; }; RunningEnvironmentTelemetry: { distribution?: string | null; distribution_version?: string | null; is_docker: boolean; /** Format: uint */ cores?: number | null; /** * Format: float * @description Average number of CPU cores used by this process over roughly the last two seconds. `None` on unsupported platforms, before two samples are collected, or on transient failures reading process CPU time. */ cpu_cores_used?: number | null; /** * Format: uint * @description Effective total memory for this process in KiB (cgroup limit or host RAM). */ ram_size?: number | null; /** * Format: uint * @description Size in KiB of the filesystem hosting Qdrant's /storage path (if not available, fallback to host disk size) */ disk_size?: number | null; cpu_flags: string; cpu_endian?: components["schemas"]["CpuEndian"] | (Record | null); gpu_devices?: (components["schemas"]["GpuDeviceTelemetry"])[] | null; }; /** @enum {string} */ CpuEndian: "little" | "big" | "other"; GpuDeviceTelemetry: { name: string; }; AuditTelemetry: { dir: string; rotation: string; /** Format: uint */ max_log_files: number; trust_forwarded_headers: boolean; log_api: boolean; /** Format: uint */ dir_size_bytes?: number | null; }; CollectionsTelemetry: { /** Format: uint */ number_of_collections: number; /** Format: uint */ max_collections?: number | null; collections?: (components["schemas"]["CollectionTelemetryEnum"])[] | null; snapshots?: (components["schemas"]["CollectionSnapshotTelemetry"])[] | null; }; CollectionTelemetryEnum: components["schemas"]["CollectionTelemetry"] | components["schemas"]["CollectionsAggregatedTelemetry"]; CollectionTelemetry: { id: string; /** Format: uint64 */ init_time_ms?: number | null; config?: components["schemas"]["CollectionConfigTelemetry"] | (Record | null); shards?: (components["schemas"]["ReplicaSetTelemetry"])[] | null; transfers?: (components["schemas"]["ShardTransferInfo"])[] | null; resharding?: (components["schemas"]["ReshardingInfo"])[] | null; shard_clean_tasks?: ({ [key: string]: components["schemas"]["ShardCleanStatusTelemetry"] | undefined; }) | null; }; CollectionConfigTelemetry: { params: components["schemas"]["CollectionParams"]; hnsw_config: components["schemas"]["HnswConfig"]; optimizer_config: components["schemas"]["OptimizersConfig"]; wal_config: components["schemas"]["WalConfig"]; /** @default null */ quantization_config?: components["schemas"]["QuantizationConfig"] | (Record | null); strict_mode_config?: components["schemas"]["StrictModeConfigOutput"] | (Record | null); /** * Format: uuid * @default null */ uuid?: string | null; /** @description Arbitrary JSON metadata for the collection */ metadata?: components["schemas"]["Payload"] | (Record | null); }; ReplicaSetTelemetry: { /** Format: uint32 */ id: number; key?: components["schemas"]["ShardKey"] | (Record | null); local?: components["schemas"]["LocalShardTelemetry"] | (Record | null); remote: (components["schemas"]["RemoteShardTelemetry"])[]; replicate_states: { [key: string]: components["schemas"]["ReplicaState"] | undefined; }; partial_snapshot?: components["schemas"]["PartialSnapshotTelemetry"] | (Record | null); }; LocalShardTelemetry: { variant_name?: string | null; status?: components["schemas"]["ShardStatus"] | (Record | null); /** * Format: uint * @description Total number of optimized points since the last start. */ total_optimized_points: number; /** * Format: uint * @description An ESTIMATION of effective amount of bytes used for vectors Do NOT rely on this number unless you know what you are doing */ vectors_size_bytes?: number | null; /** * Format: uint * @description An estimation of the effective amount of bytes used for payloads Do NOT rely on this number unless you know what you are doing */ payloads_size_bytes?: number | null; /** * Format: uint * @description Sum of segment points This is an approximate number Do NOT rely on this number unless you know what you are doing */ num_points?: number | null; /** * Format: uint * @description Sum of number of vectors in all segments This is an approximate number Do NOT rely on this number unless you know what you are doing */ num_vectors?: number | null; /** @description Sum of number of vectors across all segments, grouped by their name. This is an approximate number. Do NOT rely on this number unless you know what you are doing */ num_vectors_by_name?: ({ [key: string]: number | undefined; }) | null; segments?: (components["schemas"]["SegmentTelemetry"])[] | null; optimizations?: components["schemas"]["OptimizerTelemetry"] | (Record | null); async_scorer?: boolean | null; indexed_only_excluded_vectors?: ({ [key: string]: number | undefined; }) | null; /** @description Update queue status */ update_queue?: components["schemas"]["ShardUpdateQueueInfo"] | (Record | null); }; /** * @description Current state of the shard (supports same states as the collection) * * `Green` - all good. `Yellow` - optimization is running, 'Grey' - optimizations are possible but not triggered, `Red` - some operations failed and was not recovered * @enum {string} */ ShardStatus: "green" | "yellow" | "grey" | "red"; SegmentTelemetry: { info: components["schemas"]["SegmentInfo"]; config: components["schemas"]["SegmentConfig"]; vector_index_searches: (components["schemas"]["VectorIndexSearchesTelemetry"])[]; payload_field_indices: (components["schemas"]["PayloadIndexTelemetry"])[]; }; /** @description Aggregated information about segment */ SegmentInfo: { /** Format: uuid */ uuid: string; segment_type: components["schemas"]["SegmentType"]; /** Format: uint */ num_vectors: number; /** Format: uint */ num_points: number; /** Format: uint */ num_deferred_points?: number | null; /** Format: uint */ num_deleted_deferred_points?: number | null; /** Format: uint */ num_indexed_vectors: number; /** Format: uint */ num_deleted_vectors: number; /** * Format: uint * @description An ESTIMATION of effective amount of bytes used for vectors Do NOT rely on this number unless you know what you are doing */ vectors_size_bytes: number; /** * Format: uint * @description An estimation of the effective amount of bytes used for payloads */ payloads_size_bytes: number; /** Format: uint */ ram_usage_bytes: number; /** Format: uint */ disk_usage_bytes: number; is_appendable: boolean; index_schema: { [key: string]: components["schemas"]["PayloadIndexInfo"] | undefined; }; vector_data: { [key: string]: components["schemas"]["VectorDataInfo"] | undefined; }; /** @description Universal I/O backend that payload storage reads files with. Absent if payload storage does not support configurable backends or only supports a single backend type. */ payload_storage_io_backend?: components["schemas"]["IoBackend"] | (Record | null); /** * Format: uint32 * @description Internal ID from which points are deferred (hidden from reads). Only set for appendable segments. */ deferred_internal_id?: number | null; }; /** * @description Type of segment * @enum {string} */ SegmentType: "plain" | "indexed" | "special"; VectorDataInfo: { /** Format: uint */ num_vectors: number; /** Format: uint */ num_indexed_vectors: number; /** Format: uint */ num_deleted_vectors: number; /** @description Universal I/O backend that this vector storage reads files with. Absent if vector storage does not support configurable backends or only supports a single backend type. */ io_backend?: components["schemas"]["IoBackend"] | (Record | null); }; /** * @description Universal I/O backend that is used to read files. * * Decided when the component is opened based on `storage.performance.io_uring` option, component memory placement and kernel io_uring support. * * Options: * * * `Mmap` - Reads are served by the page cache through a memory mapping. * * * `IoUring` - Reads are submitted to the kernel with io_uring. * @enum {string} */ IoBackend: "mmap" | "io_uring"; SegmentConfig: { /** @default {} */ vector_data?: { [key: string]: components["schemas"]["VectorDataConfig"] | undefined; }; sparse_vector_data?: { [key: string]: components["schemas"]["SparseVectorDataConfig"] | undefined; }; payload_storage_type: components["schemas"]["PayloadStorageType"]; }; /** @description Config of single vector data storage */ VectorDataConfig: { /** * Format: uint * @description Size/dimensionality of the vectors used */ size: number; distance: components["schemas"]["Distance"]; storage_type: components["schemas"]["VectorStorageType"]; index: components["schemas"]["Indexes"]; /** @description Vector specific quantization config that overrides collection config */ quantization_config?: components["schemas"]["QuantizationConfig"] | (Record | null); /** @description Vector specific configuration to enable multiple vectors per point */ multivector_config?: components["schemas"]["MultiVectorConfig"] | (Record | null); /** @description Vector specific configuration to set specific storage element type */ datatype?: components["schemas"]["VectorStorageDatatype"] | (Record | null); }; /** @description Storage types for vectors */ VectorStorageType: "Memory" | "Mmap" | "ChunkedMmap" | "InRamChunkedMmap" | "InRamMmap" | "Empty"; /** @description Vector index configuration */ Indexes: OneOf<[ { /** @enum {string} */ type: "plain"; options: Record; }, { /** @enum {string} */ type: "hnsw"; options: components["schemas"]["HnswConfig"]; } ]>; /** * @description Storage types for vectors * @enum {string} */ VectorStorageDatatype: "float32" | "float16" | "uint8" | "turbo4"; /** @description Config of single sparse vector data storage */ SparseVectorDataConfig: { index: components["schemas"]["SparseIndexConfig"]; storage_type?: components["schemas"]["SparseVectorStorageType"]; /** @description Configures addition value modifications for sparse vectors. Default: none */ modifier?: components["schemas"]["Modifier"] | (Record | null); }; /** @description Configuration for sparse inverted index. */ SparseIndexConfig: { /** * Format: uint * @description We prefer a full scan search upto (excluding) this number of vectors. * * Note: this is number of vectors, not KiloBytes. */ full_scan_threshold?: number | null; index_type: components["schemas"]["SparseIndexType"]; /** @description Datatype used to store weights in the index. */ datatype?: components["schemas"]["VectorStorageDatatype"] | (Record | null); /** * @description Requested memory placement of the index. * * The structural decision is carried by `index_type`; this field additionally distinguishes `cold` from `cached` for the mmap index variant. */ memory?: components["schemas"]["Memory"] | (Record | null); }; /** @description Sparse index types */ SparseIndexType: "MutableRam" | "ImmutableRam" | "Mmap"; SparseVectorStorageType: "mmap" | "empty"; /** @description Type of payload storage */ PayloadStorageType: OneOf<[ { /** @enum {string} */ type: "mmap"; }, { /** @enum {string} */ type: "in_ram_mmap"; } ]>; VectorIndexSearchesTelemetry: { index_name?: string | null; unfiltered_plain: components["schemas"]["OperationDurationStatistics"]; unfiltered_hnsw: components["schemas"]["OperationDurationStatistics"]; unfiltered_sparse: components["schemas"]["OperationDurationStatistics"]; filtered_plain: components["schemas"]["OperationDurationStatistics"]; filtered_small_cardinality: components["schemas"]["OperationDurationStatistics"]; filtered_large_cardinality: components["schemas"]["OperationDurationStatistics"]; filtered_exact: components["schemas"]["OperationDurationStatistics"]; filtered_sparse: components["schemas"]["OperationDurationStatistics"]; unfiltered_exact: components["schemas"]["OperationDurationStatistics"]; }; OperationDurationStatistics: { /** Format: uint */ count: number; /** Format: uint */ fail_count?: number | null; /** * Format: float * @description The average time taken by 128 latest operations, calculated as a weighted mean. */ avg_duration_micros?: number | null; /** * Format: float * @description The minimum duration of the operations across all the measurements. */ min_duration_micros?: number | null; /** * Format: float * @description The maximum duration of the operations across all the measurements. */ max_duration_micros?: number | null; /** * Format: uint64 * @description The total duration of all operations in microseconds. */ total_duration_micros?: number | null; /** Format: date-time */ last_responded?: string | null; }; PayloadIndexTelemetry: { field_name?: string | null; index_type: string; /** * Format: uint * @description The amount of values indexed for all points. */ points_values_count: number; /** * Format: uint * @description The amount of points that have at least one value indexed. */ points_count: number; /** Format: uint */ histogram_bucket_size?: number | null; }; OptimizerTelemetry: { status: components["schemas"]["OptimizersStatus"]; optimizations: components["schemas"]["OperationDurationStatistics"]; log?: (components["schemas"]["TrackerTelemetry"])[] | null; }; /** @description Tracker object used in telemetry */ TrackerTelemetry: { /** @description Name of the optimizer */ name: string; /** * Format: uuid * @description UUID of the upcoming segment being created by the optimizer */ uuid: string; /** @description Internal segment IDs being optimized. These are local and in-memory, meaning that they can refer to different segments after a service restart. */ segment_ids: (number)[]; /** @description Segment UUIDs being optimized. Refers to same segments as in `segment_ids`, but trackable across restarts, and reflect their directory name. */ segment_uuids: (string)[]; status: components["schemas"]["TrackerStatus"]; /** * Format: date-time * @description Start time of the optimizer */ start_at: string; /** * Format: date-time * @description End time of the optimizer */ end_at?: string | null; }; /** @description Represents the current state of the optimizer being tracked */ TrackerStatus: OneOf<[ "optimizing" | "done", { cancelled: string; }, { error: string; } ]>; ShardUpdateQueueInfo: { /** * Format: uint * @description Number of elements in the queue */ length: number; /** * Format: uint * @description last operation number processed */ op_num?: number | null; /** * Format: uint * @description Number of points that are deferred (i.e hidden from search as they're not yet optimized). */ deferred_points?: number | null; }; RemoteShardTelemetry: { /** Format: uint32 */ shard_id: number; /** Format: uint64 */ peer_id: number; searches?: components["schemas"]["OperationDurationStatistics"] | (Record | null); updates?: components["schemas"]["OperationDurationStatistics"] | (Record | null); }; PartialSnapshotTelemetry: { /** Format: uint */ ongoing_create_snapshot_requests: number; is_recovering: boolean; /** Format: uint64 */ recovery_timestamp: number; }; ShardCleanStatusTelemetry: OneOf<[ "started" | "done" | "cancelled", { progress: components["schemas"]["ShardCleanStatusProgressTelemetry"]; }, { failed: components["schemas"]["ShardCleanStatusFailedTelemetry"]; } ]>; ShardCleanStatusProgressTelemetry: { /** Format: uint */ deleted_points: number; }; ShardCleanStatusFailedTelemetry: { reason: string; }; CollectionsAggregatedTelemetry: { /** Format: uint */ vectors: number; optimizers_status: components["schemas"]["OptimizersStatus"]; params: components["schemas"]["CollectionParams"]; }; CollectionSnapshotTelemetry: { id: string; /** Format: uint */ running_snapshots?: number | null; /** Format: uint */ running_snapshot_recovery?: number | null; /** Format: uint */ total_snapshot_creations?: number | null; }; ClusterTelemetry: { enabled: boolean; status?: components["schemas"]["ClusterStatusTelemetry"] | (Record | null); config?: components["schemas"]["ClusterConfigTelemetry"] | (Record | null); peers?: ({ [key: string]: components["schemas"]["PeerInfo"] | undefined; }) | null; peer_metadata?: ({ [key: string]: components["schemas"]["PeerMetadata"] | undefined; }) | null; metadata?: { [key: string]: unknown; } | null; resharding_enabled?: boolean | null; }; ClusterStatusTelemetry: { /** Format: uint */ number_of_peers: number; /** Format: uint64 */ term: number; /** Format: uint64 */ commit: number; /** Format: uint */ pending_operations: number; role?: components["schemas"]["StateRole"] | (Record | null); is_voter: boolean; /** Format: uint64 */ peer_id?: number | null; consensus_thread_status: components["schemas"]["ConsensusThreadStatus"]; }; ClusterConfigTelemetry: { /** Format: uint64 */ grpc_timeout_ms: number; p2p: components["schemas"]["P2pConfigTelemetry"]; consensus: components["schemas"]["ConsensusConfigTelemetry"]; }; P2pConfigTelemetry: { /** Format: uint */ connection_pool_size: number; }; ConsensusConfigTelemetry: { /** Format: uint */ max_message_queue_size: number; /** Format: uint64 */ tick_period_ms: number; /** Format: uint64 */ bootstrap_timeout_sec: number; }; /** @description Metadata describing extra properties for each peer */ PeerMetadata: { /** @description Peer Qdrant version */ version: string; }; RequestsTelemetry: { rest: components["schemas"]["WebApiTelemetry"]; grpc: components["schemas"]["GrpcTelemetry"]; }; WebApiTelemetry: { responses: { [key: string]: ({ [key: string]: components["schemas"]["OperationDurationStatistics"] | undefined; }) | undefined; }; per_collection_responses?: { [key: string]: ({ [key: string]: ({ [key: string]: components["schemas"]["OperationDurationStatistics"] | undefined; }) | undefined; }) | undefined; }; }; GrpcTelemetry: { responses: { [key: string]: ({ [key: string]: components["schemas"]["OperationDurationStatistics"] | undefined; }) | undefined; }; per_collection_responses?: { [key: string]: ({ [key: string]: ({ [key: string]: components["schemas"]["OperationDurationStatistics"] | undefined; }) | undefined; }) | undefined; }; }; MemoryTelemetry: { /** * Format: uint * @description Total number of bytes in active pages allocated by the application */ active_bytes: number; /** * Format: uint * @description Total number of bytes allocated by the application */ allocated_bytes: number; /** * Format: uint * @description Total number of bytes dedicated to metadata */ metadata_bytes: number; /** * Format: uint * @description Maximum number of bytes in physically resident data pages mapped */ resident_bytes: number; /** * Format: uint * @description Total number of bytes in virtual memory mappings */ retained_bytes: number; }; HardwareTelemetry: { collection_data: { [key: string]: components["schemas"]["HardwareUsage"] | undefined; }; }; /** @description Usage of the hardware resources, spent to process the request */ HardwareUsage: { /** Format: uint */ cpu: number; /** Format: uint */ payload_io_read: number; /** Format: uint */ payload_io_write: number; /** Format: uint */ payload_index_io_read: number; /** Format: uint */ payload_index_io_write: number; /** Format: uint */ vector_io_read: number; /** Format: uint */ vector_io_write: number; }; /** * @description Live snapshot of the adaptive search routing. * * `mode` is the runtime currently selected by [`SearchMode`]; `high_cpu_threads` and `high_io_threads` are the blocking-thread budgets of the two underlying runtimes that the adaptive handle routes between. */ SearchThreadPoolTelemetry: { /** @description Currently active mode (`high_cpu` or `high_io`). */ mode: string; /** * Format: uint * @description Blocking-thread count of the high-CPU runtime. */ high_cpu_threads: number; /** * Format: uint * @description Blocking-thread count of the high-IO runtime. */ high_io_threads: number; }; /** * @description What a node reports about the quota it is enforcing. * * Carries the verdict rather than the raw utilization, because the point of reporting it is to know whether this node is currently refusing writes — which depends on the limits as well as the readings. */ QuotaTelemetry: { config: components["schemas"]["QuotaConfig"]; exceeded: components["schemas"]["QuotaExceeded"]; }; /** * @description Cluster-wide limits on node resources. * * An unset limit means the corresponding resource is not capped. Limits are only enforced while `enabled` is true. */ QuotaConfig: { /** * @description Whether the limits below are enforced. * @default false */ enabled?: boolean; /** * Format: uint8 * @description Reject memory-consuming updates once process resident memory reaches this percentage of total system memory (or of the cgroup limit, if one applies). */ max_resident_memory_percent?: number | null; /** * Format: uint8 * @description Reject disk-consuming updates once the filesystem hosting the storage directory is filled to this percentage of its capacity. */ max_disk_usage_percent?: number | null; /** * Format: uint8 * @description How many percentage points below its limit a resource has to fall before this node starts accepting work again. * * Without a margin, a resource resting on its limit crosses it in both directions on the noise between two readings, putting the node in and out of service each time — and restarting a shard recovery with it. Raise it where usage is volatile; `0` disables the margin and releases as soon as usage is back under the limit. * * Unset leaves the built-in default in force, so a config written today does not pin a number that a later release may want to revise. */ release_margin_percent?: number | null; }; /** * @description Which of the enforced limits a node is currently refusing work over. * * Reported per resource because they are freed by different actions: disk by deleting or optimizing, memory by unloading. A single flag would not say which one to go and fix. * * `true` outlasts the reading that caused it: a resource that reaches its limit stays flagged until it has fallen a margin below, so that one resting near the limit does not flip the node in and out of service. Expect to see it set while the reported utilization is already back under the configured limit. * * A field is `null` when the node is not enforcing that resource — the quota is disabled, no limit is set for it, or it cannot be measured here. That is deliberately distinct from `false`: a resource that can never trip must not be reported as one that is within its limits, or it invites an alert that can never fire. */ QuotaExceeded: { resident_memory?: boolean | null; disk_usage?: boolean | null; }; ClusterOperations: components["schemas"]["MoveShardOperation"] | components["schemas"]["ReplicateShardOperation"] | components["schemas"]["AbortTransferOperation"] | components["schemas"]["DropReplicaOperation"] | components["schemas"]["CreateShardingKeyOperation"] | components["schemas"]["DropShardingKeyOperation"] | components["schemas"]["RestartTransferOperation"] | components["schemas"]["StartReshardingOperation"] | components["schemas"]["AbortReshardingOperation"] | components["schemas"]["ReplicatePointsOperation"]; MoveShardOperation: { move_shard: components["schemas"]["MoveShard"]; }; MoveShard: { /** Format: uint32 */ shard_id: number; /** Format: uint64 */ to_peer_id: number; /** Format: uint64 */ from_peer_id: number; /** @description Method for transferring the shard from one node to another */ method?: components["schemas"]["ShardTransferMethod"] | (Record | null); }; ReplicateShardOperation: { replicate_shard: components["schemas"]["ReplicateShard"]; }; ReplicateShard: { /** Format: uint32 */ shard_id: number; /** Format: uint64 */ to_peer_id: number; /** Format: uint64 */ from_peer_id: number; /** @description Method for transferring the shard from one node to another */ method?: components["schemas"]["ShardTransferMethod"] | (Record | null); }; AbortTransferOperation: { abort_transfer: components["schemas"]["AbortShardTransfer"]; }; AbortShardTransfer: { /** Format: uint32 */ shard_id: number; /** Format: uint64 */ to_peer_id: number; /** Format: uint64 */ from_peer_id: number; }; DropReplicaOperation: { drop_replica: components["schemas"]["Replica"]; }; Replica: { /** Format: uint32 */ shard_id: number; /** Format: uint64 */ peer_id: number; }; CreateShardingKeyOperation: { create_sharding_key: components["schemas"]["CreateShardingKey"]; }; CreateShardingKey: { shard_key: components["schemas"]["ShardKey"]; /** * Format: uint32 * @description How many shards to create for this key If not specified, will use the default value from config */ shards_number?: number | null; /** * Format: uint32 * @description How many replicas to create for each shard If not specified, will use the default value from config */ replication_factor?: number | null; /** @description Placement of shards for this key List of peer ids, that can be used to place shards for this key If not specified, will be randomly placed among all peers */ placement?: (number)[] | null; /** @description Initial state of the shards for this key If not specified, will be `Initializing` first and then `Active` Warning: do not change this unless you know what you are doing */ initial_state?: components["schemas"]["ReplicaState"] | (Record | null); }; DropShardingKeyOperation: { drop_sharding_key: components["schemas"]["DropShardingKey"]; }; DropShardingKey: { shard_key: components["schemas"]["ShardKey"]; }; RestartTransferOperation: { restart_transfer: components["schemas"]["RestartTransfer"]; }; RestartTransfer: { /** Format: uint32 */ shard_id: number; /** Format: uint64 */ from_peer_id: number; /** Format: uint64 */ to_peer_id: number; method: components["schemas"]["ShardTransferMethod"]; }; StartReshardingOperation: { start_resharding: components["schemas"]["StartResharding"]; }; StartResharding: { direction: components["schemas"]["ReshardingDirection"]; /** * Format: uint64 * @description Peer to create the new shard on, or to migrate points away from when scaling down. If not specified, the least loaded peer is picked when scaling up, a peer holding the removed shard when scaling down. */ peer_id?: number | null; /** @description Custom shard key to reshard, must already exist. If not specified, shards without a shard key are resharded. */ shard_key?: components["schemas"]["ShardKey"] | (Record | null); }; AbortReshardingOperation: { abort_resharding: components["schemas"]["AbortResharding"]; }; AbortResharding: Record; ReplicatePointsOperation: { replicate_points: components["schemas"]["ReplicatePoints"]; }; ReplicatePoints: { filter?: components["schemas"]["Filter"] | (Record | null); from_shard_key: components["schemas"]["ShardKey"]; to_shard_key: components["schemas"]["ShardKey"]; }; SnapshotRecover: { /** * Format: uri * @description Examples: - URL `http://localhost:8080/collections/my_collection/snapshots/my_snapshot` - Local path `file:///qdrant/snapshots/test_collection-2022-08-04-10-49-10.snapshot` */ location: string; /** * @description Defines which data should be used as a source of truth if there are other replicas in the cluster. If set to `Snapshot`, the snapshot will be used as a source of truth, and the current state will be overwritten. If set to `Replica`, the current state will be used as a source of truth, and after recovery if will be synchronized with the snapshot. * @default null */ priority?: components["schemas"]["SnapshotPriority"] | (Record | null); /** * @description Optional SHA256 checksum to verify snapshot integrity before recovery. * @default null */ checksum?: string | null; /** * @description Optional API key used when fetching the snapshot from a remote URL. * @default null */ api_key?: string | null; }; /** * @description Defines source of truth for snapshot recovery: * * `NoSync` means - restore snapshot without *any* additional synchronization. `Snapshot` means - prefer snapshot data over the current state. `Replica` means - prefer existing data over the snapshot. * @enum {string} */ SnapshotPriority: "no_sync" | "snapshot" | "replica"; CollectionsAliasesResponse: { aliases: (components["schemas"]["AliasDescription"])[]; }; /** * @example { * "alias_name": "blogs-title", * "collection_name": "arivx-title" * } */ AliasDescription: { alias_name: string; collection_name: string; }; /** * @description Defines write ordering guarantees for collection operations * * * `weak` - write operations may be reordered, works faster, default * * * `medium` - write operations go through dynamically selected leader, may be inconsistent for a short period of time in case of leader change * * * `strong` - Write operations go through the permanent leader, consistent, but may be unavailable if leader is down * @enum {string} */ WriteOrdering: "weak" | "medium" | "strong"; /** * @description Read consistency parameter * * Defines how many replicas should be queried to get the result * * * `N` - send N random request and return points, which present on all of them * * * `majority` - send N/2+1 random request and return points, which present on all of them * * * `quorum` - send requests to all nodes and return points which present on majority of them * * * `all` - send requests to all nodes and return points which present on all of them * * Default value is `Factor(1)` */ ReadConsistency: number | components["schemas"]["ReadConsistencyType"]; /** * @description * `majority` - send N/2+1 random request and return points, which present on all of them * * * `quorum` - send requests to all nodes and return points which present on majority of nodes * * * `all` - send requests to all nodes and return points which present on all nodes * @enum {string} */ ReadConsistencyType: "majority" | "quorum" | "all"; UpdateVectors: { /** @description Points with named vectors */ points: (components["schemas"]["PointVectors"])[]; shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); update_filter?: components["schemas"]["Filter"] | (Record | null); }; PointVectors: { id: components["schemas"]["ExtendedPointId"]; vector: components["schemas"]["VectorStruct"]; }; DeleteVectors: { /** @description Deletes values from each point in this list */ points?: (components["schemas"]["ExtendedPointId"])[] | null; /** @description Deletes values from points that satisfy this filter condition */ filter?: components["schemas"]["Filter"] | (Record | null); /** @description Vector names */ vector: (string)[]; shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); }; PointGroup: { /** @description Scored points that have the same value of the group_by key */ hits: (components["schemas"]["ScoredPoint"])[]; id: components["schemas"]["GroupId"]; /** @description Record that has been looked up using the group id */ lookup?: components["schemas"]["Record"] | (Record | null); }; /** @description Value of the group_by key, shared across all the hits in the group */ GroupId: string | number; GroupsResult: { groups: (components["schemas"]["PointGroup"])[]; }; UpdateOperations: { operations: (components["schemas"]["UpdateOperation"])[]; }; UpdateOperation: components["schemas"]["UpsertOperation"] | components["schemas"]["DeleteOperation"] | components["schemas"]["SetPayloadOperation"] | components["schemas"]["OverwritePayloadOperation"] | components["schemas"]["DeletePayloadOperation"] | components["schemas"]["ClearPayloadOperation"] | components["schemas"]["UpdateVectorsOperation"] | components["schemas"]["DeleteVectorsOperation"]; UpsertOperation: { upsert: components["schemas"]["PointInsertOperations"]; }; DeleteOperation: { delete: components["schemas"]["PointsSelector"]; }; SetPayloadOperation: { set_payload: components["schemas"]["SetPayload"]; }; OverwritePayloadOperation: { overwrite_payload: components["schemas"]["SetPayload"]; }; DeletePayloadOperation: { delete_payload: components["schemas"]["DeletePayload"]; }; ClearPayloadOperation: { clear_payload: components["schemas"]["PointsSelector"]; }; UpdateVectorsOperation: { update_vectors: components["schemas"]["UpdateVectors"]; }; DeleteVectorsOperation: { delete_vectors: components["schemas"]["DeleteVectors"]; }; ShardSnapshotRecover: { location: components["schemas"]["ShardSnapshotLocation"]; /** @default null */ priority?: components["schemas"]["SnapshotPriority"] | (Record | null); /** * @description Optional SHA256 checksum to verify snapshot integrity before recovery. * @default null */ checksum?: string | null; /** * @description Optional API key used when fetching the snapshot from a remote URL. * @default null */ api_key?: string | null; }; ShardSnapshotLocation: string; VersionInfo: { title: string; version: string; commit?: string | null; }; /** @description State of existence of a collection, true = exists, false = does not exist */ CollectionExistence: { exists: boolean; }; QueryRequest: { shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); /** * @description Sub-requests to perform first. If present, the query will be performed on the results of the prefetch(es). * @default null */ prefetch?: components["schemas"]["Prefetch"] | (components["schemas"]["Prefetch"])[] | (Record | null); /** @description Query to perform. If missing without prefetches, returns points ordered by their IDs. */ query?: components["schemas"]["QueryInterface"] | (Record | null); /** @description Define which vector name to use for querying. If missing, the default vector is used. */ using?: string | null; /** @description Filter conditions - return only those points that satisfy the specified conditions. */ filter?: components["schemas"]["Filter"] | (Record | null); /** @description Search params for when there is no prefetch */ params?: components["schemas"]["SearchParams"] | (Record | null); /** * Format: float * @description Return points with scores better than this threshold. */ score_threshold?: number | null; /** * Format: uint * @description Max number of points to return. Default is 10. */ limit?: number | null; /** * Format: uint * @description Offset of the result. Skip this many points. Default is 0 */ offset?: number | null; /** @description Options for specifying which vectors to include into the response. Default is false. */ with_vector?: components["schemas"]["WithVector"] | (Record | null); /** @description Options for specifying which payload to include or not. Default is false. */ with_payload?: components["schemas"]["WithPayloadInterface"] | (Record | null); /** * @description The location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in the current collection * @default null */ lookup_from?: components["schemas"]["LookupLocation"] | (Record | null); }; Prefetch: { /** * @description Sub-requests to perform first. If present, the query will be performed on the results of the prefetches. * @default null */ prefetch?: components["schemas"]["Prefetch"] | (components["schemas"]["Prefetch"])[] | (Record | null); /** @description Query to perform. If missing without prefetches, returns points ordered by their IDs. */ query?: components["schemas"]["QueryInterface"] | (Record | null); /** @description Define which vector name to use for querying. If missing, the default vector is used. */ using?: string | null; /** @description Filter conditions - return only those points that satisfy the specified conditions. */ filter?: components["schemas"]["Filter"] | (Record | null); /** @description Search params for when there is no prefetch */ params?: components["schemas"]["SearchParams"] | (Record | null); /** * Format: float * @description Return points with scores better than this threshold. */ score_threshold?: number | null; /** * Format: uint * @description Max number of points to return. Default is 10. */ limit?: number | null; /** * @description The location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in the current collection * @default null */ lookup_from?: components["schemas"]["LookupLocation"] | (Record | null); }; QueryInterface: components["schemas"]["VectorInput"] | components["schemas"]["Query"]; VectorInput: (number)[] | components["schemas"]["SparseVector"] | ((number)[])[] | components["schemas"]["ExtendedPointId"] | components["schemas"]["Document"] | components["schemas"]["Image"] | components["schemas"]["InferenceObject"]; Query: components["schemas"]["NearestQuery"] | components["schemas"]["RecommendQuery"] | components["schemas"]["DiscoverQuery"] | components["schemas"]["ContextQuery"] | components["schemas"]["OrderByQuery"] | components["schemas"]["FusionQuery"] | components["schemas"]["RrfQuery"] | components["schemas"]["FormulaQuery"] | components["schemas"]["SampleQuery"] | components["schemas"]["RelevanceFeedbackQuery"]; NearestQuery: { nearest: components["schemas"]["VectorInput"]; /** @description Perform MMR (Maximal Marginal Relevance) reranking after search, using the same vector in this query to calculate relevance. */ mmr?: components["schemas"]["Mmr"] | (Record | null); }; /** @description Maximal Marginal Relevance (MMR) algorithm for re-ranking the points. */ Mmr: { /** * Format: float * @description Tunable parameter for the MMR algorithm. Determines the balance between diversity and relevance. * * A higher value favors diversity (dissimilarity to selected results), while a lower value favors relevance (similarity to the query vector). * * Must be in the range [0, 1]. Default value is 0.5. */ diversity?: number | null; /** * Format: uint * @description The maximum number of candidates to consider for re-ranking. * * If not specified, the `limit` value is used. */ candidates_limit?: number | null; }; RecommendQuery: { recommend: components["schemas"]["RecommendInput"]; }; RecommendInput: { /** @description Look for vectors closest to the vectors from these points */ positive?: (components["schemas"]["VectorInput"])[] | null; /** @description Try to avoid vectors like the vector from these points */ negative?: (components["schemas"]["VectorInput"])[] | null; /** @description How to use the provided vectors to find the results */ strategy?: components["schemas"]["RecommendStrategy"] | (Record | null); }; /** * @description How to use positive and negative examples to find the results, default is `average_vector`: * * * `average_vector` - Average positive and negative vectors and create a single query with the formula `query = avg_pos + avg_pos - avg_neg`. Then performs normal search. * * * `best_score` - Uses custom search objective. Each candidate is compared against all examples, its score is then chosen from the `max(max_pos_score, max_neg_score)`. If the `max_neg_score` is chosen then it is squared and negated, otherwise it is just the `max_pos_score`. * * * `sum_scores` - Uses custom search objective. Compares against all inputs, sums all the scores. Scores against positive vectors are added, against negatives are subtracted. * @enum {string} */ RecommendStrategy: "average_vector" | "best_score" | "sum_scores"; DiscoverQuery: { discover: components["schemas"]["DiscoverInput"]; }; DiscoverInput: { target: components["schemas"]["VectorInput"]; /** @description Search space will be constrained by these pairs of vectors */ context: components["schemas"]["ContextPair"] | (components["schemas"]["ContextPair"])[] | (Record | null); }; ContextPair: { positive: components["schemas"]["VectorInput"]; negative: components["schemas"]["VectorInput"]; }; ContextQuery: { context: components["schemas"]["ContextInput"]; }; ContextInput: components["schemas"]["ContextPair"] | (components["schemas"]["ContextPair"])[] | (Record | null); OrderByQuery: { order_by: components["schemas"]["OrderByInterface"]; }; FusionQuery: { fusion: components["schemas"]["Fusion"]; }; /** * @description Fusion algorithm allows to combine results of multiple prefetches. * * Available fusion algorithms: * * * `rrf` - Reciprocal Rank Fusion (with default parameters) * `dbsf` - Distribution-Based Score Fusion * @enum {string} */ Fusion: "rrf" | "dbsf"; RrfQuery: { rrf: components["schemas"]["Rrf"]; }; /** @description Parameters for Reciprocal Rank Fusion */ Rrf: { /** * Format: uint * @description K parameter for reciprocal rank fusion * @default null */ k?: number | null; /** @description Weights for each prefetch source. Higher weight gives more influence on the final ranking. If not specified, all prefetches are weighted equally. The number of weights should match the number of prefetches. */ weights?: (number)[] | null; }; FormulaQuery: { formula: components["schemas"]["Expression"]; /** @default {} */ defaults?: { [key: string]: unknown; }; }; Expression: number | string | components["schemas"]["Condition"] | components["schemas"]["GeoDistance"] | components["schemas"]["DatetimeExpression"] | components["schemas"]["DatetimeKeyExpression"] | components["schemas"]["MultExpression"] | components["schemas"]["SumExpression"] | components["schemas"]["NegExpression"] | components["schemas"]["AbsExpression"] | components["schemas"]["DivExpression"] | components["schemas"]["SqrtExpression"] | components["schemas"]["PowExpression"] | components["schemas"]["ExpExpression"] | components["schemas"]["Log10Expression"] | components["schemas"]["LnExpression"] | components["schemas"]["LinDecayExpression"] | components["schemas"]["ExpDecayExpression"] | components["schemas"]["GaussDecayExpression"]; GeoDistance: { geo_distance: components["schemas"]["GeoDistanceParams"]; }; GeoDistanceParams: { origin: components["schemas"]["GeoPoint"]; /** @description Payload field with the destination geo point */ to: string; }; DatetimeExpression: { datetime: string; }; DatetimeKeyExpression: { datetime_key: string; }; MultExpression: { mult: (components["schemas"]["Expression"])[]; }; SumExpression: { sum: (components["schemas"]["Expression"])[]; }; NegExpression: { neg: components["schemas"]["Expression"]; }; AbsExpression: { abs: components["schemas"]["Expression"]; }; DivExpression: { div: components["schemas"]["DivParams"]; }; DivParams: { left: components["schemas"]["Expression"]; right: components["schemas"]["Expression"]; /** Format: float */ by_zero_default?: number | null; }; SqrtExpression: { sqrt: components["schemas"]["Expression"]; }; PowExpression: { pow: components["schemas"]["PowParams"]; }; PowParams: { base: components["schemas"]["Expression"]; exponent: components["schemas"]["Expression"]; }; ExpExpression: { exp: components["schemas"]["Expression"]; }; Log10Expression: { log10: components["schemas"]["Expression"]; }; LnExpression: { ln: components["schemas"]["Expression"]; }; LinDecayExpression: { lin_decay: components["schemas"]["DecayParamsExpression"]; }; DecayParamsExpression: { x: components["schemas"]["Expression"]; /** @description The target value to start decaying from. Defaults to 0. */ target?: components["schemas"]["Expression"] | (Record | null); /** * Format: float * @description The scale factor of the decay, in terms of `x`. Defaults to 1.0. Must be a non-zero positive number. */ scale?: number | null; /** * Format: float * @description The midpoint of the decay. Should be between 0 and 1.Defaults to 0.5. Output will be this value when `|x - target| == scale`. */ midpoint?: number | null; }; ExpDecayExpression: { exp_decay: components["schemas"]["DecayParamsExpression"]; }; GaussDecayExpression: { gauss_decay: components["schemas"]["DecayParamsExpression"]; }; SampleQuery: { sample: components["schemas"]["Sample"]; }; /** @enum {string} */ Sample: "random"; RelevanceFeedbackQuery: { relevance_feedback: components["schemas"]["RelevanceFeedbackInput"]; }; RelevanceFeedbackInput: { target: components["schemas"]["VectorInput"]; feedback: (components["schemas"]["FeedbackItem"])[]; strategy: components["schemas"]["FeedbackStrategy"]; }; FeedbackItem: { example: components["schemas"]["VectorInput"]; /** Format: float */ score: number; }; FeedbackStrategy: components["schemas"]["NaiveFeedbackStrategy"]; NaiveFeedbackStrategy: { naive: components["schemas"]["NaiveFeedbackStrategyParams"]; }; NaiveFeedbackStrategyParams: { /** Format: float */ a: number; /** Format: float */ b: number; /** Format: float */ c: number; }; /** @description Additional parameters of the search */ SearchParams: { /** * Format: uint * @description Params relevant to HNSW index Size of the beam in a beam-search. Larger the value - more accurate the result, more time required for search. */ hnsw_ef?: number | null; /** * @description Search without approximation. If set to true, search may run long but with exact results. * @default false */ exact?: boolean; /** @description Quantization params */ quantization?: components["schemas"]["QuantizationSearchParams"] | (Record | null); /** * @description If enabled, the engine will only perform search among indexed or small segments. Using this option prevents slow searches in case of delayed index, but does not guarantee that all uploaded vectors will be included in search results * @default false */ indexed_only?: boolean; /** @description ACORN search params */ acorn?: components["schemas"]["AcornSearchParams"] | (Record | null); /** @description Which population sparse vector IDF statistics are computed over. By default (or with explicit `"global"`) statistics are collection-wide. Only applicable to sparse vectors with the IDF modifier enabled. */ idf?: components["schemas"]["IdfParams"] | (Record | null); }; /** @description Additional parameters of the search */ QuantizationSearchParams: { /** * @description If true, quantized vectors are ignored. Default is false. * @default false */ ignore?: boolean; /** @description If true, use original vectors to re-score top-k results. Might require more time in case if original vectors are stored on disk. If not set, qdrant decides automatically apply rescoring or not. */ rescore?: boolean | null; /** * Format: double * @description Oversampling factor for quantization. Default is 1.0. * * Defines how many extra vectors should be preselected using quantized index, and then re-scored using original vectors. * * For example, if `oversampling` is 2.4 and `limit` is 100, then 240 vectors will be preselected using quantized index, and then top-100 will be returned after re-scoring. */ oversampling?: number | null; }; /** @description ACORN-related search parameters */ AcornSearchParams: { /** * @description If true, then ACORN may be used for the HNSW search based on filters selectivity. Improves search recall for searches with multiple low-selectivity payload filters, at cost of performance. * @default false */ enable?: boolean; /** * Format: double * @description Maximum selectivity of filters to enable ACORN. * * If estimated filters selectivity is higher than this value, ACORN will not be used. Selectivity is estimated as: `estimated number of points satisfying the filters / total number of points`. * * 0.0 for never, 1.0 for always. Default is 0.4. */ max_selectivity?: number | null; }; /** * @description Population over which sparse vector IDF statistics are computed for scoring — the *IDF corpus*. * * - `"global"` — collection-wide statistics, same as omitting the parameter. - `{ "corpus": }` — document count and per-term document frequencies are computed over the points matching the corpus filter only. The corpus is independent of the retrieval filter and is usually broader than it. */ IdfParams: components["schemas"]["IdfScope"] | components["schemas"]["IdfCorpusParams"]; /** * @description Named IDF scope without a corpus filter. * @enum {string} */ IdfScope: "global"; /** @description IDF statistics computed over the points matching a corpus filter. */ IdfCorpusParams: { corpus: components["schemas"]["Filter"]; }; /** @description Defines a location to use for looking up the vector. Specifies collection and vector field name. */ LookupLocation: { /** @description Name of the collection used for lookup */ collection: string; /** * @description Optional name of the vector field within the collection. If not provided, the default vector field will be used. * @default null */ vector?: string | null; /** @description Specify in which shards to look for the points, if not specified - look in all shards */ shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); }; QueryRequestBatch: { searches: (components["schemas"]["QueryRequest"])[]; }; QueryResponse: { points: (components["schemas"]["ScoredPoint"])[]; }; QueryGroupsRequest: { shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); /** * @description Sub-requests to perform first. If present, the query will be performed on the results of the prefetch(es). * @default null */ prefetch?: components["schemas"]["Prefetch"] | (components["schemas"]["Prefetch"])[] | (Record | null); /** @description Query to perform. If missing without prefetches, returns points ordered by their IDs. */ query?: components["schemas"]["QueryInterface"] | (Record | null); /** @description Define which vector name to use for querying. If missing, the default vector is used. */ using?: string | null; /** @description Filter conditions - return only those points that satisfy the specified conditions. */ filter?: components["schemas"]["Filter"] | (Record | null); /** @description Search params for when there is no prefetch */ params?: components["schemas"]["SearchParams"] | (Record | null); /** * Format: float * @description Return points with scores better than this threshold. */ score_threshold?: number | null; /** @description Options for specifying which vectors to include into the response. Default is false. */ with_vector?: components["schemas"]["WithVector"] | (Record | null); /** @description Options for specifying which payload to include or not. Default is false. */ with_payload?: components["schemas"]["WithPayloadInterface"] | (Record | null); /** * @description The location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in the current collection * @default null */ lookup_from?: components["schemas"]["LookupLocation"] | (Record | null); /** @description Payload field to group by, must be a string or number field. If the field contains more than 1 value, all values will be used for grouping. One point can be in multiple groups. */ group_by: string; /** * Format: uint * @description Maximum amount of points to return per group. Default is 3. */ group_size?: number | null; /** * Format: uint * @description Maximum amount of groups to return. Default is 10. */ limit?: number | null; /** @description Look for points in another collection using the group ids */ with_lookup?: components["schemas"]["WithLookupInterface"] | (Record | null); }; WithLookupInterface: string | components["schemas"]["WithLookup"]; WithLookup: { /** @description Name of the collection to use for points lookup */ collection: string; /** * @description Options for specifying which payload to include (or not) * @default true */ with_payload?: components["schemas"]["WithPayloadInterface"] | (Record | null); /** * @description Options for specifying which vectors to include (or not) * @default null */ with_vectors?: components["schemas"]["WithVector"] | (Record | null); }; SearchMatrixRequest: { /** @description Specify in which shards to look for the points, if not specified - look in all shards */ shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); /** @description Look only for points which satisfies this conditions */ filter?: components["schemas"]["Filter"] | (Record | null); /** * Format: uint * @description How many points to select and search within. Default is 10. */ sample?: number | null; /** * Format: uint * @description How many neighbours per sample to find. Default is 3. */ limit?: number | null; /** @description Define which vector name to use for querying. If missing, the default vector is used. */ using?: string | null; }; SearchMatrixOffsetsResponse: { /** @description Row indices of the matrix */ offsets_row: (number)[]; /** @description Column indices of the matrix */ offsets_col: (number)[]; /** @description Scores associated with matrix coordinates */ scores: (number)[]; /** @description Ids of the points in order */ ids: (components["schemas"]["ExtendedPointId"])[]; }; SearchMatrixPairsResponse: { /** @description List of pairs of points with scores */ pairs: (components["schemas"]["SearchMatrixPair"])[]; }; /** @description Pair of points (a, b) with score */ SearchMatrixPair: { a: components["schemas"]["ExtendedPointId"]; b: components["schemas"]["ExtendedPointId"]; /** Format: float */ score: number; }; FacetRequest: { shard_key?: components["schemas"]["ShardKeySelector"] | (Record | null); /** @description Payload key to use for faceting. */ key: string; /** * Format: uint * @description Max number of hits to return. Default is 10. */ limit?: number | null; /** @description Filter conditions - only consider points that satisfy these conditions. */ filter?: components["schemas"]["Filter"] | (Record | null); /** @description Whether to do a more expensive exact count for each of the values in the facet. Default is false. */ exact?: boolean | null; }; FacetResponse: { hits: (components["schemas"]["FacetValueHit"])[]; }; FacetValueHit: { value: components["schemas"]["FacetValue"]; /** Format: uint */ count: number; }; FacetValue: string | number | boolean; /** @description Usage of the hardware resources, spent to process the request */ Usage: { hardware?: components["schemas"]["HardwareUsage"] | (Record | null); inference?: components["schemas"]["InferenceUsage"] | (Record | null); }; InferenceUsage: { models: { [key: string]: components["schemas"]["ModelUsage"] | undefined; }; }; ModelUsage: { /** Format: uint64 */ tokens: number; }; ShardKeysResponse: { /** @description The existing shard keys. Only available when sharding method is `custom` */ shard_keys?: (components["schemas"]["ShardKeyDescription"])[] | null; }; ShardKeyDescription: { key: components["schemas"]["ShardKey"]; }; /** @description Optimizations progress for the collection */ OptimizationsResponse: { summary: components["schemas"]["OptimizationsSummary"]; /** @description Currently running optimizations. */ running: (components["schemas"]["Optimization"])[]; /** @description An estimated queue of pending optimizations. Requires `?with=queued`. */ queued?: (components["schemas"]["PendingOptimization"])[] | null; /** @description Completed optimizations. Requires `?with=completed`. Limited by `?completed_limit=N`. */ completed?: (components["schemas"]["Optimization"])[] | null; /** @description Segments that don't require optimization. Requires `?with=idle_segments`. */ idle_segments?: (components["schemas"]["OptimizationSegmentInfo"])[] | null; }; OptimizationsSummary: { /** * Format: uint * @description Number of pending optimizations in the queue. Each optimization will take one or more unoptimized segments and produce one optimized segment. */ queued_optimizations: number; /** * Format: uint * @description Number of unoptimized segments in the queue. */ queued_segments: number; /** * Format: uint * @description Number of points in unoptimized segments in the queue. */ queued_points: number; /** * Format: uint * @description Number of segments that don't require optimization. */ idle_segments: number; }; Optimization: { /** * Format: uuid * @description Unique identifier of the optimization process. * * After the optimization is complete, a new segment will be created with this UUID. */ uuid: string; /** @description Name of the optimizer that performed this optimization. */ optimizer: string; status: components["schemas"]["TrackerStatus"]; /** * @description Segments being optimized. * * After the optimization is complete, these segments will be replaced by the new optimized segment. */ segments: (components["schemas"]["OptimizationSegmentInfo"])[]; progress: components["schemas"]["ProgressTree"]; }; OptimizationSegmentInfo: { /** * Format: uuid * @description Unique identifier of the segment. */ uuid: string; /** * Format: uint * @description Number of non-deleted points in the segment. */ points_count: number; }; ProgressTree: { /** @description Name of the operation. */ name: string; /** * Format: date-time * @description When the operation started. */ started_at?: string | null; /** * Format: date-time * @description When the operation finished. */ finished_at?: string | null; /** * Format: double * @description For finished operations, how long they took, in seconds. */ duration_sec?: number | null; /** * Format: uint64 * @description Number of completed units of work, if applicable. */ done?: number | null; /** * Format: uint64 * @description Total number of units of work, if applicable and known. */ total?: number | null; /** @description Child operations. */ children?: (components["schemas"]["ProgressTree"])[]; }; PendingOptimization: { /** @description Name of the optimizer that scheduled this optimization. */ optimizer: string; /** @description Segments that will be optimized. */ segments: (components["schemas"]["OptimizationSegmentInfo"])[]; }; DistributedTelemetryData: { collections: { [key: string]: components["schemas"]["DistributedCollectionTelemetry"] | undefined; }; cluster?: components["schemas"]["DistributedClusterTelemetry"] | (Record | null); }; DistributedCollectionTelemetry: { /** @description Collection name */ id: string; /** @description Shards topology */ shards?: (components["schemas"]["DistributedShardTelemetry"])[] | null; /** @description Ongoing resharding operations */ reshardings?: (components["schemas"]["ReshardingInfo"])[] | null; /** @description Ongoing shard transfers */ shard_transfers?: (components["schemas"]["ShardTransferInfo"])[] | null; }; DistributedShardTelemetry: { /** * Format: uint32 * @description Shard ID */ id: number; /** @description Optional shard key */ key?: components["schemas"]["ShardKey"] | (Record | null); /** @description Replica information */ replicas: (components["schemas"]["DistributedReplicaTelemetry"])[]; }; DistributedReplicaTelemetry: { /** * Format: uint64 * @description Peer ID hosting this replica */ peer_id: number; state: components["schemas"]["ReplicaState"]; /** @description Shard status */ status?: components["schemas"]["ShardStatus"] | (Record | null); /** * Format: uint * @description Total optimized points */ total_optimized_points?: number | null; /** * Format: uint * @description Estimated vectors size in bytes */ vectors_size_bytes?: number | null; /** * Format: uint * @description Estimated payloads size in bytes */ payloads_size_bytes?: number | null; /** * Format: uint * @description Approximate number of points */ num_points?: number | null; /** * Format: uint * @description Approximate number of vectors */ num_vectors?: number | null; /** @description Approximate number of vectors by name */ num_vectors_by_name?: ({ [key: string]: number | undefined; }) | null; /** @description Shard cleaning task status. After a resharding, a cleanup task is performed to remove outdated points from this shard. */ shard_cleaning_status?: components["schemas"]["ShardCleanStatusTelemetry"] | (Record | null); /** @description Partial snapshot telemetry */ partial_snapshot?: components["schemas"]["PartialSnapshotTelemetry"] | (Record | null); }; DistributedClusterTelemetry: { enabled: boolean; /** Format: uint64 */ number_of_peers?: number | null; peers: { [key: string]: components["schemas"]["DistributedPeerInfo"] | undefined; }; }; DistributedPeerInfo: { /** @description URI of the peer */ uri: string; /** @description Whether this peer responded for this request */ responsive: boolean; /** @description If responsive, these details should be available */ details?: components["schemas"]["DistributedPeerDetails"] | (Record | null); }; DistributedPeerDetails: { /** @description Qdrant version */ version: string; /** @description Consensus role for the peer */ role?: components["schemas"]["StateRole"] | (Record | null); /** @description Whether it can participate in leader elections */ is_voter: boolean; /** * Format: uint64 * @description Election term */ term: number; /** * Format: uint64 * @description Latest accepted commit */ commit: number; /** * Format: uint64 * @description Number of operations pending for being applied */ num_pending_operations: number; consensus_thread_status: components["schemas"]["ConsensusThreadStatus"]; }; /** * @description Configuration for creating a new named vector. * * Contains only the immutable properties that define a vector space. Storage type, index, and quantization are determined automatically based on the segment type and can be configured separately later. * * Example JSON for a dense vector: ```json { "dense": { "size": 768, "distance": "Cosine" } } ``` * * Example JSON for a sparse vector: ```json { "sparse": { "modifier": "Idf" } } ``` */ VectorNameConfig: components["schemas"]["DenseVectorNameConfig"] | components["schemas"]["SparseVectorNameConfig"]; /** @description Wrapper for dense vector creation config. */ DenseVectorNameConfig: { dense: components["schemas"]["DenseVectorConfig"]; }; /** * @description Configuration for creating a new dense named vector. * * Only includes properties that define the vector space and cannot be changed after creation. Storage type, index type, and quantization are inferred. */ DenseVectorConfig: { /** * Format: uint * @description Dimensionality of the vectors */ size: number; distance: components["schemas"]["Distance"]; /** @description Configuration for multi-vector points (e.g., ColBERT) */ multivector_config?: components["schemas"]["MultiVectorConfig"] | (Record | null); /** @description Element storage type (Float32, Float16, Uint8, Turbo4) */ datatype?: components["schemas"]["VectorStorageDatatype"] | (Record | null); }; /** @description Wrapper for sparse vector creation config. */ SparseVectorNameConfig: { sparse: components["schemas"]["SparseVectorConfig"]; }; /** * @description Configuration for creating a new sparse named vector. * * Only includes properties that define the vector space and cannot be changed after creation. */ SparseVectorConfig: { /** @description Value modifier for sparse vectors (e.g., IDF) */ modifier?: components["schemas"]["Modifier"] | (Record | null); /** @description Datatype used to store weights in the index */ datatype?: components["schemas"]["VectorStorageDatatype"] | (Record | null); }; /** * @description Quota configuration in effect, and how close each peer is to it. * * The configuration is cluster-wide; the utilization is not. `usage` is the node that served the request, and `peers` is what every peer that answered reports about itself — memory and disk are node-local, so one peer being under its limit says nothing about the others. */ QuotaStatus: { config: components["schemas"]["QuotaConfig"]; usage: components["schemas"]["QuotaUsage"]; /** * @description Utilization reported by each peer, keyed by peer ID, including the one that served the request. * * Only peers that answered are listed: a peer missing from the map could not be reached, which is itself worth seeing. Absent entirely outside distributed mode, where there are no peers to ask. */ peers?: ({ [key: string]: components["schemas"]["PeerQuotaUsage"] | undefined; }) | null; }; /** * @description Utilization of the quota-managed resources **on this node alone** — memory and disk are node-local, so a peer under its limit says nothing about the rest of the cluster. * * A field is `null` when the platform does not expose the underlying stat. */ QuotaUsage: { /** * Format: uint8 * @description Resident memory of this node's process, as a percentage of the memory available to it (cgroup limit if one applies, else total system memory). */ resident_memory_percent?: number | null; /** * Format: uint8 * @description Used space of this node's storage filesystem, as a percentage of its capacity. */ disk_usage_percent?: number | null; }; /** @description What one peer reports about the quota it is enforcing. */ PeerQuotaUsage: { /** @description Whether this peer is at or over one of the enforced limits, and so is currently refusing updates. Always false while the quota is disabled. */ exceeded: boolean; /** * Format: uint8 * @description Resident memory of this node's process, as a percentage of the memory available to it (cgroup limit if one applies, else total system memory). */ resident_memory_percent?: number | null; /** * Format: uint8 * @description Used space of this node's storage filesystem, as a percentage of its capacity. */ disk_usage_percent?: number | null; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } export type external = Record; export interface operations { /** List shard keys */ list_shard_keys: { parameters: { path: { /** @description Name of the collection to list shard keys for */ collection_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["ShardKeysResponse"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** Create shard key */ create_shard_key: { parameters: { query?: { /** * @description Wait for operation commit timeout in seconds. * If timeout is reached - request will return with service error. */ timeout?: number; }; path: { /** @description Name of the collection to create shards for */ collection_name: string; }; }; /** @description Shard key configuration */ requestBody?: { content: { "application/json": components["schemas"]["CreateShardingKey"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** Delete shard key */ delete_shard_key: { parameters: { query?: { /** * @description Wait for operation commit timeout in seconds. * If timeout is reached - request will return with service error. */ timeout?: number; }; path: { /** @description Name of the collection to create shards for */ collection_name: string; }; }; /** @description Select shard key to delete */ requestBody?: { content: { "application/json": components["schemas"]["DropShardingKey"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Returns information about the running Qdrant instance * @description Returns information about the running Qdrant instance like version and commit id */ root: { responses: { /** @description Qdrant server version information */ 200: { content: { "application/json": components["schemas"]["VersionInfo"]; }; }; /** @description error */ "4XX": never; }; }; /** * Collect telemetry data * @description Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics */ telemetry: { parameters: { query?: { /** @description If true, anonymize result */ anonymize?: boolean; /** @description Level of details in telemetry data. Minimal level is 0, maximal is infinity */ details_level?: number; /** @description If true, include per-collection request statistics in the response */ per_collection?: boolean; /** @description Timeout for this request */ timeout?: number; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["TelemetryData"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Collect Prometheus metrics data * @description Collect metrics data including app info, collections info, cluster info and statistics */ metrics: { parameters: { query?: { /** @description If true, anonymize result */ anonymize?: boolean; /** @description If true, include per-collection request metrics with a collection label instead of global request metrics */ per_collection?: boolean; /** @description Timeout for this request */ timeout?: number; }; }; responses: { /** @description Metrics data in Prometheus format */ 200: { content: { "text/plain": string; }; }; /** @description error */ "4XX": never; }; }; /** * Kubernetes healthz endpoint * @description Liveness-style health check. Returns 200 as soon as the HTTP API is serving requests. It does not inspect collections, shards or consensus state, and is identical to `/livez`. Use it only to detect whether the process is up and responsive. */ healthz: { responses: { /** @description Healthz response */ 200: { content: { "text/plain": string; }; }; /** @description error */ "4XX": never; }; }; /** * Kubernetes livez endpoint * @description Kubernetes liveness probe. Returns 200 as soon as the HTTP API is serving requests. It does not inspect collections, shards or consensus state, and is identical to `/healthz`. A failure indicates the process is unresponsive and should be restarted. */ livez: { responses: { /** @description Healthz response */ 200: { content: { "text/plain": string; }; }; /** @description error */ "4XX": never; }; }; /** * Kubernetes readyz endpoint * @description Kubernetes readiness probe. Checks the instance and waits out pending data operations to see when it can start accepting traffic. In a distributed deployment it returns 200 only once the node has caught up with the cluster consensus commit and its local shards are healthy; otherwise it returns 503. In a single-node deployment it always returns 200 once the API is up. Use it to decide when to route traffic to the instance. */ readyz: { responses: { /** @description The instance is ready to accept traffic */ 200: { content: { "text/plain": string; }; }; /** @description The instance is not ready to accept traffic yet */ 503: { content: { "text/plain": string; }; }; /** @description error */ "4XX": never; }; }; /** * Get issues * @description Get a report of performance issues and configuration suggestions */ get_issues: { responses: { /** @description Successful response */ 200: { content: { "application/json": Record; }; }; /** @description error */ "4XX": never; }; }; /** * Clear issues * @description Removes all issues reported so far */ clear_issues: { responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Get cluster status info * @description Get information about the current state and composition of the cluster */ cluster_status: { responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["ClusterStatus"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Collect cluster telemetry data * @description Get telemetry data, from the point of view of the cluster. This includes peers info, collections info, shard transfers, and resharding status */ cluster_telemetry: { parameters: { query?: { /** @description The level of detail to include in the response */ details_level?: number; /** @description Timeout for this request */ timeout?: number; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["DistributedTelemetryData"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** Tries to recover current peer Raft state. */ recover_current_peer: { responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Remove peer from the cluster * @description Tries to remove peer from the cluster. Will return an error if peer has shards on it. */ remove_peer: { parameters: { query?: { /** * @description Wait for operation commit timeout in seconds. * If timeout is reached - request will return with service error. */ timeout?: number; /** @description If true - removes peer even if it has shards/replicas on it. */ force?: boolean; }; path: { /** @description Id of the peer */ peer_id: number; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Get global quotas * @description Get the cluster-wide resource quota configuration, together with the current utilization it is measured against. * The configuration is the same on every peer, but the reported utilization is for the node serving this request only - * memory and disk are node-local, so query each peer to see where the whole cluster stands. */ get_quotas: { responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["QuotaStatus"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Set global quotas * @description Replace the cluster-wide resource quota configuration. The new configuration is propagated to every peer through consensus and persisted, so it survives restarts */ update_quotas: { parameters: { query?: { /** * @description If true, wait until the new configuration is confirmed by consensus on this peer. * If false - the request returns as soon as the change is proposed. */ wait?: boolean; }; }; /** @description Quota configuration to apply */ requestBody?: { content: { "application/json": components["schemas"]["QuotaConfig"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * List collections * @description Get list name of all existing collections */ get_collections: { responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["CollectionsResponse"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Collection info * @description Get detailed information about specified existing collection */ get_collection: { parameters: { path: { /** @description Name of the collection to retrieve */ collection_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["CollectionInfo"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Create collection * @description Create new collection with given parameters */ create_collection: { parameters: { query?: { /** * @description Wait for operation commit timeout in seconds. * If timeout is reached - request will return with service error. */ timeout?: number; }; path: { /** @description Name of the new collection */ collection_name: string; }; }; /** @description Parameters of a new collection */ requestBody?: { content: { "application/json": components["schemas"]["CreateCollection"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Delete collection * @description Drop collection and all associated data */ delete_collection: { parameters: { query?: { /** * @description Wait for operation commit timeout in seconds. * If timeout is reached - request will return with service error. */ timeout?: number; }; path: { /** @description Name of the collection to delete */ collection_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Update collection parameters * @description Update parameters of the existing collection */ update_collection: { parameters: { query?: { /** * @description Wait for operation commit timeout in seconds. * If timeout is reached - request will return with service error. */ timeout?: number; }; path: { /** @description Name of the collection to update */ collection_name: string; }; }; /** @description New parameters */ requestBody?: { content: { "application/json": components["schemas"]["UpdateCollection"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** Update aliases of the collections */ update_aliases: { parameters: { query?: { /** * @description Wait for operation commit timeout in seconds. * If timeout is reached - request will return with service error. */ timeout?: number; }; }; /** @description Alias update operations */ requestBody?: { content: { "application/json": components["schemas"]["ChangeAliasesOperation"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Create index for field in collection * @description Create index for field in collection */ create_field_index: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection */ collection_name: string; }; }; /** @description Field name */ requestBody?: { content: { "application/json": components["schemas"]["CreateFieldIndex"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Check the existence of a collection * @description Returns "true" if the given collection name exists, and "false" otherwise */ collection_exists: { parameters: { path: { /** @description Name of the collection */ collection_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["CollectionExistence"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Delete index for field in collection * @description Delete field index for collection */ delete_field_index: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection */ collection_name: string; /** @description Name of the field where to delete the index */ field_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Create named vector * @description Create a new named vector on an existing collection */ create_vector_name: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection */ collection_name: string; /** @description Name of the vector to create */ vector_name: string; }; }; /** @description Vector configuration - dense or sparse */ requestBody?: { content: { "application/json": components["schemas"]["VectorNameConfig"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Delete named vector * @description Delete a named vector from a collection */ delete_vector_name: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection */ collection_name: string; /** @description Name of the vector to delete */ vector_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Collection cluster info * @description Get cluster information for a collection */ collection_cluster_info: { parameters: { path: { /** @description Name of the collection to retrieve the cluster info for */ collection_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["CollectionClusterInfo"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** Update collection cluster setup */ update_collection_cluster: { parameters: { query?: { /** * @description Wait for operation commit timeout in seconds. * If timeout is reached - request will return with service error. */ timeout?: number; }; path: { /** @description Name of the collection on which to to apply the cluster update operation */ collection_name: string; }; }; /** @description Collection cluster update operations */ requestBody?: { content: { "application/json": components["schemas"]["ClusterOperations"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Get optimization progress * @description Get progress of ongoing and completed optimizations for a collection */ get_optimizations: { parameters: { query?: { /** * @description Comma-separated list of optional fields to include in the response. * Possible values: queued, completed, idle_segments. */ with?: string; /** * @description Maximum number of completed optimizations to return. * Ignored if `completed` is not in the `with` parameter. */ completed_limit?: number; }; path: { /** @description Name of the collection */ collection_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["OptimizationsResponse"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * List aliases for collection * @description Get list of all aliases for a collection */ get_collection_aliases: { parameters: { path: { /** @description Name of the collection */ collection_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["CollectionsAliasesResponse"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * List collections aliases * @description Get list of all existing collections aliases */ get_collections_aliases: { responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["CollectionsAliasesResponse"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Recover from an uploaded snapshot * @description Recover local collection data from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created. */ recover_from_uploaded_snapshot: { parameters: { query?: { /** @description If true, wait for changes to actually happen. If false - let changes happen in background. Default is true. */ wait?: boolean; /** @description Defines source of truth for snapshot recovery */ priority?: components["schemas"]["SnapshotPriority"]; /** @description Optional SHA256 checksum to verify snapshot integrity before recovery. */ checksum?: string; }; path: { /** @description Name of the collection */ collection_name: string; }; }; /** @description Snapshot to recover from */ requestBody?: { content: { "multipart/form-data": { /** Format: binary */ snapshot?: string; }; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description operation is accepted */ 202: { content: { "application/json": { /** * Format: float * @description Time spent to process this request */ time?: number; status?: string; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Recover from a snapshot * @description Recover local collection data from a snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created. */ recover_from_snapshot: { parameters: { query?: { /** @description If true, wait for changes to actually happen. If false - let changes happen in background. Default is true. */ wait?: boolean; }; path: { /** @description Name of the collection */ collection_name: string; }; }; /** @description Snapshot to recover from */ requestBody?: { content: { "application/json": components["schemas"]["SnapshotRecover"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description operation is accepted */ 202: { content: { "application/json": { /** * Format: float * @description Time spent to process this request */ time?: number; status?: string; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * List collection snapshots * @description Get list of snapshots for a collection */ list_snapshots: { parameters: { path: { /** @description Name of the collection */ collection_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: (components["schemas"]["SnapshotDescription"])[]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Create collection snapshot * @description Create new snapshot for a collection */ create_snapshot: { parameters: { query?: { /** @description If true, wait for changes to actually happen. If false - let changes happen in background. Default is true. */ wait?: boolean; }; path: { /** @description Name of the collection for which to create a snapshot */ collection_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["SnapshotDescription"]; }; }; }; /** @description operation is accepted */ 202: { content: { "application/json": { /** * Format: float * @description Time spent to process this request */ time?: number; status?: string; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Download collection snapshot * @description Download specified snapshot from a collection as a file */ get_snapshot: { parameters: { path: { /** @description Name of the collection */ collection_name: string; /** @description Name of the snapshot to download */ snapshot_name: string; }; }; responses: { /** @description Snapshot file */ 200: { content: { "application/octet-stream": string; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Delete collection snapshot * @description Delete snapshot for a collection */ delete_snapshot: { parameters: { query?: { /** @description If true, wait for changes to actually happen. If false - let changes happen in background. Default is true. */ wait?: boolean; }; path: { /** @description Name of the collection for which to delete a snapshot */ collection_name: string; /** @description Name of the snapshot to delete */ snapshot_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description operation is accepted */ 202: { content: { "application/json": { /** * Format: float * @description Time spent to process this request */ time?: number; status?: string; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * List of storage snapshots * @description Get list of snapshots of the whole storage */ list_full_snapshots: { responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: (components["schemas"]["SnapshotDescription"])[]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Create storage snapshot * @description Create new snapshot of the whole storage */ create_full_snapshot: { parameters: { query?: { /** @description If true, wait for changes to actually happen. If false - let changes happen in background. Default is true. */ wait?: boolean; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["SnapshotDescription"]; }; }; }; /** @description operation is accepted */ 202: { content: { "application/json": { /** * Format: float * @description Time spent to process this request */ time?: number; status?: string; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Download storage snapshot * @description Download specified snapshot of the whole storage as a file */ get_full_snapshot: { parameters: { path: { /** @description Name of the snapshot to download */ snapshot_name: string; }; }; responses: { /** @description Snapshot file */ 200: { content: { "application/octet-stream": string; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Delete storage snapshot * @description Delete snapshot of the whole storage */ delete_full_snapshot: { parameters: { query?: { /** @description If true, wait for changes to actually happen. If false - let changes happen in background. Default is true. */ wait?: boolean; }; path: { /** @description Name of the full snapshot to delete */ snapshot_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description operation is accepted */ 202: { content: { "application/json": { /** * Format: float * @description Time spent to process this request */ time?: number; status?: string; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Download shard snapshot * @description Stream the current state of a shard as a snapshot file */ stream_shard_snapshot: { parameters: { path: { /** @description Name of the collection */ collection_name: string; /** @description Id of the shard */ shard_id: number; }; }; responses: { /** @description Snapshot file */ 200: { content: { "application/octet-stream": string; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Recover shard from an uploaded snapshot * @description Recover shard of a local collection from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection shard. */ recover_shard_from_uploaded_snapshot: { parameters: { query?: { /** @description If true, wait for changes to actually happen. If false - let changes happen in background. Default is true. */ wait?: boolean; /** @description Defines source of truth for snapshot recovery */ priority?: components["schemas"]["SnapshotPriority"]; /** @description Optional SHA256 checksum to verify snapshot integrity before recovery. */ checksum?: string; }; path: { /** @description Name of the collection */ collection_name: string; /** @description Id of the shard to recover */ shard_id: number; }; }; /** @description Snapshot to recover from */ requestBody?: { content: { "multipart/form-data": { /** Format: binary */ snapshot?: string; }; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description operation is accepted */ 202: { content: { "application/json": { /** * Format: float * @description Time spent to process this request */ time?: number; status?: string; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Recover from a snapshot * @description Recover shard of a local collection data from a snapshot. This will overwrite any data, stored in this shard, for the collection. */ recover_shard_from_snapshot: { parameters: { query?: { /** @description If true, wait for changes to actually happen. If false - let changes happen in background. Default is true. */ wait?: boolean; }; path: { /** @description Name of the collection */ collection_name: string; /** @description Id of the shard to recover */ shard_id: number; }; }; /** @description Snapshot to recover from */ requestBody?: { content: { "application/json": components["schemas"]["ShardSnapshotRecover"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description operation is accepted */ 202: { content: { "application/json": { /** * Format: float * @description Time spent to process this request */ time?: number; status?: string; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * List shards snapshots for a collection * @description Get list of snapshots for a shard of a collection */ list_shard_snapshots: { parameters: { path: { /** @description Name of the collection */ collection_name: string; /** @description Id of the shard */ shard_id: number; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: (components["schemas"]["SnapshotDescription"])[]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Create shard snapshot * @description Create new snapshot of a shard for a collection */ create_shard_snapshot: { parameters: { query?: { /** @description If true, wait for changes to actually happen. If false - let changes happen in background. Default is true. */ wait?: boolean; }; path: { /** @description Name of the collection for which to create a snapshot */ collection_name: string; /** @description Id of the shard */ shard_id: number; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["SnapshotDescription"]; }; }; }; /** @description operation is accepted */ 202: { content: { "application/json": { /** * Format: float * @description Time spent to process this request */ time?: number; status?: string; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Download collection snapshot * @description Download specified snapshot of a shard from a collection as a file */ get_shard_snapshot: { parameters: { path: { /** @description Name of the collection */ collection_name: string; /** @description Id of the shard */ shard_id: number; /** @description Name of the snapshot to download */ snapshot_name: string; }; }; responses: { /** @description Snapshot file */ 200: { content: { "application/octet-stream": string; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Delete shard snapshot * @description Delete snapshot of a shard for a collection */ delete_shard_snapshot: { parameters: { query?: { /** @description If true, wait for changes to actually happen. If false - let changes happen in background. Default is true. */ wait?: boolean; }; path: { /** @description Name of the collection for which to delete a snapshot */ collection_name: string; /** @description Id of the shard */ shard_id: number; /** @description Name of the snapshot to delete */ snapshot_name: string; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: boolean; }; }; }; /** @description operation is accepted */ 202: { content: { "application/json": { /** * Format: float * @description Time spent to process this request */ time?: number; status?: string; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Get point * @description Retrieve full information of single point by id */ get_point: { parameters: { query?: { /** @description Define read consistency guarantees for the operation */ consistency?: components["schemas"]["ReadConsistency"]; }; path: { /** @description Name of the collection to retrieve from */ collection_name: string; /** @description Id of the point */ id: components["schemas"]["ExtendedPointId"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["Record"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Upsert points * @description Perform insert + updates on points. If point with given ID already exists - it will be overwritten. */ upsert_points: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection to update from */ collection_name: string; }; }; /** @description Operation to perform on points */ requestBody?: { content: { "application/json": components["schemas"]["PointInsertOperations"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Get points * @description Retrieve multiple points by specified IDs */ get_points: { parameters: { query?: { /** @description Define read consistency guarantees for the operation */ consistency?: components["schemas"]["ReadConsistency"]; /** @description If set, overrides global timeout for this request. Unit is seconds. */ timeout?: number; }; path: { /** @description Name of the collection to retrieve from */ collection_name: string; }; }; /** @description List of points to retrieve */ requestBody?: { content: { "application/json": components["schemas"]["PointRequest"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: (components["schemas"]["Record"])[]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Delete points * @description Delete points */ delete_points: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection to delete from */ collection_name: string; }; }; /** @description Operation to perform on points */ requestBody?: { content: { "application/json": components["schemas"]["PointsSelector"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Update vectors * @description Update specified named vectors on points, keep unspecified vectors intact. */ update_vectors: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection to update from */ collection_name: string; }; }; /** @description Update named vectors on points */ requestBody?: { content: { "application/json": components["schemas"]["UpdateVectors"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Delete vectors * @description Delete named vectors from the given points. */ delete_vectors: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection to delete from */ collection_name: string; }; }; /** @description Delete named vectors from points */ requestBody?: { content: { "application/json": components["schemas"]["DeleteVectors"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Overwrite payload * @description Replace full payload of points with new one */ overwrite_payload: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection to set from */ collection_name: string; }; }; /** @description Payload and points selector */ requestBody?: { content: { "application/json": components["schemas"]["SetPayload"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Set payload * @description Set payload values for points */ set_payload: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection to set from */ collection_name: string; }; }; /** @description Set payload on points */ requestBody?: { content: { "application/json": components["schemas"]["SetPayload"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Delete payload * @description Delete specified key payload for points */ delete_payload: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection to delete from */ collection_name: string; }; }; /** @description delete payload on points */ requestBody?: { content: { "application/json": components["schemas"]["DeletePayload"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Clear payload * @description Remove all payload for specified points */ clear_payload: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection to clear payload from */ collection_name: string; }; }; /** @description clear payload on points */ requestBody?: { content: { "application/json": components["schemas"]["PointsSelector"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["UpdateResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Batch update points * @description Apply a series of update operations for points, vectors and payloads */ batch_update: { parameters: { query?: { /** @description If true, wait for changes to actually happen */ wait?: boolean; /** @description define ordering guarantees for the operation */ ordering?: components["schemas"]["WriteOrdering"]; /** @description Timeout for the operation */ timeout?: number; }; path: { /** @description Name of the collection to apply operations on */ collection_name: string; }; }; /** @description update operations */ requestBody?: { content: { "application/json": components["schemas"]["UpdateOperations"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: (components["schemas"]["UpdateResult"])[]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Scroll points * @description Scroll request - paginate over all points which matches given filtering condition */ scroll_points: { parameters: { query?: { /** @description Define read consistency guarantees for the operation */ consistency?: components["schemas"]["ReadConsistency"]; /** @description If set, overrides global timeout for this request. Unit is seconds. */ timeout?: number; }; path: { /** @description Name of the collection to retrieve from */ collection_name: string; }; }; /** @description Pagination and filter parameters */ requestBody?: { content: { "application/json": components["schemas"]["ScrollRequest"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["ScrollResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Count points * @description Count points which matches given filtering condition */ count_points: { parameters: { query?: { /** @description Define read consistency guarantees for the operation */ consistency?: components["schemas"]["ReadConsistency"]; /** @description If set, overrides global timeout for this request. Unit is seconds. */ timeout?: number; }; path: { /** @description Name of the collection to count in */ collection_name: string; }; }; /** @description Request counts of points which matches given filtering condition */ requestBody?: { content: { "application/json": components["schemas"]["CountRequest"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["CountResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Facet a payload key with a given filter. * @description Count points that satisfy the given filter for each unique value of a payload key. */ facet: { parameters: { query?: { /** @description Define read consistency guarantees for the operation */ consistency?: components["schemas"]["ReadConsistency"]; /** @description If set, overrides global timeout for this request. Unit is seconds. */ timeout?: number; }; path: { /** @description Name of the collection to facet in */ collection_name: string; }; }; /** @description Request counts of points for each unique value of a payload key */ requestBody?: { content: { "application/json": components["schemas"]["FacetRequest"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["FacetResponse"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Query points * @description Universally query points. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries. */ query_points: { parameters: { query?: { /** @description Define read consistency guarantees for the operation */ consistency?: components["schemas"]["ReadConsistency"]; /** @description If set, overrides global timeout for this request. Unit is seconds. */ timeout?: number; }; path: { /** @description Name of the collection to query */ collection_name: string; }; }; /** @description Describes the query to make to the collection */ requestBody?: { content: { "application/json": components["schemas"]["QueryRequest"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["QueryResponse"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Query points in batch * @description Universally query points in batch. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries. */ query_batch_points: { parameters: { query?: { /** @description Define read consistency guarantees for the operation */ consistency?: components["schemas"]["ReadConsistency"]; /** @description If set, overrides global timeout for this request. Unit is seconds. */ timeout?: number; }; path: { /** @description Name of the collection to query */ collection_name: string; }; }; /** @description Describes the queries to make to the collection */ requestBody?: { content: { "application/json": components["schemas"]["QueryRequestBatch"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: (components["schemas"]["QueryResponse"])[]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Query points, grouped by a given payload field * @description Universally query points, grouped by a given payload field */ query_points_groups: { parameters: { query?: { /** @description Define read consistency guarantees for the operation */ consistency?: components["schemas"]["ReadConsistency"]; /** @description If set, overrides global timeout for this request. Unit is seconds. */ timeout?: number; }; path: { /** @description Name of the collection to query */ collection_name: string; }; }; /** @description Describes the query to make to the collection */ requestBody?: { content: { "application/json": components["schemas"]["QueryGroupsRequest"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["GroupsResult"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Search points matrix distance pairs * @description Compute distance matrix for sampled points with a pair based output format */ search_matrix_pairs: { parameters: { query?: { /** @description Define read consistency guarantees for the operation */ consistency?: components["schemas"]["ReadConsistency"]; /** @description If set, overrides global timeout for this request. Unit is seconds. */ timeout?: number; }; path: { /** @description Name of the collection to search in */ collection_name: string; }; }; /** @description Search matrix request with optional filtering */ requestBody?: { content: { "application/json": components["schemas"]["SearchMatrixRequest"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["SearchMatrixPairsResponse"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; /** * Search points matrix distance offsets * @description Compute distance matrix for sampled points with an offset based output format */ search_matrix_offsets: { parameters: { query?: { /** @description Define read consistency guarantees for the operation */ consistency?: components["schemas"]["ReadConsistency"]; /** @description If set, overrides global timeout for this request. Unit is seconds. */ timeout?: number; }; path: { /** @description Name of the collection to search in */ collection_name: string; }; }; /** @description Search matrix request with optional filtering */ requestBody?: { content: { "application/json": components["schemas"]["SearchMatrixRequest"]; }; }; responses: { /** @description successful operation */ 200: { content: { "application/json": { /** @default null */ usage?: components["schemas"]["Usage"] | (Record | null); /** * Format: float * @description Time spent to process this request * @example 0.002 */ time?: number; /** @example ok */ status?: string; result?: components["schemas"]["SearchMatrixOffsetsResponse"]; }; }; }; /** @description error */ default: { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; /** @description error */ "4XX": { content: { "application/json": components["schemas"]["ErrorResponse"]; }; }; }; }; } export {};