class Qdrant::Api::Collections::Points

Defined in:

qdrant-api/api/collections/points.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(conn : Connection) #

[View source]

Instance Method Detail

def batch(collection_name : String, update_operations : Qdrant::Api::UpdateOperations | Nil = nil, *, wait : Bool | Nil = nil, ordering : Qdrant::Api::WriteOrdering | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::BatchUpdate200Response) #

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


[View source]
def bulk_update(collection_name : String, point_insert_operations : Qdrant::Api::PointInsertOperations | Nil = nil, *, wait : Bool | Nil = nil, ordering : Qdrant::Api::WriteOrdering | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateFieldIndex200Response) #

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


[View source]
def count(collection_name : String, count_request : Qdrant::Api::CountRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CountPoints200Response) #

Count points Count points which matches given filtering condition


[View source]
def create(collection_name : String, point_request : Qdrant::Api::PointRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::GetPoints200Response) #

Get points Retrieve multiple points by specified IDs


[View source]
def delete(collection_name : String, points_selector : Qdrant::Api::PointsSelector | Nil = nil, *, wait : Bool | Nil = nil, ordering : Qdrant::Api::WriteOrdering | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateFieldIndex200Response) #

Delete points Delete points


[View source]
def discover(collection_name : String, discover_request : Qdrant::Api::DiscoverRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::SearchPoints200Response) #

Discover points Use context and a target to find the most similar points to the target, constrained by the context. When using only the context (without a target), a special search - called context search - is performed where pairs of points are used to generate a loss that guides the search towards the zone where most positive examples overlap. This means that the score minimizes the scenario of finding a point closer to a negative than to a positive part of a pair. Since the score of a context relates to loss, the maximum score a point can get is 0.0, and it becomes normal that many points can have a score of 0.0. When using target (with or without context), the score behaves a little different: The integer part of the score represents the rank with respect to the context, while the decimal part of the score relates to the distance to the target. The context part of the score for each pair is calculated +1 if the point is closer to a positive than to a negative part of a pair, and -1 otherwise.

DEPRECATED This operation is marked deprecated in the OpenAPI spec.


[View source]
def discover_batch(collection_name : String, discover_request_batch : Qdrant::Api::DiscoverRequestBatch | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::SearchBatchPoints200Response) #

Discover batch points Look for points based on target and/or positive and negative example pairs, in batch.

DEPRECATED This operation is marked deprecated in the OpenAPI spec.


[View source]
def get(collection_name : String, id : Qdrant::Api::ExtendedPointId, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil) : Response(Qdrant::Api::GetPoint200Response) #

Get point Retrieve full information of single point by id


[View source]
def payload(collection_name : String, set_payload : Qdrant::Api::SetPayload | Nil = nil, *, wait : Bool | Nil = nil, ordering : Qdrant::Api::WriteOrdering | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateFieldIndex200Response) #

Overwrite payload Replace full payload of points with new one


[View source]
def payload_clear(collection_name : String, points_selector : Qdrant::Api::PointsSelector | Nil = nil, *, wait : Bool | Nil = nil, ordering : Qdrant::Api::WriteOrdering | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateFieldIndex200Response) #

Clear payload Remove all payload for specified points


[View source]
def payload_delete(collection_name : String, delete_payload : Qdrant::Api::DeletePayload | Nil = nil, *, wait : Bool | Nil = nil, ordering : Qdrant::Api::WriteOrdering | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateFieldIndex200Response) #

Delete payload Delete specified key payload for points


[View source]
def payload_post(collection_name : String, set_payload : Qdrant::Api::SetPayload | Nil = nil, *, wait : Bool | Nil = nil, ordering : Qdrant::Api::WriteOrdering | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateFieldIndex200Response) #

Set payload Set payload values for points


[View source]
def query(collection_name : String, query_request : Qdrant::Api::QueryRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::QueryPoints200Response) #

Query points Universally query points. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries.


[View source]
def query_batch(collection_name : String, query_request_batch : Qdrant::Api::QueryRequestBatch | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::QueryBatchPoints200Response) #

Query points in batch Universally query points in batch. This endpoint covers all capabilities of search, recommend, discover, filters. But also enables hybrid and multi-stage queries.


[View source]
def query_groups(collection_name : String, query_groups_request : Qdrant::Api::QueryGroupsRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::SearchPointGroups200Response) #

Query points, grouped by a given payload field Universally query points, grouped by a given payload field


[View source]
def recommend(collection_name : String, recommend_request : Qdrant::Api::RecommendRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::SearchPoints200Response) #

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

DEPRECATED This operation is marked deprecated in the OpenAPI spec.


[View source]
def recommend_batch(collection_name : String, recommend_request_batch : Qdrant::Api::RecommendRequestBatch | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::SearchBatchPoints200Response) #

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

DEPRECATED This operation is marked deprecated in the OpenAPI spec.


[View source]
def recommend_groups(collection_name : String, recommend_groups_request : Qdrant::Api::RecommendGroupsRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::SearchPointGroups200Response) #

Recommend point groups 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.

DEPRECATED This operation is marked deprecated in the OpenAPI spec.


[View source]
def scroll(collection_name : String, scroll_request : Qdrant::Api::ScrollRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::ScrollPoints200Response) #

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


[View source]
def search(collection_name : String, search_request : Qdrant::Api::SearchRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::SearchPoints200Response) #

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

DEPRECATED This operation is marked deprecated in the OpenAPI spec.


[View source]
def search_batch(collection_name : String, search_request_batch : Qdrant::Api::SearchRequestBatch | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::SearchBatchPoints200Response) #

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

DEPRECATED This operation is marked deprecated in the OpenAPI spec.


[View source]
def search_groups(collection_name : String, search_groups_request : Qdrant::Api::SearchGroupsRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::SearchPointGroups200Response) #

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

DEPRECATED This operation is marked deprecated in the OpenAPI spec.


[View source]
def search_matrix_offsets(collection_name : String, search_matrix_request : Qdrant::Api::SearchMatrixRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::SearchMatrixOffsets200Response) #

Search points matrix distance offsets Compute distance matrix for sampled points with an offset based output format


[View source]
def search_matrix_pairs(collection_name : String, search_matrix_request : Qdrant::Api::SearchMatrixRequest | Nil = nil, *, consistency : Qdrant::Api::ReadConsistency | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::SearchMatrixPairs200Response) #

Search points matrix distance pairs Compute distance matrix for sampled points with a pair based output format


[View source]
def vectors(collection_name : String, update_vectors : Qdrant::Api::UpdateVectors | Nil = nil, *, wait : Bool | Nil = nil, ordering : Qdrant::Api::WriteOrdering | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateFieldIndex200Response) #

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


[View source]
def vectors_delete(collection_name : String, delete_vectors : Qdrant::Api::DeleteVectors | Nil = nil, *, wait : Bool | Nil = nil, ordering : Qdrant::Api::WriteOrdering | Nil = nil, timeout : Int32 | Nil = nil) : Response(Qdrant::Api::CreateFieldIndex200Response) #

Delete vectors Delete named vectors from the given points.


[View source]