class Amazonite::DynamoDB::CreateVectorIndexAction

Overview

A new vector index to be added to a table.

Included Modules

Defined in:

dynamodb/create_vector_index_action.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(index_name : String, vector_attribute : VectorAttributeDefinition, projection : Projection, dimensions : Int64, distance_function : VectorDistanceFunction, search_schema : Array(SearchSchemaElement) | Nil = nil) #

[View source]
def self.new(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 dimensions : Int64 #

The number of dimensions in each vector.


[View source]
def dimensions=(dimensions : Int64) #

The number of dimensions in each vector.


[View source]
def distance_function : VectorDistanceFunction #

The distance function used to calculate similarity. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.


[View source]
def distance_function=(distance_function : VectorDistanceFunction) #

The distance function used to calculate similarity. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def index_name : String #

The name of the vector index. Must be unique within the table.


[View source]
def index_name=(index_name : String) #

The name of the vector index. Must be unique within the table.


[View source]
def projection : Projection #

Specifies attributes that are copied (projected) from the table into the vector index.


[View source]
def projection=(projection : Projection) #

Specifies attributes that are copied (projected) from the table into the vector index.


[View source]
def search_schema : Array(SearchSchemaElement) | Nil #

The partition key and inline filter attribute definitions for the vector index.


[View source]
def search_schema=(search_schema : Array(SearchSchemaElement) | Nil) #

The partition key and inline filter attribute definitions for the vector index.


[View source]
def validate! : Nil #

[View source]
def vector_attribute : VectorAttributeDefinition #

The attribute that contains vector embeddings. If multiple vector indexes reference the same attribute, they must all use the same number of dimensions.


[View source]
def vector_attribute=(vector_attribute : VectorAttributeDefinition) #

The attribute that contains vector embeddings. If multiple vector indexes reference the same attribute, they must all use the same number of dimensions.


[View source]