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

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

Overview

Contains details about the resource being queried.

This data type is used in the following API operations:

  • Retrieve request][1

    – in the knowledgeBaseConfiguration field

  • RetrieveAndGenerate request][2

    – in the

    knowledgeBaseConfiguration field

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax [2]: docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax

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:



3299
3300
3301
3302
3303
3304
3305
3306
3307
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3299

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) 


3299
3300
3301
3302
3303
3304
3305
3306
3307
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3299

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.

[1]: docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html

Returns:

  • (String) 


3299
3300
3301
3302
3303
3304
3305
3306
3307
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3299

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:



3299
3300
3301
3302
3303
3304
3305
3306
3307
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3299

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:



3299
3300
3301
3302
3303
3304
3305
3306
3307
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3299

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