qdrant_client.qdrant_remote module

class QdrantRemote(url: Optional[str] = None, port: Optional[int] = 6333, grpc_port: int = 6334, prefer_grpc: bool = False, https: Optional[bool] = None, api_key: Optional[str] = None, prefix: Optional[str] = None, timeout: Optional[int] = None, host: Optional[str] = None, grpc_options: Optional[Dict[str, Any]] = None, auth_token_provider: Optional[Union[Callable[[], str], Callable[[], Awaitable[str]]]] = None, **kwargs: Any)

Bases: QdrantBase

batch_update_points(collection_name: str, update_operations: Sequence[Union[UpsertOperation, DeleteOperation, SetPayloadOperation, OverwritePayloadOperation, DeletePayloadOperation, ClearPayloadOperation, UpdateVectorsOperation, DeleteVectorsOperation]], wait: bool = True, ordering: Optional[WriteOrdering] = None, **kwargs: Any) → List[UpdateResult]

clear_payload(collection_name: str, points_selector: Union[List[Union[int, str, PointId]], Filter, Filter, PointIdsList, FilterSelector, PointsSelector], wait: bool = True, ordering: Optional[WriteOrdering] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → UpdateResult

close(grpc_grace: Optional[float] = None, **kwargs: Any) → None

collection_exists(collection_name: str, **kwargs: Any) → bool

count(collection_name: str, count_filter: Optional[Union[Filter, Filter]] = None, exact: bool = True, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → CountResult

create_collection(collection_name: str, vectors_config: Union[VectorParams, Mapping[str, VectorParams]], shard_number: Optional[int] = None, replication_factor: Optional[int] = None, write_consistency_factor: Optional[int] = None, on_disk_payload: Optional[bool] = None, hnsw_config: Optional[Union[HnswConfigDiff, HnswConfigDiff]] = None, optimizers_config: Optional[Union[OptimizersConfigDiff, OptimizersConfigDiff]] = None, wal_config: Optional[Union[WalConfigDiff, WalConfigDiff]] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization, QuantizationConfig]] = None, init_from: Optional[Union[InitFrom, str]] = None, timeout: Optional[int] = None, sparse_vectors_config: Optional[Mapping[str, SparseVectorParams]] = None, sharding_method: Optional[ShardingMethod] = None, **kwargs: Any) → bool

create_full_snapshot(wait: bool = True, **kwargs: Any) → SnapshotDescription

create_payload_index(collection_name: str, field_name: str, field_schema: Optional[Union[PayloadSchemaType, KeywordIndexParams, IntegerIndexParams, FloatIndexParams, GeoIndexParams, TextIndexParams, BoolIndexParams, DatetimeIndexParams, UuidIndexParams, int, PayloadIndexParams]] = None, field_type: Optional[Union[PayloadSchemaType, KeywordIndexParams, IntegerIndexParams, FloatIndexParams, GeoIndexParams, TextIndexParams, BoolIndexParams, DatetimeIndexParams, UuidIndexParams, int, PayloadIndexParams]] = None, wait: bool = True, ordering: Optional[WriteOrdering] = None, **kwargs: Any) → UpdateResult

create_shard_key(collection_name: str, shard_key: Union[int[int], str[str]], shards_number: Optional[int] = None, replication_factor: Optional[int] = None, placement: Optional[List[int]] = None, timeout: Optional[int] = None, **kwargs: Any) → bool

create_shard_snapshot(collection_name: str, shard_id: int, wait: bool = True, **kwargs: Any) → Optional[SnapshotDescription]

create_snapshot(collection_name: str, wait: bool = True, **kwargs: Any) → Optional[SnapshotDescription]

delete(collection_name: str, points_selector: Union[List[Union[int, str, PointId]], Filter, Filter, PointIdsList, FilterSelector, PointsSelector], wait: bool = True, ordering: Optional[WriteOrdering] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → UpdateResult

delete_collection(collection_name: str, timeout: Optional[int] = None, **kwargs: Any) → bool

delete_full_snapshot(snapshot_name: str, wait: bool = True, **kwargs: Any) → Optional[bool]

delete_payload(collection_name: str, keys: Sequence[str], points: Union[List[Union[int, str, PointId]], Filter, Filter, PointIdsList, FilterSelector, PointsSelector], wait: bool = True, ordering: Optional[WriteOrdering] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → UpdateResult

delete_payload_index(collection_name: str, field_name: str, wait: bool = True, ordering: Optional[WriteOrdering] = None, **kwargs: Any) → UpdateResult

delete_shard_key(collection_name: str, shard_key: Union[int[int], str[str]], timeout: Optional[int] = None, **kwargs: Any) → bool

delete_shard_snapshot(collection_name: str, shard_id: int, snapshot_name: str, wait: bool = True, **kwargs: Any) → Optional[bool]

delete_snapshot(collection_name: str, snapshot_name: str, wait: bool = True, **kwargs: Any) → Optional[bool]

delete_vectors(collection_name: str, vectors: Sequence[str], points: Union[List[Union[int, str, PointId]], Filter, Filter, PointIdsList, FilterSelector, PointsSelector], wait: bool = True, ordering: Optional[WriteOrdering] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → UpdateResult

discover(collection_name: str, target: Optional[Union[int[int], str[str], List[float[float]], SparseVector, TargetVector]] = None, context: Optional[Sequence[Union[ContextExamplePair, ContextExamplePair]]] = None, query_filter: Optional[Union[Filter, Filter]] = None, search_params: Optional[Union[SearchParams, SearchParams]] = None, limit: int = 10, offset: int = 0, with_payload: Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude, WithPayloadSelector] = True, with_vectors: Union[bool, List[str]] = False, using: Optional[str] = None, lookup_from: Optional[Union[LookupLocation, LookupLocation]] = None, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → List[ScoredPoint]

discover_batch(collection_name: str, requests: Sequence[Union[DiscoverRequest, DiscoverPoints]], consistency: Optional[Union[int[int], ReadConsistencyType]] = None, timeout: Optional[int] = None, **kwargs: Any) → List[List[ScoredPoint]]

facet(collection_name: str, key: str, facet_filter: Optional[Union[Filter, Filter]] = None, limit: int = 10, exact: bool = False, timeout: Optional[int] = None, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → FacetResponse

get_aliases(**kwargs: Any) → CollectionsAliasesResponse

get_collection(collection_name: str, **kwargs: Any) → CollectionInfo

get_collection_aliases(collection_name: str, **kwargs: Any) → CollectionsAliasesResponse

get_collections(**kwargs: Any) → CollectionsResponse

get_locks(**kwargs: Any) → LocksOption

info() → VersionInfo

list_full_snapshots(**kwargs: Any) → List[SnapshotDescription]

list_shard_snapshots(collection_name: str, shard_id: int, **kwargs: Any) → List[SnapshotDescription]

list_snapshots(collection_name: str, **kwargs: Any) → List[SnapshotDescription]

lock_storage(reason: str, **kwargs: Any) → LocksOption

overwrite_payload(collection_name: str, payload: Dict[str, Any], points: Union[List[Union[int, str, PointId]], Filter, Filter, PointIdsList, FilterSelector, PointsSelector], wait: bool = True, ordering: Optional[WriteOrdering] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → UpdateResult

query_batch_points(collection_name: str, requests: Sequence[Union[QueryRequest, QueryPoints]], consistency: Optional[Union[int[int], ReadConsistencyType]] = None, timeout: Optional[int] = None, **kwargs: Any) → List[QueryResponse]

query_points(collection_name: str, query: Optional[Union[NearestQuery, RecommendQuery, DiscoverQuery, ContextQuery, OrderByQuery, FusionQuery, SampleQuery]] = None, using: Optional[str] = None, prefetch: Optional[Union[Prefetch, List[Prefetch]]] = None, query_filter: Optional[Union[Filter, Filter]] = None, search_params: Optional[Union[SearchParams, SearchParams]] = None, limit: int = 10, offset: Optional[int] = None, with_payload: Union[bool, Sequence[str], PayloadSelectorInclude, PayloadSelectorExclude, WithPayloadSelector] = True, with_vectors: Union[bool, Sequence[str]] = False, score_threshold: Optional[float] = None, lookup_from: Optional[Union[LookupLocation, LookupLocation]] = None, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → QueryResponse

query_points_groups(collection_name: str, group_by: str, query: Optional[Union[int, str, PointId, List[float], List[List[float]], SparseVector, NearestQuery, RecommendQuery, DiscoverQuery, ContextQuery, OrderByQuery, FusionQuery, SampleQuery, ndarray[Any, dtype[Union[bool_, int8, int16, int32, int64, uint8, uint16, uint32, uint64, float16, float32, float64, float128]]], Document]] = None, using: Optional[str] = None, prefetch: Optional[Union[Prefetch, List[Prefetch]]] = None, query_filter: Optional[Union[Filter, Filter]] = None, search_params: Optional[Union[SearchParams, SearchParams]] = None, limit: int = 10, group_size: int = 3, with_payload: Union[bool, Sequence[str], PayloadSelectorInclude, PayloadSelectorExclude, WithPayloadSelector] = True, with_vectors: Union[bool, Sequence[str]] = False, score_threshold: Optional[float] = None, with_lookup: Optional[Union[str[str], WithLookup]] = None, lookup_from: Optional[Union[LookupLocation, LookupLocation]] = None, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → GroupsResult

recommend(collection_name: str, positive: Optional[Sequence[Union[int[int], str[str], List[float[float]], SparseVector]]] = None, negative: Optional[Sequence[Union[int[int], str[str], List[float[float]], SparseVector]]] = None, query_filter: Optional[Union[Filter, Filter]] = None, search_params: Optional[Union[SearchParams, SearchParams]] = None, limit: int = 10, offset: int = 0, with_payload: Union[bool, List[str], PayloadSelectorInclude, PayloadSelectorExclude, WithPayloadSelector] = True, with_vectors: Union[bool, List[str]] = False, score_threshold: Optional[float] = None, using: Optional[str] = None, lookup_from: Optional[Union[LookupLocation, LookupLocation]] = None, strategy: Optional[RecommendStrategy] = None, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → List[ScoredPoint]

recommend_batch(collection_name: str, requests: Sequence[Union[RecommendRequest, RecommendPoints]], consistency: Optional[Union[int[int], ReadConsistencyType]] = None, timeout: Optional[int] = None, **kwargs: Any) → List[List[ScoredPoint]]

recommend_groups(collection_name: str, group_by: str, positive: Optional[Sequence[Union[int, str, PointId, List[float]]]] = None, negative: Optional[Sequence[Union[int, str, PointId, List[float]]]] = None, query_filter: Optional[Filter] = None, search_params: Optional[SearchParams] = None, limit: int = 10, group_size: int = 1, score_threshold: Optional[float] = None, with_payload: Union[bool, Sequence[str], PayloadSelectorInclude, PayloadSelectorExclude] = True, with_vectors: Union[bool, Sequence[str]] = False, using: Optional[str] = None, lookup_from: Optional[LookupLocation] = None, with_lookup: Optional[Union[str[str], WithLookup]] = None, strategy: Optional[RecommendStrategy] = None, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → GroupsResult

recover_shard_snapshot(collection_name: str, shard_id: int, location: str, api_key: Optional[str] = None, checksum: Optional[str] = None, priority: Optional[SnapshotPriority] = None, wait: bool = True, **kwargs: Any) → Optional[bool]

recover_snapshot(collection_name: str, location: str, api_key: Optional[str] = None, checksum: Optional[str] = None, priority: Optional[SnapshotPriority] = None, wait: bool = True, **kwargs: Any) → Optional[bool]

recreate_collection(collection_name: str, vectors_config: Union[VectorParams, Mapping[str, VectorParams]], shard_number: Optional[int] = None, replication_factor: Optional[int] = None, write_consistency_factor: Optional[int] = None, on_disk_payload: Optional[bool] = None, hnsw_config: Optional[Union[HnswConfigDiff, HnswConfigDiff]] = None, optimizers_config: Optional[Union[OptimizersConfigDiff, OptimizersConfigDiff]] = None, wal_config: Optional[Union[WalConfigDiff, WalConfigDiff]] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization, QuantizationConfig]] = None, init_from: Optional[Union[InitFrom, str]] = None, timeout: Optional[int] = None, sparse_vectors_config: Optional[Mapping[str, SparseVectorParams]] = None, sharding_method: Optional[ShardingMethod] = None, **kwargs: Any) → bool

retrieve(collection_name: str, ids: Sequence[Union[int, str, PointId]], with_payload: Union[bool, Sequence[str], PayloadSelectorInclude, PayloadSelectorExclude, WithPayloadSelector] = True, with_vectors: Union[bool, Sequence[str]] = False, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → List[Record]

scroll(collection_name: str, scroll_filter: Optional[Union[Filter, Filter]] = None, limit: int = 10, order_by: Optional[Union[str[str], OrderBy, OrderBy]] = None, offset: Optional[Union[int, str, PointId]] = None, with_payload: Union[bool, Sequence[str], PayloadSelectorInclude, PayloadSelectorExclude, WithPayloadSelector] = True, with_vectors: Union[bool, Sequence[str]] = False, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → Tuple[List[Record], Optional[Union[int, str, PointId]]]

search(collection_name: str, query_vector: Union[Sequence[float], Tuple[str, List[float]], NamedVector, NamedSparseVector, ndarray[Any, dtype[Union[bool_, int8, int16, int32, int64, uint8, uint16, uint32, uint64, float16, float32, float64, float128]]]], query_filter: Optional[Union[Filter, Filter]] = None, search_params: Optional[Union[SearchParams, SearchParams]] = None, limit: int = 10, offset: Optional[int] = None, with_payload: Union[bool, Sequence[str], PayloadSelectorInclude, PayloadSelectorExclude, WithPayloadSelector] = True, with_vectors: Union[bool, Sequence[str]] = False, score_threshold: Optional[float] = None, append_payload: bool = True, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → List[ScoredPoint]

search_batch(collection_name: str, requests: Sequence[Union[SearchRequest, SearchPoints]], consistency: Optional[Union[int[int], ReadConsistencyType]] = None, timeout: Optional[int] = None, **kwargs: Any) → List[List[ScoredPoint]]

search_groups(collection_name: str, query_vector: Union[Sequence[float], Tuple[str, List[float]], NamedVector, NamedSparseVector, ndarray[Any, dtype[Union[bool_, int8, int16, int32, int64, uint8, uint16, uint32, uint64, float16, float32, float64, float128]]]], group_by: str, query_filter: Optional[Filter] = None, search_params: Optional[SearchParams] = None, limit: int = 10, group_size: int = 1, with_payload: Union[bool, Sequence[str], PayloadSelectorInclude, PayloadSelectorExclude] = True, with_vectors: Union[bool, Sequence[str]] = False, score_threshold: Optional[float] = None, with_lookup: Optional[Union[str[str], WithLookup]] = None, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → GroupsResult

search_matrix_offsets(collection_name: str, query_filter: Optional[Union[Filter, Filter]] = None, limit: int = 3, sample: int = 10, using: Optional[str] = None, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → SearchMatrixOffsetsResponse

search_matrix_pairs(collection_name: str, query_filter: Optional[Union[Filter, Filter]] = None, limit: int = 3, sample: int = 10, using: Optional[str] = None, consistency: Optional[Union[int[int], ReadConsistencyType]] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, timeout: Optional[int] = None, **kwargs: Any) → SearchMatrixPairsResponse

set_payload(collection_name: str, payload: Dict[str, Any], points: Union[List[Union[int, str, PointId]], Filter, Filter, PointIdsList, FilterSelector, PointsSelector], key: Optional[str] = None, wait: bool = True, ordering: Optional[WriteOrdering] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → UpdateResult

unlock_storage(**kwargs: Any) → LocksOption

update_collection(collection_name: str, optimizers_config: Optional[Union[OptimizersConfigDiff, OptimizersConfigDiff]] = None, collection_params: Optional[Union[CollectionParamsDiff, CollectionParamsDiff]] = None, vectors_config: Optional[Union[Dict[str, VectorParamsDiff], VectorsConfigDiff]] = None, hnsw_config: Optional[Union[HnswConfigDiff, HnswConfigDiff]] = None, quantization_config: Optional[Union[ScalarQuantization, ProductQuantization, BinaryQuantization, Disabled, QuantizationConfigDiff]] = None, timeout: Optional[int] = None, sparse_vectors_config: Optional[Mapping[str, SparseVectorParams]] = None, **kwargs: Any) → bool

update_collection_aliases(change_aliases_operations: Sequence[Union[CreateAliasOperation, RenameAliasOperation, DeleteAliasOperation, AliasOperations]], timeout: Optional[int] = None, **kwargs: Any) → bool

update_vectors(collection_name: str, points: Sequence[PointVectors], wait: bool = True, ordering: Optional[WriteOrdering] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → UpdateResult

upload_collection(collection_name: str, vectors: Union[Dict[str, ndarray[Any, dtype[Union[bool_, int8, int16, int32, int64, uint8, uint16, uint32, uint64, float16, float32, float64, float128]]]], ndarray[Any, dtype[Union[bool_, int8, int16, int32, int64, uint8, uint16, uint32, uint64, float16, float32, float64, float128]]], Iterable[Union[List[float[float]], List[List[float[float]]], Dict[str[str], Union[List[float[float]], SparseVector, List[List[float[float]]], Document]], Document]]], payload: Optional[Iterable[Dict[Any, Any]]] = None, ids: Optional[Iterable[Union[int, str, PointId]]] = None, batch_size: int = 64, parallel: int = 1, method: Optional[str] = None, max_retries: int = 3, wait: bool = False, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → None

upload_points(collection_name: str, points: Iterable[PointStruct], batch_size: int = 64, parallel: int = 1, method: Optional[str] = None, max_retries: int = 3, wait: bool = False, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → None

upload_records(collection_name: str, records: Iterable[Record], batch_size: int = 64, parallel: int = 1, method: Optional[str] = None, max_retries: int = 3, wait: bool = False, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → None

upsert(collection_name: str, points: Union[Batch, Sequence[Union[PointStruct, PointStruct]]], wait: bool = True, ordering: Optional[WriteOrdering] = None, shard_key_selector: Optional[Union[int[int], str[str], List[Union[int[int], str[str]]]]] = None, **kwargs: Any) → UpdateResult

property async_grpc_collections: qdrant_client.grpc.collections_service_pb2_grpc.CollectionsStub

gRPC client for collections methods

Returns

An instance of raw gRPC client, generated from Protobuf

property async_grpc_points: qdrant_client.grpc.points_service_pb2_grpc.PointsStub

gRPC client for points methods

Returns

An instance of raw gRPC client, generated from Protobuf

property async_grpc_root: qdrant_client.grpc.qdrant_pb2_grpc.QdrantStub

gRPC client for info methods

Returns

An instance of raw gRPC client, generated from Protobuf

property async_grpc_snapshots: qdrant_client.grpc.snapshots_service_pb2_grpc.SnapshotsStub

gRPC client for snapshots methods

Returns

An instance of raw gRPC client, generated from Protobuf

property closed: bool

property grpc_collections: qdrant_client.grpc.collections_service_pb2_grpc.CollectionsStub

gRPC client for collections methods

Returns

An instance of raw gRPC client, generated from Protobuf

property grpc_points: qdrant_client.grpc.points_service_pb2_grpc.PointsStub

gRPC client for points methods

Returns

An instance of raw gRPC client, generated from Protobuf

property grpc_root: qdrant_client.grpc.qdrant_pb2_grpc.QdrantStub

gRPC client for info methods

Returns

An instance of raw gRPC client, generated from Protobuf

property grpc_snapshots: qdrant_client.grpc.snapshots_service_pb2_grpc.SnapshotsStub

gRPC client for snapshots methods

Returns

An instance of raw gRPC client, generated from Protobuf

property http: SyncApis[ApiClient]

REST Client

Returns

An instance of raw REST API client, generated from OpenAPI schema

property rest: SyncApis[ApiClient]

REST Client

Returns

An instance of raw REST API client, generated from OpenAPI schema