Class: Aws::S3Vectors::Types::PutInputVector

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 to add to a vector index.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data ⇒ Types::VectorData

The vector data of the vector.

Vector dimensions must match the dimension count that's configured for the vector index.

  • For the cosine distance metric, zero vectors (vectors containing all zeros) aren't allowed.

  • For both cosine and euclidean distance metrics, vector data must contain only valid floating-point values. Invalid values such as NaN (Not a Number) or Infinity aren't allowed.

Returns:



911
912
913
914
915
916
917
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 911

class PutInputVector < Struct.new(
  :key,
  :data,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ String

The name of the vector. The key uniquely identifies the vector in a vector index.

Returns:

  • (String) 


911
912
913
914
915
916
917
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 911

class PutInputVector < Struct.new(
  :key,
  :data,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end

#metadata ⇒ Hash, ...

Metadata about the vector. All metadata entries undergo validation to ensure they meet the format requirements for size and data types.

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


911
912
913
914
915
916
917
 
# File 'gems/aws-sdk-s3vectors/lib/aws-sdk-s3vectors/types.rb', line 911

class PutInputVector < Struct.new(
  :key,
  :data,
  :metadata)
  SENSITIVE = []
  include Aws::Structure
end