Class: Aws::DynamoDB::Types::SearchVectorsInput

Inherits:

Struct

• Object
• Struct
• Aws::DynamoDB::Types::SearchVectorsInput

Includes:

Structure

Defined in:

lib/aws-sdk-dynamodb/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #expression_attribute_names ⇒ Hash<String,String>

  One or more substitution tokens for attribute names in an expression.

• #expression_attribute_values ⇒ Hash<String,Types::AttributeValue>

  One or more values that can be substituted in an expression.

• #index_name ⇒ String

  The name of the vector index to search.

• #projection_expression ⇒ String

  A string that identifies one or more attributes to retrieve from the index.

• #return_consumed_capacity ⇒ String

  Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:.

• #search_condition_expression ⇒ String

  A condition expression used to filter the vector search results.

• #search_vector ⇒ Array<Types::AttributeValue>

  The search vector to compare against the indexed vectors.

• #table_name ⇒ String

  The name or Amazon Resource Name (ARN) of the table containing the vector index.

• #top_k ⇒ Integer

  The number of most similar results to return.

Instance Attribute Details

#expression_attribute_names ⇒ Hash<String,String>

One or more substitution tokens for attribute names in an expression. Use the # character in an expression to dereference an attribute name.

Returns:

• (Hash<String,String>)

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

class SearchVectorsInput < Struct.new(
  :table_name,
  :index_name,
  :return_consumed_capacity,
  :expression_attribute_names,
  :expression_attribute_values,
  :projection_expression,
  :search_vector,
  :search_condition_expression,
  :top_k)
  SENSITIVE = []
  include Aws::Structure
end

#expression_attribute_values ⇒ Hash<String,Types::AttributeValue>

One or more values that can be substituted in an expression. Use the : character in an expression to dereference an attribute value.

Returns:

• (Hash<String,Types::AttributeValue>)

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

class SearchVectorsInput < Struct.new(
  :table_name,
  :index_name,
  :return_consumed_capacity,
  :expression_attribute_names,
  :expression_attribute_values,
  :projection_expression,
  :search_vector,
  :search_condition_expression,
  :top_k)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

The name of the vector index to search. The index must be in the ACTIVE state.

Returns:

• (String)

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

class SearchVectorsInput < Struct.new(
  :table_name,
  :index_name,
  :return_consumed_capacity,
  :expression_attribute_names,
  :expression_attribute_values,
  :projection_expression,
  :search_vector,
  :search_condition_expression,
  :top_k)
  SENSITIVE = []
  include Aws::Structure
end

#projection_expression ⇒ String

A string that identifies one or more attributes to retrieve from the index. Separate attribute names with commas. If not specified, the operation returns all attributes projected into the vector index.

Only attributes projected into the vector index can be retrieved.

Returns:

• (String)

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

class SearchVectorsInput < Struct.new(
  :table_name,
  :index_name,
  :return_consumed_capacity,
  :expression_attribute_names,
  :expression_attribute_values,
  :projection_expression,
  :search_vector,
  :search_condition_expression,
  :top_k)
  SENSITIVE = []
  include Aws::Structure
end

#return_consumed_capacity ⇒ String

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

• INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

  Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

• TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

• NONE - No ConsumedCapacity details are included in the response.

Returns:

• (String)

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

class SearchVectorsInput < Struct.new(
  :table_name,
  :index_name,
  :return_consumed_capacity,
  :expression_attribute_names,
  :expression_attribute_values,
  :projection_expression,
  :search_vector,
  :search_condition_expression,
  :top_k)
  SENSITIVE = []
  include Aws::Structure
end

#search_condition_expression ⇒ String

A condition expression used to filter the vector search results. The expression can reference attributes defined in the vector index search schema, including HASH and INLINE_FILTER key elements.

Only the equality operator (=) is supported for HASH attributes. Comparison and range operators are supported for INLINE_FILTER attributes. Only top-level attributes from the search schema can be referenced.

Returns:

• (String)

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

class SearchVectorsInput < Struct.new(
  :table_name,
  :index_name,
  :return_consumed_capacity,
  :expression_attribute_names,
  :expression_attribute_values,
  :projection_expression,
  :search_vector,
  :search_condition_expression,
  :top_k)
  SENSITIVE = []
  include Aws::Structure
end

#search_vector ⇒ Array<Types::AttributeValue>

The search vector to compare against the indexed vectors. Each element is a 32-bit IEEE-754 floating point number, provided in DynamoDB list format.

The number of dimensions must match the number of dimensions configured for the vector index.

Returns:

• (Array<Types::AttributeValue>)

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

class SearchVectorsInput < Struct.new(
  :table_name,
  :index_name,
  :return_consumed_capacity,
  :expression_attribute_names,
  :expression_attribute_values,
  :projection_expression,
  :search_vector,
  :search_condition_expression,
  :top_k)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

The name or Amazon Resource Name (ARN) of the table containing the vector index.

Returns:

• (String)

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

class SearchVectorsInput < Struct.new(
  :table_name,
  :index_name,
  :return_consumed_capacity,
  :expression_attribute_names,
  :expression_attribute_values,
  :projection_expression,
  :search_vector,
  :search_condition_expression,
  :top_k)
  SENSITIVE = []
  include Aws::Structure
end

#top_k ⇒ Integer

The number of most similar results to return.

Returns:

• (Integer)

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

class SearchVectorsInput < Struct.new(
  :table_name,
  :index_name,
  :return_consumed_capacity,
  :expression_attribute_names,
  :expression_attribute_values,
  :projection_expression,
  :search_vector,
  :search_condition_expression,
  :top_k)
  SENSITIVE = []
  include Aws::Structure
end