class Amazonite::DynamoDB::VectorIndexInfo

Overview

Contains the configuration of a vector index as it existed at the time a backup was created.

Included Modules

Defined in:

dynamodb/vector_index_info.cr

Constructors

Instance Method Summary

Constructor Detail

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

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

[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 | Nil #

The number of dimensions in each vector.


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

The number of dimensions in each vector.


[View source]
def distance_function : VectorDistanceFunction | Nil #

The distance function used to calculate similarity between vectors.


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

The distance function used to calculate similarity between vectors.


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

See Object#hash(hasher)


def index_name : String | Nil #

The name of the vector index.


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

The name of the vector index.


[View source]
def projection : Projection | Nil #

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


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

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


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

The search schema that defines partition key and inline filter attributes for the vector index.


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

The search schema that defines partition key and inline filter attributes for the vector index.


[View source]
def validate! : Nil #

[View source]
def vector_attribute : VectorAttributeDefinition | Nil #

The vector attribute configuration for the index.


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

The vector attribute configuration for the index.


[View source]