Class: Aws::BedrockAgentRuntime::Types::KnowledgeBaseRetrieveAndGenerateConfiguration

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

Overview

Contains details about the resource being queried.

This data type is used in the following API operations:

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#generation_configuration ⇒ Types::GenerationConfiguration

Contains configurations for response generation based on the knowledge base query results.

Returns:



2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2012

class KnowledgeBaseRetrieveAndGenerateConfiguration < Struct.new(
  :generation_configuration,
  :knowledge_base_id,
  :model_arn,
  :orchestration_configuration,
  :retrieval_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_id ⇒ String

The unique identifier of the knowledge base that is queried.

Returns:

  • (String) 


2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2012

class KnowledgeBaseRetrieveAndGenerateConfiguration < Struct.new(
  :generation_configuration,
  :knowledge_base_id,
  :model_arn,
  :orchestration_configuration,
  :retrieval_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#model_arn ⇒ String

The ARN of the foundation model or inference profile used to generate a response.

Returns:

  • (String) 


2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2012

class KnowledgeBaseRetrieveAndGenerateConfiguration < Struct.new(
  :generation_configuration,
  :knowledge_base_id,
  :model_arn,
  :orchestration_configuration,
  :retrieval_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#orchestration_configuration ⇒ Types::OrchestrationConfiguration

Settings for how the model processes the prompt prior to retrieval and generation.

Returns:



2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2012

class KnowledgeBaseRetrieveAndGenerateConfiguration < Struct.new(
  :generation_configuration,
  :knowledge_base_id,
  :model_arn,
  :orchestration_configuration,
  :retrieval_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#retrieval_configuration ⇒ Types::KnowledgeBaseRetrievalConfiguration

Contains configurations for how to retrieve and return the knowledge base query.

Returns:



2012
2013
2014
2015
2016
2017
2018
2019
2020
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2012

class KnowledgeBaseRetrieveAndGenerateConfiguration < Struct.new(
  :generation_configuration,
  :knowledge_base_id,
  :model_arn,
  :orchestration_configuration,
  :retrieval_configuration)
  SENSITIVE = []
  include Aws::Structure
end