class Amazonite::DynamoDB::VectorIndexDescription

• Amazonite::DynamoDB::VectorIndexDescription
• Reference
• Object

Overview

Contains the current state and configuration of a vector index, including its status, size, item count, and the settings specified when the index was created.

Included Modules

• JSON::Serializable

Defined in:

dynamodb/vector_index_description.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(index_name : String | Nil = nil, search_schema : Array(SearchSchemaElement) | Nil = nil, projection : Projection | Nil = nil, vector_attribute : VectorAttributeDefinition | Nil = nil, dimensions : Int64 | Nil = nil, distance_function : VectorDistanceFunction | Nil = nil, index_status : IndexStatus | Nil = nil, backfilling : Bool | Nil = nil, index_size_bytes : Int64 | Nil = nil, item_count : Int64 | Nil = nil, index_arn : String | Nil = nil)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #backfilling : Bool | Nil

  Specifies whether the index is currently backfilling.

• #backfilling=(backfilling : Bool | Nil)

  Specifies whether the index is currently backfilling.

• #dimensions : Int64 | Nil

  The number of dimensions in each vector.

• #dimensions=(dimensions : Int64 | Nil)

  The number of dimensions in each vector.

• #distance_function : VectorDistanceFunction | Nil

  The distance function used to calculate similarity between vectors.

• #distance_function=(distance_function : VectorDistanceFunction | Nil)

  The distance function used to calculate similarity between vectors.

• #hash(hasher)

  See Object#hash(hasher)

• #index_arn : String | Nil

  The Amazon Resource Name (ARN) that uniquely identifies the vector index.

• #index_arn=(index_arn : String | Nil)

  The Amazon Resource Name (ARN) that uniquely identifies the vector index.

• #index_name : String | Nil

  The name of the vector index.

• #index_name=(index_name : String | Nil)

  The name of the vector index.

• #index_size_bytes : Int64 | Nil

  The total size of the vector index, in bytes.

• #index_size_bytes=(index_size_bytes : Int64 | Nil)

  The total size of the vector index, in bytes.

• #index_status : IndexStatus | Nil

  The current state of the vector index:

• #index_status=(index_status : IndexStatus | Nil)

  The current state of the vector index:

• #item_count : Int64 | Nil

  The number of items indexed in the vector index.

• #item_count=(item_count : Int64 | Nil)

  The number of items indexed in the vector index.

• #projection : Projection | Nil

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

• #projection=(projection : Projection | Nil)

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

  The vector attribute configuration for the index.

• #vector_attribute=(vector_attribute : VectorAttributeDefinition | Nil)

  The vector attribute configuration for the index.

Constructor Detail

Instance Method Detail