mirror of
https://github.com/qdrant/qdrant-client.git
synced 2026-07-26 04:31:03 -05:00
* new: update models, remove init_from and locks * deprecate: remove init from tests * deprecate: remove lock tests * new: convert ascii_folding * fix: fix type stub * new: convert acorn * new: convert shard key with fallback * new: update grpcio and grpcio tools in generator (#1106) * new: update grpcio and grpcio tools in generator * fix: bind grpcio and tools versions to 1.62.0 in generator * Remove deprecated methods (#1103) * deprecate: remove old api methods * deprecate: remove type stub for removed methods * deprecate: remove old api methods from test_qdrant_client * deprecate: replace search with query points in test_in_memory * deprecate: replace search methods in fastembed mixin with query points * deprecate: replace old api methods in test async qdrant client * deprecate: replace search with query points in test delete points * deprecate: replace discover and context with query points in test_discovery * deprecate: replace recommend_groups with query_points_groups in test_group_recommend * deprecate: replace search_groups in test_group_search * deprecate: replace recommend with query points in test_recommendation * deprecate: replace search with query points in test search * deprecate: replace context and discover with query points in test sparse discovery * deprecate: replace search with query points in test sparse idf search * deprecate: replace recommend with query points in test sparse recommend * deprecate: replace search with query points in test sparse search * deprecate: replace missing search request with query request in qdrant_fastembed * deprecate: replace search with query points in test multivector search queries * deprecate: replace upload records with upload points in test_updates * deprecate: remove redundant structs (#1104) * deprecate: remove redundant structs * fix: do not use removed conversions in local mode * fix: remove redundant conversions, simplify types.QueryRequest * deprecate: replace old style grpc vector conversion to a new one (#1105) * deprecate: replace old style grpc vector conversion to a new one * fix: ignore union attr in conversion * review fixes --------- Co-authored-by: generall <andrey@vasnetsov.com> --------- Co-authored-by: generall <andrey@vasnetsov.com> --------- Co-authored-by: generall <andrey@vasnetsov.com> * new: deprecate add, query, query_batch in fastembed mixin (#1102) * new: deprecate add, query, query_batch in fastembed mixin * 1.16 -> 1.17 --------- Co-authored-by: generall <andrey@vasnetsov.com> --------- Co-authored-by: generall <andrey@vasnetsov.com>
366 lines
10 KiB
Python
366 lines
10 KiB
Python
# flake8: noqa E501
|
|
from typing import TYPE_CHECKING, Any, Dict, Set, TypeVar, Union
|
|
|
|
from pydantic import BaseModel
|
|
from pydantic.main import BaseModel
|
|
from pydantic.version import VERSION as PYDANTIC_VERSION
|
|
from qdrant_client.http.models import *
|
|
from qdrant_client.http.models import models as m
|
|
|
|
PYDANTIC_V2 = PYDANTIC_VERSION.startswith("2.")
|
|
Model = TypeVar("Model", bound="BaseModel")
|
|
|
|
SetIntStr = Set[Union[int, str]]
|
|
DictIntStrAny = Dict[Union[int, str], Any]
|
|
file = None
|
|
|
|
|
|
def to_json(model: BaseModel, *args: Any, **kwargs: Any) -> str:
|
|
if PYDANTIC_V2:
|
|
return model.model_dump_json(*args, **kwargs)
|
|
else:
|
|
return model.json(*args, **kwargs)
|
|
|
|
|
|
def jsonable_encoder(
|
|
obj: Any,
|
|
include: Union[SetIntStr, DictIntStrAny] = None,
|
|
exclude=None,
|
|
by_alias: bool = True,
|
|
skip_defaults: bool = None,
|
|
exclude_unset: bool = True,
|
|
exclude_none: bool = True,
|
|
):
|
|
if hasattr(obj, "json") or hasattr(obj, "model_dump_json"):
|
|
return to_json(
|
|
obj,
|
|
include=include,
|
|
exclude=exclude,
|
|
by_alias=by_alias,
|
|
exclude_unset=bool(exclude_unset or skip_defaults),
|
|
exclude_none=exclude_none,
|
|
)
|
|
|
|
return obj
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
from qdrant_client.http.api_client import ApiClient
|
|
|
|
|
|
class _DistributedApi:
|
|
def __init__(self, api_client: "Union[ApiClient, AsyncApiClient]"):
|
|
self.api_client = api_client
|
|
|
|
def _build_for_cluster_status(
|
|
self,
|
|
):
|
|
"""
|
|
Get information about the current state and composition of the cluster
|
|
"""
|
|
headers = {}
|
|
return self.api_client.request(
|
|
type_=m.InlineResponse2002,
|
|
method="GET",
|
|
url="/cluster",
|
|
headers=headers if headers else None,
|
|
)
|
|
|
|
def _build_for_collection_cluster_info(
|
|
self,
|
|
collection_name: str,
|
|
):
|
|
"""
|
|
Get cluster information for a collection
|
|
"""
|
|
path_params = {
|
|
"collection_name": str(collection_name),
|
|
}
|
|
|
|
headers = {}
|
|
return self.api_client.request(
|
|
type_=m.InlineResponse2007,
|
|
method="GET",
|
|
url="/collections/{collection_name}/cluster",
|
|
headers=headers if headers else None,
|
|
path_params=path_params,
|
|
)
|
|
|
|
def _build_for_create_shard_key(
|
|
self,
|
|
collection_name: str,
|
|
timeout: int = None,
|
|
create_sharding_key: m.CreateShardingKey = None,
|
|
):
|
|
path_params = {
|
|
"collection_name": str(collection_name),
|
|
}
|
|
|
|
query_params = {}
|
|
if timeout is not None:
|
|
query_params["timeout"] = str(timeout)
|
|
|
|
headers = {}
|
|
body = jsonable_encoder(create_sharding_key)
|
|
if "Content-Type" not in headers:
|
|
headers["Content-Type"] = "application/json"
|
|
return self.api_client.request(
|
|
type_=m.InlineResponse200,
|
|
method="PUT",
|
|
url="/collections/{collection_name}/shards",
|
|
headers=headers if headers else None,
|
|
path_params=path_params,
|
|
params=query_params,
|
|
content=body,
|
|
)
|
|
|
|
def _build_for_delete_shard_key(
|
|
self,
|
|
collection_name: str,
|
|
timeout: int = None,
|
|
drop_sharding_key: m.DropShardingKey = None,
|
|
):
|
|
path_params = {
|
|
"collection_name": str(collection_name),
|
|
}
|
|
|
|
query_params = {}
|
|
if timeout is not None:
|
|
query_params["timeout"] = str(timeout)
|
|
|
|
headers = {}
|
|
body = jsonable_encoder(drop_sharding_key)
|
|
if "Content-Type" not in headers:
|
|
headers["Content-Type"] = "application/json"
|
|
return self.api_client.request(
|
|
type_=m.InlineResponse200,
|
|
method="POST",
|
|
url="/collections/{collection_name}/shards/delete",
|
|
headers=headers if headers else None,
|
|
path_params=path_params,
|
|
params=query_params,
|
|
content=body,
|
|
)
|
|
|
|
def _build_for_recover_current_peer(
|
|
self,
|
|
):
|
|
headers = {}
|
|
return self.api_client.request(
|
|
type_=m.InlineResponse200,
|
|
method="POST",
|
|
url="/cluster/recover",
|
|
headers=headers if headers else None,
|
|
)
|
|
|
|
def _build_for_remove_peer(
|
|
self,
|
|
peer_id: int,
|
|
timeout: int = None,
|
|
force: bool = None,
|
|
):
|
|
"""
|
|
Tries to remove peer from the cluster. Will return an error if peer has shards on it.
|
|
"""
|
|
path_params = {
|
|
"peer_id": str(peer_id),
|
|
}
|
|
|
|
query_params = {}
|
|
if timeout is not None:
|
|
query_params["timeout"] = str(timeout)
|
|
if force is not None:
|
|
query_params["force"] = str(force).lower()
|
|
|
|
headers = {}
|
|
return self.api_client.request(
|
|
type_=m.InlineResponse200,
|
|
method="DELETE",
|
|
url="/cluster/peer/{peer_id}",
|
|
headers=headers if headers else None,
|
|
path_params=path_params,
|
|
params=query_params,
|
|
)
|
|
|
|
def _build_for_update_collection_cluster(
|
|
self,
|
|
collection_name: str,
|
|
timeout: int = None,
|
|
cluster_operations: m.ClusterOperations = None,
|
|
):
|
|
path_params = {
|
|
"collection_name": str(collection_name),
|
|
}
|
|
|
|
query_params = {}
|
|
if timeout is not None:
|
|
query_params["timeout"] = str(timeout)
|
|
|
|
headers = {}
|
|
body = jsonable_encoder(cluster_operations)
|
|
if "Content-Type" not in headers:
|
|
headers["Content-Type"] = "application/json"
|
|
return self.api_client.request(
|
|
type_=m.InlineResponse200,
|
|
method="POST",
|
|
url="/collections/{collection_name}/cluster",
|
|
headers=headers if headers else None,
|
|
path_params=path_params,
|
|
params=query_params,
|
|
content=body,
|
|
)
|
|
|
|
|
|
class AsyncDistributedApi(_DistributedApi):
|
|
async def cluster_status(
|
|
self,
|
|
) -> m.InlineResponse2002:
|
|
"""
|
|
Get information about the current state and composition of the cluster
|
|
"""
|
|
return await self._build_for_cluster_status()
|
|
|
|
async def collection_cluster_info(
|
|
self,
|
|
collection_name: str,
|
|
) -> m.InlineResponse2007:
|
|
"""
|
|
Get cluster information for a collection
|
|
"""
|
|
return await self._build_for_collection_cluster_info(
|
|
collection_name=collection_name,
|
|
)
|
|
|
|
async def create_shard_key(
|
|
self,
|
|
collection_name: str,
|
|
timeout: int = None,
|
|
create_sharding_key: m.CreateShardingKey = None,
|
|
) -> m.InlineResponse200:
|
|
return await self._build_for_create_shard_key(
|
|
collection_name=collection_name,
|
|
timeout=timeout,
|
|
create_sharding_key=create_sharding_key,
|
|
)
|
|
|
|
async def delete_shard_key(
|
|
self,
|
|
collection_name: str,
|
|
timeout: int = None,
|
|
drop_sharding_key: m.DropShardingKey = None,
|
|
) -> m.InlineResponse200:
|
|
return await self._build_for_delete_shard_key(
|
|
collection_name=collection_name,
|
|
timeout=timeout,
|
|
drop_sharding_key=drop_sharding_key,
|
|
)
|
|
|
|
async def recover_current_peer(
|
|
self,
|
|
) -> m.InlineResponse200:
|
|
return await self._build_for_recover_current_peer()
|
|
|
|
async def remove_peer(
|
|
self,
|
|
peer_id: int,
|
|
timeout: int = None,
|
|
force: bool = None,
|
|
) -> m.InlineResponse200:
|
|
"""
|
|
Tries to remove peer from the cluster. Will return an error if peer has shards on it.
|
|
"""
|
|
return await self._build_for_remove_peer(
|
|
peer_id=peer_id,
|
|
timeout=timeout,
|
|
force=force,
|
|
)
|
|
|
|
async def update_collection_cluster(
|
|
self,
|
|
collection_name: str,
|
|
timeout: int = None,
|
|
cluster_operations: m.ClusterOperations = None,
|
|
) -> m.InlineResponse200:
|
|
return await self._build_for_update_collection_cluster(
|
|
collection_name=collection_name,
|
|
timeout=timeout,
|
|
cluster_operations=cluster_operations,
|
|
)
|
|
|
|
|
|
class SyncDistributedApi(_DistributedApi):
|
|
def cluster_status(
|
|
self,
|
|
) -> m.InlineResponse2002:
|
|
"""
|
|
Get information about the current state and composition of the cluster
|
|
"""
|
|
return self._build_for_cluster_status()
|
|
|
|
def collection_cluster_info(
|
|
self,
|
|
collection_name: str,
|
|
) -> m.InlineResponse2007:
|
|
"""
|
|
Get cluster information for a collection
|
|
"""
|
|
return self._build_for_collection_cluster_info(
|
|
collection_name=collection_name,
|
|
)
|
|
|
|
def create_shard_key(
|
|
self,
|
|
collection_name: str,
|
|
timeout: int = None,
|
|
create_sharding_key: m.CreateShardingKey = None,
|
|
) -> m.InlineResponse200:
|
|
return self._build_for_create_shard_key(
|
|
collection_name=collection_name,
|
|
timeout=timeout,
|
|
create_sharding_key=create_sharding_key,
|
|
)
|
|
|
|
def delete_shard_key(
|
|
self,
|
|
collection_name: str,
|
|
timeout: int = None,
|
|
drop_sharding_key: m.DropShardingKey = None,
|
|
) -> m.InlineResponse200:
|
|
return self._build_for_delete_shard_key(
|
|
collection_name=collection_name,
|
|
timeout=timeout,
|
|
drop_sharding_key=drop_sharding_key,
|
|
)
|
|
|
|
def recover_current_peer(
|
|
self,
|
|
) -> m.InlineResponse200:
|
|
return self._build_for_recover_current_peer()
|
|
|
|
def remove_peer(
|
|
self,
|
|
peer_id: int,
|
|
timeout: int = None,
|
|
force: bool = None,
|
|
) -> m.InlineResponse200:
|
|
"""
|
|
Tries to remove peer from the cluster. Will return an error if peer has shards on it.
|
|
"""
|
|
return self._build_for_remove_peer(
|
|
peer_id=peer_id,
|
|
timeout=timeout,
|
|
force=force,
|
|
)
|
|
|
|
def update_collection_cluster(
|
|
self,
|
|
collection_name: str,
|
|
timeout: int = None,
|
|
cluster_operations: m.ClusterOperations = None,
|
|
) -> m.InlineResponse200:
|
|
return self._build_for_update_collection_cluster(
|
|
collection_name=collection_name,
|
|
timeout=timeout,
|
|
cluster_operations=cluster_operations,
|
|
)
|