Struct Payload 

pub struct Payload(/* private fields */);

Point payload

A JSON-like object that can be attached to points. With payloads you can store any kind of information along with your points. Qdrant provides comprehensive ways to filter on payload values during vector search.

Payload documentation: https://qdrant.tech/documentation/concepts/payload/

Serde

Requires serde feature

Serde JSON types can be converted to and from Payload. Note that a valid payload must be a JSON object, and not another JSON type.

Convert a JSON Value to and from Payload:

use serde_json::{Value, json};

let value = json!({
    "city": "Berlin",
});

let payload = Payload::try_from(value).expect("not a JSON object");
let value = Value::from(payload);

If the above value is not a JSON object, a QdrantError::JsonToPayload error is returned.

Convert a JSON object (Map<String, Value>) to and from from Payload:

use serde_json::{Map, Value};

let mut object = Map::new();
object.insert("city".to_string(), "Berlin".into());

let payload = Payload::from(object);
let object = Map::from(payload);

Implementations

impl Payload

pub fn new() -> Self

Construct a new empty payload object

pub fn new_from_hashmap(payload: HashMap<String, Value>) -> Self

👎Deprecated since 1.10.0: use Payload::from instead

Construct a payload object from the given hash map

pub fn insert(&mut self, key: impl ToString, val: impl Into<Value>)

Insert a payload value at the given key, replacing any existing value

pub fn deserialize<T: DeserializeOwned>(self) -> Result<T, QdrantError>

Deserializes the payload directly into T. This requires T to implement serde::Deserialize. Returns an error if T and the payload have a different structure.

use qdrant_client::Payload;
use serde_json::json;
use serde::Deserialize;

#[derive(Deserialize)]
struct MyData {
    value1: String,
    value2: u32,
}

let payload: Payload = json!({
    "value1": "Qdrant",
    "value2": 42,
})
.try_into()
.unwrap();

let parsed: MyData = payload.deserialize().unwrap();
assert_eq!(parsed.value1, "Qdrant");
assert_eq!(parsed.value2, 42);

Trait Implementations

impl Clone for Payload

fn clone(&self) -> Payload

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Payload

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Payload

fn default() -> Payload

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Payload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K, const N: usize> From<[(K, Value); N]> for Payload

where K: Into<String>,

fn from(values: [(K, Value); N]) -> Self

Converts to this type from the input type.

impl From<HashMap<&str, Value>> for Payload

fn from(payload: HashMap<&str, Value>) -> Self

Converts to this type from the input type.

impl From<HashMap<String, Value>> for Payload

fn from(payload: HashMap<String, Value>) -> Self

Converts to this type from the input type.

impl From<HashMap<String, Value>> for Payload

Available on crate feature serde only.

fn from(value: HashMap<String, Value>) -> Self

Converts to this type from the input type.

impl From<Map<String, Value>> for Payload

Available on crate feature serde only.

fn from(object: Map<String, Value>) -> Self

Convert JSON object into payload

If you have a JSON object as generic value of type Value, you can convert it with Payload::try_from.

impl From<Payload> for HashMap<String, Value>

fn from(payload: Payload) -> Self

Converts to this type from the input type.

impl From<Payload> for Map<String, Value>

Available on crate feature serde only.

fn from(value: Payload) -> Map<String, Value>

Converts to this type from the input type.

impl From<Payload> for Value

fn from(val: Payload) -> Self

Converts to this type from the input type.

impl From<Payload> for Value

Available on crate feature serde only.

fn from(value: Payload) -> Value

Converts to this type from the input type.

impl PartialEq for Payload

fn eq(&self, other: &Payload) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Payload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Value> for Payload

Available on crate feature serde only.

fn try_from(value: Value) -> Result<Self, Self::Error>

Convert JSON object into payload

The JSON value must be a valid object. A JSON object of type Map<String, Value> can be converted without errors using Payload::from.

Errors

Returns an QdrantError::JsonToPayload error if the value is not an object.

type Error = QdrantError

The type returned in the event of a conversion error.

impl StructuralPartialEq for Payload