Class: Aws::BedrockAgentRuntime::Types::AgenticRetrieveConfiguration

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

Overview

Configuration settings for the agentic retrieval operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#foundation_model_configuration ⇒ Types::FoundationModelConfiguration

The foundation model configuration. Required when foundationModelType is CUSTOM.

Returns:



606
607
608
609
610
611
612
613
614
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 606

class AgenticRetrieveConfiguration < Struct.new(
  :foundation_model_configuration,
  :foundation_model_type,
  :max_agent_iteration,
  :reranking_configuration,
  :reranking_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#foundation_model_type ⇒ String

The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.

Returns:

  • (String) 


606
607
608
609
610
611
612
613
614
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 606

class AgenticRetrieveConfiguration < Struct.new(
  :foundation_model_configuration,
  :foundation_model_type,
  :max_agent_iteration,
  :reranking_configuration,
  :reranking_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_agent_iteration ⇒ Integer

The maximum number of agent iterations for retrieval.

Returns:

  • (Integer) 


606
607
608
609
610
611
612
613
614
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 606

class AgenticRetrieveConfiguration < Struct.new(
  :foundation_model_configuration,
  :foundation_model_type,
  :max_agent_iteration,
  :reranking_configuration,
  :reranking_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#reranking_configuration ⇒ Types::AgenticRetrieveRerankingConfiguration

The reranking model configuration. Required when rerankingModelType is CUSTOM.

Returns:



606
607
608
609
610
611
612
613
614
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 606

class AgenticRetrieveConfiguration < Struct.new(
  :foundation_model_configuration,
  :foundation_model_type,
  :max_agent_iteration,
  :reranking_configuration,
  :reranking_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#reranking_model_type ⇒ String

The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.

Returns:

  • (String) 


606
607
608
609
610
611
612
613
614
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 606

class AgenticRetrieveConfiguration < Struct.new(
  :foundation_model_configuration,
  :foundation_model_type,
  :max_agent_iteration,
  :reranking_configuration,
  :reranking_model_type)
  SENSITIVE = []
  include Aws::Structure
end