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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct SearchVectorsInput {
/// <p>The name or Amazon Resource Name (ARN) of the table containing the vector index.</p>
pub table_name: ::std::option::Option<::std::string::String>,
/// <p>The name of the vector index to search. The index must be in the <code>ACTIVE</code> state.</p>
pub index_name: ::std::option::Option<::std::string::String>,
/// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
/// <ul>
/// <li>
/// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
/// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
/// <li>
/// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
/// <li>
/// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
/// </ul>
pub return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
/// <p>One or more substitution tokens for attribute names in an expression. Use the <code>#</code> character in an expression to dereference an attribute name.</p>
pub expression_attribute_names: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>One or more values that can be substituted in an expression. Use the <code>:</code> character in an expression to dereference an attribute value.</p>
pub expression_attribute_values: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
/// <p>A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index.</p>
/// <p>Only attributes projected into the vector index can be retrieved.</p>
pub projection_expression: ::std::option::Option<::std::string::String>,
/// <p>The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.</p>
/// <p>The number of dimensions must match the number of dimensions configured for the vector index.</p>
pub search_vector: ::std::option::Option<::std::vec::Vec<crate::types::AttributeValue>>,
/// <p>A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including <code>HASH</code> and <code>INLINE_FILTER</code> key elements.</p>
/// <p>Only the equality operator (<code>=</code>) is supported for <code>HASH</code> attributes. Comparison and range operators are supported for <code>INLINE_FILTER</code> attributes. Only top-level attributes from the search schema can be referenced.</p>
pub search_condition_expression: ::std::option::Option<::std::string::String>,
/// <p>The number of most similar results to return.</p>
pub top_k: ::std::option::Option<i32>,
}
impl SearchVectorsInput {
/// <p>The name or Amazon Resource Name (ARN) of the table containing the vector index.</p>
pub fn table_name(&self) -> ::std::option::Option<&str> {
self.table_name.as_deref()
}
/// <p>The name of the vector index to search. The index must be in the <code>ACTIVE</code> state.</p>
pub fn index_name(&self) -> ::std::option::Option<&str> {
self.index_name.as_deref()
}
/// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
/// <ul>
/// <li>
/// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
/// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
/// <li>
/// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
/// <li>
/// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
/// </ul>
pub fn return_consumed_capacity(&self) -> ::std::option::Option<&crate::types::ReturnConsumedCapacity> {
self.return_consumed_capacity.as_ref()
}
/// <p>One or more substitution tokens for attribute names in an expression. Use the <code>#</code> character in an expression to dereference an attribute name.</p>
pub fn expression_attribute_names(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.expression_attribute_names.as_ref()
}
/// <p>One or more values that can be substituted in an expression. Use the <code>:</code> character in an expression to dereference an attribute value.</p>
pub fn expression_attribute_values(
&self,
) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
self.expression_attribute_values.as_ref()
}
/// <p>A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index.</p>
/// <p>Only attributes projected into the vector index can be retrieved.</p>
pub fn projection_expression(&self) -> ::std::option::Option<&str> {
self.projection_expression.as_deref()
}
/// <p>The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.</p>
/// <p>The number of dimensions must match the number of dimensions configured for the vector index.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.search_vector.is_none()`.
pub fn search_vector(&self) -> &[crate::types::AttributeValue] {
self.search_vector.as_deref().unwrap_or_default()
}
/// <p>A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including <code>HASH</code> and <code>INLINE_FILTER</code> key elements.</p>
/// <p>Only the equality operator (<code>=</code>) is supported for <code>HASH</code> attributes. Comparison and range operators are supported for <code>INLINE_FILTER</code> attributes. Only top-level attributes from the search schema can be referenced.</p>
pub fn search_condition_expression(&self) -> ::std::option::Option<&str> {
self.search_condition_expression.as_deref()
}
/// <p>The number of most similar results to return.</p>
pub fn top_k(&self) -> ::std::option::Option<i32> {
self.top_k
}
}
impl SearchVectorsInput {
/// Creates a new builder-style object to manufacture [`SearchVectorsInput`](crate::operation::search_vectors::SearchVectorsInput).
pub fn builder() -> crate::operation::search_vectors::builders::SearchVectorsInputBuilder {
crate::operation::search_vectors::builders::SearchVectorsInputBuilder::default()
}
}
/// A builder for [`SearchVectorsInput`](crate::operation::search_vectors::SearchVectorsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SearchVectorsInputBuilder {
pub(crate) table_name: ::std::option::Option<::std::string::String>,
pub(crate) index_name: ::std::option::Option<::std::string::String>,
pub(crate) return_consumed_capacity: ::std::option::Option<crate::types::ReturnConsumedCapacity>,
pub(crate) expression_attribute_names: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) expression_attribute_values: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
pub(crate) projection_expression: ::std::option::Option<::std::string::String>,
pub(crate) search_vector: ::std::option::Option<::std::vec::Vec<crate::types::AttributeValue>>,
pub(crate) search_condition_expression: ::std::option::Option<::std::string::String>,
pub(crate) top_k: ::std::option::Option<i32>,
}
impl SearchVectorsInputBuilder {
/// <p>The name or Amazon Resource Name (ARN) of the table containing the vector index.</p>
/// This field is required.
pub fn table_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.table_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name or Amazon Resource Name (ARN) of the table containing the vector index.</p>
pub fn set_table_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.table_name = input;
self
}
/// <p>The name or Amazon Resource Name (ARN) of the table containing the vector index.</p>
pub fn get_table_name(&self) -> &::std::option::Option<::std::string::String> {
&self.table_name
}
/// <p>The name of the vector index to search. The index must be in the <code>ACTIVE</code> state.</p>
/// This field is required.
pub fn index_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.index_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the vector index to search. The index must be in the <code>ACTIVE</code> state.</p>
pub fn set_index_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.index_name = input;
self
}
/// <p>The name of the vector index to search. The index must be in the <code>ACTIVE</code> state.</p>
pub fn get_index_name(&self) -> &::std::option::Option<::std::string::String> {
&self.index_name
}
/// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
/// <ul>
/// <li>
/// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
/// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
/// <li>
/// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
/// <li>
/// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
/// </ul>
pub fn return_consumed_capacity(mut self, input: crate::types::ReturnConsumedCapacity) -> Self {
self.return_consumed_capacity = ::std::option::Option::Some(input);
self
}
/// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
/// <ul>
/// <li>
/// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
/// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
/// <li>
/// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
/// <li>
/// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
/// </ul>
pub fn set_return_consumed_capacity(mut self, input: ::std::option::Option<crate::types::ReturnConsumedCapacity>) -> Self {
self.return_consumed_capacity = input;
self
}
/// <p>Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:</p>
/// <ul>
/// <li>
/// <p><code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p>
/// <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p></li>
/// <li>
/// <p><code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p></li>
/// <li>
/// <p><code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p></li>
/// </ul>
pub fn get_return_consumed_capacity(&self) -> &::std::option::Option<crate::types::ReturnConsumedCapacity> {
&self.return_consumed_capacity
}
/// Adds a key-value pair to `expression_attribute_names`.
///
/// To override the contents of this collection use [`set_expression_attribute_names`](Self::set_expression_attribute_names).
///
/// <p>One or more substitution tokens for attribute names in an expression. Use the <code>#</code> character in an expression to dereference an attribute name.</p>
pub fn expression_attribute_names(
mut self,
k: impl ::std::convert::Into<::std::string::String>,
v: impl ::std::convert::Into<::std::string::String>,
) -> Self {
let mut hash_map = self.expression_attribute_names.unwrap_or_default();
hash_map.insert(k.into(), v.into());
self.expression_attribute_names = ::std::option::Option::Some(hash_map);
self
}
/// <p>One or more substitution tokens for attribute names in an expression. Use the <code>#</code> character in an expression to dereference an attribute name.</p>
pub fn set_expression_attribute_names(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
) -> Self {
self.expression_attribute_names = input;
self
}
/// <p>One or more substitution tokens for attribute names in an expression. Use the <code>#</code> character in an expression to dereference an attribute name.</p>
pub fn get_expression_attribute_names(
&self,
) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.expression_attribute_names
}
/// Adds a key-value pair to `expression_attribute_values`.
///
/// To override the contents of this collection use [`set_expression_attribute_values`](Self::set_expression_attribute_values).
///
/// <p>One or more values that can be substituted in an expression. Use the <code>:</code> character in an expression to dereference an attribute value.</p>
pub fn expression_attribute_values(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::AttributeValue) -> Self {
let mut hash_map = self.expression_attribute_values.unwrap_or_default();
hash_map.insert(k.into(), v);
self.expression_attribute_values = ::std::option::Option::Some(hash_map);
self
}
/// <p>One or more values that can be substituted in an expression. Use the <code>:</code> character in an expression to dereference an attribute value.</p>
pub fn set_expression_attribute_values(
mut self,
input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>>,
) -> Self {
self.expression_attribute_values = input;
self
}
/// <p>One or more values that can be substituted in an expression. Use the <code>:</code> character in an expression to dereference an attribute value.</p>
pub fn get_expression_attribute_values(
&self,
) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::AttributeValue>> {
&self.expression_attribute_values
}
/// <p>A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index.</p>
/// <p>Only attributes projected into the vector index can be retrieved.</p>
pub fn projection_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.projection_expression = ::std::option::Option::Some(input.into());
self
}
/// <p>A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index.</p>
/// <p>Only attributes projected into the vector index can be retrieved.</p>
pub fn set_projection_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.projection_expression = input;
self
}
/// <p>A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index.</p>
/// <p>Only attributes projected into the vector index can be retrieved.</p>
pub fn get_projection_expression(&self) -> &::std::option::Option<::std::string::String> {
&self.projection_expression
}
/// Appends an item to `search_vector`.
///
/// To override the contents of this collection use [`set_search_vector`](Self::set_search_vector).
///
/// <p>The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.</p>
/// <p>The number of dimensions must match the number of dimensions configured for the vector index.</p>
pub fn search_vector(mut self, input: crate::types::AttributeValue) -> Self {
let mut v = self.search_vector.unwrap_or_default();
v.push(input);
self.search_vector = ::std::option::Option::Some(v);
self
}
/// <p>The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.</p>
/// <p>The number of dimensions must match the number of dimensions configured for the vector index.</p>
pub fn set_search_vector(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AttributeValue>>) -> Self {
self.search_vector = input;
self
}
/// <p>The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.</p>
/// <p>The number of dimensions must match the number of dimensions configured for the vector index.</p>
pub fn get_search_vector(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AttributeValue>> {
&self.search_vector
}
/// <p>A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including <code>HASH</code> and <code>INLINE_FILTER</code> key elements.</p>
/// <p>Only the equality operator (<code>=</code>) is supported for <code>HASH</code> attributes. Comparison and range operators are supported for <code>INLINE_FILTER</code> attributes. Only top-level attributes from the search schema can be referenced.</p>
pub fn search_condition_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.search_condition_expression = ::std::option::Option::Some(input.into());
self
}
/// <p>A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including <code>HASH</code> and <code>INLINE_FILTER</code> key elements.</p>
/// <p>Only the equality operator (<code>=</code>) is supported for <code>HASH</code> attributes. Comparison and range operators are supported for <code>INLINE_FILTER</code> attributes. Only top-level attributes from the search schema can be referenced.</p>
pub fn set_search_condition_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.search_condition_expression = input;
self
}
/// <p>A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including <code>HASH</code> and <code>INLINE_FILTER</code> key elements.</p>
/// <p>Only the equality operator (<code>=</code>) is supported for <code>HASH</code> attributes. Comparison and range operators are supported for <code>INLINE_FILTER</code> attributes. Only top-level attributes from the search schema can be referenced.</p>
pub fn get_search_condition_expression(&self) -> &::std::option::Option<::std::string::String> {
&self.search_condition_expression
}
/// <p>The number of most similar results to return.</p>
/// This field is required.
pub fn top_k(mut self, input: i32) -> Self {
self.top_k = ::std::option::Option::Some(input);
self
}
/// <p>The number of most similar results to return.</p>
pub fn set_top_k(mut self, input: ::std::option::Option<i32>) -> Self {
self.top_k = input;
self
}
/// <p>The number of most similar results to return.</p>
pub fn get_top_k(&self) -> &::std::option::Option<i32> {
&self.top_k
}
/// Consumes the builder and constructs a [`SearchVectorsInput`](crate::operation::search_vectors::SearchVectorsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::search_vectors::SearchVectorsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::search_vectors::SearchVectorsInput {
table_name: self.table_name,
index_name: self.index_name,
return_consumed_capacity: self.return_consumed_capacity,
expression_attribute_names: self.expression_attribute_names,
expression_attribute_values: self.expression_attribute_values,
projection_expression: self.projection_expression,
search_vector: self.search_vector,
search_condition_expression: self.search_condition_expression,
top_k: self.top_k,
})
}
}