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

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

Overview

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) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 533

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

#data_type ⇒ String

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

Returns:

  • (String) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 533

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

#dimension ⇒ Integer

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

Returns:

  • (Integer) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 533

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

#distance_metric ⇒ String

The distance metric to be used for similarity search.

Returns:

  • (String) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 533

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

#encryption_configuration ⇒ Types::EncryptionConfiguration

The encryption configuration for a vector index. By default, if you don't specify, all new vectors in the vector index will use the encryption configuration of the vector bucket.

Returns:



533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 533

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

#index_arn ⇒ String

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

Returns:

  • (String) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 533

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

#index_mode ⇒ String

The mode that determines how the vector index processes queries.

Valid values:

  • CLASSIC - Applies metadata filters during the vector search.

  • ENHANCED - Applies metadata filters before the vector search.

Returns:

  • (String) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 533

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

#index_name ⇒ String

The name of the vector index.

Returns:

  • (String) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 533

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

#metadata_configuration ⇒ Types::MetadataConfiguration

The metadata configuration for the vector index.

Returns:



533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 533

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

#vector_bucket_name ⇒ String

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

Returns:

  • (String) 


533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 533

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