1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
use crate::qdrant::{
ClearPayloadPoints, DeletePayloadPoints, PointsOperationResponse, SetPayloadPoints,
};
use crate::qdrant_client::{Qdrant, QdrantResult};
/// # Payload operations
///
/// Manage point payloads.
///
/// Documentation: <https://qdrant.tech/documentation/concepts/payload/>
impl Qdrant {
/// Set payload of points.
///
/// Sets only the given payload values on a point, leaving other existing payloads in place.
///
/// ```no_run
///# use qdrant_client::{Qdrant, QdrantError};
/// use qdrant_client::Payload;
/// use qdrant_client::qdrant::{PointsIdsList, SetPayloadPointsBuilder};
/// use serde_json::json;
///
///# async fn set_payload(client: &Qdrant)
///# -> Result<(), QdrantError> {
/// let payload: Payload = json!({
/// "property1": "string",
/// "property2": "string",
/// })
/// .try_into()
/// .unwrap();
///
/// client
/// .set_payload(
/// SetPayloadPointsBuilder::new("my_collection", payload)
/// .points_selector(PointsIdsList {
/// ids: vec![0.into(), 3.into(), 10.into()],
/// })
/// .wait(true),
/// )
/// .await?;
///# Ok(())
///# }
/// ```
///
/// Documentation: <https://qdrant.tech/documentation/concepts/payload/#set-payload>
pub async fn set_payload(
&self,
request: impl Into<SetPayloadPoints>,
) -> QdrantResult<PointsOperationResponse> {
let request = &request.into();
self.with_points_client(|mut points_api| async move {
let result = points_api.set_payload(request.clone()).await?;
Ok(result.into_inner())
})
.await
}
/// Overwrite payload of points.
///
/// Sets the given payload values on a point, completely replacing existing payload.
///
/// ```no_run
///# use qdrant_client::{Qdrant, QdrantError};
/// use qdrant_client::Payload;
/// use qdrant_client::qdrant::{
/// points_selector::PointsSelectorOneOf, PointsIdsList, SetPayloadPointsBuilder,
/// };
/// use serde_json::json;
///
///# async fn overwrite_payload(client: &Qdrant)
///# -> Result<(), QdrantError> {
/// let payload: Payload = json!({
/// "property1": "string",
/// "property2": "string",
/// })
/// .try_into()
/// .unwrap();
///
/// client
/// .overwrite_payload(
/// SetPayloadPointsBuilder::new("my_collection", payload)
/// .points_selector(PointsSelectorOneOf::Points(PointsIdsList {
/// ids: vec![0.into(), 3.into(), 10.into()],
/// }))
/// .wait(true),
/// )
/// .await?;
///# Ok(())
///# }
/// ```
///
/// Documentation: <https://qdrant.tech/documentation/concepts/payload/#overwrite-payload>
pub async fn overwrite_payload(
&self,
request: impl Into<SetPayloadPoints>,
) -> QdrantResult<PointsOperationResponse> {
let request = &request.into();
self.with_points_client(|mut points_api| async move {
let result = points_api.overwrite_payload(request.clone()).await?;
Ok(result.into_inner())
})
.await
}
/// Delete specified payload keys of points.
///
/// ```no_run
///# use qdrant_client::{Qdrant, QdrantError};
/// use qdrant_client::qdrant::{DeletePayloadPointsBuilder, PointsIdsList};
///
///# async fn delete_payload(client: &Qdrant)
///# -> Result<(), QdrantError> {
/// client
/// .delete_payload(
/// DeletePayloadPointsBuilder::new(
/// "my_collection",
/// vec!["color".to_string(), "price".to_string()],
/// )
/// .points_selector(PointsIdsList {
/// ids: vec![0.into(), 3.into(), 100.into()],
/// })
/// .wait(true),
/// )
/// .await?;
///# Ok(())
///# }
/// ```
///
/// Documentation: <https://qdrant.tech/documentation/concepts/payload/#delete-payload-keys>
pub async fn delete_payload(
&self,
request: impl Into<DeletePayloadPoints>,
) -> QdrantResult<PointsOperationResponse> {
let request = &request.into();
self.with_points_client(|mut points_api| async move {
let result = points_api.delete_payload(request.clone()).await?;
Ok(result.into_inner())
})
.await
}
/// Clear all payload of points.
///
/// ```no_run
///# use qdrant_client::{Qdrant, QdrantError};
/// use qdrant_client::qdrant::{ClearPayloadPointsBuilder, PointsIdsList};
///
///# async fn clear_payload(client: &Qdrant)
///# -> Result<(), QdrantError> {
/// client
/// .clear_payload(ClearPayloadPointsBuilder::new("my_collection").points(
/// PointsIdsList {
/// ids: vec![0.into(), 3.into(), 100.into()],
/// },
/// ))
/// .await?;
///# Ok(())
///# }
/// ```
///
/// Documentation: <https://qdrant.tech/documentation/concepts/payload/#clear-payload>
pub async fn clear_payload(
&self,
request: impl Into<ClearPayloadPoints>,
) -> QdrantResult<PointsOperationResponse> {
let request = &request.into();
self.with_points_client(|mut points_api| async move {
let result = points_api.clear_payload(request.clone()).await?;
Ok(result.into_inner())
})
.await
}
}