Package io.metaloom.qdrant.client.http.method

Interface PointMethods

All Known Subinterfaces:

QDrantHttpClient

All Known Implementing Classes:

AbstractQDrantClient, QDrantHttpClientImpl

public interface PointMethods

Method Summary

Modifier and Type	Method	Description
QDrantClientRequest<UpdateResultResponse>	clearPayload(String collectionName, PointsClearPayloadRequest request, boolean wait)	Remove all payload for specified points.
QDrantClientRequest<PointCountResponse>	countPoints(String collectionName, PointCountRequest request)	Count points which matches given filtering condition.
QDrantClientRequest<UpdateResultResponse>	deletePayload(String collectionName, PointDeletePayloadRequest request, boolean wait)	Delete specified key payload for points.
QDrantClientRequest<UpdateResultResponse>	deletePoints(String collectionName, PointsDeleteRequest request, boolean wait)	Delete points.
QDrantClientRequest<DeleteVectorsResponse>	deleteVectors(String collectionName, PointDeleteVectorsRequest request, boolean wait, WriteOrdering ordering)	Delete named vectors from the given points.
default QDrantClientRequest<PointGetResponse>	getPoint(String collectionName, long id)	Retrieve full information of single point by id.
default QDrantClientRequest<PointGetResponse>	getPoint(String collectionName, PointId pointId)	Retrieve full information of single point by id.
QDrantClientRequest<PointGetResponse>	getPoint(String collectionName, String pointId)	Retrieve full information of single point by id.
default QDrantClientRequest<PointGetResponse>	getPoint(String collectionName, UUID uuid)	Retrieve full information of single point by id.
QDrantClientRequest<PointsGetResponse>	getPoints(String collectionName, PointsGetRequest request)	Retrieve multiple points by specified IDs.
QDrantClientRequest<UpdateResultResponse>	overwritePayload(String collectionName, PointOverwritePayloadRequest request, boolean wait)	Replace full payload of points with new one.
QDrantClientRequest<PointsRecommendBatchResponse>	recommendBatchPoints(String collectionName, PointsRecommendBatchRequest request)	Look for the points which are closer to stored positive examples and at the same time further to negative examples.
QDrantClientRequest<PointsRecommendGroupResponse>	recommendGroupPoints(String collectionName, PointsRecommendGroupRequest request)	Look for the points which are closer to stored positive examples and at the same time further to negative examples, grouped by a given payload field.
QDrantClientRequest<PointsRecommendResponse>	recommendPoints(String collectionName, PointsRecommendRequest request)	Look for the points which are closer to stored positive examples and at the same time further to negative examples.
QDrantClientRequest<PointsScrollResponse>	scrollPoints(String collectionName, PointsScrollRequest request)	Scroll request - paginate over all points which matches given filtering condition.
QDrantClientRequest<PointsSearchBatchResponse>	searchBatchPoints(String collectionName, PointsSearchBatchRequest request)	Retrieve by batch the closest points based on vector similarity and given filtering conditions.
QDrantClientRequest<PointsSearchGroupResponse>	searchGroupPoints(String collectionName, PointsSearchGroupRequest request)	Retrieve closest points based on vector similarity and given filtering conditions, grouped by a given payload field.
QDrantClientRequest<PointsSearchResponse>	searchPoints(String collectionName, PointsSearchRequest request)	Retrieve closest points based on vector similarity and given filtering conditions.
QDrantClientRequest<UpdateResultResponse>	setPointPayload(String collectionName, PointSetPayloadRequest request, boolean wait)	Set payload values for points.
QDrantClientRequest<UpdateVectorsResponse>	updateVectors(String collectionName, PointUpdateVectorsRequest request, boolean wait, WriteOrdering ordering)	Update specified named vectors on points, keep unspecified vectors intact.
QDrantClientRequest<UpdateResultResponse>	upsertPoints(String collectionName, PointsUpsertRequest request, boolean wait)	Perform insert + updates on points.

Method Details

getPoint

QDrantClientRequest<PointGetResponse> getPoint(String collectionName,
 String pointId)

Retrieve full information of single point by id.

Parameters:

collectionName -

pointId -

Returns:

getPoint

default QDrantClientRequest<PointGetResponse> getPoint(String collectionName,
 PointId pointId)

Retrieve full information of single point by id.

Parameters:

collectionName -

pointId -

Returns:

getPoint

default QDrantClientRequest<PointGetResponse> getPoint(String collectionName,
 long id)

Retrieve full information of single point by id.

Parameters:

collectionName -

id -

Returns:

getPoint

default QDrantClientRequest<PointGetResponse> getPoint(String collectionName,
 UUID uuid)

Retrieve full information of single point by id.

Parameters:

collectionName -

uuid -

Returns:

getPoints

QDrantClientRequest<PointsGetResponse> getPoints(String collectionName,
 PointsGetRequest request)

Retrieve multiple points by specified IDs.

Parameters:

collectionName -

request -

Returns:

upsertPoints

QDrantClientRequest<UpdateResultResponse> upsertPoints(String collectionName,
 PointsUpsertRequest request,
 boolean wait)

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

Parameters:

collectionName -

request -

wait -

Returns:

deletePoints

QDrantClientRequest<UpdateResultResponse> deletePoints(String collectionName,
 PointsDeleteRequest request,
 boolean wait)

Delete points.

Parameters:

collectionName -

request -

wait -

Returns:

updateVectors

QDrantClientRequest<UpdateVectorsResponse> updateVectors(String collectionName,
 PointUpdateVectorsRequest request,
 boolean wait,
 WriteOrdering ordering)

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

Parameters:

collectionName -

request -

wait -

ordering -

Returns:

deleteVectors

QDrantClientRequest<DeleteVectorsResponse> deleteVectors(String collectionName,
 PointDeleteVectorsRequest request,
 boolean wait,
 WriteOrdering ordering)

Delete named vectors from the given points.

Parameters:

collectionName -

request -

wait -

ordering -

Returns:

setPointPayload

QDrantClientRequest<UpdateResultResponse> setPointPayload(String collectionName,
 PointSetPayloadRequest request,
 boolean wait)

Set payload values for points. This will merge the points payload and add new properties or update existing ones.

Parameters:

collectionName -

request -

wait -

Returns:

overwritePayload

QDrantClientRequest<UpdateResultResponse> overwritePayload(String collectionName,
 PointOverwritePayloadRequest request,
 boolean wait)

Replace full payload of points with new one. This will overwrite the whole given payload with the new one. Existing properties will be remove.

Parameters:

collectionName -

request -

wait -

Returns:

deletePayload

QDrantClientRequest<UpdateResultResponse> deletePayload(String collectionName,
 PointDeletePayloadRequest request,
 boolean wait)

Delete specified key payload for points. This will only delete the specified properties from the found payloads.

Parameters:

collectionName -

request -

wait -

Returns:

clearPayload

QDrantClientRequest<UpdateResultResponse> clearPayload(String collectionName,
 PointsClearPayloadRequest request,
 boolean wait)

Remove all payload for specified points. Removes the whole payload from all selected points.

Parameters:

collectionName -

request -

wait -

Returns:

scrollPoints

QDrantClientRequest<PointsScrollResponse> scrollPoints(String collectionName,
 PointsScrollRequest request)

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

Parameters:

collectionName -

request -

Returns:

searchPoints

QDrantClientRequest<PointsSearchResponse> searchPoints(String collectionName,
 PointsSearchRequest request)

Retrieve closest points based on vector similarity and given filtering conditions.

Parameters:

collectionName -

request -

Returns:

searchBatchPoints

QDrantClientRequest<PointsSearchBatchResponse> searchBatchPoints(String collectionName,
 PointsSearchBatchRequest request)

Retrieve by batch the closest points based on vector similarity and given filtering conditions.

Parameters:

collectionName -

request -

Returns:

searchGroupPoints

QDrantClientRequest<PointsSearchGroupResponse> searchGroupPoints(String collectionName,
 PointsSearchGroupRequest request)

Retrieve closest points based on vector similarity and given filtering conditions, grouped by a given payload field.

Parameters:

collectionName -

request -

Returns:

recommendPoints

QDrantClientRequest<PointsRecommendResponse> recommendPoints(String collectionName,
 PointsRecommendRequest request)

Look for the points which are closer to stored positive examples and at the same time further to negative examples.

Parameters:

collectionName -

request -

Returns:

recommendBatchPoints

QDrantClientRequest<PointsRecommendBatchResponse> recommendBatchPoints(String collectionName,
 PointsRecommendBatchRequest request)

Look for the points which are closer to stored positive examples and at the same time further to negative examples.

Parameters:

collectionName -

request -

Returns:

recommendGroupPoints

QDrantClientRequest<PointsRecommendGroupResponse> recommendGroupPoints(String collectionName,
 PointsRecommendGroupRequest request)

Look for the points which are closer to stored positive examples and at the same time further to negative examples, grouped by a given payload field.

Parameters:

collectionName -

request -

Returns:

countPoints

QDrantClientRequest<PointCountResponse> countPoints(String collectionName,
 PointCountRequest request)

Count points which matches given filtering condition.

Parameters:

collectionName -

request -

Returns: