upstream-archive/qdrant-client
1
0
Fork 0
mirror of https://github.com/qdrant/qdrant-client.git synced 2026-08-02 08:00:57 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
dev
qdrant-client/qdrant_client/http/models/models.py
George 399449a6d9 new: 1.19.0 updates (#1298) 
* new: 1.19.0 updates

* fix: fix search params as a dict in local mode

* fix: update qdrant backward compatibility version

* fix: add version check to the test

* fix: add version check to the test
2026-08-01 02:48:14 +07:00

4308 lines
177 KiB
Python
Raw Permalink Blame History

from datetime import date, datetime
from enum import Enum
from typing import Any, Dict, List, Literal, Optional, Union
from uuid import UUID
from pydantic import BaseModel, Field
from pydantic.types import StrictBool, StrictFloat, StrictInt, StrictStr
Payload = Dict[str, Any]
SparseVectorsConfig = Dict[str, "SparseVectorParams"]
StrictModeMultivectorConfig = Dict[str, "StrictModeMultivector"]
StrictModeMultivectorConfigOutput = Dict[str, "StrictModeMultivectorOutput"]
StrictModeSparseConfig = Dict[str, "StrictModeSparse"]
StrictModeSparseConfigOutput = Dict[str, "StrictModeSparseOutput"]
VectorsConfigDiff = Dict[str, "VectorParamsDiff"]
class AbortReshardingOperation(BaseModel, extra="forbid"):
abort_resharding: Any = Field(..., description="")
class AbortShardTransfer(BaseModel, extra="forbid"):
shard_id: int = Field(..., description="")
to_peer_id: int = Field(..., description="")
from_peer_id: int = Field(..., description="")
class AbortTransferOperation(BaseModel, extra="forbid"):
abort_transfer: "AbortShardTransfer" = Field(..., description="")
class AbsExpression(BaseModel, extra="forbid"):
abs: "Expression" = Field(..., description="")
class AcornSearchParams(BaseModel, extra="forbid"):
"""
ACORN-related search parameters
"""
enable: Optional[bool] = Field(
default=False,
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.",
)
max_selectivity: Optional[float] = Field(
default=None,
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.",
)
class AliasDescription(BaseModel):
alias_name: str = Field(..., description="")
collection_name: str = Field(..., description="")
class AppBuildTelemetry(BaseModel):
name: str = Field(..., description="")
version: str = Field(..., description="")
features: Optional["AppFeaturesTelemetry"] = Field(default=None, description="")
runtime_features: Optional["FeatureFlags"] = Field(default=None, description="")
low_memory_mode: Optional["LowMemoryMode"] = Field(default=None, description="")
hnsw_global_config: Optional["HnswGlobalConfig"] = Field(default=None, description="")
system: Optional["RunningEnvironmentTelemetry"] = Field(default=None, description="")
jwt_rbac: Optional[bool] = Field(default=None, description="")
hide_jwt_dashboard: Optional[bool] = Field(default=None, description="")
audit: Optional["AuditTelemetry"] = Field(default=None, description="")
startup: Union[datetime, date] = Field(..., description="")
class AppFeaturesTelemetry(BaseModel):
debug: bool = Field(..., description="")
service_debug_feature: bool = Field(..., description="")
recovery_mode: bool = Field(..., description="")
gpu: bool = Field(..., description="")
rocksdb: bool = Field(..., description="")
staging: bool = Field(..., description="")
class AuditTelemetry(BaseModel):
dir: str = Field(..., description="")
rotation: str = Field(..., description="")
max_log_files: int = Field(..., description="")
trust_forwarded_headers: bool = Field(..., description="")
log_api: bool = Field(..., description="")
dir_size_bytes: Optional[int] = Field(default=None, description="")
class Batch(BaseModel, extra="forbid"):
ids: List["ExtendedPointId"] = Field(..., description="")
vectors: "BatchVectorStruct" = Field(..., description="")
payloads: Optional[List["Payload"]] = Field(default=None, description="")
class BinaryQuantization(BaseModel, extra="forbid"):
binary: "BinaryQuantizationConfig" = Field(..., description="")
class BinaryQuantizationConfig(BaseModel, extra="forbid"):
always_ram: Optional[bool] = Field(default=None, description="Deprecated: use `memory` instead.")
memory: Optional["Memory"] = Field(
default=None,
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.",
)
encoding: Optional["BinaryQuantizationEncoding"] = Field(default=None, description="")
query_encoding: Optional["BinaryQuantizationQueryEncoding"] = Field(
default=None,
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.",
)
class BinaryQuantizationEncoding(str, Enum):
ONE_BIT = "one_bit"
TWO_BITS = "two_bits"
ONE_AND_HALF_BITS = "one_and_half_bits"
class BinaryQuantizationQueryEncoding(str, Enum):
DEFAULT = "default"
BINARY = "binary"
SCALAR4BITS = "scalar4bits"
SCALAR8BITS = "scalar8bits"
class Bm25Config(BaseModel, extra="forbid"):
"""
Configuration of the local bm25 models.
"""
k: Optional[float] = Field(
default=1.2,
description="Controls term frequency saturation. Higher values mean term frequency has more impact. Default is 1.2",
)
b: Optional[float] = Field(
default=0.75,
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.",
)
avg_len: Optional[float] = Field(
default=256, description="Expected average document length in the collection. Default is 256."
)
tokenizer: Optional["TokenizerType"] = Field(default=None, description="Configuration of the local bm25 models.")
language: Optional[str] = Field(
default=None,
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.",
)
lowercase: Optional[bool] = Field(
default=None, description="Lowercase the text before tokenization. Default is `true`."
)
ascii_folding: Optional[bool] = Field(
default=None,
description="If true, normalize tokens by folding accented characters to ASCII (e.g., 'ação' -> 'acao'). Default is `false`.",
)
stopwords: Optional["StopwordsInterface"] = Field(
default=None,
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.",
)
stemmer: Optional["StemmingAlgorithm"] = Field(
default=None,
description="Configuration of the stemmer. Processes tokens to their root form. Default: initialized Snowball stemmer for specified `language` or English if not specified.",
)
min_token_len: Optional[int] = Field(
default=None,
description="Minimum token length to keep. If token is shorter than this, it will be discarded. Default is `None`, which means no minimum length.",
)
max_token_len: Optional[int] = Field(
default=None,
description="Maximum token length to keep. If token is longer than this, it will be discarded. Default is `None`, which means no maximum length.",
)
class BoolIndexParams(BaseModel, extra="forbid"):
type: "BoolIndexType" = Field(..., description="")
on_disk: Optional[bool] = Field(
default=None, description="Deprecated: use `memory` instead. If true, store the index on disk. Default: false."
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
enable_hnsw: Optional[bool] = Field(
default=None,
description="Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true.",
)
class BoolIndexType(str, Enum):
BOOL = "bool"
class ChangeAliasesOperation(BaseModel, extra="forbid"):
"""
Operation for performing changes of collection aliases. Alias changes are atomic, meaning that no collection modifications can happen between alias operations.
"""
actions: List["AliasOperations"] = Field(
...,
description="Operation for performing changes of collection aliases. Alias changes are atomic, meaning that no collection modifications can happen between alias operations.",
)
class ClearPayloadOperation(BaseModel, extra="forbid"):
clear_payload: "PointsSelector" = Field(..., description="")
class ClusterConfigTelemetry(BaseModel):
grpc_timeout_ms: int = Field(..., description="")
p2p: "P2pConfigTelemetry" = Field(..., description="")
consensus: "ConsensusConfigTelemetry" = Field(..., description="")
class ClusterStatusOneOf(BaseModel):
status: Literal[
"disabled",
] = Field(..., description="")
class ClusterStatusOneOf1(BaseModel):
"""
Description of enabled cluster
"""
status: Literal[
"enabled",
] = Field(..., description="Description of enabled cluster")
peer_id: int = Field(..., description="ID of this peer")
peers: Dict[str, "PeerInfo"] = Field(..., description="Peers composition of the cluster with main information")
raft_info: "RaftInfo" = Field(..., description="Description of enabled cluster")
consensus_thread_status: "ConsensusThreadStatus" = Field(..., description="Description of enabled cluster")
message_send_failures: Dict[str, "MessageSendErrors"] = Field(
...,
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.",
)
class ClusterStatusTelemetry(BaseModel):
number_of_peers: int = Field(..., description="")
term: int = Field(..., description="")
commit: int = Field(..., description="")
pending_operations: int = Field(..., description="")
role: Optional["StateRole"] = Field(default=None, description="")
is_voter: bool = Field(..., description="")
peer_id: Optional[int] = Field(default=None, description="")
consensus_thread_status: "ConsensusThreadStatus" = Field(..., description="")
class ClusterTelemetry(BaseModel):
enabled: bool = Field(..., description="")
status: Optional["ClusterStatusTelemetry"] = Field(default=None, description="")
config: Optional["ClusterConfigTelemetry"] = Field(default=None, description="")
peers: Optional[Dict[str, "PeerInfo"]] = Field(default=None, description="")
peer_metadata: Optional[Dict[str, "PeerMetadata"]] = Field(default=None, description="")
metadata: Optional[Dict[str, Any]] = Field(default=None, description="")
resharding_enabled: Optional[bool] = Field(default=None, description="")
class CollectionClusterInfo(BaseModel):
"""
Current clustering distribution for the collection
"""
peer_id: int = Field(..., description="ID of this peer")
shard_count: int = Field(..., description="Total number of shards")
local_shards: List["LocalShardInfo"] = Field(..., description="Local shards")
remote_shards: List["RemoteShardInfo"] = Field(..., description="Remote shards")
shard_transfers: List["ShardTransferInfo"] = Field(..., description="Shard transfers")
resharding_operations: Optional[List["ReshardingInfo"]] = Field(default=None, description="Resharding operations")
class CollectionConfig(BaseModel):
"""
Information about the collection configuration
"""
params: "CollectionParams" = Field(..., description="Information about the collection configuration")
hnsw_config: "HnswConfig" = Field(..., description="Information about the collection configuration")
optimizer_config: "OptimizersConfig" = Field(..., description="Information about the collection configuration")
wal_config: Optional["WalConfig"] = Field(
default=None, description="Information about the collection configuration"
)
quantization_config: Optional["QuantizationConfig"] = Field(
default=None, description="Information about the collection configuration"
)
strict_mode_config: Optional["StrictModeConfigOutput"] = Field(
default=None, description="Information about the collection configuration"
)
metadata: Optional["Payload"] = Field(
default=None,
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.",
)
class CollectionConfigTelemetry(BaseModel):
params: "CollectionParams" = Field(..., description="")
hnsw_config: "HnswConfig" = Field(..., description="")
optimizer_config: "OptimizersConfig" = Field(..., description="")
wal_config: "WalConfig" = Field(..., description="")
quantization_config: Optional["QuantizationConfig"] = Field(default=None, description="")
strict_mode_config: Optional["StrictModeConfigOutput"] = Field(default=None, description="")
uuid: Optional[UUID] = Field(default=None, description="")
metadata: Optional["Payload"] = Field(default=None, description="Arbitrary JSON metadata for the collection")
class CollectionDescription(BaseModel):
name: str = Field(..., description="")
class CollectionExistence(BaseModel):
"""
State of existence of a collection, true = exists, false = does not exist
"""
exists: bool = Field(..., description="State of existence of a collection, true = exists, false = does not exist")
class CollectionInfo(BaseModel):
"""
Current statistics and configuration of the collection
"""
status: "CollectionStatus" = Field(..., description="Current statistics and configuration of the collection")
optimizer_status: "OptimizersStatus" = Field(
..., description="Current statistics and configuration of the collection"
)
warnings: Optional[List["CollectionWarning"]] = Field(
default=None, description="Warnings related to the collection"
)
indexed_vectors_count: Optional[int] = Field(
default=None,
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.",
)
points_count: Optional[int] = Field(
default=None,
description="Approximate number of points (vectors + payloads) in collection. Each point could be accessed by unique id.",
)
segments_count: int = Field(
..., description="Number of segments in collection. Each segment has independent vector as payload indexes"
)
config: "CollectionConfig" = Field(..., description="Current statistics and configuration of the collection")
payload_schema: Dict[str, "PayloadIndexInfo"] = Field(..., description="Types of stored payload")
update_queue: Optional["UpdateQueueInfo"] = Field(default=None, description="Update queue info")
class CollectionParams(BaseModel):
vectors: Optional["VectorsConfig"] = Field(default=None, description="")
shard_number: Optional[int] = Field(default=1, description="Number of shards the collection has")
sharding_method: Optional["ShardingMethod"] = Field(
default=None,
description="Sharding method Default is Auto - points are distributed across all available shards Custom - points are distributed across shards according to shard key",
)
replication_factor: Optional[int] = Field(default=1, description="Number of replicas for each shard")
write_consistency_factor: Optional[int] = Field(
default=1,
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.",
)
read_fan_out_factor: Optional[int] = Field(
default=None,
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_delay_ms: Optional[int] = Field(
default=None,
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.",
)
on_disk_payload: Optional[bool] = Field(
default=True,
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",
)
payload: Optional["PayloadStorageParams"] = Field(default=None, description="Configuration of the payload storage")
sparse_vectors: Optional[Dict[str, "SparseVectorParams"]] = Field(
default=None, description="Configuration of the sparse vector storage"
)
class CollectionParamsDiff(BaseModel, extra="forbid"):
replication_factor: Optional[int] = Field(default=None, description="Number of replicas for each shard")
write_consistency_factor: Optional[int] = Field(
default=None, description="Minimal number successful responses from replicas to consider operation successful"
)
read_fan_out_factor: Optional[int] = Field(
default=None,
description="Fan-out every read request to these many additional remote nodes (and return first available response)",
)
read_fan_out_delay_ms: Optional[int] = Field(
default=None, description="Delay in milliseconds before sending read requests to remote nodes"
)
on_disk_payload: Optional[bool] = Field(
default=None,
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.",
)
payload: Optional["PayloadStorageParams"] = Field(
default=None, description="Update params of the payload storage. If none - it is left unchanged."
)
class CollectionSnapshotTelemetry(BaseModel):
id: str = Field(..., description="")
running_snapshots: Optional[int] = Field(default=None, description="")
running_snapshot_recovery: Optional[int] = Field(default=None, description="")
total_snapshot_creations: Optional[int] = Field(default=None, description="")
class CollectionStatus(str, Enum):
"""
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
"""
def __str__(self) -> str:
return str(self.value)
GREEN = "green"
YELLOW = "yellow"
GREY = "grey"
RED = "red"
class CollectionTelemetry(BaseModel):
id: str = Field(..., description="")
init_time_ms: Optional[int] = Field(default=None, description="")
config: Optional["CollectionConfigTelemetry"] = Field(default=None, description="")
shards: Optional[List["ReplicaSetTelemetry"]] = Field(default=None, description="")
transfers: Optional[List["ShardTransferInfo"]] = Field(default=None, description="")
resharding: Optional[List["ReshardingInfo"]] = Field(default=None, description="")
shard_clean_tasks: Optional[Dict[str, "ShardCleanStatusTelemetry"]] = Field(default=None, description="")
class CollectionWarning(BaseModel):
message: str = Field(..., description="Warning message")
class CollectionsAggregatedTelemetry(BaseModel):
vectors: int = Field(..., description="")
optimizers_status: "OptimizersStatus" = Field(..., description="")
params: "CollectionParams" = Field(..., description="")
class CollectionsAliasesResponse(BaseModel):
aliases: List["AliasDescription"] = Field(..., description="")
class CollectionsResponse(BaseModel):
collections: List["CollectionDescription"] = Field(..., description="")
class CollectionsTelemetry(BaseModel):
number_of_collections: int = Field(..., description="")
max_collections: Optional[int] = Field(default=None, description="")
collections: Optional[List["CollectionTelemetryEnum"]] = Field(default=None, description="")
snapshots: Optional[List["CollectionSnapshotTelemetry"]] = Field(default=None, description="")
class CompressionRatio(str, Enum):
X4 = "x4"
X8 = "x8"
X16 = "x16"
X32 = "x32"
X64 = "x64"
class ConsensusConfigTelemetry(BaseModel):
max_message_queue_size: int = Field(..., description="")
tick_period_ms: int = Field(..., description="")
bootstrap_timeout_sec: int = Field(..., description="")
class ConsensusThreadStatusOneOf(BaseModel):
consensus_thread_status: Literal[
"working",
] = Field(..., description="")
last_update: Union[datetime, date] = Field(..., description="")
class ConsensusThreadStatusOneOf1(BaseModel):
consensus_thread_status: Literal[
"stopped",
] = Field(..., description="")
class ConsensusThreadStatusOneOf2(BaseModel):
consensus_thread_status: Literal[
"stopped_with_err",
] = Field(..., description="")
err: str = Field(..., description="")
class ContextPair(BaseModel, extra="forbid"):
positive: "VectorInput" = Field(..., description="")
negative: "VectorInput" = Field(..., description="")
class ContextQuery(BaseModel, extra="forbid"):
context: "ContextInput" = Field(..., description="")
class CountRequest(BaseModel, extra="forbid"):
"""
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.
"""
shard_key: Optional["ShardKeySelector"] = Field(
default=None,
description="Specify in which shards to look for the points, if not specified - look in all shards",
)
filter: Optional["Filter"] = Field(default=None, description="Look only for points which satisfies this conditions")
exact: Optional[bool] = Field(
default=True,
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",
)
class CountResult(BaseModel):
count: int = Field(..., description="Number of points which satisfy the conditions")
class CpuEndian(str, Enum):
LITTLE = "little"
BIG = "big"
OTHER = "other"
class CreateAlias(BaseModel, extra="forbid"):
"""
Create alternative name for a collection. Collection will be available under both names for search, retrieve,
"""
collection_name: str = Field(
...,
description="Create alternative name for a collection. Collection will be available under both names for search, retrieve,",
)
alias_name: str = Field(
...,
description="Create alternative name for a collection. Collection will be available under both names for search, retrieve,",
)
class CreateAliasOperation(BaseModel, extra="forbid"):
create_alias: "CreateAlias" = Field(..., description="")
class CreateCollection(BaseModel, extra="forbid"):
"""
Operation for creating new collection and (optionally) specify index params
"""
vectors: Optional["VectorsConfig"] = Field(
default=None, description="Operation for creating new collection and (optionally) specify index params"
)
shard_number: Optional[int] = Field(
default=None,
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",
)
sharding_method: Optional["ShardingMethod"] = Field(
default=None,
description="Sharding method Default is Auto - points are distributed across all available shards Custom - points are distributed across shards according to shard key",
)
replication_factor: Optional[int] = Field(
default=None, description="Number of shards replicas. Default is 1 Minimum is 1"
)
write_consistency_factor: Optional[int] = Field(
default=None,
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.",
)
on_disk_payload: Optional[bool] = Field(
default=None,
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",
)
payload: Optional["PayloadStorageParams"] = Field(default=None, description="Configuration of the payload storage")
hnsw_config: Optional["HnswConfigDiff"] = Field(
default=None,
description="Custom params for HNSW index. If none - values from service configuration file are used.",
)
wal_config: Optional["WalConfigDiff"] = Field(
default=None, description="Custom params for WAL. If none - values from service configuration file are used."
)
optimizers_config: Optional["OptimizersConfigDiff"] = Field(
default=None,
description="Custom params for Optimizers. If none - values from service configuration file are used.",
)
quantization_config: Optional["QuantizationConfig"] = Field(
default=None, description="Quantization parameters. If none - quantization is disabled."
)
sparse_vectors: Optional[Dict[str, "SparseVectorParams"]] = Field(
default=None, description="Sparse vector data config."
)
strict_mode_config: Optional["StrictModeConfig"] = Field(default=None, description="Strict-mode config.")
metadata: Optional["Payload"] = Field(
default=None,
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.",
)
class CreateFieldIndex(BaseModel, extra="forbid"):
field_name: str = Field(..., description="")
field_schema: Optional["PayloadFieldSchema"] = Field(default=None, description="")
class CreateShardingKey(BaseModel, extra="forbid"):
shard_key: "ShardKey" = Field(..., description="")
shards_number: Optional[int] = Field(
default=None,
description="How many shards to create for this key If not specified, will use the default value from config",
)
replication_factor: Optional[int] = Field(
default=None,
description="How many replicas to create for each shard If not specified, will use the default value from config",
)
placement: Optional[List[int]] = Field(
default=None,
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",
)
initial_state: Optional["ReplicaState"] = Field(
default=None,
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",
)
class CreateShardingKeyOperation(BaseModel, extra="forbid"):
create_sharding_key: "CreateShardingKey" = Field(..., description="")
class Datatype(str, Enum):
FLOAT32 = "float32"
UINT8 = "uint8"
FLOAT16 = "float16"
TURBO4 = "turbo4"
class DatetimeExpression(BaseModel, extra="forbid"):
datetime: str = Field(..., description="")
class DatetimeIndexParams(BaseModel, extra="forbid"):
type: "DatetimeIndexType" = Field(..., description="")
is_principal: Optional[bool] = Field(
default=None,
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.",
)
on_disk: Optional[bool] = Field(
default=None, description="Deprecated: use `memory` instead. If true, store the index on disk. Default: false."
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
enable_hnsw: Optional[bool] = Field(
default=None,
description="Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true.",
)
class DatetimeIndexType(str, Enum):
DATETIME = "datetime"
class DatetimeKeyExpression(BaseModel, extra="forbid"):
datetime_key: str = Field(..., description="")
class DatetimeRange(BaseModel, extra="forbid"):
"""
Range filter request
"""
lt: Optional[Union[datetime, date]] = Field(default=None, description="point.key < range.lt")
gt: Optional[Union[datetime, date]] = Field(default=None, description="point.key > range.gt")
gte: Optional[Union[datetime, date]] = Field(default=None, description="point.key >= range.gte")
lte: Optional[Union[datetime, date]] = Field(default=None, description="point.key <= range.lte")
class DecayParamsExpression(BaseModel, extra="forbid"):
x: "Expression" = Field(..., description="")
target: Optional["Expression"] = Field(
default=None, description="The target value to start decaying from. Defaults to 0."
)
scale: Optional[float] = Field(
default=None,
description="The scale factor of the decay, in terms of `x`. Defaults to 1.0. Must be a non-zero positive number.",
)
midpoint: Optional[float] = Field(
default=None,
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`.",
)
class DeleteAlias(BaseModel, extra="forbid"):
"""
Delete alias if exists
"""
alias_name: str = Field(..., description="Delete alias if exists")
class DeleteAliasOperation(BaseModel, extra="forbid"):
"""
Delete alias if exists
"""
delete_alias: "DeleteAlias" = Field(..., description="Delete alias if exists")
class DeleteOperation(BaseModel, extra="forbid"):
delete: "PointsSelector" = Field(..., description="")
class DeletePayload(BaseModel, extra="forbid"):
"""
This data structure is used in API interface and applied across multiple shards
"""
keys: List[str] = Field(..., description="List of payload keys to remove from payload")
points: Optional[List["ExtendedPointId"]] = Field(
default=None, description="Deletes values from each point in this list"
)
filter: Optional["Filter"] = Field(
default=None, description="Deletes values from points that satisfy this filter condition"
)
shard_key: Optional["ShardKeySelector"] = Field(
default=None, description="This data structure is used in API interface and applied across multiple shards"
)
class DeletePayloadOperation(BaseModel, extra="forbid"):
delete_payload: "DeletePayload" = Field(..., description="")
class DeleteVectors(BaseModel, extra="forbid"):
points: Optional[List["ExtendedPointId"]] = Field(
default=None, description="Deletes values from each point in this list"
)
filter: Optional["Filter"] = Field(
default=None, description="Deletes values from points that satisfy this filter condition"
)
vector: List[str] = Field(..., description="Vector names")
shard_key: Optional["ShardKeySelector"] = Field(default=None, description="")
class DeleteVectorsOperation(BaseModel, extra="forbid"):
delete_vectors: "DeleteVectors" = Field(..., description="")
class DenseVectorConfig(BaseModel, extra="forbid"):
"""
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.
"""
size: int = Field(..., description="Dimensionality of the vectors")
distance: "Distance" = Field(
...,
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.",
)
multivector_config: Optional["MultiVectorConfig"] = Field(
default=None, description="Configuration for multi-vector points (e.g., ColBERT)"
)
datatype: Optional["VectorStorageDatatype"] = Field(
default=None, description="Element storage type (Float32, Float16, Uint8, Turbo4)"
)
class DenseVectorNameConfig(BaseModel, extra="forbid"):
"""
Wrapper for dense vector creation config.
"""
dense: "DenseVectorConfig" = Field(..., description="Wrapper for dense vector creation config.")
class Direction(str, Enum):
ASC = "asc"
DESC = "desc"
class Disabled(str, Enum):
DISABLED = "Disabled"
class DisabledStemmerParams(BaseModel, extra="forbid"):
type: "NoStemmer" = Field(..., description="")
class DiscoverInput(BaseModel, extra="forbid"):
target: "VectorInput" = Field(..., description="")
context: Union[List["ContextPair"], "ContextPair"] = Field(
..., description="Search space will be constrained by these pairs of vectors"
)
class DiscoverQuery(BaseModel, extra="forbid"):
discover: "DiscoverInput" = Field(..., description="")
class Distance(str, Enum):
"""
Type of internal tags, build from payload Distance function types used to compare vectors
"""
def __str__(self) -> str:
return str(self.value)
COSINE = "Cosine"
EUCLID = "Euclid"
DOT = "Dot"
MANHATTAN = "Manhattan"
class DistributedClusterTelemetry(BaseModel):
enabled: bool = Field(..., description="")
number_of_peers: Optional[int] = Field(default=None, description="")
peers: Dict[str, "DistributedPeerInfo"] = Field(..., description="")
class DistributedCollectionTelemetry(BaseModel):
id: str = Field(..., description="Collection name")
shards: Optional[List["DistributedShardTelemetry"]] = Field(default=None, description="Shards topology")
reshardings: Optional[List["ReshardingInfo"]] = Field(default=None, description="Ongoing resharding operations")
shard_transfers: Optional[List["ShardTransferInfo"]] = Field(default=None, description="Ongoing shard transfers")
class DistributedPeerDetails(BaseModel):
version: str = Field(..., description="Qdrant version")
role: Optional["StateRole"] = Field(default=None, description="Consensus role for the peer")
is_voter: bool = Field(..., description="Whether it can participate in leader elections")
term: int = Field(..., description="Election term")
commit: int = Field(..., description="Latest accepted commit")
num_pending_operations: int = Field(..., description="Number of operations pending for being applied")
consensus_thread_status: "ConsensusThreadStatus" = Field(..., description="")
class DistributedPeerInfo(BaseModel):
uri: str = Field(..., description="URI of the peer")
responsive: bool = Field(..., description="Whether this peer responded for this request")
details: Optional["DistributedPeerDetails"] = Field(
default=None, description="If responsive, these details should be available"
)
class DistributedReplicaTelemetry(BaseModel):
peer_id: int = Field(..., description="Peer ID hosting this replica")
state: "ReplicaState" = Field(..., description="")
status: Optional["ShardStatus"] = Field(default=None, description="Shard status")
total_optimized_points: Optional[int] = Field(default=None, description="Total optimized points")
vectors_size_bytes: Optional[int] = Field(default=None, description="Estimated vectors size in bytes")
payloads_size_bytes: Optional[int] = Field(default=None, description="Estimated payloads size in bytes")
num_points: Optional[int] = Field(default=None, description="Approximate number of points")
num_vectors: Optional[int] = Field(default=None, description="Approximate number of vectors")
num_vectors_by_name: Optional[Dict[str, int]] = Field(
default=None, description="Approximate number of vectors by name"
)
shard_cleaning_status: Optional["ShardCleanStatusTelemetry"] = Field(
default=None,
description="Shard cleaning task status. After a resharding, a cleanup task is performed to remove outdated points from this shard.",
)
partial_snapshot: Optional["PartialSnapshotTelemetry"] = Field(
default=None, description="Partial snapshot telemetry"
)
class DistributedShardTelemetry(BaseModel):
id: int = Field(..., description="Shard ID")
key: Optional["ShardKey"] = Field(default=None, description="Optional shard key")
replicas: List["DistributedReplicaTelemetry"] = Field(..., description="Replica information")
class DistributedTelemetryData(BaseModel):
collections: Dict[str, "DistributedCollectionTelemetry"] = Field(..., description="")
cluster: Optional["DistributedClusterTelemetry"] = Field(default=None, description="")
class DivExpression(BaseModel, extra="forbid"):
div: "DivParams" = Field(..., description="")
class DivParams(BaseModel, extra="forbid"):
left: "Expression" = Field(..., description="")
right: "Expression" = Field(..., description="")
by_zero_default: Optional[float] = Field(default=None, description="")
class Document(BaseModel, extra="forbid"):
"""
WARN: Work-in-progress, unimplemented Text document for embedding. Requires inference infrastructure, unimplemented.
"""
text: str = Field(
..., description="Text of the document. This field will be used as input for the embedding model."
)
model: str = Field(
...,
description="Name of the model used to generate the vector. List of available models depends on a provider.",
)
options: Optional["DocumentOptions"] = Field(
default=None,
description="Additional options for the model, will be passed to the inference service as-is. See model cards for available options.",
)
class DropReplicaOperation(BaseModel, extra="forbid"):
drop_replica: "Replica" = Field(..., description="")
class DropShardingKey(BaseModel, extra="forbid"):
shard_key: "ShardKey" = Field(..., description="")
class DropShardingKeyOperation(BaseModel, extra="forbid"):
drop_sharding_key: "DropShardingKey" = Field(..., description="")
class ErrorResponse(BaseModel):
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional["ErrorResponseStatus"] = Field(default=None, description="")
result: Optional[Any] = Field(default=None, description="")
class ErrorResponseStatus(BaseModel):
error: Optional[str] = Field(default=None, description="Description of the occurred error.")
class ExpDecayExpression(BaseModel, extra="forbid"):
exp_decay: "DecayParamsExpression" = Field(..., description="")
class ExpExpression(BaseModel, extra="forbid"):
exp: "Expression" = Field(..., description="")
class FacetRequest(BaseModel, extra="forbid"):
shard_key: Optional["ShardKeySelector"] = Field(default=None, description="")
key: str = Field(..., description="Payload key to use for faceting.")
limit: Optional[int] = Field(default=None, description="Max number of hits to return. Default is 10.")
filter: Optional["Filter"] = Field(
default=None, description="Filter conditions - only consider points that satisfy these conditions."
)
exact: Optional[bool] = Field(
default=None,
description="Whether to do a more expensive exact count for each of the values in the facet. Default is false.",
)
class FacetResponse(BaseModel):
hits: List["FacetValueHit"] = Field(..., description="")
class FacetValueHit(BaseModel):
value: "FacetValue" = Field(..., description="")
count: int = Field(..., description="")
class FeatureFlags(BaseModel):
all: Optional[bool] = Field(
default=False,
description="Magic feature flag that enables all features. Note that this will only be applied to all flags when passed into [`init_feature_flags`].",
)
incremental_hnsw_building: Optional[bool] = Field(
default=True, description="Use incremental HNSW building. Enabled by default in Qdrant 1.14.1."
)
appendable_quantization: Optional[bool] = Field(
default=True,
description="Use appendable quantization in appendable plain segments. Enabled by default in Qdrant 1.16.0.",
)
single_file_mmap_vector_storage: Optional[bool] = Field(
default=True,
description="Use single-file mmap in-ram vector storage (InRamMmap) Enabled by default in Qdrant 1.18.3+",
)
async_payload_storage: Optional[bool] = Field(
default=True,
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.",
)
write_segment_manifest: Optional[bool] = Field(
default=False,
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.",
)
append_only_mutations: Optional[bool] = Field(
default=False,
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.",
)
compact_bitmask: Optional[bool] = Field(
default=False,
description="Persist write-once bitmasks in the compact `StoredBitmask` format instead of raw dense bitslices. Only gates writing: both formats are always readable.",
)
serverless_compatible: Optional[bool] = Field(
default=False,
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`].",
)
class FeedbackItem(BaseModel, extra="forbid"):
example: "VectorInput" = Field(..., description="")
score: float = Field(..., description="")
class FieldCondition(BaseModel, extra="forbid"):
"""
All possible payload filtering conditions
"""
key: str = Field(..., description="Payload key")
match: Optional["Match"] = Field(default=None, description="Check if point has field with a given value")
range: Optional["RangeInterface"] = Field(default=None, description="Check if points value lies in a given range")
geo_bounding_box: Optional["GeoBoundingBox"] = Field(
default=None, description="Check if points geolocation lies in a given area"
)
geo_radius: Optional["GeoRadius"] = Field(default=None, description="Check if geo point is within a given radius")
geo_polygon: Optional["GeoPolygon"] = Field(
default=None, description="Check if geo point is within a given polygon"
)
values_count: Optional["ValuesCount"] = Field(default=None, description="Check number of values of the field")
is_empty: Optional[bool] = Field(
default=None, description="Check that the field is empty, alternative syntax for `is_empty: 'field_name'`"
)
is_null: Optional[bool] = Field(
default=None, description="Check that the field is null, alternative syntax for `is_null: 'field_name'`"
)
class Filter(BaseModel, extra="forbid"):
should: Optional[Union[List["Condition"], "Condition"]] = Field(
default=None, description="At least one of those conditions should match"
)
min_should: Optional["MinShould"] = Field(
default=None, description="At least minimum amount of given conditions should match"
)
must: Optional[Union[List["Condition"], "Condition"]] = Field(default=None, description="All conditions must match")
must_not: Optional[Union[List["Condition"], "Condition"]] = Field(
default=None, description="All conditions must NOT match"
)
class FilterSelector(BaseModel, extra="forbid"):
filter: "Filter" = Field(..., description="")
shard_key: Optional["ShardKeySelector"] = Field(default=None, description="")
class FloatIndexParams(BaseModel, extra="forbid"):
type: "FloatIndexType" = Field(..., description="")
is_principal: Optional[bool] = Field(
default=None,
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.",
)
on_disk: Optional[bool] = Field(
default=None, description="Deprecated: use `memory` instead. If true, store the index on disk. Default: false."
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
enable_hnsw: Optional[bool] = Field(
default=None,
description="Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true.",
)
class FloatIndexType(str, Enum):
FLOAT = "float"
class FormulaQuery(BaseModel, extra="forbid"):
formula: "Expression" = Field(..., description="")
defaults: Optional[Dict[str, Any]] = Field(default={}, description="")
class Fusion(str, Enum):
"""
Fusion algorithm allows to combine results of multiple prefetches. Available fusion algorithms: * `rrf` - Reciprocal Rank Fusion (with default parameters) * `dbsf` - Distribution-Based Score Fusion
"""
def __str__(self) -> str:
return str(self.value)
RRF = "rrf"
DBSF = "dbsf"
class FusionQuery(BaseModel, extra="forbid"):
fusion: "Fusion" = Field(..., description="")
class GaussDecayExpression(BaseModel, extra="forbid"):
gauss_decay: "DecayParamsExpression" = Field(..., description="")
class GeoBoundingBox(BaseModel, extra="forbid"):
"""
Geo filter request Matches coordinates inside the rectangle, described by coordinates of lop-left and bottom-right edges
"""
top_left: "GeoPoint" = Field(
...,
description="Geo filter request Matches coordinates inside the rectangle, described by coordinates of lop-left and bottom-right edges",
)
bottom_right: "GeoPoint" = Field(
...,
description="Geo filter request Matches coordinates inside the rectangle, described by coordinates of lop-left and bottom-right edges",
)
class GeoDistance(BaseModel, extra="forbid"):
geo_distance: "GeoDistanceParams" = Field(..., description="")
class GeoDistanceParams(BaseModel, extra="forbid"):
origin: "GeoPoint" = Field(..., description="")
to: str = Field(..., description="Payload field with the destination geo point")
class GeoIndexParams(BaseModel, extra="forbid"):
type: "GeoIndexType" = Field(..., description="")
on_disk: Optional[bool] = Field(
default=None, description="Deprecated: use `memory` instead. If true, store the index on disk. Default: false."
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
enable_hnsw: Optional[bool] = Field(
default=None,
description="Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true.",
)
class GeoIndexType(str, Enum):
GEO = "geo"
class GeoLineString(BaseModel, extra="forbid"):
"""
Ordered sequence of GeoPoints representing the line
"""
points: List["GeoPoint"] = Field(..., description="Ordered sequence of GeoPoints representing the line")
class GeoPoint(BaseModel, extra="forbid"):
"""
Geo point payload schema
"""
lon: float = Field(..., description="Geo point payload schema")
lat: float = Field(..., description="Geo point payload schema")
class GeoPolygon(BaseModel, extra="forbid"):
"""
Geo filter request Matches coordinates inside the polygon, defined by `exterior` and `interiors`
"""
exterior: "GeoLineString" = Field(
...,
description="Geo filter request Matches coordinates inside the polygon, defined by `exterior` and `interiors`",
)
interiors: Optional[List["GeoLineString"]] = Field(
default=None,
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.",
)
class GeoRadius(BaseModel, extra="forbid"):
"""
Geo filter request Matches coordinates inside the circle of `radius` and center with coordinates `center`
"""
center: "GeoPoint" = Field(
...,
description="Geo filter request Matches coordinates inside the circle of `radius` and center with coordinates `center`",
)
radius: float = Field(..., description="Radius of the area in meters")
class GpuDeviceTelemetry(BaseModel):
name: str = Field(..., description="")
class GroupsResult(BaseModel):
groups: List["PointGroup"] = Field(..., description="")
class GrpcTelemetry(BaseModel):
responses: Dict[str, Dict[str, "OperationDurationStatistics"]] = Field(..., description="")
per_collection_responses: Optional[Dict[str, Dict[str, Dict[str, "OperationDurationStatistics"]]]] = Field(
default=None, description=""
)
class HardwareTelemetry(BaseModel):
collection_data: Dict[str, "HardwareUsage"] = Field(..., description="")
class HardwareUsage(BaseModel):
"""
Usage of the hardware resources, spent to process the request
"""
cpu: int = Field(..., description="Usage of the hardware resources, spent to process the request")
payload_io_read: int = Field(..., description="Usage of the hardware resources, spent to process the request")
payload_io_write: int = Field(..., description="Usage of the hardware resources, spent to process the request")
payload_index_io_read: int = Field(..., description="Usage of the hardware resources, spent to process the request")
payload_index_io_write: int = Field(
..., description="Usage of the hardware resources, spent to process the request"
)
vector_io_read: int = Field(..., description="Usage of the hardware resources, spent to process the request")
vector_io_write: int = Field(..., description="Usage of the hardware resources, spent to process the request")
class HasIdCondition(BaseModel, extra="forbid"):
"""
ID-based filtering condition
"""
has_id: List["ExtendedPointId"] = Field(..., description="ID-based filtering condition")
class HasVectorCondition(BaseModel, extra="forbid"):
"""
Filter points which have specific vector assigned
"""
has_vector: str = Field(..., description="Filter points which have specific vector assigned")
class HnswConfig(BaseModel):
"""
Config of HNSW index
"""
m: int = Field(
...,
description="Number of edges per node in the index graph. Larger the value - more accurate the search, more space required.",
)
ef_construct: int = Field(
...,
description="Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build index.",
)
full_scan_threshold: int = Field(
...,
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",
)
max_indexing_threads: Optional[int] = Field(
default=0,
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.",
)
on_disk: Optional[bool] = Field(
default=None,
description="Deprecated: use `memory` instead. Store HNSW index on disk. If set to false, index will be stored in RAM. Default: false",
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
payload_m: Optional[int] = Field(
default=None,
description="Custom M param for hnsw graph built for payload index. If not set, default M will be used.",
)
inline_storage: Optional[bool] = Field(
default=None,
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.",
)
class HnswConfigDiff(BaseModel, extra="forbid"):
m: Optional[int] = Field(
default=None,
description="Number of edges per node in the index graph. Larger the value - more accurate the search, more space required.",
)
ef_construct: Optional[int] = Field(
default=None,
description="Number of neighbours to consider during the index building. Larger the value - more accurate the search, more time required to build the index.",
)
full_scan_threshold: Optional[int] = Field(
default=None,
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",
)
max_indexing_threads: Optional[int] = Field(
default=None,
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.",
)
on_disk: Optional[bool] = Field(
default=None,
description="Deprecated: use `memory` instead. Store HNSW index on disk. If set to false, the index will be stored in RAM. Default: false",
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
payload_m: Optional[int] = Field(
default=None,
description="Custom M param for additional payload-aware HNSW links. If not set, default M will be used.",
)
inline_storage: Optional[bool] = Field(
default=None,
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.",
)
class HnswGlobalConfig(BaseModel):
healing_threshold: Optional[float] = Field(
default=0.3,
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`.",
)
class IdfCorpusParams(BaseModel, extra="forbid"):
"""
IDF statistics computed over the points matching a corpus filter.
"""
corpus: "Filter" = Field(..., description="IDF statistics computed over the points matching a corpus filter.")
class IdfScope(str, Enum):
"""
Named IDF scope without a corpus filter.
"""
def __str__(self) -> str:
return str(self.value)
GLOBAL = "global"
class Image(BaseModel, extra="forbid"):
"""
WARN: Work-in-progress, unimplemented Image object for embedding. Requires inference infrastructure, unimplemented.
"""
image: Any = Field(..., description="Image data: base64 encoded image or an URL")
model: str = Field(
...,
description="Name of the model used to generate the vector. List of available models depends on a provider.",
)
options: Optional[Dict[str, Any]] = Field(
default=None, description="Parameters for the model Values of the parameters are model-specific"
)
class IndexesOneOf(BaseModel):
"""
Do not use any index, scan whole vector collection during search. Guarantee 100% precision, but may be time consuming on large collections.
"""
type: Literal["plain",] = Field(
...,
description="Do not use any index, scan whole vector collection during search. Guarantee 100% precision, but may be time consuming on large collections.",
)
options: Any = Field(
...,
description="Do not use any index, scan whole vector collection during search. Guarantee 100% precision, but may be time consuming on large collections.",
)
class IndexesOneOf1(BaseModel):
"""
Use filterable HNSW index for approximate search. Is very fast even on a very huge collections, but require additional space to store index and additional time to build it.
"""
type: Literal["hnsw",] = Field(
...,
description="Use filterable HNSW index for approximate search. Is very fast even on a very huge collections, but require additional space to store index and additional time to build it.",
)
options: "HnswConfig" = Field(
...,
description="Use filterable HNSW index for approximate search. Is very fast even on a very huge collections, but require additional space to store index and additional time to build it.",
)
class InferenceObject(BaseModel, extra="forbid"):
"""
WARN: Work-in-progress, unimplemented Custom object for embedding. Requires inference infrastructure, unimplemented.
"""
object: Any = Field(
...,
description="Arbitrary data, used as input for the embedding model. Used if the model requires more than one input or a custom input.",
)
model: str = Field(
...,
description="Name of the model used to generate the vector. List of available models depends on a provider.",
)
options: Optional[Dict[str, Any]] = Field(
default=None, description="Parameters for the model Values of the parameters are model-specific"
)
class InferenceUsage(BaseModel):
models: Dict[str, "ModelUsage"] = Field(..., description="")
class InlineResponse200(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["ShardKeysResponse"] = Field(default=None, description="")
class InlineResponse2001(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional[bool] = Field(default=None, description="")
class InlineResponse20010(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["OptimizationsResponse"] = Field(default=None, description="")
class InlineResponse20011(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["CollectionsAliasesResponse"] = Field(default=None, description="")
class InlineResponse20012(BaseModel):
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional[bool] = Field(default=None, description="")
class InlineResponse20013(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional[List["SnapshotDescription"]] = Field(default=None, description="")
class InlineResponse20014(BaseModel):
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["SnapshotDescription"] = Field(default=None, description="")
class InlineResponse20015(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["Record"] = Field(default=None, description="")
class InlineResponse20016(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional[List["Record"]] = Field(default=None, description="")
class InlineResponse20017(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional[List["UpdateResult"]] = Field(default=None, description="")
class InlineResponse20018(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["ScrollResult"] = Field(default=None, description="")
class InlineResponse20019(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["CountResult"] = Field(default=None, description="")
class InlineResponse2002(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["TelemetryData"] = Field(default=None, description="")
class InlineResponse20020(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["FacetResponse"] = Field(default=None, description="")
class InlineResponse20021(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["QueryResponse"] = Field(default=None, description="")
class InlineResponse20022(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional[List["QueryResponse"]] = Field(default=None, description="")
class InlineResponse20023(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["GroupsResult"] = Field(default=None, description="")
class InlineResponse20024(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["SearchMatrixPairsResponse"] = Field(default=None, description="")
class InlineResponse20025(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["SearchMatrixOffsetsResponse"] = Field(default=None, description="")
class InlineResponse2003(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["ClusterStatus"] = Field(default=None, description="")
class InlineResponse2004(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["DistributedTelemetryData"] = Field(default=None, description="")
class InlineResponse2005(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["CollectionsResponse"] = Field(default=None, description="")
class InlineResponse2006(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["CollectionInfo"] = Field(default=None, description="")
class InlineResponse2007(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["UpdateResult"] = Field(default=None, description="")
class InlineResponse2008(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["CollectionExistence"] = Field(default=None, description="")
class InlineResponse2009(BaseModel):
usage: Optional["Usage"] = Field(default=None, description="")
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
result: Optional["CollectionClusterInfo"] = Field(default=None, description="")
class InlineResponse202(BaseModel):
time: Optional[float] = Field(default=None, description="Time spent to process this request")
status: Optional[str] = Field(default=None, description="")
class IntegerIndexParams(BaseModel, extra="forbid"):
type: "IntegerIndexType" = Field(..., description="")
lookup: Optional[bool] = Field(default=None, description="If true - support direct lookups. Default is true.")
range: Optional[bool] = Field(default=None, description="If true - support ranges filters. Default is true.")
is_principal: Optional[bool] = Field(
default=None,
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.",
)
on_disk: Optional[bool] = Field(
default=None, description="Deprecated: use `memory` instead. If true, store the index on disk. Default: false."
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
enable_hnsw: Optional[bool] = Field(
default=None,
description="Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true.",
)
class IntegerIndexType(str, Enum):
INTEGER = "integer"
class IoBackend(str, Enum):
"""
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.
"""
def __str__(self) -> str:
return str(self.value)
MMAP = "mmap"
IO_URING = "io_uring"
class IsEmptyCondition(BaseModel, extra="forbid"):
"""
Select points with empty payload for a specified field
"""
is_empty: "PayloadField" = Field(..., description="Select points with empty payload for a specified field")
class IsNullCondition(BaseModel, extra="forbid"):
"""
Select points with null payload for a specified field
"""
is_null: "PayloadField" = Field(..., description="Select points with null payload for a specified field")
class KeywordIndexParams(BaseModel, extra="forbid"):
type: "KeywordIndexType" = Field(..., description="")
is_tenant: Optional[bool] = Field(
default=None, description="If true - used for tenant optimization. Default: false."
)
on_disk: Optional[bool] = Field(
default=None, description="Deprecated: use `memory` instead. If true, store the index on disk. Default: false."
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
enable_hnsw: Optional[bool] = Field(
default=None,
description="Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true.",
)
prefix: Optional[bool] = Field(
default=None,
description="If true, enable prefix matching (`match: { 'prefix': ... }`) on this field. Default: false.",
)
class KeywordIndexType(str, Enum):
KEYWORD = "keyword"
class Language(str, Enum):
ARABIC = "arabic"
AZERBAIJANI = "azerbaijani"
BASQUE = "basque"
BENGALI = "bengali"
CATALAN = "catalan"
CHINESE = "chinese"
DANISH = "danish"
DUTCH = "dutch"
ENGLISH = "english"
FINNISH = "finnish"
FRENCH = "french"
GERMAN = "german"
GREEK = "greek"
HEBREW = "hebrew"
HINGLISH = "hinglish"
HUNGARIAN = "hungarian"
INDONESIAN = "indonesian"
ITALIAN = "italian"
JAPANESE = "japanese"
KAZAKH = "kazakh"
NEPALI = "nepali"
NORWEGIAN = "norwegian"
PORTUGUESE = "portuguese"
ROMANIAN = "romanian"
RUSSIAN = "russian"
SLOVENE = "slovene"
SPANISH = "spanish"
SWEDISH = "swedish"
TAJIK = "tajik"
TURKISH = "turkish"
class LinDecayExpression(BaseModel, extra="forbid"):
lin_decay: "DecayParamsExpression" = Field(..., description="")
class LnExpression(BaseModel, extra="forbid"):
ln: "Expression" = Field(..., description="")
class LocalShardInfo(BaseModel):
shard_id: int = Field(..., description="Local shard id")
shard_key: Optional["ShardKey"] = Field(default=None, description="User-defined sharding key")
points_count: int = Field(..., description="Number of points in the shard")
state: "ReplicaState" = Field(..., description="")
class LocalShardTelemetry(BaseModel):
variant_name: Optional[str] = Field(default=None, description="")
status: Optional["ShardStatus"] = Field(default=None, description="")
total_optimized_points: int = Field(..., description="Total number of optimized points since the last start.")
vectors_size_bytes: Optional[int] = Field(
default=None,
description="An ESTIMATION of effective amount of bytes used for vectors Do NOT rely on this number unless you know what you are doing",
)
payloads_size_bytes: Optional[int] = Field(
default=None,
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",
)
num_points: Optional[int] = Field(
default=None,
description="Sum of segment points This is an approximate number Do NOT rely on this number unless you know what you are doing",
)
num_vectors: Optional[int] = Field(
default=None,
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_by_name: Optional[Dict[str, int]] = Field(
default=None,
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",
)
segments: Optional[List["SegmentTelemetry"]] = Field(default=None, description="")
optimizations: Optional["OptimizerTelemetry"] = Field(default=None, description="")
async_scorer: Optional[bool] = Field(default=None, description="")
indexed_only_excluded_vectors: Optional[Dict[str, int]] = Field(default=None, description="")
update_queue: Optional["ShardUpdateQueueInfo"] = Field(default=None, description="Update queue status")
class Log10Expression(BaseModel, extra="forbid"):
log10: "Expression" = Field(..., description="")
class LookupLocation(BaseModel, extra="forbid"):
"""
Defines a location to use for looking up the vector. Specifies collection and vector field name.
"""
collection: str = Field(..., description="Name of the collection used for lookup")
vector: Optional[str] = Field(
default=None,
description="Optional name of the vector field within the collection. If not provided, the default vector field will be used.",
)
shard_key: Optional["ShardKeySelector"] = Field(
default=None,
description="Specify in which shards to look for the points, if not specified - look in all shards",
)
class LowMemoryModeOneOf(str, Enum):
"""
No special handling. Every component loads as persisted.
"""
def __str__(self) -> str:
return str(self.value)
DISABLED = "disabled"
class LowMemoryModeOneOf1(str, Enum):
"""
Load RAM-friendly components as their on-disk variants where possible: * Quantization is loaded as if `always_ram = false`. * Payload field indexes are loaded as if `on_disk = true`. * Payload storage is loaded as the mmap variant (lazy populate).
"""
def __str__(self) -> str:
return str(self.value)
NO_RESIDENT = "no_resident"
class LowMemoryModeOneOf2(str, Enum):
"""
Same as [`LowMemoryMode::NoResident`], plus mmap page population is skipped on load (for original vectors, HNSW graph and payload storage).
"""
def __str__(self) -> str:
return str(self.value)
NO_POPULATE = "no_populate"
class MatchAny(BaseModel, extra="forbid"):
"""
Exact match on any of the given values
"""
any: "AnyVariants" = Field(..., description="Exact match on any of the given values")
class MatchExcept(BaseModel, extra="forbid"):
"""
Should have at least one value not matching the any given values
"""
except_: "AnyVariants" = Field(
..., description="Should have at least one value not matching the any given values", alias="except"
)
class MatchPhrase(BaseModel, extra="forbid"):
"""
Full-text phrase match of the string.
"""
phrase: str = Field(..., description="Full-text phrase match of the string.")
class MatchPrefix(BaseModel, extra="forbid"):
"""
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.
"""
prefix: str = Field(
...,
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.",
)
class MatchText(BaseModel, extra="forbid"):
"""
Full-text match of the strings.
"""
text: str = Field(..., description="Full-text match of the strings.")
class MatchTextAny(BaseModel, extra="forbid"):
"""
Full-text match of at least one token of the string.
"""
text_any: str = Field(..., description="Full-text match of at least one token of the string.")
class MatchValue(BaseModel, extra="forbid"):
"""
Exact match of the given value
"""
value: "ValueVariants" = Field(..., description="Exact match of the given value")
class MaxOptimizationThreadsSetting(str, Enum):
AUTO = "auto"
class Memory(str, Enum):
"""
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.
"""
def __str__(self) -> str:
return str(self.value)
COLD = "cold"
CACHED = "cached"
PINNED = "pinned"
class MemoryTelemetry(BaseModel):
active_bytes: int = Field(..., description="Total number of bytes in active pages allocated by the application")
allocated_bytes: int = Field(..., description="Total number of bytes allocated by the application")
metadata_bytes: int = Field(..., description="Total number of bytes dedicated to metadata")
resident_bytes: int = Field(..., description="Maximum number of bytes in physically resident data pages mapped")
retained_bytes: int = Field(..., description="Total number of bytes in virtual memory mappings")
class MessageSendErrors(BaseModel):
"""
Message send failures for a particular peer
"""
count: int = Field(..., description="Message send failures for a particular peer")
latest_error: Optional[str] = Field(default=None, description="Message send failures for a particular peer")
latest_error_timestamp: Optional[Union[datetime, date]] = Field(
default=None, description="Timestamp of the latest error"
)
class MinShould(BaseModel, extra="forbid"):
conditions: List["Condition"] = Field(..., description="")
min_count: int = Field(..., description="")
class Mmr(BaseModel, extra="forbid"):
"""
Maximal Marginal Relevance (MMR) algorithm for re-ranking the points.
"""
diversity: Optional[float] = Field(
default=None,
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.",
)
candidates_limit: Optional[int] = Field(
default=None,
description="The maximum number of candidates to consider for re-ranking. If not specified, the `limit` value is used.",
)
class ModelUsage(BaseModel):
tokens: int = Field(..., description="")
class Modifier(str, Enum):
"""
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
"""
def __str__(self) -> str:
return str(self.value)
NONE = "none"
IDF = "idf"
class MoveShard(BaseModel, extra="forbid"):
shard_id: int = Field(..., description="")
to_peer_id: int = Field(..., description="")
from_peer_id: int = Field(..., description="")
method: Optional["ShardTransferMethod"] = Field(
default=None, description="Method for transferring the shard from one node to another"
)
class MoveShardOperation(BaseModel, extra="forbid"):
move_shard: "MoveShard" = Field(..., description="")
class MultExpression(BaseModel, extra="forbid"):
mult: List["Expression"] = Field(..., description="")
class MultiVectorComparator(str, Enum):
MAX_SIM = "max_sim"
class MultiVectorConfig(BaseModel, extra="forbid"):
comparator: "MultiVectorComparator" = Field(..., description="")
class NaiveFeedbackStrategy(BaseModel, extra="forbid"):
naive: "NaiveFeedbackStrategyParams" = Field(..., description="")
class NaiveFeedbackStrategyParams(BaseModel, extra="forbid"):
a: float = Field(..., description="")
b: float = Field(..., description="")
c: float = Field(..., description="")
class NearestQuery(BaseModel, extra="forbid"):
nearest: "VectorInput" = Field(..., description="")
mmr: Optional["Mmr"] = Field(
default=None,
description="Perform MMR (Maximal Marginal Relevance) reranking after search, using the same vector in this query to calculate relevance.",
)
class NegExpression(BaseModel, extra="forbid"):
neg: "Expression" = Field(..., description="")
class Nested(BaseModel, extra="forbid"):
"""
Select points with payload for a specified nested field
"""
key: str = Field(..., description="Select points with payload for a specified nested field")
filter: "Filter" = Field(..., description="Select points with payload for a specified nested field")
class NestedCondition(BaseModel, extra="forbid"):
nested: "Nested" = Field(..., description="")
class NoStemmer(str, Enum):
"""
Tag selecting the explicit 'no stemming' algorithm.
"""
def __str__(self) -> str:
return str(self.value)
NONE = "none"
class OperationDurationStatistics(BaseModel):
count: int = Field(..., description="")
fail_count: Optional[int] = Field(default=None, description="")
avg_duration_micros: Optional[float] = Field(
default=None, description="The average time taken by 128 latest operations, calculated as a weighted mean."
)
min_duration_micros: Optional[float] = Field(
default=None, description="The minimum duration of the operations across all the measurements."
)
max_duration_micros: Optional[float] = Field(
default=None, description="The maximum duration of the operations across all the measurements."
)
total_duration_micros: Optional[int] = Field(
default=None, description="The total duration of all operations in microseconds."
)
last_responded: Optional[Union[datetime, date]] = Field(default=None, description="")
class Optimization(BaseModel):
uuid: UUID = Field(
...,
description="Unique identifier of the optimization process. After the optimization is complete, a new segment will be created with this UUID.",
)
optimizer: str = Field(..., description="Name of the optimizer that performed this optimization.")
status: "TrackerStatus" = Field(..., description="")
segments: List["OptimizationSegmentInfo"] = Field(
...,
description="Segments being optimized. After the optimization is complete, these segments will be replaced by the new optimized segment.",
)
progress: "ProgressTree" = Field(..., description="")
class OptimizationSegmentInfo(BaseModel):
uuid: UUID = Field(..., description="Unique identifier of the segment.")
points_count: int = Field(..., description="Number of non-deleted points in the segment.")
class OptimizationsResponse(BaseModel):
"""
Optimizations progress for the collection
"""
summary: "OptimizationsSummary" = Field(..., description="Optimizations progress for the collection")
running: List["Optimization"] = Field(..., description="Currently running optimizations.")
queued: Optional[List["PendingOptimization"]] = Field(
default=None, description="An estimated queue of pending optimizations. Requires `?with=queued`."
)
completed: Optional[List["Optimization"]] = Field(
default=None,
description="Completed optimizations. Requires `?with=completed`. Limited by `?completed_limit=N`.",
)
idle_segments: Optional[List["OptimizationSegmentInfo"]] = Field(
default=None, description="Segments that don't require optimization. Requires `?with=idle_segments`."
)
class OptimizationsSummary(BaseModel):
queued_optimizations: int = Field(
...,
description="Number of pending optimizations in the queue. Each optimization will take one or more unoptimized segments and produce one optimized segment.",
)
queued_segments: int = Field(..., description="Number of unoptimized segments in the queue.")
queued_points: int = Field(..., description="Number of points in unoptimized segments in the queue.")
idle_segments: int = Field(..., description="Number of segments that don't require optimization.")
class OptimizerTelemetry(BaseModel):
status: "OptimizersStatus" = Field(..., description="")
optimizations: "OperationDurationStatistics" = Field(..., description="")
log: Optional[List["TrackerTelemetry"]] = Field(default=None, description="")
class OptimizersConfig(BaseModel):
deleted_threshold: Optional[float] = Field(
default=0.2,
description="The minimal fraction of deleted vectors in a segment, required to perform segment optimization",
)
vacuum_min_vector_number: Optional[int] = Field(
default=1000, description="The minimal number of vectors in a segment, required to perform segment optimization"
)
default_segment_number: int = Field(
...,
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.",
)
max_segment_size: Optional[int] = Field(
default=None,
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.",
)
memmap_threshold: Optional[int] = Field(
default=None,
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",
)
indexing_threshold: Optional[int] = Field(
default=None,
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.",
)
flush_interval_sec: int = Field(..., description="Minimum interval between forced flushes.")
max_optimization_threads: Optional[int] = Field(
default=None,
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.",
)
prevent_unoptimized: Optional[bool] = Field(
default=None,
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.",
)
class OptimizersConfigDiff(BaseModel, extra="forbid"):
deleted_threshold: Optional[float] = Field(
default=None,
description="The minimal fraction of deleted vectors in a segment, required to perform segment optimization",
)
vacuum_min_vector_number: Optional[int] = Field(
default=None, description="The minimal number of vectors in a segment, required to perform segment optimization"
)
default_segment_number: Optional[int] = Field(
default=None,
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",
)
max_segment_size: Optional[int] = Field(
default=None,
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",
)
memmap_threshold: Optional[int] = Field(
default=None,
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",
)
indexing_threshold: Optional[int] = Field(
default=None,
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 <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md>. To disable vector indexing, set to `0`. Note: 1kB = 1 vector of size 256.",
)
flush_interval_sec: Optional[int] = Field(default=None, description="Minimum interval between forced flushes.")
max_optimization_threads: Optional["MaxOptimizationThreads"] = Field(
default=None,
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.",
)
prevent_unoptimized: Optional[bool] = Field(
default=None,
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.",
)
class OptimizersStatusOneOf(str, Enum):
"""
Optimizers are reporting as expected
"""
def __str__(self) -> str:
return str(self.value)
OK = "ok"
class OptimizersStatusOneOf1(BaseModel):
"""
Something wrong happened with optimizers
"""
error: str = Field(..., description="Something wrong happened with optimizers")
class OrderBy(BaseModel, extra="forbid"):
key: str = Field(..., description="Payload key to order by")
direction: Optional["Direction"] = Field(
default=None, description="Direction of ordering: `asc` or `desc`. Default is ascending."
)
start_from: Optional["StartFrom"] = Field(
default=None,
description="Which payload value to start scrolling from. Default is the lowest value for `asc` and the highest for `desc`",
)
class OrderByQuery(BaseModel, extra="forbid"):
order_by: "OrderByInterface" = Field(..., description="")
class OverwritePayloadOperation(BaseModel, extra="forbid"):
overwrite_payload: "SetPayload" = Field(..., description="")
class P2pConfigTelemetry(BaseModel):
connection_pool_size: int = Field(..., description="")
class PartialSnapshotTelemetry(BaseModel):
ongoing_create_snapshot_requests: int = Field(..., description="")
is_recovering: bool = Field(..., description="")
recovery_timestamp: int = Field(..., description="")
class PayloadField(BaseModel, extra="forbid"):
"""
Payload field
"""
key: str = Field(..., description="Payload field name")
class PayloadIndexInfo(BaseModel):
"""
Display payload field type & index information
"""
data_type: "PayloadSchemaType" = Field(..., description="Display payload field type & index information")
params: Optional["PayloadSchemaParams"] = Field(
default=None, description="Display payload field type & index information"
)
points: int = Field(..., description="Number of points indexed with this index")
class PayloadIndexTelemetry(BaseModel):
field_name: Optional[str] = Field(default=None, description="")
index_type: str = Field(..., description="")
points_values_count: int = Field(..., description="The amount of values indexed for all points.")
points_count: int = Field(..., description="The amount of points that have at least one value indexed.")
histogram_bucket_size: Optional[int] = Field(default=None, description="")
class PayloadSchemaType(str, Enum):
"""
All possible names of payload types
"""
def __str__(self) -> str:
return str(self.value)
KEYWORD = "keyword"
INTEGER = "integer"
FLOAT = "float"
GEO = "geo"
TEXT = "text"
BOOL = "bool"
DATETIME = "datetime"
UUID = "uuid"
class PayloadSelectorExclude(BaseModel, extra="forbid"):
exclude: List[str] = Field(..., description="Exclude this fields from returning payload")
class PayloadSelectorInclude(BaseModel, extra="forbid"):
include: List[str] = Field(..., description="Only include this payload keys")
class PayloadStorageParams(BaseModel, extra="forbid"):
"""
Params of the payload storage
"""
memory: Optional["Memory"] = Field(
default=None,
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).",
)
class PayloadStorageTypeOneOf(BaseModel):
type: Literal[
"mmap",
] = Field(..., description="")
class PayloadStorageTypeOneOf1(BaseModel):
type: Literal[
"in_ram_mmap",
] = Field(..., description="")
class PeerInfo(BaseModel):
"""
Information of a peer in the cluster
"""
uri: str = Field(..., description="Information of a peer in the cluster")
class PeerMetadata(BaseModel):
"""
Metadata describing extra properties for each peer
"""
version: str = Field(..., description="Peer Qdrant version")
class PendingOptimization(BaseModel):
optimizer: str = Field(..., description="Name of the optimizer that scheduled this optimization.")
segments: List["OptimizationSegmentInfo"] = Field(..., description="Segments that will be optimized.")
class PointGroup(BaseModel):
hits: List["ScoredPoint"] = Field(..., description="Scored points that have the same value of the group_by key")
id: "GroupId" = Field(..., description="")
lookup: Optional["Record"] = Field(default=None, description="Record that has been looked up using the group id")
class PointIdsList(BaseModel, extra="forbid"):
points: List["ExtendedPointId"] = Field(..., description="")
shard_key: Optional["ShardKeySelector"] = Field(default=None, description="")
class PointRequest(BaseModel, extra="forbid"):
shard_key: Optional["ShardKeySelector"] = Field(
default=None,
description="Specify in which shards to look for the points, if not specified - look in all shards",
)
ids: List["ExtendedPointId"] = Field(..., description="Look for points with ids")
with_payload: Optional["WithPayloadInterface"] = Field(
default=None, description="Select which payload to return with the response. Default is true."
)
with_vector: Optional["WithVector"] = Field(default=None, description="")
class PointStruct(BaseModel, extra="forbid"):
id: "ExtendedPointId" = Field(..., description="")
vector: "VectorStruct" = Field(..., description="")
payload: Optional["Payload"] = Field(default=None, description="Payload values (optional)")
class PointVectors(BaseModel, extra="forbid"):
id: "ExtendedPointId" = Field(..., description="")
vector: "VectorStruct" = Field(..., description="")
class PointsBatch(BaseModel, extra="forbid"):
batch: "Batch" = Field(..., description="")
shard_key: Optional["ShardKeySelector"] = Field(default=None, description="")
update_filter: Optional["Filter"] = Field(
default=None,
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_mode: Optional["UpdateMode"] = Field(
default=None, description="Mode of the upsert operation: insert_only, upsert (default), update_only"
)
class PointsList(BaseModel, extra="forbid"):
points: List["PointStruct"] = Field(..., description="")
shard_key: Optional["ShardKeySelector"] = Field(default=None, description="")
update_filter: Optional["Filter"] = Field(
default=None,
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_mode: Optional["UpdateMode"] = Field(
default=None, description="Mode of the upsert operation: insert_only, upsert (default), update_only"
)
class PowExpression(BaseModel, extra="forbid"):
pow: "PowParams" = Field(..., description="")
class PowParams(BaseModel, extra="forbid"):
base: "Expression" = Field(..., description="")
exponent: "Expression" = Field(..., description="")
class Prefetch(BaseModel, extra="forbid"):
prefetch: Optional[Union[List["Prefetch"], "Prefetch"]] = Field(
default=None,
description="Sub-requests to perform first. If present, the query will be performed on the results of the prefetches.",
)
query: Optional["QueryInterface"] = Field(
default=None,
description="Query to perform. If missing without prefetches, returns points ordered by their IDs.",
)
using: Optional[str] = Field(
default=None,
description="Define which vector name to use for querying. If missing, the default vector is used.",
)
filter: Optional["Filter"] = Field(
default=None, description="Filter conditions - return only those points that satisfy the specified conditions."
)
params: Optional["SearchParams"] = Field(default=None, description="Search params for when there is no prefetch")
score_threshold: Optional[float] = Field(
default=None, description="Return points with scores better than this threshold."
)
limit: Optional[int] = Field(default=None, description="Max number of points to return. Default is 10.")
lookup_from: Optional["LookupLocation"] = Field(
default=None,
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",
)
class ProductQuantization(BaseModel, extra="forbid"):
product: "ProductQuantizationConfig" = Field(..., description="")
class ProductQuantizationConfig(BaseModel, extra="forbid"):
compression: "CompressionRatio" = Field(..., description="")
always_ram: Optional[bool] = Field(default=None, description="Deprecated: use `memory` instead.")
memory: Optional["Memory"] = Field(
default=None,
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.",
)
class ProgressTree(BaseModel):
name: str = Field(..., description="Name of the operation.")
started_at: Optional[Union[datetime, date]] = Field(default=None, description="When the operation started.")
finished_at: Optional[Union[datetime, date]] = Field(default=None, description="When the operation finished.")
duration_sec: Optional[float] = Field(
default=None, description="For finished operations, how long they took, in seconds."
)
done: Optional[int] = Field(default=None, description="Number of completed units of work, if applicable.")
total: Optional[int] = Field(default=None, description="Total number of units of work, if applicable and known.")
children: Optional[List["ProgressTree"]] = Field(default=None, description="Child operations.")
class QuantizationSearchParams(BaseModel, extra="forbid"):
"""
Additional parameters of the search
"""
ignore: Optional[bool] = Field(
default=False, description="If true, quantized vectors are ignored. Default is false."
)
rescore: Optional[bool] = Field(
default=None,
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.",
)
oversampling: Optional[float] = Field(
default=None,
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.",
)
class QueryGroupsRequest(BaseModel, extra="forbid"):
shard_key: Optional["ShardKeySelector"] = Field(default=None, description="")
prefetch: Optional[Union[List["Prefetch"], "Prefetch"]] = Field(
default=None,
description="Sub-requests to perform first. If present, the query will be performed on the results of the prefetch(es).",
)
query: Optional["QueryInterface"] = Field(
default=None,
description="Query to perform. If missing without prefetches, returns points ordered by their IDs.",
)
using: Optional[str] = Field(
default=None,
description="Define which vector name to use for querying. If missing, the default vector is used.",
)
filter: Optional["Filter"] = Field(
default=None, description="Filter conditions - return only those points that satisfy the specified conditions."
)
params: Optional["SearchParams"] = Field(default=None, description="Search params for when there is no prefetch")
score_threshold: Optional[float] = Field(
default=None, description="Return points with scores better than this threshold."
)
with_vector: Optional["WithVector"] = Field(
default=None, description="Options for specifying which vectors to include into the response. Default is false."
)
with_payload: Optional["WithPayloadInterface"] = Field(
default=None, description="Options for specifying which payload to include or not. Default is false."
)
lookup_from: Optional["LookupLocation"] = Field(
default=None,
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",
)
group_by: str = Field(
...,
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_size: Optional[int] = Field(
default=None, description="Maximum amount of points to return per group. Default is 3."
)
limit: Optional[int] = Field(default=None, description="Maximum amount of groups to return. Default is 10.")
with_lookup: Optional["WithLookupInterface"] = Field(
default=None, description="Look for points in another collection using the group ids"
)
class QueryRequest(BaseModel, extra="forbid"):
shard_key: Optional["ShardKeySelector"] = Field(default=None, description="")
prefetch: Optional[Union[List["Prefetch"], "Prefetch"]] = Field(
default=None,
description="Sub-requests to perform first. If present, the query will be performed on the results of the prefetch(es).",
)
query: Optional["QueryInterface"] = Field(
default=None,
description="Query to perform. If missing without prefetches, returns points ordered by their IDs.",
)
using: Optional[str] = Field(
default=None,
description="Define which vector name to use for querying. If missing, the default vector is used.",
)
filter: Optional["Filter"] = Field(
default=None, description="Filter conditions - return only those points that satisfy the specified conditions."
)
params: Optional["SearchParams"] = Field(default=None, description="Search params for when there is no prefetch")
score_threshold: Optional[float] = Field(
default=None, description="Return points with scores better than this threshold."
)
limit: Optional[int] = Field(default=None, description="Max number of points to return. Default is 10.")
offset: Optional[int] = Field(default=None, description="Offset of the result. Skip this many points. Default is 0")
with_vector: Optional["WithVector"] = Field(
default=None, description="Options for specifying which vectors to include into the response. Default is false."
)
with_payload: Optional["WithPayloadInterface"] = Field(
default=None, description="Options for specifying which payload to include or not. Default is false."
)
lookup_from: Optional["LookupLocation"] = Field(
default=None,
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",
)
class QueryRequestBatch(BaseModel, extra="forbid"):
searches: List["QueryRequest"] = Field(..., description="")
class QueryResponse(BaseModel):
points: List["ScoredPoint"] = Field(..., description="")
class RaftInfo(BaseModel):
"""
Summary information about the current raft state
"""
term: int = Field(
...,
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.",
)
commit: int = Field(
..., description="The index of the latest committed (finalized) operation that this peer is aware of."
)
pending_operations: int = Field(
..., description="Number of consensus operations pending to be applied on this peer"
)
leader: Optional[int] = Field(default=None, description="Leader of the current term")
role: Optional["StateRole"] = Field(default=None, description="Role of this peer in the current term")
is_voter: bool = Field(..., description="Is this peer a voter or a learner")
class Range(BaseModel, extra="forbid"):
"""
Range filter request
"""
lt: Optional[float] = Field(default=None, description="point.key < range.lt")
gt: Optional[float] = Field(default=None, description="point.key > range.gt")
gte: Optional[float] = Field(default=None, description="point.key >= range.gte")
lte: Optional[float] = Field(default=None, description="point.key <= range.lte")
class ReadConsistencyType(str, Enum):
"""
* `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
"""
def __str__(self) -> str:
return str(self.value)
MAJORITY = "majority"
QUORUM = "quorum"
ALL = "all"
class RecommendInput(BaseModel, extra="forbid"):
positive: Optional[List["VectorInput"]] = Field(
default=None, description="Look for vectors closest to the vectors from these points"
)
negative: Optional[List["VectorInput"]] = Field(
default=None, description="Try to avoid vectors like the vector from these points"
)
strategy: Optional["RecommendStrategy"] = Field(
default=None, description="How to use the provided vectors to find the results"
)
class RecommendQuery(BaseModel, extra="forbid"):
recommend: "RecommendInput" = Field(..., description="")
class RecommendStrategy(str, Enum):
"""
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.
"""
def __str__(self) -> str:
return str(self.value)
AVERAGE_VECTOR = "average_vector"
BEST_SCORE = "best_score"
SUM_SCORES = "sum_scores"
class Record(BaseModel):
"""
Point data
"""
id: "ExtendedPointId" = Field(..., description="Point data")
payload: Optional["Payload"] = Field(default=None, description="Payload - values assigned to the point")
vector: Optional["VectorStructOutput"] = Field(default=None, description="Vector of the point")
shard_key: Optional["ShardKey"] = Field(default=None, description="Shard Key")
order_value: Optional["OrderValue"] = Field(default=None, description="Point data")
class RelevanceFeedbackInput(BaseModel, extra="forbid"):
target: "VectorInput" = Field(..., description="")
feedback: List["FeedbackItem"] = Field(..., description="")
strategy: "FeedbackStrategy" = Field(..., description="")
class RelevanceFeedbackQuery(BaseModel, extra="forbid"):
relevance_feedback: "RelevanceFeedbackInput" = Field(..., description="")
class RemoteShardInfo(BaseModel):
shard_id: int = Field(..., description="Remote shard id")
shard_key: Optional["ShardKey"] = Field(default=None, description="User-defined sharding key")
peer_id: int = Field(..., description="Remote peer id")
state: "ReplicaState" = Field(..., description="")
class RemoteShardTelemetry(BaseModel):
shard_id: int = Field(..., description="")
peer_id: int = Field(..., description="")
searches: Optional["OperationDurationStatistics"] = Field(default=None, description="")
updates: Optional["OperationDurationStatistics"] = Field(default=None, description="")
class RenameAlias(BaseModel, extra="forbid"):
"""
Change alias to a new one
"""
old_alias_name: str = Field(..., description="Change alias to a new one")
new_alias_name: str = Field(..., description="Change alias to a new one")
class RenameAliasOperation(BaseModel, extra="forbid"):
"""
Change alias to a new one
"""
rename_alias: "RenameAlias" = Field(..., description="Change alias to a new one")
class Replica(BaseModel, extra="forbid"):
shard_id: int = Field(..., description="")
peer_id: int = Field(..., description="")
class ReplicaSetTelemetry(BaseModel):
id: int = Field(..., description="")
key: Optional["ShardKey"] = Field(default=None, description="")
local: Optional["LocalShardTelemetry"] = Field(default=None, description="")
remote: List["RemoteShardTelemetry"] = Field(..., description="")
replicate_states: Dict[str, "ReplicaState"] = Field(..., description="")
partial_snapshot: Optional["PartialSnapshotTelemetry"] = Field(default=None, description="")
class ReplicaState(str, Enum):
"""
State of the single shard within a replica set.
"""
def __str__(self) -> str:
return str(self.value)
ACTIVE = "Active"
DEAD = "Dead"
PARTIAL = "Partial"
INITIALIZING = "Initializing"
LISTENER = "Listener"
PARTIALSNAPSHOT = "PartialSnapshot"
RECOVERY = "Recovery"
RESHARDING = "Resharding"
RESHARDINGSCALEDOWN = "ReshardingScaleDown"
ACTIVEREAD = "ActiveRead"
MANUALRECOVERY = "ManualRecovery"
class ReplicatePoints(BaseModel, extra="forbid"):
filter: Optional["Filter"] = Field(default=None, description="")
from_shard_key: "ShardKey" = Field(..., description="")
to_shard_key: "ShardKey" = Field(..., description="")
class ReplicatePointsOperation(BaseModel, extra="forbid"):
replicate_points: "ReplicatePoints" = Field(..., description="")
class ReplicateShard(BaseModel, extra="forbid"):
shard_id: int = Field(..., description="")
to_peer_id: int = Field(..., description="")
from_peer_id: int = Field(..., description="")
method: Optional["ShardTransferMethod"] = Field(
default=None, description="Method for transferring the shard from one node to another"
)
class ReplicateShardOperation(BaseModel, extra="forbid"):
replicate_shard: "ReplicateShard" = Field(..., description="")
class RequestsTelemetry(BaseModel):
rest: "WebApiTelemetry" = Field(..., description="")
grpc: "GrpcTelemetry" = Field(..., description="")
class ReshardingDirection(str, Enum):
"""
Resharding direction, scale up or down in number of shards - `up` - Scale up, add a new shard - `down` - Scale down, remove a shard
"""
def __str__(self) -> str:
return str(self.value)
UP = "up"
DOWN = "down"
class ReshardingInfo(BaseModel):
direction: "ReshardingDirection" = Field(..., description="")
shard_id: int = Field(..., description="")
peer_id: int = Field(..., description="")
shard_key: Optional["ShardKey"] = Field(default=None, description="")
class RestartTransfer(BaseModel, extra="forbid"):
shard_id: int = Field(..., description="")
from_peer_id: int = Field(..., description="")
to_peer_id: int = Field(..., description="")
method: "ShardTransferMethod" = Field(..., description="")
class RestartTransferOperation(BaseModel, extra="forbid"):
restart_transfer: "RestartTransfer" = Field(..., description="")
class Rrf(BaseModel, extra="forbid"):
"""
Parameters for Reciprocal Rank Fusion
"""
k: Optional[int] = Field(default=None, description="K parameter for reciprocal rank fusion")
weights: Optional[List[float]] = Field(
default=None,
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.",
)
class RrfQuery(BaseModel, extra="forbid"):
rrf: "Rrf" = Field(..., description="")
class RunningEnvironmentTelemetry(BaseModel):
distribution: Optional[str] = Field(default=None, description="")
distribution_version: Optional[str] = Field(default=None, description="")
is_docker: bool = Field(..., description="")
cores: Optional[int] = Field(default=None, description="")
cpu_cores_used: Optional[float] = Field(
default=None,
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.",
)
ram_size: Optional[int] = Field(default=None, description="")
disk_size: Optional[int] = Field(default=None, description="")
cpu_flags: str = Field(..., description="")
cpu_endian: Optional["CpuEndian"] = Field(default=None, description="")
gpu_devices: Optional[List["GpuDeviceTelemetry"]] = Field(default=None, description="")
class Sample(str, Enum):
RANDOM = "random"
class SampleQuery(BaseModel, extra="forbid"):
sample: "Sample" = Field(..., description="")
class ScalarQuantization(BaseModel, extra="forbid"):
scalar: "ScalarQuantizationConfig" = Field(..., description="")
class ScalarQuantizationConfig(BaseModel, extra="forbid"):
type: "ScalarType" = Field(..., description="")
quantile: Optional[float] = Field(
default=None,
description="Quantile for quantization. Expected value range in [0.5, 1.0]. If not set - use the whole range of values",
)
always_ram: Optional[bool] = Field(
default=None,
description="Deprecated: use `memory` instead. If true - quantized vectors always will be stored in RAM, ignoring the config of main storage",
)
memory: Optional["Memory"] = Field(
default=None,
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.",
)
class ScalarType(str, Enum):
INT8 = "int8"
class ScoredPoint(BaseModel):
"""
Search result
"""
id: "ExtendedPointId" = Field(..., description="Search result")
version: int = Field(..., description="Point version")
score: float = Field(..., description="Points vector distance to the query vector")
payload: Optional["Payload"] = Field(default=None, description="Payload - values assigned to the point")
vector: Optional["VectorStructOutput"] = Field(default=None, description="Vector of the point")
shard_key: Optional["ShardKey"] = Field(default=None, description="Shard Key")
order_value: Optional["OrderValue"] = Field(default=None, description="Order-by value")
class ScrollRequest(BaseModel, extra="forbid"):
"""
Scroll request - paginate over all points which matches given condition
"""
shard_key: Optional["ShardKeySelector"] = Field(
default=None,
description="Specify in which shards to look for the points, if not specified - look in all shards",
)
offset: Optional["ExtendedPointId"] = Field(default=None, description="Start ID to read points from.")
limit: Optional[int] = Field(default=None, description="Page size. Default: 10")
filter: Optional["Filter"] = Field(
default=None, description="Look only for points which satisfies this conditions. If not provided - all points."
)
with_payload: Optional["WithPayloadInterface"] = Field(
default=None, description="Select which payload to return with the response. Default is true."
)
with_vector: Optional["WithVector"] = Field(
default=None, description="Scroll request - paginate over all points which matches given condition"
)
order_by: Optional["OrderByInterface"] = Field(default=None, description="Order the records by a payload field.")
class ScrollResult(BaseModel):
"""
Result of the points read request
"""
points: List["Record"] = Field(..., description="List of retrieved points")
next_page_offset: Optional["ExtendedPointId"] = Field(
default=None, description="Offset which should be used to retrieve a next page result"
)
class SearchMatrixOffsetsResponse(BaseModel):
offsets_row: List[int] = Field(..., description="Row indices of the matrix")
offsets_col: List[int] = Field(..., description="Column indices of the matrix")
scores: List[float] = Field(..., description="Scores associated with matrix coordinates")
ids: List["ExtendedPointId"] = Field(..., description="Ids of the points in order")
class SearchMatrixPair(BaseModel):
"""
Pair of points (a, b) with score
"""
a: "ExtendedPointId" = Field(..., description="Pair of points (a, b) with score")
b: "ExtendedPointId" = Field(..., description="Pair of points (a, b) with score")
score: float = Field(..., description="Pair of points (a, b) with score")
class SearchMatrixPairsResponse(BaseModel):
pairs: List["SearchMatrixPair"] = Field(..., description="List of pairs of points with scores")
class SearchMatrixRequest(BaseModel, extra="forbid"):
shard_key: Optional["ShardKeySelector"] = Field(
default=None,
description="Specify in which shards to look for the points, if not specified - look in all shards",
)
filter: Optional["Filter"] = Field(default=None, description="Look only for points which satisfies this conditions")
sample: Optional[int] = Field(
default=None, description="How many points to select and search within. Default is 10."
)
limit: Optional[int] = Field(default=None, description="How many neighbours per sample to find. Default is 3.")
using: Optional[str] = Field(
default=None,
description="Define which vector name to use for querying. If missing, the default vector is used.",
)
class SearchParams(BaseModel, extra="forbid"):
"""
Additional parameters of the search
"""
hnsw_ef: Optional[int] = Field(
default=None,
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.",
)
exact: Optional[bool] = Field(
default=False,
description="Search without approximation. If set to true, search may run long but with exact results.",
)
quantization: Optional["QuantizationSearchParams"] = Field(default=None, description="Quantization params")
indexed_only: Optional[bool] = Field(
default=False,
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",
)
acorn: Optional["AcornSearchParams"] = Field(default=None, description="ACORN search params")
idf: Optional["IdfParams"] = Field(
default=None,
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.",
)
class SearchThreadPoolTelemetry(BaseModel):
"""
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.
"""
mode: str = Field(..., description="Currently active mode (`high_cpu` or `high_io`).")
high_cpu_threads: int = Field(..., description="Blocking-thread count of the high-CPU runtime.")
high_io_threads: int = Field(..., description="Blocking-thread count of the high-IO runtime.")
class SegmentConfig(BaseModel):
vector_data: Optional[Dict[str, "VectorDataConfig"]] = Field(default={}, description="")
sparse_vector_data: Optional[Dict[str, "SparseVectorDataConfig"]] = Field(default=None, description="")
payload_storage_type: "PayloadStorageType" = Field(..., description="")
class SegmentInfo(BaseModel):
"""
Aggregated information about segment
"""
uuid: UUID = Field(..., description="Aggregated information about segment")
segment_type: "SegmentType" = Field(..., description="Aggregated information about segment")
num_vectors: int = Field(..., description="Aggregated information about segment")
num_points: int = Field(..., description="Aggregated information about segment")
num_deferred_points: Optional[int] = Field(default=None, description="Aggregated information about segment")
num_deleted_deferred_points: Optional[int] = Field(default=None, description="Aggregated information about segment")
num_indexed_vectors: int = Field(..., description="Aggregated information about segment")
num_deleted_vectors: int = Field(..., description="Aggregated information about segment")
vectors_size_bytes: int = Field(
...,
description="An ESTIMATION of effective amount of bytes used for vectors Do NOT rely on this number unless you know what you are doing",
)
payloads_size_bytes: int = Field(
..., description="An estimation of the effective amount of bytes used for payloads"
)
ram_usage_bytes: int = Field(..., description="Aggregated information about segment")
disk_usage_bytes: int = Field(..., description="Aggregated information about segment")
is_appendable: bool = Field(..., description="Aggregated information about segment")
index_schema: Dict[str, "PayloadIndexInfo"] = Field(..., description="Aggregated information about segment")
vector_data: Dict[str, "VectorDataInfo"] = Field(..., description="Aggregated information about segment")
payload_storage_io_backend: Optional["IoBackend"] = Field(
default=None,
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.",
)
deferred_internal_id: Optional[int] = Field(
default=None,
description="Internal ID from which points are deferred (hidden from reads). Only set for appendable segments.",
)
class SegmentTelemetry(BaseModel):
info: "SegmentInfo" = Field(..., description="")
config: "SegmentConfig" = Field(..., description="")
vector_index_searches: List["VectorIndexSearchesTelemetry"] = Field(..., description="")
payload_field_indices: List["PayloadIndexTelemetry"] = Field(..., description="")
class SegmentType(str, Enum):
"""
Type of segment
"""
def __str__(self) -> str:
return str(self.value)
PLAIN = "plain"
INDEXED = "indexed"
SPECIAL = "special"
class SetPayload(BaseModel, extra="forbid"):
"""
This data structure is used in API interface and applied across multiple shards
"""
payload: "Payload" = Field(
..., description="This data structure is used in API interface and applied across multiple shards"
)
points: Optional[List["ExtendedPointId"]] = Field(
default=None, description="Assigns payload to each point in this list"
)
filter: Optional["Filter"] = Field(
default=None, description="Assigns payload to each point that satisfy this filter condition"
)
shard_key: Optional["ShardKeySelector"] = Field(
default=None, description="This data structure is used in API interface and applied across multiple shards"
)
key: Optional[str] = Field(
default=None, description="Assigns payload to each point that satisfy this path of property"
)
class SetPayloadOperation(BaseModel, extra="forbid"):
set_payload: "SetPayload" = Field(..., description="")
class ShardCleanStatusFailedTelemetry(BaseModel):
reason: str = Field(..., description="")
class ShardCleanStatusProgressTelemetry(BaseModel):
deleted_points: int = Field(..., description="")
class ShardCleanStatusTelemetryOneOf(str, Enum):
STARTED = "started"
DONE = "done"
CANCELLED = "cancelled"
class ShardCleanStatusTelemetryOneOf1(BaseModel):
progress: "ShardCleanStatusProgressTelemetry" = Field(..., description="")
class ShardCleanStatusTelemetryOneOf2(BaseModel):
failed: "ShardCleanStatusFailedTelemetry" = Field(..., description="")
class ShardKeyDescription(BaseModel):
key: "ShardKey" = Field(..., description="")
class ShardKeyWithFallback(BaseModel, extra="forbid"):
target: "ShardKey" = Field(..., description="")
fallback: "ShardKey" = Field(..., description="")
class ShardKeysResponse(BaseModel):
shard_keys: Optional[List["ShardKeyDescription"]] = Field(
default=None, description="The existing shard keys. Only available when sharding method is `custom`"
)
class ShardSnapshotRecover(BaseModel, extra="forbid"):
location: "ShardSnapshotLocation" = Field(..., description="")
priority: Optional["SnapshotPriority"] = Field(default=None, description="")
checksum: Optional[str] = Field(
default=None, description="Optional SHA256 checksum to verify snapshot integrity before recovery."
)
api_key: Optional[str] = Field(
default=None, description="Optional API key used when fetching the snapshot from a remote URL."
)
class ShardStatus(str, Enum):
"""
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
"""
def __str__(self) -> str:
return str(self.value)
GREEN = "green"
YELLOW = "yellow"
GREY = "grey"
RED = "red"
class ShardTransferInfo(BaseModel):
shard_id: int = Field(..., description="")
to_shard_id: Optional[int] = Field(
default=None,
description="Target shard ID if different than source shard ID Used exclusively with `ReshardingStreamRecords` transfer method.",
)
from_: int = Field(..., description="Source peer id", alias="from")
to: int = Field(..., description="Destination peer id")
sync: bool = Field(
...,
description="If `true` transfer is a synchronization of a replicas If `false` transfer is a moving of a shard from one peer to another",
)
method: Optional["ShardTransferMethod"] = Field(default=None, description="")
comment: Optional[str] = Field(
default=None, description="A human-readable report of the transfer progress. Available only on the source peer."
)
class ShardTransferMethod(str, Enum):
"""
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.
"""
def __str__(self) -> str:
return str(self.value)
STREAM_RECORDS = "stream_records"
SNAPSHOT = "snapshot"
WAL_DELTA = "wal_delta"
RESHARDING_STREAM_RECORDS = "resharding_stream_records"
class ShardUpdateQueueInfo(BaseModel):
length: int = Field(..., description="Number of elements in the queue")
op_num: Optional[int] = Field(default=None, description="last operation number processed")
deferred_points: Optional[int] = Field(
default=None,
description="Number of points that are deferred (i.e hidden from search as they're not yet optimized).",
)
class ShardingMethod(str, Enum):
AUTO = "auto"
CUSTOM = "custom"
class Slice(BaseModel, extra="forbid"):
"""
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.
"""
total: int = Field(..., description="Total number of disjoint slices the id space is split into")
index: int = Field(..., description="Which slice to select, must be in `0..total`")
class SliceCondition(BaseModel, extra="forbid"):
"""
Select points that fall into one of `total` disjoint deterministic slices of the id space, for parallel scans and reproducible sampling.
"""
slice: "Slice" = Field(
...,
description="Select points that fall into one of `total` disjoint deterministic slices of the id space, for parallel scans and reproducible sampling.",
)
class SnapshotDescription(BaseModel):
name: str = Field(..., description="")
creation_time: Optional[str] = Field(default=None, description="")
size: int = Field(..., description="")
checksum: Optional[str] = Field(default=None, description="")
class SnapshotPriority(str, Enum):
"""
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.
"""
def __str__(self) -> str:
return str(self.value)
NO_SYNC = "no_sync"
SNAPSHOT = "snapshot"
REPLICA = "replica"
class SnapshotRecover(BaseModel, extra="forbid"):
location: str = Field(
...,
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`",
)
priority: Optional["SnapshotPriority"] = Field(
default=None,
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.",
)
checksum: Optional[str] = Field(
default=None, description="Optional SHA256 checksum to verify snapshot integrity before recovery."
)
api_key: Optional[str] = Field(
default=None, description="Optional API key used when fetching the snapshot from a remote URL."
)
class Snowball(str, Enum):
SNOWBALL = "snowball"
class SnowballLanguage(str, Enum):
"""
Languages supported by snowball stemmer.
"""
def __str__(self) -> str:
return str(self.value)
ARABIC = "arabic"
ARMENIAN = "armenian"
DANISH = "danish"
DUTCH = "dutch"
ENGLISH = "english"
FINNISH = "finnish"
FRENCH = "french"
GERMAN = "german"
GREEK = "greek"
HUNGARIAN = "hungarian"
ITALIAN = "italian"
NORWEGIAN = "norwegian"
PORTUGUESE = "portuguese"
ROMANIAN = "romanian"
RUSSIAN = "russian"
SPANISH = "spanish"
SWEDISH = "swedish"
TAMIL = "tamil"
TURKISH = "turkish"
class SnowballParams(BaseModel, extra="forbid"):
type: "Snowball" = Field(..., description="")
language: "SnowballLanguage" = Field(..., description="")
class SparseIndexConfig(BaseModel):
"""
Configuration for sparse inverted index.
"""
full_scan_threshold: Optional[int] = Field(
default=None,
description="We prefer a full scan search upto (excluding) this number of vectors. Note: this is number of vectors, not KiloBytes.",
)
index_type: "SparseIndexType" = Field(..., description="Configuration for sparse inverted index.")
datatype: Optional["VectorStorageDatatype"] = Field(
default=None, description="Datatype used to store weights in the index."
)
memory: Optional["Memory"] = Field(
default=None,
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.",
)
class SparseIndexParams(BaseModel, extra="forbid"):
"""
Configuration for sparse inverted index.
"""
full_scan_threshold: Optional[int] = Field(
default=None,
description="We prefer a full scan search upto (excluding) this number of vectors. Note: this is number of vectors, not KiloBytes.",
)
on_disk: Optional[bool] = Field(
default=None,
description="Deprecated: use `memory` instead. Store index on disk. If set to false, the index will be stored in RAM. Default: false",
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
datatype: Optional["Datatype"] = Field(
default=None,
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.",
)
class SparseIndexTypeOneOf(str, Enum):
"""
Mutable RAM sparse index
"""
def __str__(self) -> str:
return str(self.value)
MUTABLERAM = "MutableRam"
class SparseIndexTypeOneOf1(str, Enum):
"""
Immutable RAM sparse index
"""
def __str__(self) -> str:
return str(self.value)
IMMUTABLERAM = "ImmutableRam"
class SparseIndexTypeOneOf2(str, Enum):
"""
Mmap sparse index
"""
def __str__(self) -> str:
return str(self.value)
MMAP = "Mmap"
class SparseVector(BaseModel, extra="forbid"):
"""
Sparse vector structure
"""
indices: List[int] = Field(..., description="Indices must be unique")
values: List[float] = Field(..., description="Values and indices must be the same length")
class SparseVectorConfig(BaseModel, extra="forbid"):
"""
Configuration for creating a new sparse named vector. Only includes properties that define the vector space and cannot be changed after creation.
"""
modifier: Optional["Modifier"] = Field(default=None, description="Value modifier for sparse vectors (e.g., IDF)")
datatype: Optional["VectorStorageDatatype"] = Field(
default=None, description="Datatype used to store weights in the index"
)
class SparseVectorDataConfig(BaseModel):
"""
Config of single sparse vector data storage
"""
index: "SparseIndexConfig" = Field(..., description="Config of single sparse vector data storage")
storage_type: Optional["SparseVectorStorageType"] = Field(
default=None, description="Config of single sparse vector data storage"
)
modifier: Optional["Modifier"] = Field(
default=None, description="Configures addition value modifications for sparse vectors. Default: none"
)
class SparseVectorNameConfig(BaseModel, extra="forbid"):
"""
Wrapper for sparse vector creation config.
"""
sparse: "SparseVectorConfig" = Field(..., description="Wrapper for sparse vector creation config.")
class SparseVectorParams(BaseModel, extra="forbid"):
"""
Params of single sparse vector data storage
"""
index: Optional["SparseIndexParams"] = Field(
default=None, description="Custom params for index. If none - values from collection configuration are used."
)
modifier: Optional["Modifier"] = Field(
default=None, description="Configures addition value modifications for sparse vectors. Default: none"
)
class SparseVectorStorageTypeOneOf(str, Enum):
"""
Storage in memory maps (gridstore storage)
"""
def __str__(self) -> str:
return str(self.value)
MMAP = "mmap"
class SparseVectorStorageTypeOneOf1(str, Enum):
"""
Placeholder storage: contains no data, all vectors reported as deleted. Used for newly created sparse named vectors on immutable segments.
"""
def __str__(self) -> str:
return str(self.value)
EMPTY = "empty"
class SqrtExpression(BaseModel, extra="forbid"):
sqrt: "Expression" = Field(..., description="")
class StartResharding(BaseModel, extra="forbid"):
direction: "ReshardingDirection" = Field(..., description="")
peer_id: Optional[int] = Field(
default=None,
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.",
)
shard_key: Optional["ShardKey"] = Field(
default=None,
description="Custom shard key to reshard, must already exist. If not specified, shards without a shard key are resharded.",
)
class StartReshardingOperation(BaseModel, extra="forbid"):
start_resharding: "StartResharding" = Field(..., description="")
class StateRole(str, Enum):
"""
Role of the peer in the consensus
"""
def __str__(self) -> str:
return str(self.value)
FOLLOWER = "Follower"
CANDIDATE = "Candidate"
LEADER = "Leader"
PRECANDIDATE = "PreCandidate"
class StopwordsSet(BaseModel, extra="forbid"):
languages: Optional[List["Language"]] = Field(
default=None,
description="Set of languages to use for stopwords. Multiple pre-defined lists of stopwords can be combined.",
)
custom: Optional[List[str]] = Field(
default=None, description="Custom stopwords set. Will be merged with the languages set."
)
class StrictModeConfig(BaseModel, extra="forbid"):
enabled: Optional[bool] = Field(default=None, description="Whether strict mode is enabled for a collection or not.")
max_query_limit: Optional[int] = Field(
default=None, description="Max allowed `limit` parameter for all APIs that don't have their own max limit."
)
max_timeout: Optional[int] = Field(default=None, description="Max allowed `timeout` parameter.")
unindexed_filtering_retrieve: Optional[bool] = Field(
default=None, description="Allow usage of unindexed fields in retrieval based (e.g. search) filters."
)
unindexed_filtering_update: Optional[bool] = Field(
default=None, description="Allow usage of unindexed fields in filtered updates (e.g. delete by payload)."
)
search_max_hnsw_ef: Optional[int] = Field(
default=None, description="Max HNSW ef value allowed in search parameters."
)
search_allow_exact: Optional[bool] = Field(default=None, description="Whether exact search is allowed.")
search_max_oversampling: Optional[float] = Field(
default=None, description="Max oversampling value allowed in search."
)
upsert_max_batchsize: Optional[int] = Field(default=None, description="Max batchsize when upserting")
search_max_batchsize: Optional[int] = Field(default=None, description="Max batchsize when searching")
max_collection_vector_size_bytes: Optional[int] = Field(
default=None, description="Max size of a collections vector storage in bytes, ignoring replicas."
)
read_rate_limit: Optional[int] = Field(
default=None, description="Max number of read operations per minute per replica"
)
write_rate_limit: Optional[int] = Field(
default=None, description="Max number of write operations per minute per replica"
)
max_collection_payload_size_bytes: Optional[int] = Field(
default=None, description="Max size of a collections payload storage in bytes"
)
max_points_count: Optional[int] = Field(default=None, description="Max number of points estimated in a collection")
filter_max_conditions: Optional[int] = Field(default=None, description="Max conditions a filter can have.")
condition_max_size: Optional[int] = Field(
default=None, description="Max size of a condition, eg. items in `MatchAny`."
)
multivector_config: Optional["StrictModeMultivectorConfig"] = Field(
default=None, description="Multivector strict mode configuration"
)
sparse_config: Optional["StrictModeSparseConfig"] = Field(
default=None, description="Sparse vector strict mode configuration"
)
max_payload_index_count: Optional[int] = Field(
default=None, description="Max number of payload indexes in a collection"
)
max_resident_memory_percent: Optional[int] = Field(
default=None,
description="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]. Applied uniformly to external and internal (replication) traffic — rejection is deterministic so it does not cause replica divergence. Delete operations are not affected, so callers can still free memory.",
)
max_disk_usage_percent: Optional[int] = Field(
default=None,
description="Reject disk-consuming update operations (e.g. upsert, set payload) when the filesystem hosting Qdrant storage is filled above this percentage of its total capacity. Value in [1, 100]. Applied uniformly to external and internal (replication) traffic — rejection is deterministic so it does not cause replica divergence. Delete operations are not affected, so callers can still free disk space. Free space is sampled with a small TTL cache; the gate may take a few seconds to react.",
)
class StrictModeConfigOutput(BaseModel):
enabled: Optional[bool] = Field(default=None, description="Whether strict mode is enabled for a collection or not.")
max_query_limit: Optional[int] = Field(
default=None, description="Max allowed `limit` parameter for all APIs that don't have their own max limit."
)
max_timeout: Optional[int] = Field(default=None, description="Max allowed `timeout` parameter.")
unindexed_filtering_retrieve: Optional[bool] = Field(
default=None, description="Allow usage of unindexed fields in retrieval based (e.g. search) filters."
)
unindexed_filtering_update: Optional[bool] = Field(
default=None, description="Allow usage of unindexed fields in filtered updates (e.g. delete by payload)."
)
search_max_hnsw_ef: Optional[int] = Field(default=None, description="Max HNSW value allowed in search parameters.")
search_allow_exact: Optional[bool] = Field(default=None, description="Whether exact search is allowed or not.")
search_max_oversampling: Optional[float] = Field(
default=None, description="Max oversampling value allowed in search."
)
upsert_max_batchsize: Optional[int] = Field(default=None, description="Max batchsize when upserting")
search_max_batchsize: Optional[int] = Field(default=None, description="Max batchsize when searching")
max_collection_vector_size_bytes: Optional[int] = Field(
default=None, description="Max size of a collections vector storage in bytes, ignoring replicas."
)
read_rate_limit: Optional[int] = Field(
default=None, description="Max number of read operations per minute per replica"
)
write_rate_limit: Optional[int] = Field(
default=None, description="Max number of write operations per minute per replica"
)
max_collection_payload_size_bytes: Optional[int] = Field(
default=None, description="Max size of a collections payload storage in bytes"
)
max_points_count: Optional[int] = Field(default=None, description="Max number of points estimated in a collection")
filter_max_conditions: Optional[int] = Field(default=None, description="Max conditions a filter can have.")
condition_max_size: Optional[int] = Field(
default=None, description="Max size of a condition, eg. items in `MatchAny`."
)
multivector_config: Optional["StrictModeMultivectorConfigOutput"] = Field(
default=None, description="Multivector configuration"
)
sparse_config: Optional["StrictModeSparseConfigOutput"] = Field(
default=None, description="Sparse vector configuration"
)
max_payload_index_count: Optional[int] = Field(
default=None, description="Max number of payload indexes in a collection"
)
max_resident_memory_percent: Optional[int] = Field(
default=None,
description="Reject memory-consuming update operations when resident memory exceeds this percentage of total RAM (1-100)",
)
max_disk_usage_percent: Optional[int] = Field(
default=None,
description="Reject disk-consuming update operations when the storage filesystem exceeds this percentage of total capacity (1-100)",
)
class StrictModeMultivector(BaseModel, extra="forbid"):
max_vectors: Optional[int] = Field(default=None, description="Max number of vectors in a multivector")
class StrictModeMultivectorOutput(BaseModel):
max_vectors: Optional[int] = Field(default=None, description="Max number of vectors in a multivector")
class StrictModeSparse(BaseModel, extra="forbid"):
max_length: Optional[int] = Field(default=None, description="Max length of sparse vector")
class StrictModeSparseOutput(BaseModel):
max_length: Optional[int] = Field(default=None, description="Max length of sparse vector")
class SumExpression(BaseModel, extra="forbid"):
sum: List["Expression"] = Field(..., description="")
class TelemetryData(BaseModel):
id: str = Field(..., description="")
app: Optional["AppBuildTelemetry"] = Field(default=None, description="")
collections: "CollectionsTelemetry" = Field(..., description="")
cluster: Optional["ClusterTelemetry"] = Field(default=None, description="")
requests: Optional["RequestsTelemetry"] = Field(default=None, description="")
memory: Optional["MemoryTelemetry"] = Field(default=None, description="")
hardware: Optional["HardwareTelemetry"] = Field(default=None, description="")
search_pool: Optional["SearchThreadPoolTelemetry"] = Field(default=None, description="")
class TextIndexParams(BaseModel, extra="forbid"):
type: "TextIndexType" = Field(..., description="")
tokenizer: Optional["TokenizerType"] = Field(default=None, description="")
min_token_len: Optional[int] = Field(default=None, description="Minimum characters to be tokenized.")
max_token_len: Optional[int] = Field(default=None, description="Maximum characters to be tokenized.")
lowercase: Optional[bool] = Field(default=None, description="If true, lowercase all tokens. Default: true.")
ascii_folding: Optional[bool] = Field(
default=None,
description="If true, normalize tokens by folding accented characters to ASCII (e.g., 'ação' -> 'acao'). Default: false.",
)
phrase_matching: Optional[bool] = Field(
default=None, description="If true, support phrase matching. Default: false."
)
stopwords: Optional["StopwordsInterface"] = Field(
default=None,
description="Ignore this set of tokens. Can select from predefined languages and/or provide a custom set.",
)
on_disk: Optional[bool] = Field(
default=None, description="Deprecated: use `memory` instead. If true, store the index on disk. Default: false."
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
stemmer: Optional["StemmingAlgorithm"] = Field(
default=None, description="Algorithm for stemming. Default: disabled."
)
enable_hnsw: Optional[bool] = Field(
default=None,
description="Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true.",
)
class TextIndexType(str, Enum):
TEXT = "text"
class TokenizerType(str, Enum):
PREFIX = "prefix"
WHITESPACE = "whitespace"
WORD = "word"
MULTILINGUAL = "multilingual"
class TrackerStatusOneOf(str, Enum):
OPTIMIZING = "optimizing"
DONE = "done"
class TrackerStatusOneOf1(BaseModel):
cancelled: str = Field(..., description="")
class TrackerStatusOneOf2(BaseModel):
error: str = Field(..., description="")
class TrackerTelemetry(BaseModel):
"""
Tracker object used in telemetry
"""
name: str = Field(..., description="Name of the optimizer")
uuid: UUID = Field(..., description="UUID of the upcoming segment being created by the optimizer")
segment_ids: List[int] = Field(
...,
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_uuids: List[UUID] = Field(
...,
description="Segment UUIDs being optimized. Refers to same segments as in `segment_ids`, but trackable across restarts, and reflect their directory name.",
)
status: "TrackerStatus" = Field(..., description="Tracker object used in telemetry")
start_at: Union[datetime, date] = Field(..., description="Start time of the optimizer")
end_at: Optional[Union[datetime, date]] = Field(default=None, description="End time of the optimizer")
class TurboQuantBitSize(str, Enum):
BITS1 = "bits1"
BITS1_5 = "bits1_5"
BITS2 = "bits2"
BITS4 = "bits4"
class TurboQuantQuantizationConfig(BaseModel, extra="forbid"):
always_ram: Optional[bool] = Field(default=None, description="Deprecated: use `memory` instead.")
memory: Optional["Memory"] = Field(
default=None,
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.",
)
bits: Optional["TurboQuantBitSize"] = Field(default=None, description="")
class TurboQuantization(BaseModel, extra="forbid"):
turbo: "TurboQuantQuantizationConfig" = Field(..., description="")
class UpdateCollection(BaseModel, extra="forbid"):
"""
Operation for updating parameters of the existing collection
"""
vectors: Optional["VectorsConfigDiff"] = Field(
default=None,
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.",
)
optimizers_config: Optional["OptimizersConfigDiff"] = Field(
default=None,
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",
)
params: Optional["CollectionParamsDiff"] = Field(
default=None, description="Collection base params. If none - it is left unchanged."
)
hnsw_config: Optional["HnswConfigDiff"] = Field(
default=None, description="HNSW parameters to update for the collection index. If none - it is left unchanged."
)
quantization_config: Optional["QuantizationConfigDiff"] = Field(
default=None, description="Quantization parameters to update. If none - it is left unchanged."
)
sparse_vectors: Optional["SparseVectorsConfig"] = Field(
default=None, description="Map of sparse vector data parameters to update for each sparse vector."
)
strict_mode_config: Optional["StrictModeConfig"] = Field(
default=None, description="Operation for updating parameters of the existing collection"
)
metadata: Optional["Payload"] = Field(
default=None,
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`.",
)
class UpdateMode(str, Enum):
"""
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
"""
def __str__(self) -> str:
return str(self.value)
UPSERT = "upsert"
INSERT_ONLY = "insert_only"
UPDATE_ONLY = "update_only"
class UpdateOperations(BaseModel, extra="forbid"):
operations: List["UpdateOperation"] = Field(..., description="")
class UpdateQueueInfo(BaseModel):
length: int = Field(..., description="Number of elements in the queue")
deferred_points: Optional[int] = Field(
default=None,
description="Number of points that are deferred (i.e hidden from search as they're not yet optimized).",
)
class UpdateResult(BaseModel):
operation_id: Optional[int] = Field(default=None, description="Sequential number of the operation")
status: "UpdateStatus" = Field(..., description="")
class UpdateStatus(str, Enum):
"""
`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.
"""
def __str__(self) -> str:
return str(self.value)
ACKNOWLEDGED = "acknowledged"
COMPLETED = "completed"
WAIT_TIMEOUT = "wait_timeout"
class UpdateVectors(BaseModel, extra="forbid"):
points: List["PointVectors"] = Field(..., description="Points with named vectors")
shard_key: Optional["ShardKeySelector"] = Field(default=None, description="")
update_filter: Optional["Filter"] = Field(default=None, description="")
class UpdateVectorsOperation(BaseModel, extra="forbid"):
update_vectors: "UpdateVectors" = Field(..., description="")
class UpsertOperation(BaseModel, extra="forbid"):
upsert: "PointInsertOperations" = Field(..., description="")
class Usage(BaseModel):
"""
Usage of the hardware resources, spent to process the request
"""
hardware: Optional["HardwareUsage"] = Field(
default=None, description="Usage of the hardware resources, spent to process the request"
)
inference: Optional["InferenceUsage"] = Field(
default=None, description="Usage of the hardware resources, spent to process the request"
)
class UuidIndexParams(BaseModel, extra="forbid"):
type: "UuidIndexType" = Field(..., description="")
is_tenant: Optional[bool] = Field(default=None, description="If true - used for tenant optimization.")
on_disk: Optional[bool] = Field(
default=None, description="Deprecated: use `memory` instead. If true, store the index on disk. Default: false."
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
enable_hnsw: Optional[bool] = Field(
default=None,
description="Enable HNSW graph building for this payload field. If true, builds additional HNSW links (Need payload_m > 0). Default: true.",
)
class UuidIndexType(str, Enum):
UUID = "uuid"
class ValuesCount(BaseModel, extra="forbid"):
"""
Values count filter request
"""
lt: Optional[int] = Field(default=None, description="point.key.length() < values_count.lt")
gt: Optional[int] = Field(default=None, description="point.key.length() > values_count.gt")
gte: Optional[int] = Field(default=None, description="point.key.length() >= values_count.gte")
lte: Optional[int] = Field(default=None, description="point.key.length() <= values_count.lte")
class VectorDataConfig(BaseModel):
"""
Config of single vector data storage
"""
size: int = Field(..., description="Size/dimensionality of the vectors used")
distance: "Distance" = Field(..., description="Config of single vector data storage")
storage_type: "VectorStorageType" = Field(..., description="Config of single vector data storage")
index: "Indexes" = Field(..., description="Config of single vector data storage")
quantization_config: Optional["QuantizationConfig"] = Field(
default=None, description="Vector specific quantization config that overrides collection config"
)
multivector_config: Optional["MultiVectorConfig"] = Field(
default=None, description="Vector specific configuration to enable multiple vectors per point"
)
datatype: Optional["VectorStorageDatatype"] = Field(
default=None, description="Vector specific configuration to set specific storage element type"
)
class VectorDataInfo(BaseModel):
num_vectors: int = Field(..., description="")
num_indexed_vectors: int = Field(..., description="")
num_deleted_vectors: int = Field(..., description="")
io_backend: Optional["IoBackend"] = Field(
default=None,
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.",
)
class VectorIndexSearchesTelemetry(BaseModel):
index_name: Optional[str] = Field(default=None, description="")
unfiltered_plain: "OperationDurationStatistics" = Field(..., description="")
unfiltered_hnsw: "OperationDurationStatistics" = Field(..., description="")
unfiltered_sparse: "OperationDurationStatistics" = Field(..., description="")
filtered_plain: "OperationDurationStatistics" = Field(..., description="")
filtered_small_cardinality: "OperationDurationStatistics" = Field(..., description="")
filtered_large_cardinality: "OperationDurationStatistics" = Field(..., description="")
filtered_exact: "OperationDurationStatistics" = Field(..., description="")
filtered_sparse: "OperationDurationStatistics" = Field(..., description="")
unfiltered_exact: "OperationDurationStatistics" = Field(..., description="")
class VectorParams(BaseModel, extra="forbid"):
"""
Params of single vector data storage
"""
size: int = Field(..., description="Size of a vectors used")
distance: "Distance" = Field(..., description="Params of single vector data storage")
hnsw_config: Optional["HnswConfigDiff"] = Field(
default=None,
description="Custom params for HNSW index. If none - values from collection configuration are used.",
)
quantization_config: Optional["QuantizationConfig"] = Field(
default=None,
description="Custom params for quantization. If none - values from collection configuration are used.",
)
on_disk: Optional[bool] = Field(
default=None,
description="Deprecated: use `memory` instead. If true, vectors are served from disk, improving RAM usage at the cost of latency Default: false",
)
memory: Optional["Memory"] = Field(
default=None,
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).",
)
datatype: Optional["Datatype"] = Field(
default=None,
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.",
)
multivector_config: Optional["MultiVectorConfig"] = Field(
default=None, description="Params of single vector data storage"
)
class VectorParamsDiff(BaseModel, extra="forbid"):
hnsw_config: Optional["HnswConfigDiff"] = Field(
default=None, description="Update params for HNSW index. If empty object - it will be unset."
)
quantization_config: Optional["QuantizationConfigDiff"] = Field(
default=None, description="Update params for quantization. If none - it is left unchanged."
)
on_disk: Optional[bool] = Field(
default=None,
description="Deprecated: use `memory` instead. If true, vectors are served from disk, improving RAM usage at the cost of latency",
)
memory: Optional["Memory"] = Field(
default=None,
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.",
)
class VectorStorageDatatype(str, Enum):
"""
Storage types for vectors
"""
def __str__(self) -> str:
return str(self.value)
FLOAT32 = "float32"
FLOAT16 = "float16"
UINT8 = "uint8"
TURBO4 = "turbo4"
class VectorStorageTypeOneOf(str, Enum):
"""
Storage in memory (RAM) Will be very fast at the cost of consuming a lot of memory.
"""
def __str__(self) -> str:
return str(self.value)
MEMORY = "Memory"
class VectorStorageTypeOneOf1(str, Enum):
"""
Storage in mmap file, not appendable Search performance is defined by disk speed and the fraction of vectors that fit in memory.
"""
def __str__(self) -> str:
return str(self.value)
MMAP = "Mmap"
class VectorStorageTypeOneOf2(str, Enum):
"""
Storage in chunked mmap files, appendable Search performance is defined by disk speed and the fraction of vectors that fit in memory.
"""
def __str__(self) -> str:
return str(self.value)
CHUNKEDMMAP = "ChunkedMmap"
class VectorStorageTypeOneOf3(str, Enum):
"""
Same as `ChunkedMmap`, but vectors are forced to be locked in RAM In this way we avoid cold requests to disk, but risk to run out of memory Designed as a replacement for `Memory`, which doesn't depend on RocksDB
"""
def __str__(self) -> str:
return str(self.value)
INRAMCHUNKEDMMAP = "InRamChunkedMmap"
class VectorStorageTypeOneOf4(str, Enum):
"""
Storage in a single mmap file, not appendable Pre-fetched into RAM on load
"""
def __str__(self) -> str:
return str(self.value)
INRAMMMAP = "InRamMmap"
class VectorStorageTypeOneOf5(str, Enum):
"""
Placeholder storage: contains no data, all vectors reported as deleted. Used for newly created named vectors on immutable segments. No files on disk, reconstructed from config on load.
"""
def __str__(self) -> str:
return str(self.value)
EMPTY = "Empty"
class VersionInfo(BaseModel):
title: str = Field(..., description="")
version: str = Field(..., description="")
commit: Optional[str] = Field(default=None, description="")
class WalConfig(BaseModel):
wal_capacity_mb: int = Field(..., description="Size of a single WAL segment in MB")
wal_segments_ahead: int = Field(..., description="Number of WAL segments to create ahead of actually used ones")
wal_retain_closed: Optional[int] = Field(default=1, description="Number of closed WAL segments to keep")
class WalConfigDiff(BaseModel, extra="forbid"):
wal_capacity_mb: Optional[int] = Field(default=None, description="Size of a single WAL segment in MB")
wal_segments_ahead: Optional[int] = Field(
default=None, description="Number of WAL segments to create ahead of actually used ones"
)
wal_retain_closed: Optional[int] = Field(default=None, description="Number of closed WAL segments to retain")
class WebApiTelemetry(BaseModel):
responses: Dict[str, Dict[str, "OperationDurationStatistics"]] = Field(..., description="")
per_collection_responses: Optional[Dict[str, Dict[str, Dict[str, "OperationDurationStatistics"]]]] = Field(
default=None, description=""
)
class WithLookup(BaseModel, extra="forbid"):
collection: str = Field(..., description="Name of the collection to use for points lookup")
with_payload: Optional["WithPayloadInterface"] = Field(
default=None, description="Options for specifying which payload to include (or not)"
)
with_vectors: Optional["WithVector"] = Field(
default=None, description="Options for specifying which vectors to include (or not)"
)
class WriteOrdering(str, Enum):
"""
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
"""
def __str__(self) -> str:
return str(self.value)
WEAK = "weak"
MEDIUM = "medium"
STRONG = "strong"
AliasOperations = Union[
CreateAliasOperation,
DeleteAliasOperation,
RenameAliasOperation,
]
AnyVariants = Union[
List[StrictStr],
List[StrictInt],
]
ClusterOperations = Union[
MoveShardOperation,
ReplicateShardOperation,
AbortTransferOperation,
DropReplicaOperation,
CreateShardingKeyOperation,
DropShardingKeyOperation,
RestartTransferOperation,
StartReshardingOperation,
AbortReshardingOperation,
ReplicatePointsOperation,
]
ClusterStatus = Union[
ClusterStatusOneOf,
ClusterStatusOneOf1,
]
CollectionTelemetryEnum = Union[
CollectionTelemetry,
CollectionsAggregatedTelemetry,
]
Condition = Union[
FieldCondition,
IsEmptyCondition,
IsNullCondition,
HasIdCondition,
HasVectorCondition,
SliceCondition,
NestedCondition,
Filter,
]
ConsensusThreadStatus = Union[
ConsensusThreadStatusOneOf,
ConsensusThreadStatusOneOf1,
ConsensusThreadStatusOneOf2,
]
ContextInput = Union[
ContextPair,
List[ContextPair],
]
DocumentOptions = Union[
Dict[StrictStr, Any],
Bm25Config,
]
ExtendedPointId = Union[
StrictInt,
Union[StrictStr, UUID],
]
FacetValue = Union[
StrictBool,
StrictInt,
StrictStr,
]
FeedbackStrategy = Union[
NaiveFeedbackStrategy,
]
GroupId = Union[
StrictInt,
StrictStr,
]
IdfParams = Union[
IdfScope,
IdfCorpusParams,
]
Indexes = Union[
IndexesOneOf,
IndexesOneOf1,
]
LowMemoryMode = Union[
LowMemoryModeOneOf,
LowMemoryModeOneOf1,
LowMemoryModeOneOf2,
]
Match = Union[
MatchValue,
MatchText,
MatchTextAny,
MatchPhrase,
MatchPrefix,
MatchAny,
MatchExcept,
]
MaxOptimizationThreads = Union[
StrictInt,
MaxOptimizationThreadsSetting,
]
OptimizersStatus = Union[
OptimizersStatusOneOf,
OptimizersStatusOneOf1,
]
OrderByInterface = Union[
StrictStr,
OrderBy,
]
OrderValue = Union[
StrictInt,
StrictFloat,
]
PayloadSchemaParams = Union[
KeywordIndexParams,
IntegerIndexParams,
FloatIndexParams,
GeoIndexParams,
TextIndexParams,
BoolIndexParams,
DatetimeIndexParams,
UuidIndexParams,
]
PayloadSelector = Union[
PayloadSelectorInclude,
PayloadSelectorExclude,
]
PayloadStorageType = Union[
PayloadStorageTypeOneOf,
PayloadStorageTypeOneOf1,
]
PointInsertOperations = Union[
PointsBatch,
PointsList,
]
PointsSelector = Union[
PointIdsList,
FilterSelector,
]
QuantizationConfig = Union[
ScalarQuantization,
ProductQuantization,
BinaryQuantization,
TurboQuantization,
]
QuantizationConfigDiff = Union[
ScalarQuantization,
ProductQuantization,
BinaryQuantization,
TurboQuantization,
Disabled,
]
Query = Union[
NearestQuery,
RecommendQuery,
DiscoverQuery,
ContextQuery,
OrderByQuery,
FusionQuery,
RrfQuery,
FormulaQuery,
SampleQuery,
RelevanceFeedbackQuery,
]
RangeInterface = Union[
Range,
DatetimeRange,
]
ReadConsistency = Union[
StrictInt,
ReadConsistencyType,
]
ShardCleanStatusTelemetry = Union[
ShardCleanStatusTelemetryOneOf,
ShardCleanStatusTelemetryOneOf1,
ShardCleanStatusTelemetryOneOf2,
]
ShardKey = Union[
StrictInt,
StrictStr,
]
ShardSnapshotLocation = Union[
StrictStr,
]
SparseIndexType = Union[
SparseIndexTypeOneOf,
SparseIndexTypeOneOf1,
SparseIndexTypeOneOf2,
]
SparseVectorStorageType = Union[
SparseVectorStorageTypeOneOf,
SparseVectorStorageTypeOneOf1,
]
StartFrom = Union[
StrictInt,
StrictFloat,
datetime,
date,
]
StemmingAlgorithm = Union[
SnowballParams,
DisabledStemmerParams,
]
StopwordsInterface = Union[
Language,
StopwordsSet,
]
TrackerStatus = Union[
TrackerStatusOneOf,
TrackerStatusOneOf1,
TrackerStatusOneOf2,
]
UpdateOperation = Union[
UpsertOperation,
DeleteOperation,
SetPayloadOperation,
OverwritePayloadOperation,
DeletePayloadOperation,
ClearPayloadOperation,
UpdateVectorsOperation,
DeleteVectorsOperation,
]
ValueVariants = Union[
StrictBool,
StrictInt,
StrictStr,
]
Vector = Union[
List[StrictFloat],
SparseVector,
List[List[StrictFloat]],
Document,
Image,
InferenceObject,
]
VectorNameConfig = Union[
DenseVectorNameConfig,
SparseVectorNameConfig,
]
VectorOutput = Union[
List[StrictFloat],
SparseVector,
List[List[StrictFloat]],
]
VectorStorageType = Union[
VectorStorageTypeOneOf,
VectorStorageTypeOneOf1,
VectorStorageTypeOneOf2,
VectorStorageTypeOneOf3,
VectorStorageTypeOneOf4,
VectorStorageTypeOneOf5,
]
VectorsConfig = Union[
VectorParams,
Dict[StrictStr, VectorParams],
]
WithLookupInterface = Union[
StrictStr,
WithLookup,
]
WithVector = Union[
StrictBool,
List[StrictStr],
]
BatchVectorStruct = Union[
List[List[StrictFloat]],
List[List[List[StrictFloat]]],
Dict[StrictStr, List[Vector]],
List[Document],
List[Image],
List[InferenceObject],
]
Expression = Union[
StrictFloat,
StrictStr,
Condition,
GeoDistance,
DatetimeExpression,
DatetimeKeyExpression,
MultExpression,
SumExpression,
NegExpression,
AbsExpression,
DivExpression,
SqrtExpression,
PowExpression,
ExpExpression,
Log10Expression,
LnExpression,
LinDecayExpression,
ExpDecayExpression,
GaussDecayExpression,
]
PayloadFieldSchema = Union[
PayloadSchemaType,
PayloadSchemaParams,
]
ShardKeySelector = Union[
ShardKey,
List[ShardKey],
ShardKeyWithFallback,
]
VectorInput = Union[
List[StrictFloat],
SparseVector,
List[List[StrictFloat]],
ExtendedPointId,
Document,
Image,
InferenceObject,
]
VectorStruct = Union[
List[StrictFloat],
List[List[StrictFloat]],
Dict[StrictStr, Vector],
Document,
Image,
InferenceObject,
]
VectorStructOutput = Union[
List[StrictFloat],
List[List[StrictFloat]],
Dict[StrictStr, VectorOutput],
]
WithPayloadInterface = Union[
StrictBool,
List[StrictStr],
PayloadSelector,
]
QueryInterface = Union[
VectorInput,
Query,
]
Reference in New Issue View Git Blame Copy Permalink