Struct Condition

Source

pub struct Condition {
    pub condition_one_of: Option<ConditionOneOf>,
}

Fields§

§condition_one_of: Option<ConditionOneOf>

Implementations§

Source §

impl Condition

Source

pub fn is_empty(key: impl Into<String>) -> Self

Create a Condition to check if a field is empty.

§Examples:

qdrant_client::qdrant::Condition::is_empty("field");

Source

pub fn is_null(key: impl Into<String>) -> Self

Create a Condition to check if the point has a null key.

§Examples:

qdrant_client::qdrant::Condition::is_empty("remark");

Source

pub fn has_id(ids: impl IntoIterator<Item = impl Into<PointId>>) -> Self

Create a Condition to check if the point has one of the given ids.

§Examples:

qdrant_client::qdrant::Condition::has_id([0, 8, 15]);

Source

pub fn has_vector(vector_name: impl Into<String>) -> Self

Create a Condition to check if the point has a specific named vector.

§Examples:

qdrant_client::qdrant::Condition::has_vector("my_vector");

Source

pub fn matches(field: impl Into<String>, match: impl Into<MatchValue>) -> Self

Create a Condition that matches a field against a certain value.

§Examples:

qdrant_client::qdrant::Condition::matches("number", 42);
qdrant_client::qdrant::Condition::matches("tag", vec!["i".to_string(), "em".into()]);

Source

pub fn matches_text(field: impl Into<String>, query: impl Into<String>) -> Self

Create a Condition to initiate full text match.

§Examples:

qdrant_client::qdrant::Condition::matches_text("description", "good cheap");

Source

pub fn matches_phrase( field: impl Into<String>, query: impl Into<String>, ) -> Self

Create a Condition to initiate full text phrase match.

§Examples:

qdrant_client::qdrant::Condition::matches_phrase("description", "time machine");

Source

pub fn matches_text_any( field: impl Into<String>, query: impl Into<String>, ) -> Self

Create a Condition to match any of the given text tokens.

§Examples:

qdrant_client::qdrant::Condition::matches_text_any("tags", "rust python");

Source

pub fn matches_prefix( field: impl Into<String>, prefix: impl Into<String>, ) -> Self

Create a Condition to match keywords starting with the given prefix.

Requires the keyword index of the field to be created with prefix matching enabled, see KeywordIndexParamsBuilder::prefix.

§Examples:

qdrant_client::qdrant::Condition::matches_prefix("city", "Ber");

Source

pub fn slice(total: u32, index: u32) -> Self

Create a Condition selecting one of total disjoint deterministic slices of the id space. Useful to split a collection into equally sized chunks, for example to scroll through it in parallel.

index must be less than total.

§Examples:

// Select the first of four slices of the collection
qdrant_client::qdrant::Condition::slice(4, 0);

Source

pub fn range(field: impl Into<String>, range: Range) -> Self

Create a Condition that checks numeric fields against a range.

§Examples:

use qdrant_client::qdrant::Range;
qdrant_client::qdrant::Condition::range("number", Range {
    gte: Some(42.),
    ..Default::default()
});

Source

pub fn datetime_range(field: impl Into<String>, range: DatetimeRange) -> Self

Create a Condition that checks datetime fields against a range.

§Examples:

use qdrant_client::qdrant::{DatetimeRange, Timestamp};
qdrant_client::qdrant::Condition::datetime_range("timestamp", DatetimeRange {
    gte: Some(Timestamp::date(2023, 2, 8).unwrap()),
    ..Default::default()
});

Source

pub fn geo_radius(field: impl Into<String>, geo_radius: GeoRadius) -> Self

Create a Condition that checks geo fields against a radius.

§Examples:

use qdrant_client::qdrant::{GeoPoint, GeoRadius};
qdrant_client::qdrant::Condition::geo_radius("location", GeoRadius {
  center: Some(GeoPoint { lon: 42., lat: 42. }),
  radius: 42.,
});

Source

pub fn geo_bounding_box( field: impl Into<String>, geo_bounding_box: GeoBoundingBox, ) -> Self

Create a Condition that checks geo fields against a bounding box.

§Examples:

use qdrant_client::qdrant::{GeoPoint, GeoBoundingBox};
qdrant_client::qdrant::Condition::geo_bounding_box("location", GeoBoundingBox {
  top_left: Some(GeoPoint { lon: 42., lat: 42. }),
  bottom_right: Some(GeoPoint { lon: 42., lat: 42. }),
});

Source

pub fn geo_polygon(field: impl Into<String>, geo_polygon: GeoPolygon) -> Self

Create a Condition that checks geo fields against a geo polygons.

§Examples:

use qdrant_client::qdrant::{GeoLineString, GeoPoint, GeoPolygon};
let polygon = GeoPolygon {
 exterior: Some(GeoLineString { points: vec![GeoPoint { lon: 42., lat: 42. }]}),
 interiors: vec![],
};
qdrant_client::qdrant::Condition::geo_polygon("location", polygon);

Source

pub fn values_count(field: impl Into<String>, values_count: ValuesCount) -> Self

Create a Condition that checks count of values in a field.

§Examples:

use qdrant_client::qdrant::ValuesCount;
qdrant_client::qdrant::Condition::values_count("tags", ValuesCount {
 gte: Some(42),
 ..Default::default()
});

Source

pub fn nested(field: impl Into<String>, filter: Filter) -> Self

Create a Condition that applies a per-element filter to a nested array

The field parameter should be a key-path to a nested array of objects. You may specify it as both array_field or array_field[].

For motivation and further examples, see API documentation.

§Panics:

If debug assertions are enabled, this will panic if the filter, or any its subfilters, contain a HasIdCondition (equivalently, a condition created with Self::has_id), as these are unsupported for nested object filters.

§Examples:

use qdrant_client::qdrant::Filter;
qdrant_client::qdrant::Condition::nested("array_field[]", Filter::any([
  qdrant_client::qdrant::Condition::is_null("element_field")
]));