Class: Aws::S3Vectors::Types::Index

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb

Overview

Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

The attributes of a vector index.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

Date and time when the vector index was created.

Returns:

  • (Time) 


471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 471

class Index < Struct.new(
  :vector_bucket_name,
  :index_name,
  :index_arn,
  :creation_time,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#data_type ⇒ String

The data type of the vectors inserted into the vector index.

Returns:

  • (String) 


471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 471

class Index < Struct.new(
  :vector_bucket_name,
  :index_name,
  :index_arn,
  :creation_time,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#dimension ⇒ Integer

The number of values in the vectors that are inserted into the vector index.

Returns:

  • (Integer) 


471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 471

class Index < Struct.new(
  :vector_bucket_name,
  :index_name,
  :index_arn,
  :creation_time,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#distance_metric ⇒ String

The distance metric to be used for similarity search.

Returns:

  • (String) 


471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 471

class Index < Struct.new(
  :vector_bucket_name,
  :index_name,
  :index_arn,
  :creation_time,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#index_arn ⇒ String

The Amazon Resource Name (ARN) of the vector index.

Returns:

  • (String) 


471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 471

class Index < Struct.new(
  :vector_bucket_name,
  :index_name,
  :index_arn,
  :creation_time,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

The name of the vector index.

Returns:

  • (String) 


471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 471

class Index < Struct.new(
  :vector_bucket_name,
  :index_name,
  :index_arn,
  :creation_time,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#metadata_configuration ⇒ Types::MetadataConfiguration

The metadata configuration for the vector index.

Returns:



471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 471

class Index < Struct.new(
  :vector_bucket_name,
  :index_name,
  :index_arn,
  :creation_time,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vector_bucket_name ⇒ String

The name of the vector bucket that contains the vector index.

Returns:

  • (String) 


471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 471

class Index < Struct.new(
  :vector_bucket_name,
  :index_name,
  :index_arn,
  :creation_time,
  :data_type,
  :dimension,
  :distance_metric,
  :metadata_configuration)
  SENSITIVE = []
  include Aws::Structure
end