qdrant_client.http.models.models module¶

class AbortReshardingOperation(*, abort_resharding: Any)[source]¶

Bases: BaseModel

abort_resharding: Any¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class AbortShardTransfer(*, shard_id: int, to_peer_id: int, from_peer_id: int)[source]¶

Bases: BaseModel

from_peer_id: int¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

shard_id: int¶

to_peer_id: int¶

class AbortTransferOperation(*, abort_transfer: AbortShardTransfer)[source]¶

Bases: BaseModel

abort_transfer: AbortShardTransfer¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class AliasDescription(*, alias_name: str, collection_name: str)[source]¶

Bases: BaseModel

alias_name: str¶

collection_name: str¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class AppBuildTelemetry(*, name: str, version: str, features: Optional[AppFeaturesTelemetry] = None, system: Optional[RunningEnvironmentTelemetry] = None, jwt_rbac: Optional[bool] = None, hide_jwt_dashboard: Optional[bool] = None, startup: Union[datetime, date])[source]¶

Bases: BaseModel

features: Optional[AppFeaturesTelemetry]¶

hide_jwt_dashboard: Optional[bool]¶

jwt_rbac: Optional[bool]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶

startup: Union[datetime, date]¶

system: Optional[RunningEnvironmentTelemetry]¶

version: str¶

class AppFeaturesTelemetry(*, debug: bool, web_feature: bool, service_debug_feature: bool, recovery_mode: bool, gpu: bool)[source]¶

Bases: BaseModel

debug: bool¶

gpu: bool¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

recovery_mode: bool¶

service_debug_feature: bool¶

web_feature: bool¶

class Batch(*, ids: List[Union[int, str]], vectors: Union[List[List[float]], List[List[List[float]]], Dict[str, List[Union[List[float], SparseVector, List[List[float]], Document, Image, InferenceObject]]], List[Document], List[Image], List[InferenceObject]], payloads: Optional[List[Dict[str, Any]]] = None)[source]¶

Bases: BaseModel

ids: List[ExtendedPointId]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payloads: Optional[List[Payload]]¶

vectors: BatchVectorStruct¶

class BinaryQuantization(*, binary: BinaryQuantizationConfig)[source]¶

Bases: BaseModel

binary: BinaryQuantizationConfig¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class BinaryQuantizationConfig(*, always_ram: Optional[bool] = None)[source]¶

Bases: BaseModel

always_ram: Optional[bool]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class BoolIndexParams(*, type: BoolIndexType, on_disk: Optional[bool] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

on_disk: Optional[bool]¶

type: BoolIndexType¶

class BoolIndexType(value)[source]¶

Bases: str, Enum

An enumeration.

BOOL = 'bool'¶

class ChangeAliasesOperation(*, actions: List[Union[CreateAliasOperation, DeleteAliasOperation, RenameAliasOperation]])[source]¶

Bases: BaseModel

Operation for performing changes of collection aliases. Alias changes are atomic, meaning that no collection modifications can happen between alias operations.

actions: List[AliasOperations]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ClearPayloadOperation(*, clear_payload: Union[PointIdsList, FilterSelector])[source]¶

Bases: BaseModel

clear_payload: PointsSelector¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ClusterConfigTelemetry(*, grpc_timeout_ms: int, p2p: P2pConfigTelemetry, consensus: ConsensusConfigTelemetry)[source]¶

Bases: BaseModel

consensus: ConsensusConfigTelemetry¶

grpc_timeout_ms: int¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

p2p: P2pConfigTelemetry¶

class ClusterStatusOneOf(*, status: Literal['disabled'])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status: Literal['disabled']¶

class ClusterStatusOneOf1(*, status: Literal['enabled'], peer_id: int, peers: Dict[str, PeerInfo], raft_info: RaftInfo, consensus_thread_status: Union[ConsensusThreadStatusOneOf, ConsensusThreadStatusOneOf1, ConsensusThreadStatusOneOf2], message_send_failures: Dict[str, MessageSendErrors])[source]¶

Bases: BaseModel

Description of enabled cluster

consensus_thread_status: ConsensusThreadStatus¶

message_send_failures: Dict[str, MessageSendErrors]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

peer_id: int¶

peers: Dict[str, PeerInfo]¶

raft_info: RaftInfo¶

status: Literal['enabled']¶

class ClusterStatusTelemetry(*, number_of_peers: int, term: int, commit: int, pending_operations: int, role: Optional[StateRole] = None, is_voter: bool, peer_id: Optional[int] = None, consensus_thread_status: Union[ConsensusThreadStatusOneOf, ConsensusThreadStatusOneOf1, ConsensusThreadStatusOneOf2])[source]¶

Bases: BaseModel

commit: int¶

consensus_thread_status: ConsensusThreadStatus¶

is_voter: bool¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number_of_peers: int¶

peer_id: Optional[int]¶

pending_operations: int¶

role: Optional[StateRole]¶

term: int¶

class ClusterTelemetry(*, enabled: bool, status: Optional[ClusterStatusTelemetry] = None, config: Optional[ClusterConfigTelemetry] = None, peers: Optional[Dict[str, PeerInfo]] = None, metadata: Optional[Dict[str, Any]] = None)[source]¶

Bases: BaseModel

config: Optional[ClusterConfigTelemetry]¶

enabled: bool¶

metadata: Optional[Dict[str, Any]]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

peers: Optional[Dict[str, PeerInfo]]¶

status: Optional[ClusterStatusTelemetry]¶

class CollectionClusterInfo(*, peer_id: int, shard_count: int, local_shards: List[LocalShardInfo], remote_shards: List[RemoteShardInfo], shard_transfers: List[ShardTransferInfo], resharding_operations: Optional[List[ReshardingInfo]] = None)[source]¶

Bases: BaseModel

Current clustering distribution for the collection

local_shards: List[LocalShardInfo]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

peer_id: int¶

remote_shards: List[RemoteShardInfo]¶

resharding_operations: Optional[List[ReshardingInfo]]¶

shard_count: int¶

shard_transfers: List[ShardTransferInfo]¶

class CollectionConfig(*, params: CollectionParams, hnsw_config: HnswConfig, optimizer_config: OptimizersConfig, wal_config: Optional[WalConfig] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, strict_mode_config: Optional[StrictModeConfig] = None)[source]¶

Bases: BaseModel

Information about the collection configuration

hnsw_config: HnswConfig¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

optimizer_config: OptimizersConfig¶

params: CollectionParams¶

quantization_config: Optional[QuantizationConfig]¶

strict_mode_config: Optional[StrictModeConfig]¶

wal_config: Optional[WalConfig]¶

class CollectionConfigInternal(*, params: CollectionParams, hnsw_config: HnswConfig, optimizer_config: OptimizersConfig, wal_config: WalConfig, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, strict_mode_config: Optional[StrictModeConfig] = None, uuid: Optional[UUID] = None)[source]¶

Bases: BaseModel

hnsw_config: HnswConfig¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

optimizer_config: OptimizersConfig¶

params: CollectionParams¶

quantization_config: Optional[QuantizationConfig]¶

strict_mode_config: Optional[StrictModeConfig]¶

uuid: Optional[UUID]¶

wal_config: WalConfig¶

class CollectionDescription(*, name: str)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶

class CollectionExistence(*, exists: bool)[source]¶

Bases: BaseModel

State of existence of a collection, true = exists, false = does not exist

exists: bool¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CollectionInfo(*, status: CollectionStatus, optimizer_status: Union[OptimizersStatusOneOf, OptimizersStatusOneOf1], vectors_count: Optional[int] = None, indexed_vectors_count: Optional[int] = None, points_count: Optional[int] = None, segments_count: int, config: CollectionConfig, payload_schema: Dict[str, PayloadIndexInfo])[source]¶

Bases: BaseModel

Current statistics and configuration of the collection

config: CollectionConfig¶

indexed_vectors_count: Optional[int]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

optimizer_status: OptimizersStatus¶

payload_schema: Dict[str, PayloadIndexInfo]¶

points_count: Optional[int]¶

segments_count: int¶

status: CollectionStatus¶

vectors_count: Optional[int]¶

class CollectionParams(*, vectors: Optional[Union[VectorParams, Dict[str, VectorParams]]] = None, shard_number: Optional[int] = 1, sharding_method: Optional[ShardingMethod] = None, replication_factor: Optional[int] = 1, write_consistency_factor: Optional[int] = 1, read_fan_out_factor: Optional[int] = None, on_disk_payload: Optional[bool] = True, sparse_vectors: Optional[Dict[str, SparseVectorParams]] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

on_disk_payload: Optional[bool]¶

read_fan_out_factor: Optional[int]¶

replication_factor: Optional[int]¶

shard_number: Optional[int]¶

sharding_method: Optional[ShardingMethod]¶

sparse_vectors: Optional[Dict[str, SparseVectorParams]]¶

vectors: Optional[VectorsConfig]¶

write_consistency_factor: Optional[int]¶

class CollectionParamsDiff(*, replication_factor: Optional[int] = None, write_consistency_factor: Optional[int] = None, read_fan_out_factor: Optional[int] = None, on_disk_payload: Optional[bool] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

on_disk_payload: Optional[bool]¶

read_fan_out_factor: Optional[int]¶

replication_factor: Optional[int]¶

write_consistency_factor: Optional[int]¶

class CollectionStatus(value)[source]¶

Bases: 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

GREEN = 'green'¶

GREY = 'grey'¶

RED = 'red'¶

YELLOW = 'yellow'¶

class CollectionTelemetry(*, id: str, init_time_ms: int, config: CollectionConfigInternal, shards: List[ReplicaSetTelemetry], transfers: List[ShardTransferInfo], resharding: List[ReshardingInfo], shard_clean_tasks: Dict[str, Union[ShardCleanStatusTelemetryOneOf, ShardCleanStatusTelemetryOneOf1, ShardCleanStatusTelemetryOneOf2]])[source]¶

Bases: BaseModel

config: CollectionConfigInternal¶

id: str¶

init_time_ms: int¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

resharding: List[ReshardingInfo]¶

shard_clean_tasks: Dict[str, ShardCleanStatusTelemetry]¶

shards: List[ReplicaSetTelemetry]¶

transfers: List[ShardTransferInfo]¶

class CollectionsAggregatedTelemetry(*, vectors: int, optimizers_status: Union[OptimizersStatusOneOf, OptimizersStatusOneOf1], params: CollectionParams)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

optimizers_status: OptimizersStatus¶

params: CollectionParams¶

vectors: int¶

class CollectionsAliasesResponse(*, aliases: List[AliasDescription])[source]¶

Bases: BaseModel

aliases: List[AliasDescription]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CollectionsResponse(*, collections: List[CollectionDescription])[source]¶

Bases: BaseModel

collections: List[CollectionDescription]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CollectionsTelemetry(*, number_of_collections: int, collections: Optional[List[Union[CollectionTelemetry, CollectionsAggregatedTelemetry]]] = None)[source]¶

Bases: BaseModel

collections: Optional[List[CollectionTelemetryEnum]]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

number_of_collections: int¶

class CompressionRatio(value)[source]¶

Bases: str, Enum

An enumeration.

X16 = 'x16'¶

X32 = 'x32'¶

X4 = 'x4'¶

X64 = 'x64'¶

X8 = 'x8'¶

class ConsensusConfigTelemetry(*, max_message_queue_size: int, tick_period_ms: int, bootstrap_timeout_sec: int)[source]¶

Bases: BaseModel

bootstrap_timeout_sec: int¶

max_message_queue_size: int¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

tick_period_ms: int¶

class ConsensusThreadStatusOneOf(*, consensus_thread_status: Literal['working'], last_update: Union[datetime, date])[source]¶

Bases: BaseModel

consensus_thread_status: Literal['working']¶

last_update: Union[datetime, date]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ConsensusThreadStatusOneOf1(*, consensus_thread_status: Literal['stopped'])[source]¶

Bases: BaseModel

consensus_thread_status: Literal['stopped']¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ConsensusThreadStatusOneOf2(*, consensus_thread_status: Literal['stopped_with_err'], err: str)[source]¶

Bases: BaseModel

consensus_thread_status: Literal['stopped_with_err']¶

err: str¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ContextExamplePair(*, positive: Union[int, str, List[float], SparseVector], negative: Union[int, str, List[float], SparseVector])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

negative: RecommendExample¶

positive: RecommendExample¶

class ContextPair(*, positive: Union[List[float], SparseVector, List[List[float]], int, str, Document, Image, InferenceObject], negative: Union[List[float], SparseVector, List[List[float]], int, str, Document, Image, InferenceObject])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

negative: VectorInput¶

positive: VectorInput¶

class ContextQuery(*, context: Union[ContextPair, List[ContextPair]])[source]¶

Bases: BaseModel

context: ContextInput¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CountRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, filter: Optional[Filter] = None, exact: Optional[bool] = True)[source]¶

Bases: BaseModel

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.

exact: Optional[bool]¶

filter: Optional[Filter]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

shard_key: Optional[ShardKeySelector]¶

class CountResult(*, count: int)[source]¶

Bases: BaseModel

count: int¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CpuEndian(value)[source]¶

Bases: str, Enum

An enumeration.

BIG = 'big'¶

LITTLE = 'little'¶

OTHER = 'other'¶

class CreateAlias(*, collection_name: str, alias_name: str)[source]¶

Bases: BaseModel

Create alternative name for a collection. Collection will be available under both names for search, retrieve,

alias_name: str¶

collection_name: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CreateAliasOperation(*, create_alias: CreateAlias)[source]¶

Bases: BaseModel

create_alias: CreateAlias¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CreateCollection(*, vectors: Optional[Union[VectorParams, Dict[str, VectorParams]]] = None, shard_number: Optional[int] = None, sharding_method: Optional[ShardingMethod] = None, replication_factor: Optional[int] = None, write_consistency_factor: Optional[int] = None, on_disk_payload: Optional[bool] = None, hnsw_config: Optional[HnswConfigDiff] = None, wal_config: Optional[WalConfigDiff] = None, optimizers_config: Optional[OptimizersConfigDiff] = None, init_from: Optional[InitFrom] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization]] = None, sparse_vectors: Optional[Dict[str, SparseVectorParams]] = None, strict_mode_config: Optional[StrictModeConfig] = None)[source]¶

Bases: BaseModel

Operation for creating new collection and (optionally) specify index params

hnsw_config: Optional[HnswConfigDiff]¶

init_from: Optional[InitFrom]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

on_disk_payload: Optional[bool]¶

optimizers_config: Optional[OptimizersConfigDiff]¶

quantization_config: Optional[QuantizationConfig]¶

replication_factor: Optional[int]¶

shard_number: Optional[int]¶

sharding_method: Optional[ShardingMethod]¶

sparse_vectors: Optional[Dict[str, SparseVectorParams]]¶

strict_mode_config: Optional[StrictModeConfig]¶

vectors: Optional[VectorsConfig]¶

wal_config: Optional[WalConfigDiff]¶

write_consistency_factor: Optional[int]¶

class CreateFieldIndex(*, field_name: str, field_schema: Optional[Union[PayloadSchemaType, KeywordIndexParams, IntegerIndexParams, FloatIndexParams, GeoIndexParams, TextIndexParams, BoolIndexParams, DatetimeIndexParams, UuidIndexParams]] = None)[source]¶

Bases: BaseModel

field_name: str¶

field_schema: Optional[PayloadFieldSchema]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class CreateShardingKey(*, shard_key: Union[int, str], shards_number: Optional[int] = None, replication_factor: Optional[int] = None, placement: Optional[List[int]] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

placement: Optional[List[int]]¶

replication_factor: Optional[int]¶

shard_key: ShardKey¶

shards_number: Optional[int]¶

class CreateShardingKeyOperation(*, create_sharding_key: CreateShardingKey)[source]¶

Bases: BaseModel

create_sharding_key: CreateShardingKey¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Datatype(value)[source]¶

Bases: str, Enum

An enumeration.

FLOAT16 = 'float16'¶

FLOAT32 = 'float32'¶

UINT8 = 'uint8'¶

class DatetimeIndexParams(*, type: DatetimeIndexType, is_principal: Optional[bool] = None, on_disk: Optional[bool] = None)[source]¶

Bases: BaseModel

is_principal: Optional[bool]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

on_disk: Optional[bool]¶

type: DatetimeIndexType¶

class DatetimeIndexType(value)[source]¶

Bases: str, Enum

An enumeration.

DATETIME = 'datetime'¶

class DatetimeRange(*, lt: Optional[Union[datetime, date]] = None, gt: Optional[Union[datetime, date]] = None, gte: Optional[Union[datetime, date]] = None, lte: Optional[Union[datetime, date]] = None)[source]¶

Bases: BaseModel

Range filter request

gt: Optional[Union[datetime, date]]¶

gte: Optional[Union[datetime, date]]¶

lt: Optional[Union[datetime, date]]¶

lte: Optional[Union[datetime, date]]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class DeleteAlias(*, alias_name: str)[source]¶

Bases: BaseModel

Delete alias if exists

alias_name: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class DeleteAliasOperation(*, delete_alias: DeleteAlias)[source]¶

Bases: BaseModel

Delete alias if exists

delete_alias: DeleteAlias¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class DeleteOperation(*, delete: Union[PointIdsList, FilterSelector])[source]¶

Bases: BaseModel

delete: PointsSelector¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class DeletePayload(*, keys: List[str], points: Optional[List[Union[int, str]]] = None, filter: Optional[Filter] = None, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)[source]¶

Bases: BaseModel

This data structure is used in API interface and applied across multiple shards

filter: Optional[Filter]¶

keys: List[str]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

points: Optional[List[ExtendedPointId]]¶

shard_key: Optional[ShardKeySelector]¶

class DeletePayloadOperation(*, delete_payload: DeletePayload)[source]¶

Bases: BaseModel

delete_payload: DeletePayload¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class DeleteVectors(*, points: Optional[List[Union[int, str]]] = None, filter: Optional[Filter] = None, vector: List[str], shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)[source]¶

Bases: BaseModel

filter: Optional[Filter]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

points: Optional[List[ExtendedPointId]]¶

shard_key: Optional[ShardKeySelector]¶

vector: List[str]¶

class DeleteVectorsOperation(*, delete_vectors: DeleteVectors)[source]¶

Bases: BaseModel

delete_vectors: DeleteVectors¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Direction(value)[source]¶

Bases: str, Enum

An enumeration.

ASC = 'asc'¶

DESC = 'desc'¶

class Disabled(value)[source]¶

Bases: str, Enum

An enumeration.

DISABLED = 'Disabled'¶

class DiscoverInput(*, target: Union[List[float], SparseVector, List[List[float]], int, str, Document, Image, InferenceObject], context: Union[List[ContextPair], ContextPair])[source]¶

Bases: BaseModel

context: Union[List[ContextPair], ContextPair]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

target: VectorInput¶

class DiscoverQuery(*, discover: DiscoverInput)[source]¶

Bases: BaseModel

discover: DiscoverInput¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class DiscoverRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, target: Optional[Union[int, str, List[float], SparseVector]] = None, context: Optional[List[ContextExamplePair]] = None, filter: Optional[Filter] = None, params: Optional[SearchParams] = None, limit: int, offset: Optional[int] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, with_vector: Optional[Union[bool, List[str]]] = None, using: Optional[str] = None, lookup_from: Optional[LookupLocation] = None)[source]¶

Bases: BaseModel

Use context and a target to find the most similar points, constrained by the context.

context: Optional[List[ContextExamplePair]]¶

filter: Optional[Filter]¶

limit: int¶

lookup_from: Optional[LookupLocation]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

offset: Optional[int]¶

params: Optional[SearchParams]¶

shard_key: Optional[ShardKeySelector]¶

target: Optional[RecommendExample]¶

using: Optional[UsingVector]¶

with_payload: Optional[WithPayloadInterface]¶

with_vector: Optional[WithVector]¶

class DiscoverRequestBatch(*, searches: List[DiscoverRequest])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

searches: List[DiscoverRequest]¶

class Distance(value)[source]¶

Bases: str, Enum

Type of internal tags, build from payload Distance function types used to compare vectors

COSINE = 'Cosine'¶

DOT = 'Dot'¶

EUCLID = 'Euclid'¶

MANHATTAN = 'Manhattan'¶

class Document(*, text: str, model: str, options: Optional[Dict[str, Any]] = None)[source]¶

Bases: BaseModel

WARN: Work-in-progress, unimplemented Text document for embedding. Requires inference infrastructure, unimplemented.

model: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

options: Optional[Dict[str, Any]]¶

text: str¶

class DropReplicaOperation(*, drop_replica: Replica)[source]¶

Bases: BaseModel

drop_replica: Replica¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class DropShardingKey(*, shard_key: Union[int, str])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

shard_key: ShardKey¶

class DropShardingKeyOperation(*, drop_sharding_key: DropShardingKey)[source]¶

Bases: BaseModel

drop_sharding_key: DropShardingKey¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ErrorResponse(*, time: Optional[float] = None, status: Optional[ErrorResponseStatus] = None, result: Optional[Any] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[Any]¶

status: Optional[ErrorResponseStatus]¶

time: Optional[float]¶

class ErrorResponseStatus(*, error: Optional[str] = None)[source]¶

Bases: BaseModel

error: Optional[str]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class FacetRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, key: str, limit: Optional[int] = None, filter: Optional[Filter] = None, exact: Optional[bool] = None)[source]¶

Bases: BaseModel

exact: Optional[bool]¶

filter: Optional[Filter]¶

key: str¶

limit: Optional[int]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

shard_key: Optional[ShardKeySelector]¶

class FacetResponse(*, hits: List[FacetValueHit])[source]¶

Bases: BaseModel

hits: List[FacetValueHit]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class FacetValueHit(*, value: Union[bool, int, str], count: int)[source]¶

Bases: BaseModel

count: int¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

value: FacetValue¶

class FieldCondition(*, key: str, match: Optional[Union[MatchValue, MatchText, MatchAny, MatchExcept]] = None, range: Optional[Union[Range, DatetimeRange]] = None, geo_bounding_box: Optional[GeoBoundingBox] = None, geo_radius: Optional[GeoRadius] = None, geo_polygon: Optional[GeoPolygon] = None, values_count: Optional[ValuesCount] = None)[source]¶

Bases: BaseModel

All possible payload filtering conditions

geo_bounding_box: Optional[GeoBoundingBox]¶

geo_polygon: Optional[GeoPolygon]¶

geo_radius: Optional[GeoRadius]¶

key: str¶

match: Optional[Match]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

range: Optional[RangeInterface]¶

values_count: Optional[ValuesCount]¶

class Filter(*, should: Optional[Union[List[Union[FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter]], FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter]] = None, min_should: Optional[MinShould] = None, must: Optional[Union[List[Union[FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter]], FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter]] = None, must_not: Optional[Union[List[Union[FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter]], FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter]] = None)[source]¶

Bases: BaseModel

min_should: Optional[MinShould]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

must: Optional[Union[List[Condition], Condition]]¶

must_not: Optional[Union[List[Condition], Condition]]¶

should: Optional[Union[List[Condition], Condition]]¶

class FilterSelector(*, filter: Filter, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)[source]¶

Bases: BaseModel

filter: Filter¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

shard_key: Optional[ShardKeySelector]¶

class FloatIndexParams(*, type: FloatIndexType, is_principal: Optional[bool] = None, on_disk: Optional[bool] = None)[source]¶

Bases: BaseModel

is_principal: Optional[bool]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

on_disk: Optional[bool]¶

type: FloatIndexType¶

class FloatIndexType(value)[source]¶

Bases: str, Enum

An enumeration.

FLOAT = 'float'¶

class Fusion(value)[source]¶

Bases: str, Enum

Fusion algorithm allows to combine results of multiple prefetches. Available fusion algorithms: * rrf - Reciprocal Rank Fusion * dbsf - Distribution-Based Score Fusion

DBSF = 'dbsf'¶

RRF = 'rrf'¶

class FusionQuery(*, fusion: Fusion)[source]¶

Bases: BaseModel

fusion: Fusion¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class GeoBoundingBox(*, top_left: GeoPoint, bottom_right: GeoPoint)[source]¶

Bases: BaseModel

Geo filter request Matches coordinates inside the rectangle, described by coordinates of lop-left and bottom-right edges

bottom_right: GeoPoint¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

top_left: GeoPoint¶

class GeoIndexParams(*, type: GeoIndexType, on_disk: Optional[bool] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

on_disk: Optional[bool]¶

type: GeoIndexType¶

class GeoIndexType(value)[source]¶

Bases: str, Enum

An enumeration.

GEO = 'geo'¶

class GeoLineString(*, points: List[GeoPoint])[source]¶

Bases: BaseModel

Ordered sequence of GeoPoints representing the line

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

points: List[GeoPoint]¶

class GeoPoint(*, lon: float, lat: float)[source]¶

Bases: BaseModel

Geo point payload schema

lat: float¶

lon: float¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class GeoPolygon(*, exterior: GeoLineString, interiors: Optional[List[GeoLineString]] = None)[source]¶

Bases: BaseModel

Geo filter request Matches coordinates inside the polygon, defined by exterior and interiors

exterior: GeoLineString¶

interiors: Optional[List[GeoLineString]]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class GeoRadius(*, center: GeoPoint, radius: float)[source]¶

Bases: BaseModel

Geo filter request Matches coordinates inside the circle of radius and center with coordinates center

center: GeoPoint¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

radius: float¶

class GpuDeviceTelemetry(*, name: str)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶

class GroupsResult(*, groups: List[PointGroup])[source]¶

Bases: BaseModel

groups: List[PointGroup]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class GrpcTelemetry(*, responses: Dict[str, OperationDurationStatistics])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

responses: Dict[str, OperationDurationStatistics]¶

class HardwareTelemetry(*, collection_data: Dict[str, HardwareUsage])[source]¶

Bases: BaseModel

collection_data: Dict[str, HardwareUsage]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class HardwareUsage(*, cpu: int, io_read: int, io_write: int)[source]¶

Bases: BaseModel

Usage of the hardware resources, spent to process the request

cpu: int¶

io_read: int¶

io_write: int¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class HasIdCondition(*, has_id: List[Union[int, str]])[source]¶

Bases: BaseModel

ID-based filtering condition

has_id: List[ExtendedPointId]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class HasVectorCondition(*, has_vector: str)[source]¶

Bases: BaseModel

Filter points which have specific vector assigned

has_vector: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class HnswConfig(*, m: int, ef_construct: int, full_scan_threshold: int, max_indexing_threads: Optional[int] = 0, on_disk: Optional[bool] = None, payload_m: Optional[int] = None)[source]¶

Bases: BaseModel

Config of HNSW index

ef_construct: int¶

full_scan_threshold: int¶

m: int¶

max_indexing_threads: Optional[int]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

on_disk: Optional[bool]¶

payload_m: Optional[int]¶

class HnswConfigDiff(*, m: Optional[int] = None, ef_construct: Optional[int] = None, full_scan_threshold: Optional[int] = None, max_indexing_threads: Optional[int] = None, on_disk: Optional[bool] = None, payload_m: Optional[int] = None)[source]¶

Bases: BaseModel

ef_construct: Optional[int]¶

full_scan_threshold: Optional[int]¶

m: Optional[int]¶

max_indexing_threads: Optional[int]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

on_disk: Optional[bool]¶

payload_m: Optional[int]¶

class Image(*, image: Any, model: str, options: Optional[Dict[str, Any]] = None)[source]¶

Bases: BaseModel

WARN: Work-in-progress, unimplemented Image object for embedding. Requires inference infrastructure, unimplemented.

image: Any¶

model: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

options: Optional[Dict[str, Any]]¶

class IndexesOneOf(*, type: Literal['plain'], options: Any)[source]¶

Bases: BaseModel

Do not use any index, scan whole vector collection during search. Guarantee 100% precision, but may be time consuming on large collections.

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

options: Any¶

type: Literal['plain']¶

class IndexesOneOf1(*, type: Literal['hnsw'], options: HnswConfig)[source]¶

Bases: 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.

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

options: HnswConfig¶

type: Literal['hnsw']¶

class InferenceObject(*, object: Any, model: str, options: Optional[Dict[str, Any]] = None)[source]¶

Bases: BaseModel

WARN: Work-in-progress, unimplemented Custom object for embedding. Requires inference infrastructure, unimplemented.

model: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

object: Any¶

options: Optional[Dict[str, Any]]¶

class InitFrom(*, collection: str)[source]¶

Bases: BaseModel

Operation for creating new collection and (optionally) specify index params

collection: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class InlineResponse200(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[bool] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[bool]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse2001(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[TelemetryData] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[TelemetryData]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20010(*, time: Optional[float] = None, status: Optional[str] = None, result: Optional[bool] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[bool]¶

status: Optional[str]¶

time: Optional[float]¶

class InlineResponse20011(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[SnapshotDescription]] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[List[SnapshotDescription]]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20012(*, time: Optional[float] = None, status: Optional[str] = None, result: Optional[SnapshotDescription] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[SnapshotDescription]¶

status: Optional[str]¶

time: Optional[float]¶

class InlineResponse20013(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[Record] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[Record]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20014(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[Record]] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[List[Record]]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20015(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[UpdateResult]] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[List[UpdateResult]]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20016(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[ScrollResult] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[ScrollResult]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20017(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[ScoredPoint]] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[List[ScoredPoint]]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20018(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[List[ScoredPoint]]] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[List[List[ScoredPoint]]]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20019(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[GroupsResult] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[GroupsResult]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse2002(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[LocksOption] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[LocksOption]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20020(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CountResult] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[CountResult]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20021(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[FacetResponse] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[FacetResponse]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20022(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[QueryResponse] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[QueryResponse]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20023(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[List[QueryResponse]] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[List[QueryResponse]]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20024(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[SearchMatrixPairsResponse] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[SearchMatrixPairsResponse]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse20025(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[SearchMatrixOffsetsResponse] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[SearchMatrixOffsetsResponse]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse2003(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[Union[ClusterStatusOneOf, ClusterStatusOneOf1]] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[ClusterStatus]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse2004(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CollectionsResponse] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[CollectionsResponse]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse2005(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CollectionInfo] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[CollectionInfo]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse2006(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[UpdateResult] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[UpdateResult]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse2007(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CollectionExistence] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[CollectionExistence]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse2008(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CollectionClusterInfo] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[CollectionClusterInfo]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse2009(*, usage: Optional[HardwareUsage] = None, time: Optional[float] = None, status: Optional[str] = None, result: Optional[CollectionsAliasesResponse] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

result: Optional[CollectionsAliasesResponse]¶

status: Optional[str]¶

time: Optional[float]¶

usage: Optional[HardwareUsage]¶

class InlineResponse202(*, time: Optional[float] = None, status: Optional[str] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status: Optional[str]¶

time: Optional[float]¶

class IntegerIndexParams(*, type: IntegerIndexType, lookup: Optional[bool] = None, range: Optional[bool] = None, is_principal: Optional[bool] = None, on_disk: Optional[bool] = None)[source]¶

Bases: BaseModel

is_principal: Optional[bool]¶

lookup: Optional[bool]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

on_disk: Optional[bool]¶

range: Optional[bool]¶

type: IntegerIndexType¶

class IntegerIndexType(value)[source]¶

Bases: str, Enum

An enumeration.

INTEGER = 'integer'¶

class IsEmptyCondition(*, is_empty: PayloadField)[source]¶

Bases: BaseModel

Select points with empty payload for a specified field

is_empty: PayloadField¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class IsNullCondition(*, is_null: PayloadField)[source]¶

Bases: BaseModel

Select points with null payload for a specified field

is_null: PayloadField¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class KeywordIndexParams(*, type: KeywordIndexType, is_tenant: Optional[bool] = None, on_disk: Optional[bool] = None)[source]¶

Bases: BaseModel

is_tenant: Optional[bool]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

on_disk: Optional[bool]¶

type: KeywordIndexType¶

class KeywordIndexType(value)[source]¶

Bases: str, Enum

An enumeration.

KEYWORD = 'keyword'¶

class LocalShardInfo(*, shard_id: int, shard_key: Optional[Union[int, str]] = None, points_count: int, state: ReplicaState)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

points_count: int¶

shard_id: int¶

shard_key: Optional[ShardKey]¶

state: ReplicaState¶

class LocalShardTelemetry(*, variant_name: Optional[str] = None, status: Optional[ShardStatus] = None, total_optimized_points: int, segments: List[SegmentTelemetry], optimizations: OptimizerTelemetry, async_scorer: Optional[bool] = None)[source]¶

Bases: BaseModel

async_scorer: Optional[bool]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

optimizations: OptimizerTelemetry¶

segments: List[SegmentTelemetry]¶

status: Optional[ShardStatus]¶

total_optimized_points: int¶

variant_name: Optional[str]¶

class LocksOption(*, error_message: Optional[str] = None, write: bool)[source]¶

Bases: BaseModel

error_message: Optional[str]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

write: bool¶

class LookupLocation(*, collection: str, vector: Optional[str] = None, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)[source]¶

Bases: BaseModel

Defines a location to use for looking up the vector. Specifies collection and vector field name.

collection: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

shard_key: Optional[ShardKeySelector]¶

vector: Optional[str]¶

class MatchAny(*, any: Union[List[str], List[int]])[source]¶

Bases: BaseModel

Exact match on any of the given values

any: AnyVariants¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class MatchExcept(*, except_: Union[List[str], List[int]])[source]¶

Bases: BaseModel

Should have at least one value not matching the any given values

except_: AnyVariants¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class MatchText(*, text: str)[source]¶

Bases: BaseModel

Full-text match of the strings.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

text: str¶

class MatchValue(*, value: Union[bool, int, str])[source]¶

Bases: BaseModel

Exact match of the given value

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

value: ValueVariants¶

class MaxOptimizationThreadsSetting(value)[source]¶

Bases: str, Enum

An enumeration.

AUTO = 'auto'¶

class MemoryTelemetry(*, active_bytes: int, allocated_bytes: int, metadata_bytes: int, resident_bytes: int, retained_bytes: int)[source]¶

Bases: BaseModel

active_bytes: int¶

allocated_bytes: int¶

metadata_bytes: int¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

resident_bytes: int¶

retained_bytes: int¶

class MessageSendErrors(*, count: int, latest_error: Optional[str] = None, latest_error_timestamp: Optional[Union[datetime, date]] = None)[source]¶

Bases: BaseModel

Message send failures for a particular peer

count: int¶

latest_error: Optional[str]¶

latest_error_timestamp: Optional[Union[datetime, date]]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class MinShould(*, conditions: List[Union[FieldCondition, IsEmptyCondition, IsNullCondition, HasIdCondition, HasVectorCondition, NestedCondition, Filter]], min_count: int)[source]¶

Bases: BaseModel

conditions: List[Condition]¶

min_count: int¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class Modifier(value)[source]¶

Bases: 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

IDF = 'idf'¶

NONE = 'none'¶

class MoveShard(*, shard_id: int, to_peer_id: int, from_peer_id: int, method: Optional[Union[ShardTransferMethodOneOf, ShardTransferMethodOneOf1, ShardTransferMethodOneOf2, ShardTransferMethodOneOf3]] = None)[source]¶

Bases: BaseModel

from_peer_id: int¶

method: Optional[ShardTransferMethod]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

shard_id: int¶

to_peer_id: int¶

class MoveShardOperation(*, move_shard: MoveShard)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

move_shard: MoveShard¶

class MultiVectorComparator(value)[source]¶

Bases: str, Enum

An enumeration.

MAX_SIM = 'max_sim'¶

class MultiVectorConfig(*, comparator: MultiVectorComparator)[source]¶

Bases: BaseModel

comparator: MultiVectorComparator¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class NamedSparseVector(*, name: str, vector: SparseVector)[source]¶

Bases: BaseModel

Sparse vector data with name

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶

vector: SparseVector¶

class NamedVector(*, name: str, vector: List[float])[source]¶

Bases: BaseModel

Dense vector data with name

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str¶

vector: List[float]¶

class NearestQuery(*, nearest: Union[List[float], SparseVector, List[List[float]], int, str, Document, Image, InferenceObject])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nearest: VectorInput¶

class Nested(*, key: str, filter: Filter)[source]¶

Bases: BaseModel

Select points with payload for a specified nested field

filter: Filter¶

key: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class NestedCondition(*, nested: Nested)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

nested: Nested¶

class OperationDurationStatistics(*, count: int, fail_count: Optional[int] = None, avg_duration_micros: Optional[float] = None, min_duration_micros: Optional[float] = None, max_duration_micros: Optional[float] = None, total_duration_micros: int, last_responded: Optional[Union[datetime, date]] = None)[source]¶

Bases: BaseModel

avg_duration_micros: Optional[float]¶

count: int¶

fail_count: Optional[int]¶

last_responded: Optional[Union[datetime, date]]¶

max_duration_micros: Optional[float]¶

min_duration_micros: Optional[float]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

total_duration_micros: int¶

class OptimizerTelemetry(*, status: Union[OptimizersStatusOneOf, OptimizersStatusOneOf1], optimizations: OperationDurationStatistics, log: List[TrackerTelemetry])[source]¶

Bases: BaseModel

log: List[TrackerTelemetry]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

optimizations: OperationDurationStatistics¶

status: OptimizersStatus¶

class OptimizersConfig(*, deleted_threshold: float, vacuum_min_vector_number: int, default_segment_number: int, max_segment_size: Optional[int] = None, memmap_threshold: Optional[int] = None, indexing_threshold: Optional[int] = None, flush_interval_sec: int, max_optimization_threads: Optional[int] = None)[source]¶

Bases: BaseModel

default_segment_number: int¶

deleted_threshold: float¶

flush_interval_sec: int¶

indexing_threshold: Optional[int]¶

max_optimization_threads: Optional[int]¶

max_segment_size: Optional[int]¶

memmap_threshold: Optional[int]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

vacuum_min_vector_number: int¶

class OptimizersConfigDiff(*, deleted_threshold: Optional[float] = None, vacuum_min_vector_number: Optional[int] = None, default_segment_number: Optional[int] = None, max_segment_size: Optional[int] = None, memmap_threshold: Optional[int] = None, indexing_threshold: Optional[int] = None, flush_interval_sec: Optional[int] = None, max_optimization_threads: Optional[Union[int, MaxOptimizationThreadsSetting]] = None)[source]¶

Bases: BaseModel

default_segment_number: Optional[int]¶

deleted_threshold: Optional[float]¶

flush_interval_sec: Optional[int]¶

indexing_threshold: Optional[int]¶

max_optimization_threads: Optional[MaxOptimizationThreads]¶

max_segment_size: Optional[int]¶

memmap_threshold: Optional[int]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

vacuum_min_vector_number: Optional[int]¶

class OptimizersStatusOneOf(value)[source]¶

Bases: str, Enum

Optimizers are reporting as expected

OK = 'ok'¶

class OptimizersStatusOneOf1(*, error: str)[source]¶

Bases: BaseModel

Something wrong happened with optimizers

error: str¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class OrderBy(*, key: str, direction: Optional[Direction] = None, start_from: Optional[Union[int, float, datetime, date]] = None)[source]¶

Bases: BaseModel

direction: Optional[Direction]¶

key: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

start_from: Optional[StartFrom]¶

class OrderByQuery(*, order_by: Union[str, OrderBy])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

order_by: OrderByInterface¶

class OverwritePayloadOperation(*, overwrite_payload: SetPayload)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

overwrite_payload: SetPayload¶

class P2pConfigTelemetry(*, connection_pool_size: int)[source]¶

Bases: BaseModel

connection_pool_size: int¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class PayloadField(*, key: str)[source]¶

Bases: BaseModel

Payload field

key: str¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class PayloadIndexInfo(*, data_type: PayloadSchemaType, params: Optional[Union[KeywordIndexParams, IntegerIndexParams, FloatIndexParams, GeoIndexParams, TextIndexParams, BoolIndexParams, DatetimeIndexParams, UuidIndexParams]] = None, points: int)[source]¶

Bases: BaseModel

Display payload field type & index information

data_type: PayloadSchemaType¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

params: Optional[PayloadSchemaParams]¶

points: int¶

class PayloadIndexTelemetry(*, field_name: Optional[str] = None, points_values_count: int, points_count: int, histogram_bucket_size: Optional[int] = None)[source]¶

Bases: BaseModel

field_name: Optional[str]¶

histogram_bucket_size: Optional[int]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

points_count: int¶

points_values_count: int¶

class PayloadSchemaType(value)[source]¶

Bases: str, Enum

All possible names of payload types

BOOL = 'bool'¶

DATETIME = 'datetime'¶

FLOAT = 'float'¶

GEO = 'geo'¶

INTEGER = 'integer'¶

KEYWORD = 'keyword'¶

TEXT = 'text'¶

UUID = 'uuid'¶

class PayloadSelectorExclude(*, exclude: List[str])[source]¶

Bases: BaseModel

exclude: List[str]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class PayloadSelectorInclude(*, include: List[str])[source]¶

Bases: BaseModel

include: List[str]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class PayloadStorageTypeOneOf(*, type: Literal['in_memory'])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['in_memory']¶

class PayloadStorageTypeOneOf1(*, type: Literal['on_disk'])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['on_disk']¶

class PayloadStorageTypeOneOf2(*, type: Literal['mmap'])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Literal['mmap']¶

class PeerInfo(*, uri: str)[source]¶

Bases: BaseModel

Information of a peer in the cluster

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

uri: str¶

class PointGroup(*, hits: List[ScoredPoint], id: Union[int, str], lookup: Optional[Record] = None)[source]¶

Bases: BaseModel

hits: List[ScoredPoint]¶

id: GroupId¶

lookup: Optional[Record]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class PointIdsList(*, points: List[Union[int, str]], shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

points: List[ExtendedPointId]¶

shard_key: Optional[ShardKeySelector]¶

class PointRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, ids: List[Union[int, str]], with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, with_vector: Optional[Union[bool, List[str]]] = None)[source]¶

Bases: BaseModel

ids: List[ExtendedPointId]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

shard_key: Optional[ShardKeySelector]¶

with_payload: Optional[WithPayloadInterface]¶

with_vector: Optional[WithVector]¶

class PointStruct(*, id: Union[int, str], vector: Union[List[float], List[List[float]], Dict[str, Union[List[float], SparseVector, List[List[float]], Document, Image, InferenceObject]], Document, Image, InferenceObject], payload: Optional[Dict[str, Any]] = None)[source]¶

Bases: BaseModel

id: ExtendedPointId¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

payload: Optional[Payload]¶

vector: VectorStruct¶

class PointVectors(*, id: Union[int, str], vector: Union[List[float], List[List[float]], Dict[str, Union[List[float], SparseVector, List[List[float]], Document, Image, InferenceObject]], Document, Image, InferenceObject])[source]¶

Bases: BaseModel

id: ExtendedPointId¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

vector: VectorStruct¶

class PointsBatch(*, batch: Batch, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)[source]¶

Bases: BaseModel

batch: Batch¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

shard_key: Optional[ShardKeySelector]¶

class PointsList(*, points: List[PointStruct], shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

points: List[PointStruct]¶

shard_key: Optional[ShardKeySelector]¶

class Prefetch(*, prefetch: Optional[Union[List[Prefetch], Prefetch]] = None, query: Optional[Union[List[float], SparseVector, List[List[float]], int, str, Document, Image, InferenceObject, NearestQuery, RecommendQuery, DiscoverQuery, ContextQuery, OrderByQuery, FusionQuery, SampleQuery]] = None, using: Optional[str] = None, filter: Optional[Filter] = None, params: Optional[SearchParams] = None, score_threshold: Optional[float] = None, limit: Optional[int] = None, lookup_from: Optional[LookupLocation] = None)[source]¶

Bases: BaseModel

filter: Optional[Filter]¶

limit: Optional[int]¶

lookup_from: Optional[LookupLocation]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

params: Optional[SearchParams]¶

prefetch: Optional[Union[List[Prefetch], Prefetch]]¶

query: Optional[QueryInterface]¶

score_threshold: Optional[float]¶

using: Optional[str]¶

class ProductQuantization(*, product: ProductQuantizationConfig)[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

product: ProductQuantizationConfig¶

class ProductQuantizationConfig(*, compression: CompressionRatio, always_ram: Optional[bool] = None)[source]¶

Bases: BaseModel

always_ram: Optional[bool]¶

compression: CompressionRatio¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class QuantizationSearchParams(*, ignore: Optional[bool] = False, rescore: Optional[bool] = None, oversampling: Optional[float] = None)[source]¶

Bases: BaseModel

Additional parameters of the search

ignore: Optional[bool]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

oversampling: Optional[float]¶

rescore: Optional[bool]¶

class QueryGroupsRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, prefetch: Optional[Union[List[Prefetch], Prefetch]] = None, query: Optional[Union[List[float], SparseVector, List[List[float]], int, str, Document, Image, InferenceObject, NearestQuery, RecommendQuery, DiscoverQuery, ContextQuery, OrderByQuery, FusionQuery, SampleQuery]] = None, using: Optional[str] = None, filter: Optional[Filter] = None, params: Optional[SearchParams] = None, score_threshold: Optional[float] = None, with_vector: Optional[Union[bool, List[str]]] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, lookup_from: Optional[LookupLocation] = None, group_by: str, group_size: Optional[int] = None, limit: Optional[int] = None, with_lookup: Optional[Union[str, WithLookup]] = None)[source]¶

Bases: BaseModel

filter: Optional[Filter]¶

group_by: str¶

group_size: Optional[int]¶

limit: Optional[int]¶

lookup_from: Optional[LookupLocation]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

params: Optional[SearchParams]¶

prefetch: Optional[Union[List[Prefetch], Prefetch]]¶

query: Optional[QueryInterface]¶

score_threshold: Optional[float]¶

shard_key: Optional[ShardKeySelector]¶

using: Optional[str]¶

with_lookup: Optional[WithLookupInterface]¶

with_payload: Optional[WithPayloadInterface]¶

with_vector: Optional[WithVector]¶

class QueryRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, prefetch: Optional[Union[List[Prefetch], Prefetch]] = None, query: Optional[Union[List[float], SparseVector, List[List[float]], int, str, Document, Image, InferenceObject, NearestQuery, RecommendQuery, DiscoverQuery, ContextQuery, OrderByQuery, FusionQuery, SampleQuery]] = None, using: Optional[str] = None, filter: Optional[Filter] = None, params: Optional[SearchParams] = None, score_threshold: Optional[float] = None, limit: Optional[int] = None, offset: Optional[int] = None, with_vector: Optional[Union[bool, List[str]]] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, lookup_from: Optional[LookupLocation] = None)[source]¶

Bases: BaseModel

filter: Optional[Filter]¶

limit: Optional[int]¶

lookup_from: Optional[LookupLocation]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

offset: Optional[int]¶

params: Optional[SearchParams]¶

prefetch: Optional[Union[List[Prefetch], Prefetch]]¶

query: Optional[QueryInterface]¶

score_threshold: Optional[float]¶

shard_key: Optional[ShardKeySelector]¶

using: Optional[str]¶

with_payload: Optional[WithPayloadInterface]¶

with_vector: Optional[WithVector]¶

class QueryRequestBatch(*, searches: List[QueryRequest])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

searches: List[QueryRequest]¶

class QueryResponse(*, points: List[ScoredPoint])[source]¶

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

points: List[ScoredPoint]¶

class RaftInfo(*, term: int, commit: int, pending_operations: int, leader: Optional[int] = None, role: Optional[StateRole] = None, is_voter: bool)[source]¶

Bases: BaseModel

Summary information about the current raft state

commit: int¶

is_voter: bool¶

leader: Optional[int]¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pending_operations: int¶

role: Optional[StateRole]¶

term: int¶

class Range(*, lt: Optional[float] = None, gt: Optional[float] = None, gte: Optional[float] = None, lte: Optional[float] = None)[source]¶

Bases: BaseModel

Range filter request

gt: Optional[float]¶

gte: Optional[float]¶

lt: Optional[float]¶

lte: Optional[float]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ReadConsistencyType(value)[source]¶

Bases: 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

ALL = 'all'¶

MAJORITY = 'majority'¶

QUORUM = 'quorum'¶

class RecommendGroupsRequest(*, shard_key: Optional[Union[int, str, List[Union[int, str]]]] = None, positive: Optional[List[Union[int, str, List[float], SparseVector]]] = [], negative: Optional[List[Union[int, str, List[float], SparseVector]]] = [], strategy: Optional[RecommendStrategy] = None, filter: Optional[Filter] = None, params: Optional[SearchParams] = None, with_payload: Optional[Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude]] = None, with_vector: Optional[Union[bool, List[str]]] = None, score_threshold: Optional[float] = None, using: Optional[str] = None, lookup_from: Optional[LookupLocation] = None, group_by: str, group_size: int, limit: int, with_lookup: Optional[Union[str, WithLookup]] = None)[source]¶

Bases: BaseModel

filter: Optional[Filter]¶

group_by: str¶

group_size: int¶

limit: int¶

lookup_from: Optional[LookupLocation]¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

negative: Optional[List[RecommendExample]]¶

params