class Amazonite::DynamoDB::SearchVectorsInput

Included Modules

JSON::Serializable

Defined in:

dynamodb/search_vectors_input.cr

Constructors

.new(table_name : String, index_name : String, search_vector : Array(AttributeValue), top_k : Int32, return_consumed_capacity : ReturnConsumedCapacity | Nil = nil, expression_attribute_names : Hash(String, String) | Nil = nil, expression_attribute_values : Hash(String, AttributeValue) | Nil = nil, projection_expression : String | Nil = nil, search_condition_expression : String | Nil = nil)
.new(pull : JSON::PullParser)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

#==(other : self)
Returns true if this reference is the same as other.
#expression_attribute_names : Hash(String, String) | Nil
One or more substitution tokens for attribute names in an expression.
#expression_attribute_names=(expression_attribute_names : Hash(String, String) | Nil)
One or more substitution tokens for attribute names in an expression.
#expression_attribute_values : Hash(String, AttributeValue) | Nil
One or more values that can be substituted in an expression.
#expression_attribute_values=(expression_attribute_values : Hash(String, AttributeValue) | Nil)
One or more values that can be substituted in an expression.
#hash(hasher)
See Object#hash(hasher)
#index_name : String
The name of the vector index to search.
#index_name=(index_name : String)
The name of the vector index to search.
#projection_expression : String | Nil
A string that identifies one or more attributes to retrieve from the index.
#projection_expression=(projection_expression : String | Nil)
A string that identifies one or more attributes to retrieve from the index.
#return_consumed_capacity : ReturnConsumedCapacity | Nil
#return_consumed_capacity=(return_consumed_capacity : ReturnConsumedCapacity | Nil)
#search_condition_expression : String | Nil
A condition expression used to filter the vector search results.
#search_condition_expression=(search_condition_expression : String | Nil)
A condition expression used to filter the vector search results.
#search_vector : Array(AttributeValue)
The search vector to compare against the indexed vectors.
#search_vector=(search_vector : Array(AttributeValue))
The search vector to compare against the indexed vectors.
#table_name : String
The name or Amazon Resource Name (ARN) of the table containing the vector index.
#table_name=(table_name : String)
The name or Amazon Resource Name (ARN) of the table containing the vector index.
#top_k : Int32
The number of most similar results to return.
#top_k=(top_k : Int32)
The number of most similar results to return.
#validate! : Nil

Constructor Detail

def self.new(table_name : String, index_name : String, search_vector : Array(AttributeValue), top_k : Int32, return_consumed_capacity : ReturnConsumedCapacity | Nil = nil, expression_attribute_names : Hash(String, String) | Nil = nil, expression_attribute_values : Hash(String, AttributeValue) | Nil = nil, projection_expression : String | Nil = nil, search_condition_expression : String | Nil = nil) #

[View source]

def self.new(pull : JSON::PullParser) #

[View source]

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #

Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.

def expression_attribute_names : Hash(String, String) | Nil #

One or more substitution tokens for attribute names in an expression. Use the # character in an expression to dereference an attribute name.

[View source]

def expression_attribute_names=(expression_attribute_names : Hash(String, String) | Nil) #

One or more substitution tokens for attribute names in an expression. Use the # character in an expression to dereference an attribute name.

[View source]

def expression_attribute_values : Hash(String, AttributeValue) | Nil #

One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value.

[View source]

def expression_attribute_values=(expression_attribute_values : Hash(String, AttributeValue) | Nil) #

One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value.

[View source]

def hash(hasher) #

Description copied from class Reference

See Object#hash(hasher)

def index_name : String #

The name of the vector index to search. The index must be in the ACTIVE state.

[View source]

def index_name=(index_name : String) #

The name of the vector index to search. The index must be in the ACTIVE state.

[View source]

def projection_expression : String | Nil #

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.

Only attributes projected into the vector index can be retrieved.

[View source]

def projection_expression=(projection_expression : String | Nil) #

Only attributes projected into the vector index can be retrieved.

[View source]

def return_consumed_capacity : ReturnConsumedCapacity | Nil #

[View source]

def return_consumed_capacity=(return_consumed_capacity : ReturnConsumedCapacity | Nil) #

[View source]

def search_condition_expression : String | Nil #

A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including HASH and INLINE_FILTER key elements.

Only the equality operator (=) is supported for HASH attributes. Comparison and range operators are supported for INLINE_FILTER attributes. Only top-level attributes from the search schema can be referenced.

[View source]

def search_condition_expression=(search_condition_expression : String | Nil) #

A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including HASH and INLINE_FILTER key elements.

[View source]

def search_vector : Array(AttributeValue) #

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.

The number of dimensions must match the number of dimensions configured for the vector index.

[View source]

def search_vector=(search_vector : Array(AttributeValue)) #

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.

The number of dimensions must match the number of dimensions configured for the vector index.

[View source]

def table_name : String #

The name or Amazon Resource Name (ARN) of the table containing the vector index.

[View source]

def table_name=(table_name : String) #

The name or Amazon Resource Name (ARN) of the table containing the vector index.

[View source]

def top_k : Int32 #

The number of most similar results to return.

[View source]

def top_k=(top_k : Int32) #

The number of most similar results to return.

[View source]

def validate! : Nil #

[View source]