qdrant_client.http.api.points_api module

class AsyncPointsApi(api_client: Union[ApiClient, AsyncApiClient])

Bases: _PointsApi

async batch_update(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, update_operations: Optional[UpdateOperations] = None) → InlineResponse20015

Apply a series of update operations for points, vectors and payloads

async clear_payload(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, points_selector: Optional[Union[PointIdsList, FilterSelector]] = None) → InlineResponse2006

Remove all payload for specified points

async count_points(collection_name: str, timeout: Optional[int] = None, count_request: Optional[CountRequest] = None) → InlineResponse20020

Count points which matches given filtering condition

async delete_payload(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, delete_payload: Optional[DeletePayload] = None) → InlineResponse2006

Delete specified key payload for points

async delete_points(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, points_selector: Optional[Union[PointIdsList, FilterSelector]] = None) → InlineResponse2006

Delete points

async delete_vectors(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, delete_vectors: Optional[DeleteVectors] = None) → InlineResponse2006

Delete named vectors from the given points.

async facet(collection_name: str, timeout: Optional[int] = None, consistency: Optional[Union[int, ReadConsistencyType]] = None, facet_request: Optional[FacetRequest] = None) → InlineResponse20021

Count points that satisfy the given filter for each unique value of a payload key.

async get_point(collection_name: str, id: Union[int, str], consistency: Optional[Union[int, ReadConsistencyType]] = None) → InlineResponse20013

Retrieve full information of single point by id

async get_points(collection_name: str, consistency: Optional[Union[int, ReadConsistencyType]] = None, timeout: Optional[int] = None, point_request: Optional[PointRequest] = None) → InlineResponse20014

Retrieve multiple points by specified IDs

async overwrite_payload(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, set_payload: Optional[SetPayload] = None) → InlineResponse2006

Replace full payload of points with new one

async scroll_points(collection_name: str, consistency: Optional[Union[int, ReadConsistencyType]] = None, timeout: Optional[int] = None, scroll_request: Optional[ScrollRequest] = None) → InlineResponse20016

Scroll request - paginate over all points which matches given filtering condition

async set_payload(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, set_payload: Optional[SetPayload] = None) → InlineResponse2006

Set payload values for points

async update_vectors(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, update_vectors: Optional[UpdateVectors] = None) → InlineResponse2006

Update specified named vectors on points, keep unspecified vectors intact.

async upsert_points(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, point_insert_operations: Optional[Union[PointsBatch, PointsList]] = None) → InlineResponse2006

Perform insert + updates on points. If point with given ID already exists - it will be overwritten.

class SyncPointsApi(api_client: Union[ApiClient, AsyncApiClient])

Bases: _PointsApi

batch_update(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, update_operations: Optional[UpdateOperations] = None) → InlineResponse20015

Apply a series of update operations for points, vectors and payloads

clear_payload(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, points_selector: Optional[Union[PointIdsList, FilterSelector]] = None) → InlineResponse2006

Remove all payload for specified points

count_points(collection_name: str, timeout: Optional[int] = None, count_request: Optional[CountRequest] = None) → InlineResponse20020

Count points which matches given filtering condition

delete_payload(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, delete_payload: Optional[DeletePayload] = None) → InlineResponse2006

Delete specified key payload for points

delete_points(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, points_selector: Optional[Union[PointIdsList, FilterSelector]] = None) → InlineResponse2006

Delete points

delete_vectors(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, delete_vectors: Optional[DeleteVectors] = None) → InlineResponse2006

Delete named vectors from the given points.

facet(collection_name: str, timeout: Optional[int] = None, consistency: Optional[Union[int, ReadConsistencyType]] = None, facet_request: Optional[FacetRequest] = None) → InlineResponse20021

Count points that satisfy the given filter for each unique value of a payload key.

get_point(collection_name: str, id: Union[int, str], consistency: Optional[Union[int, ReadConsistencyType]] = None) → InlineResponse20013

Retrieve full information of single point by id

get_points(collection_name: str, consistency: Optional[Union[int, ReadConsistencyType]] = None, timeout: Optional[int] = None, point_request: Optional[PointRequest] = None) → InlineResponse20014

Retrieve multiple points by specified IDs

overwrite_payload(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, set_payload: Optional[SetPayload] = None) → InlineResponse2006

Replace full payload of points with new one

scroll_points(collection_name: str, consistency: Optional[Union[int, ReadConsistencyType]] = None, timeout: Optional[int] = None, scroll_request: Optional[ScrollRequest] = None) → InlineResponse20016

Scroll request - paginate over all points which matches given filtering condition

set_payload(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, set_payload: Optional[SetPayload] = None) → InlineResponse2006

Set payload values for points

update_vectors(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, update_vectors: Optional[UpdateVectors] = None) → InlineResponse2006

Update specified named vectors on points, keep unspecified vectors intact.

upsert_points(collection_name: str, wait: Optional[bool] = None, ordering: Optional[WriteOrdering] = None, point_insert_operations: Optional[Union[PointsBatch, PointsList]] = None) → InlineResponse2006

Perform insert + updates on points. If point with given ID already exists - it will be overwritten.

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)

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