Qdrant.Api.Http.Points (Qdrant v0.1.18)

Copy Markdown View Source

Client-aware Qdrant points and search API.

Each operation accepts a Qdrant.Client first and a keyword list of request options last. No-client positional forms remain available for compatibility.

Summary

Functions

batch_update_points(collection_name, body)
batch_update_points(client, collection_name, body)
batch_update_points(client, collection_name, body, opts)

Applies a batch of point updates. Options: :wait, :ordering, :timeout.

batch_update_points(collection_name, body, wait, ordering, timeout)
clear_payload(collection_name, body)
clear_payload(client, collection_name, body)
clear_payload(client, collection_name, body, opts)

Clears payloads selected by a map such as %{points: [1, 2]} or %{filter: %{must: [...]}}. Options: :wait, :ordering, :timeout.

clear_payload(collection_name, body, wait, ordering, timeout)
count_points(collection_name, body)
count_points(client, collection_name, body)
count_points(client, collection_name, body, opts)

Counts points matching the request body. Options: :timeout.

delete_payload(collection_name, body)
delete_payload(client, collection_name, body)
delete_payload(client, collection_name, body, opts)

Deletes payload keys. Options: :wait, :ordering, :timeout.

delete_payload(collection_name, body, wait, ordering, timeout)
delete_points(collection_name, body)
delete_points(client, collection_name, body)
delete_points(client, collection_name, body, opts)

Deletes points selected by the request body. Options: :wait, :ordering, :timeout.

delete_points(collection_name, body, wait, ordering, timeout)
delete_vectors(collection_name, body)
delete_vectors(client, collection_name, body)
delete_vectors(client, collection_name, body, opts)

Deletes vectors. Options: :wait, :ordering, :timeout.

delete_vectors(collection_name, body, wait, ordering, timeout)
discover_points(collection_name, body)
discover_points(client, collection_name, body)
discover_points(client, collection_name, body, opts)

Discovers points from context pairs. Options: :consistency, :timeout.

discover_points_batch(collection_name, body)
discover_points_batch(client, collection_name, body)
discover_points_batch(client, collection_name, body, opts)

Runs batch discovery. The body must be %{searches: [discovery, ...]}. Options: :consistency, :timeout.

facet_points(collection_name, body)
facet_points(client, collection_name, body)
facet_points(client, collection_name, body, opts)

Calculates facet values. Options: :consistency, :timeout.

get_point(collection_name, id)
get_point(client, collection_name, id)
get_point(client, collection_name, id, opts)

Retrieves one point. Options: :consistency.

get_points(collection_name, body)
get_points(client, collection_name, body)
get_points(client, collection_name, body, opts)

Retrieves points by ID. Options: :consistency, :timeout.

overwrite_payload(collection_name, body)
overwrite_payload(client, collection_name, body)
overwrite_payload(client, collection_name, body, opts)

Replaces complete payloads. Options: :wait, :ordering, :timeout.

overwrite_payload(collection_name, body, wait, ordering, timeout)
query_points(collection_name, body)
query_points(client, collection_name, body)
query_points(client, collection_name, body, opts)

Runs a universal query. :query may be omitted for ID-ordered retrieval. Options: :consistency, :timeout.

query_points_batch(collection_name, body)
query_points_batch(client, collection_name, body)
query_points_batch(client, collection_name, body, opts)

Runs batch universal queries. The body must be %{searches: [query, ...]}. Options: :consistency, :timeout.

query_points_groups(collection_name, body)
query_points_groups(client, collection_name, body)
query_points_groups(client, collection_name, body, opts)

Runs a grouped universal query. Options: :consistency, :timeout.

recommend_points(collection_name, body)
recommend_points(client, collection_name, body)
recommend_points(client, collection_name, body, opts)

Recommends points. Options: :consistency, :timeout.

recommend_points_batch(collection_name, body)
recommend_points_batch(client, collection_name, body)
recommend_points_batch(client, collection_name, body, opts)

Runs batch recommendation. The body must be %{searches: [recommendation, ...]}. Options: :consistency, :timeout.

recommend_points_groups(collection_name, body)
recommend_points_groups(client, collection_name, body)
recommend_points_groups(client, collection_name, body, opts)

Recommends points grouped by a field. Options: :consistency, :timeout.

scroll_points(collection_name, body)
scroll_points(client, collection_name, body)
scroll_points(client, collection_name, body, opts)

Scrolls through points. Options: :consistency, :timeout.

search_matrix_offsets(collection_name, body)
search_matrix_offsets(client, collection_name, body)
search_matrix_offsets(client, collection_name, body, opts)

Calculates a distance matrix as offsets. Options: :consistency, :timeout.

search_matrix_pairs(collection_name, body)
search_matrix_pairs(client, collection_name, body)
search_matrix_pairs(client, collection_name, body, opts)

Calculates a distance matrix as point pairs. Options: :consistency, :timeout.

search_points(collection_name, body)
search_points(client, collection_name, body)
search_points(client, collection_name, body, opts)

Searches for nearest points. Options: :consistency, :timeout.

search_points_batch(collection_name, body)
search_points_batch(client, collection_name, body)
search_points_batch(client, collection_name, body, opts)

Runs batch search. The body must be %{searches: [search, ...]}. Options: :consistency, :timeout.

search_points_groups(collection_name, body)
search_points_groups(client, collection_name, body)
search_points_groups(client, collection_name, body, opts)

Searches points grouped by a field. Options: :consistency, :timeout.

set_payload(collection_name, body)
set_payload(client, collection_name, body)
set_payload(client, collection_name, body, opts)

Sets payload values. Options: :wait, :ordering, :timeout.

set_payload(collection_name, body, wait, ordering, timeout)
update_vectors(collection_name, body)
update_vectors(client, collection_name, body)
update_vectors(client, collection_name, body, opts)

Updates vectors. Options: :wait, :ordering, :timeout.

update_vectors(collection_name, body, wait, ordering, timeout)
upsert_points(collection_name, body)
upsert_points(client, collection_name, body)
upsert_points(client, collection_name, body, opts)

Inserts or replaces points. Options: :wait, :ordering, :timeout.

upsert_points(collection_name, body, wait, ordering, timeout)

Functions

batch_update_points(collection_name, body)

batch_update_points(client, collection_name, body)

batch_update_points(client, collection_name, body, opts)

@spec batch_update_points(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Applies a batch of point updates. Options: :wait, :ordering, :timeout.

batch_update_points(collection_name, body, wait, ordering, timeout)

clear_payload(collection_name, body)

clear_payload(client, collection_name, body)

clear_payload(client, collection_name, body, opts)

@spec clear_payload(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Clears payloads selected by a map such as %{points: [1, 2]} or %{filter: %{must: [...]}}. Options: :wait, :ordering, :timeout.

clear_payload(collection_name, body, wait, ordering, timeout)

count_points(collection_name, body)

count_points(client, collection_name, body)

count_points(client, collection_name, body, opts)

@spec count_points(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Counts points matching the request body. Options: :timeout.

delete_payload(collection_name, body)

delete_payload(client, collection_name, body)

delete_payload(client, collection_name, body, opts)

@spec delete_payload(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Deletes payload keys. Options: :wait, :ordering, :timeout.

delete_payload(collection_name, body, wait, ordering, timeout)

delete_points(collection_name, body)

delete_points(client, collection_name, body)

delete_points(client, collection_name, body, opts)

@spec delete_points(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Deletes points selected by the request body. Options: :wait, :ordering, :timeout.

delete_points(collection_name, body, wait, ordering, timeout)

delete_vectors(collection_name, body)

delete_vectors(client, collection_name, body)

delete_vectors(client, collection_name, body, opts)

@spec delete_vectors(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Deletes vectors. Options: :wait, :ordering, :timeout.

delete_vectors(collection_name, body, wait, ordering, timeout)

discover_points(collection_name, body)

discover_points(client, collection_name, body)

discover_points(client, collection_name, body, opts)

@spec discover_points(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Discovers points from context pairs. Options: :consistency, :timeout.

discover_points_batch(collection_name, body)

discover_points_batch(client, collection_name, body)

discover_points_batch(client, collection_name, body, opts)

@spec discover_points_batch(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.batch_request(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Runs batch discovery. The body must be %{searches: [discovery, ...]}. Options: :consistency, :timeout.

facet_points(collection_name, body)

facet_points(client, collection_name, body)

facet_points(client, collection_name, body, opts)

@spec facet_points(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Calculates facet values. Options: :consistency, :timeout.

get_point(collection_name, id)

get_point(client, collection_name, id)

get_point(client, collection_name, id, opts)

@spec get_point(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.extended_point_id(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Retrieves one point. Options: :consistency.

get_points(collection_name, body)

get_points(client, collection_name, body)

get_points(client, collection_name, body, opts)

@spec get_points(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Retrieves points by ID. Options: :consistency, :timeout.

overwrite_payload(collection_name, body)

overwrite_payload(client, collection_name, body)

overwrite_payload(client, collection_name, body, opts)

@spec overwrite_payload(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Replaces complete payloads. Options: :wait, :ordering, :timeout.

overwrite_payload(collection_name, body, wait, ordering, timeout)

query_points(collection_name, body)

query_points(client, collection_name, body)

query_points(client, collection_name, body, opts)

@spec query_points(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Runs a universal query. :query may be omitted for ID-ordered retrieval. Options: :consistency, :timeout.

query_points_batch(collection_name, body)

query_points_batch(client, collection_name, body)

query_points_batch(client, collection_name, body, opts)

@spec query_points_batch(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.batch_request(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Runs batch universal queries. The body must be %{searches: [query, ...]}. Options: :consistency, :timeout.

query_points_groups(collection_name, body)

query_points_groups(client, collection_name, body)

query_points_groups(client, collection_name, body, opts)

@spec query_points_groups(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Runs a grouped universal query. Options: :consistency, :timeout.

recommend_points(collection_name, body)

recommend_points(client, collection_name, body)

recommend_points(client, collection_name, body, opts)

@spec recommend_points(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Recommends points. Options: :consistency, :timeout.

recommend_points_batch(collection_name, body)

recommend_points_batch(client, collection_name, body)

recommend_points_batch(client, collection_name, body, opts)

@spec recommend_points_batch(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.batch_request(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Runs batch recommendation. The body must be %{searches: [recommendation, ...]}. Options: :consistency, :timeout.

recommend_points_groups(collection_name, body)

recommend_points_groups(client, collection_name, body)

recommend_points_groups(client, collection_name, body, opts)

@spec recommend_points_groups(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Recommends points grouped by a field. Options: :consistency, :timeout.

scroll_points(collection_name, body)

scroll_points(client, collection_name, body)

scroll_points(client, collection_name, body, opts)

@spec scroll_points(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Scrolls through points. Options: :consistency, :timeout.

search_matrix_offsets(collection_name, body)

search_matrix_offsets(client, collection_name, body)

search_matrix_offsets(client, collection_name, body, opts)

@spec search_matrix_offsets(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Calculates a distance matrix as offsets. Options: :consistency, :timeout.

search_matrix_pairs(collection_name, body)

search_matrix_pairs(client, collection_name, body)

search_matrix_pairs(client, collection_name, body, opts)

@spec search_matrix_pairs(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Calculates a distance matrix as point pairs. Options: :consistency, :timeout.

search_points(collection_name, body)

search_points(client, collection_name, body)

search_points(client, collection_name, body, opts)

@spec search_points(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Searches for nearest points. Options: :consistency, :timeout.

search_points_batch(collection_name, body)

search_points_batch(client, collection_name, body)

search_points_batch(client, collection_name, body, opts)

@spec search_points_batch(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.batch_request(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Runs batch search. The body must be %{searches: [search, ...]}. Options: :consistency, :timeout.

search_points_groups(collection_name, body)

search_points_groups(client, collection_name, body)

search_points_groups(client, collection_name, body, opts)

@spec search_points_groups(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Searches points grouped by a field. Options: :consistency, :timeout.

set_payload(collection_name, body)

set_payload(client, collection_name, body)

set_payload(client, collection_name, body, opts)

@spec set_payload(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Sets payload values. Options: :wait, :ordering, :timeout.

set_payload(collection_name, body, wait, ordering, timeout)

update_vectors(collection_name, body)

update_vectors(client, collection_name, body)

update_vectors(client, collection_name, body, opts)

@spec update_vectors(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Updates vectors. Options: :wait, :ordering, :timeout.

update_vectors(collection_name, body, wait, ordering, timeout)

upsert_points(collection_name, body)

upsert_points(client, collection_name, body)

upsert_points(client, collection_name, body, opts)

@spec upsert_points(
  Qdrant.Client.t(),
  String.t(),
  Qdrant.Types.request_body(),
  Qdrant.Types.request_options()
) :: Qdrant.Types.result()

Inserts or replaces points. Options: :wait, :ordering, :timeout.

upsert_points(collection_name, body, wait, ordering, timeout)