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

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::KnowledgeBaseRetrieveAndGenerateConfiguration

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:

• Retrieve request – in the knowledgeBaseConfiguration field

• RetrieveAndGenerate request – in the knowledgeBaseConfiguration field

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #generation_configuration ⇒ Types::GenerationConfiguration

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

• #knowledge_base_id ⇒ String

  The unique identifier of the knowledge base that is queried.

• #model_arn ⇒ String

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

• #orchestration_configuration ⇒ Types::OrchestrationConfiguration

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

• #retrieval_configuration ⇒ Types::KnowledgeBaseRetrievalConfiguration

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

Instance Attribute Details

#generation_configuration ⇒ Types::GenerationConfiguration

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

Returns:

• (Types::GenerationConfiguration)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2843

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)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2843

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)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2843

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:

• (Types::OrchestrationConfiguration)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2843

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:

• (Types::KnowledgeBaseRetrievalConfiguration)

# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2843

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