Class: Aws::DynamoDB::Types::CreateVectorIndexAction

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::CreateVectorIndexAction

Includes:

Structure

Defined in:

lib/aws-sdk-dynamodb/types.rb

Overview

A new vector index to be added to a table.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dimensions ⇒ Integer

  The number of dimensions in each vector.

• #distance_function ⇒ String

  The distance function used to calculate similarity.

• #index_name ⇒ String

  The name of the vector index.

• #projection ⇒ Types::Projection

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

• #search_schema ⇒ Array<Types::SearchSchemaElement>

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

• #vector_attribute ⇒ Types::VectorAttributeDefinition

  The attribute that contains vector embeddings.

Instance Attribute Details

#dimensions ⇒ Integer

The number of dimensions in each vector.

Returns:

• (Integer)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2266

class CreateVectorIndexAction < Struct.new(
  :index_name,
  :vector_attribute,
  :search_schema,
  :projection,
  :dimensions,
  :distance_function)
  SENSITIVE = []
  include Aws::Structure
end

#distance_function ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2266

class CreateVectorIndexAction < Struct.new(
  :index_name,
  :vector_attribute,
  :search_schema,
  :projection,
  :dimensions,
  :distance_function)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2266

class CreateVectorIndexAction < Struct.new(
  :index_name,
  :vector_attribute,
  :search_schema,
  :projection,
  :dimensions,
  :distance_function)
  SENSITIVE = []
  include Aws::Structure
end

#projection ⇒ Types::Projection

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

Returns:

• (Types::Projection)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2266

class CreateVectorIndexAction < Struct.new(
  :index_name,
  :vector_attribute,
  :search_schema,
  :projection,
  :dimensions,
  :distance_function)
  SENSITIVE = []
  include Aws::Structure
end

#search_schema ⇒ Array<Types::SearchSchemaElement>

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

Returns:

• (Array<Types::SearchSchemaElement>)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2266

class CreateVectorIndexAction < Struct.new(
  :index_name,
  :vector_attribute,
  :search_schema,
  :projection,
  :dimensions,
  :distance_function)
  SENSITIVE = []
  include Aws::Structure
end

#vector_attribute ⇒ Types::VectorAttributeDefinition

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

Returns:

• (Types::VectorAttributeDefinition)

# File 'lib/aws-sdk-dynamodb/types.rb', line 2266

class CreateVectorIndexAction < Struct.new(
  :index_name,
  :vector_attribute,
  :search_schema,
  :projection,
  :dimensions,
  :distance_function)
  SENSITIVE = []
  include Aws::Structure
end