Package io.metaloom.qdrant.client.grpc.method

Interface PointMethods

All Superinterfaces:

ClientSettings, io.metaloom.qdrant.client.CommonSettings

All Known Subinterfaces:

QDrantGRPCClient

All Known Implementing Classes:

AbstractQDrantGRPCClient, QDrantGRPCClientImpl

public interface PointMethods
extends ClientSettings

Method Summary

Modifier and Type	Method	Description
default GrpcClientRequest<Points.PointsOperationResponse>	clearPayload(String collectionName, boolean wait, Points.Filter filter, Points.PointId... ids)	Remove all payload for specified points.
default GrpcClientRequest<Points.CountResponse>	countPoints(String collectionName, Points.Filter filter, boolean exact)	Count points which matches given filtering condition.
default GrpcClientRequest<Points.PointsOperationResponse>	deletePayload(String collectionName, boolean wait, Set<String> keys, Points.Filter filter, Points.PointId... ids)	Delete specified key payload for points.
default GrpcClientRequest<Points.PointsOperationResponse>	deletePoints(String collectionName, boolean wait, Points.PointId... ids)	Delete points.
default GrpcClientRequest<Points.GetResponse>	getPoint(String collectionName, boolean withPayload, boolean withVector, Points.PointId pointId)	Retrieve full information of single point by id.
default GrpcClientRequest<Points.GetResponse>	getPoint(String collectionName, Points.PointId pointId)	Retrieve full information of single point by id.
default GrpcClientRequest<Points.GetResponse>	getPoint(String collectionName, Points.WithPayloadSelector withPayloadSelector, Points.WithVectorsSelector withVectorsSelector, Points.PointId pointId)	Retrieve full information of single point by id.
default GrpcClientRequest<Points.GetResponse>	getPoints(String collectionName, Points.WithPayloadSelector withPayloadSelector, Points.WithVectorsSelector withVectorsSelector, Points.PointId... ids)	Retrieve multiple points by specified IDs
default GrpcClientRequest<Points.GetResponse>	getPoints(String collectionName, Points.WithPayloadSelector withPayloadSelector, Points.WithVectorsSelector withVectorsSelector, List<Points.PointId> ids)	Retrieve multiple points by specified IDs
default GrpcClientRequest<Points.PointsOperationResponse>	overwritePayload(String collectionName, boolean wait, Points.Filter filter, Map<String,JsonWithInt.Value> payload, Points.PointId... ids)	Replace full payload of points with new one.
default GrpcClientRequest<Points.ScrollResponse>	scrollPoint(String collectionName, Points.PointId offset, Integer limit, Points.Filter filter, Points.WithPayloadSelector withPayloadSelector, Points.WithVectorsSelector withVectorSelector)	Scroll request - paginate over all points which matches given filtering condition.
default GrpcClientRequest<Points.PointsOperationResponse>	setPointPayload(String collectionName, boolean wait, Points.Filter filter, Map<String,JsonWithInt.Value> payload, Points.PointId... ids)	Set payload values for points.
default GrpcClientRequest<Points.PointsOperationResponse>	upsertPoint(String collectionName, Points.PointStruct point, boolean wait)	Perform insert + updates on point.
default GrpcClientRequest<Points.PointsOperationResponse>	upsertPoints(String collectionName, List<? extends Points.PointStruct> points, boolean wait)	Perform insert + updates on points.

Methods inherited from interface io.metaloom.qdrant.client.ClientSettings

channel, request

Methods inherited from interface io.metaloom.qdrant.client.CommonSettings

getConnectTimeout, getHostname, getPort, getReadTimeout, getWriteTimeout

Method Details

getPoint

default GrpcClientRequest<Points.GetResponse> getPoint(String collectionName,
 Points.PointId pointId)

Retrieve full information of single point by id.

Parameters:

collectionName -

pointId -

Returns:

getPoint

default GrpcClientRequest<Points.GetResponse> getPoint(String collectionName,
 boolean withPayload,
 boolean withVector,
 Points.PointId pointId)

Retrieve full information of single point by id.

Parameters:

collectionName -

withPayload -

withVector -

pointId -

Returns:

getPoint

default GrpcClientRequest<Points.GetResponse> getPoint(String collectionName,
 Points.WithPayloadSelector withPayloadSelector,
 Points.WithVectorsSelector withVectorsSelector,
 Points.PointId pointId)

Retrieve full information of single point by id.

Parameters:

collectionName -

withPayloadSelector -

withVectorsSelector -

pointId -

Returns:

getPoints

default GrpcClientRequest<Points.GetResponse> getPoints(String collectionName,
 Points.WithPayloadSelector withPayloadSelector,
 Points.WithVectorsSelector withVectorsSelector,
 Points.PointId... ids)

Retrieve multiple points by specified IDs

Parameters:

collectionName -

withPayloadSelector -

withVectorsSelector -

ids -

Returns:

getPoints

default GrpcClientRequest<Points.GetResponse> getPoints(String collectionName,
 Points.WithPayloadSelector withPayloadSelector,
 Points.WithVectorsSelector withVectorsSelector,
 List<Points.PointId> ids)

Retrieve multiple points by specified IDs

Parameters:

collectionName -

withPayloadSelector -

withVectorsSelector -

ids -

Returns:

scrollPoint

default GrpcClientRequest<Points.ScrollResponse> scrollPoint(String collectionName,
 Points.PointId offset,
 Integer limit,
 Points.Filter filter,
 Points.WithPayloadSelector withPayloadSelector,
 Points.WithVectorsSelector withVectorSelector)

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

Parameters:

collectionName - Name of the collection to retrieve from

offset - Start ID to read points from.

limit - Page size. Default: 10

filter - Look only for points which satisfies this conditions. If not provided - all points.

withPayloadSelector - Select which payload to return with the response. Default: All

withVectorSelector - Options for specifying which vector to include

Returns:

countPoints

default GrpcClientRequest<Points.CountResponse> countPoints(String collectionName,
 Points.Filter filter,
 boolean exact)

Count points which matches given filtering condition.

Parameters:

collectionName - Name of the collection to count in

filter - Look only for points which satisfies this conditions

exact - If true, count exact number of points. If false, count approximate number of points faster. Approximate count might be unreliable during the indexing process.

Returns:

clearPayload

default GrpcClientRequest<Points.PointsOperationResponse> clearPayload(String collectionName,
 boolean wait,
 Points.Filter filter,
 Points.PointId... ids)

Remove all payload for specified points.

Parameters:

collectionName - Name of the collection to clear payload from

wait - If true, wait for changes to actually happen

filter - Filter to be used to select points

ids - List of point ids to clear payload from

Returns:

deletePayload

default GrpcClientRequest<Points.PointsOperationResponse> deletePayload(String collectionName,
 boolean wait,
 Set<String> keys,
 Points.Filter filter,
 Points.PointId... ids)

Delete specified key payload for points.

Parameters:

collectionName - Name of the collection to delete from

wait - If true, wait for changes to actually happen

keys - List of payload keys to remove from payload

filter - Deletes values from points that satisfy this filter condition

ids - Deletes values from each point in this list

Returns:

overwritePayload

default GrpcClientRequest<Points.PointsOperationResponse> overwritePayload(String collectionName,
 boolean wait,
 Points.Filter filter,
 Map<String,JsonWithInt.Value> payload,
 Points.PointId... ids)

Replace full payload of points with new one.

Parameters:

collectionName - Name of the collection to set from

wait - If true, wait for changes to actually happen

filter - Assigns payload to each point that satisfy this filter condition

payload - Payload to be assigned to matching points

ids - Assigns payload to each point in this list

Returns:

setPointPayload

default GrpcClientRequest<Points.PointsOperationResponse> setPointPayload(String collectionName,
 boolean wait,
 Points.Filter filter,
 Map<String,JsonWithInt.Value> payload,
 Points.PointId... ids)

Set payload values for points.

Parameters:

collectionName - Name of the collection to set from

wait - If true, wait for changes to actually happen

filter - Assigns payload to each point that satisfy this filter condition

payload - Payload to assign

ids - Assigns payload to each point in this list

Returns:

deletePoints

default GrpcClientRequest<Points.PointsOperationResponse> deletePoints(String collectionName,
 boolean wait,
 Points.PointId... ids)

Delete points.

Parameters:

collectionName - Name of the collection to delete from

wait - If true, wait for changes to actually happen

ids -

Returns:

upsertPoint

default GrpcClientRequest<Points.PointsOperationResponse> upsertPoint(String collectionName,
 Points.PointStruct point,
 boolean wait)

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

Parameters:

collectionName - Name of the collection to update from

point - Point to be inserted

wait - If true, wait for changes to actually happen

Returns:

upsertPoints

default GrpcClientRequest<Points.PointsOperationResponse> upsertPoints(String collectionName,
 List<? extends Points.PointStruct> points,
 boolean wait)

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

Parameters:

collectionName - Name of the collection to update from

points - Batch of points to be inserted

wait - If true, wait for changes to actually happen

Returns: