class
Amazonite::DynamoDB::VectorIndex
- Amazonite::DynamoDB::VectorIndex
- Reference
- Object
Overview
Contains the configuration settings for a vector index, including the index name, vector attribute, dimensions, distance function, search schema, and projection.
Included Modules
- JSON::Serializable
Defined in:
dynamodb/vector_index.crConstructors
- .new(index_name : String, vector_attribute : VectorAttributeDefinition, projection : Projection, dimensions : Int64, distance_function : VectorDistanceFunction, search_schema : Array(SearchSchemaElement) | Nil = nil)
- .new(pull : JSON::PullParser)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#dimensions : Int64
The number of dimensions in each vector.
-
#dimensions=(dimensions : Int64)
The number of dimensions in each vector.
-
#distance_function : VectorDistanceFunction
The distance function used to calculate similarity between vectors.
-
#distance_function=(distance_function : VectorDistanceFunction)
The distance function used to calculate similarity between vectors.
-
#hash(hasher)
See
Object#hash(hasher) -
#index_name : String
The name of the vector index.
-
#index_name=(index_name : String)
The name of the vector index.
-
#projection : Projection
Specifies attributes that are copied (projected) from the table into the vector index.
-
#projection=(projection : Projection)
Specifies attributes that are copied (projected) from the table into the vector index.
-
#search_schema : Array(SearchSchemaElement) | Nil
The search schema that defines partition key and inline filter attributes for the vector index.
-
#search_schema=(search_schema : Array(SearchSchemaElement) | Nil)
The search schema that defines partition key and inline filter attributes for the vector index.
- #validate! : Nil
-
#vector_attribute : VectorAttributeDefinition
The vector attribute configuration for the index.
-
#vector_attribute=(vector_attribute : VectorAttributeDefinition)
The vector attribute configuration for the index.
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
The distance function used to calculate similarity between vectors. Valid values: COSINE,
EUCLIDEAN, DOT_PRODUCT.
The distance function used to calculate similarity between vectors. Valid values: COSINE,
EUCLIDEAN, DOT_PRODUCT.
Specifies attributes that are copied (projected) from the table into the vector index.
Specifies attributes that are copied (projected) from the table into the vector index.
The search schema that defines partition key and inline filter attributes for the vector index.
The search schema that defines partition key and inline filter attributes for the vector index.
The vector attribute configuration for the index.
The vector attribute configuration for the index.