Class: Aws::BedrockAgentCore::Types::SearchCriteria

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentCore::Types::SearchCriteria

Defined in:

gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb

Overview

Contains search criteria for retrieving memory records.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:search_query]

Instance Attribute Summary

• #memory_strategy_id ⇒ String

  The memory strategy identifier to filter memory records by.

• #metadata_filters ⇒ Array<Types::MemoryMetadataFilterExpression>

  Filters to apply to metadata associated with a memory.

• #search_query ⇒ String

  The search query to use for finding relevant memory records.

• #top_k ⇒ Integer

  The maximum number of top-scoring memory records to return.

Instance Attribute Details

#memory_strategy_id ⇒ String

The memory strategy identifier to filter memory records by.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 9531

class SearchCriteria < Struct.new(
  :search_query,
  :memory_strategy_id,
  :top_k,
  :metadata_filters)
  SENSITIVE = [:search_query]
  include Aws::Structure
end

#metadata_filters ⇒ Array<Types::MemoryMetadataFilterExpression>

Filters to apply to metadata associated with a memory.

Returns:

• (Array<Types::MemoryMetadataFilterExpression>)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 9531

class SearchCriteria < Struct.new(
  :search_query,
  :memory_strategy_id,
  :top_k,
  :metadata_filters)
  SENSITIVE = [:search_query]
  include Aws::Structure
end

#search_query ⇒ String

The search query to use for finding relevant memory records.

Returns:

• (String)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 9531

class SearchCriteria < Struct.new(
  :search_query,
  :memory_strategy_id,
  :top_k,
  :metadata_filters)
  SENSITIVE = [:search_query]
  include Aws::Structure
end

#top_k ⇒ Integer

The maximum number of top-scoring memory records to return. This value is used for semantic search ranking.

Returns:

• (Integer)

# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 9531

class SearchCriteria < Struct.new(
  :search_query,
  :memory_strategy_id,
  :top_k,
  :metadata_filters)
  SENSITIVE = [:search_query]
  include Aws::Structure
end