qdrant_client.http.api.service_api module

class AsyncServiceApi(api_client: Union[ApiClient, AsyncApiClient])[source]

Bases: _ServiceApi

async get_locks() → InlineResponse2002[source]

Get lock options. If write is locked, all write operations and collection creation are forbidden

async healthz() → str[source]

An endpoint for health checking used in Kubernetes.

async livez() → str[source]

An endpoint for health checking used in Kubernetes.

async metrics(anonymize: Optional[bool] = None) → str[source]

Collect metrics data including app info, collections info, cluster info and statistics

async post_locks(locks_option: Optional[LocksOption] = None) → InlineResponse2002[source]

Set lock options. If write is locked, all write operations and collection creation are forbidden. Returns previous lock options

async readyz() → str[source]

An endpoint for health checking used in Kubernetes.

async root() → VersionInfo[source]

Returns information about the running Qdrant instance like version and commit id

async telemetry(anonymize: Optional[bool] = None, details_level: Optional[int] = None) → InlineResponse2001[source]

Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics

class SyncServiceApi(api_client: Union[ApiClient, AsyncApiClient])[source]

Bases: _ServiceApi

get_locks() → InlineResponse2002[source]

Get lock options. If write is locked, all write operations and collection creation are forbidden

healthz() → str[source]

An endpoint for health checking used in Kubernetes.

livez() → str[source]

An endpoint for health checking used in Kubernetes.

metrics(anonymize: Optional[bool] = None) → str[source]

Collect metrics data including app info, collections info, cluster info and statistics

post_locks(locks_option: Optional[LocksOption] = None) → InlineResponse2002[source]

Set lock options. If write is locked, all write operations and collection creation are forbidden. Returns previous lock options

readyz() → str[source]

An endpoint for health checking used in Kubernetes.

root() → VersionInfo[source]

Returns information about the running Qdrant instance like version and commit id

telemetry(anonymize: Optional[bool] = None, details_level: Optional[int] = None) → InlineResponse2001[source]

Collect telemetry data including app info, system info, collections info, cluster info, configs and statistics

jsonable_encoder(obj: Any, include: Optional[Union[Set[Union[int, str]], Dict[Union[int, str], Any]]] = None, exclude=None, by_alias: bool = True, skip_defaults: Optional[bool] = None, exclude_unset: bool = True, exclude_none: bool = True)[source]

to_json(model: BaseModel, *args: Any, **kwargs: Any) → str[source]