Class: Aws::BedrockAgent::Types::RetrievalInstructionContent

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

Overview

The instruction content, as a set of named fields. Every field is optional; at least one must be present. Service-side validation enforces per-field and aggregate size limits.

See Also:

Constant Summary collapse

SENSITIVE = 
[:retrieval_guidance, :persona, :answer_format, :answer_policy]

Instance Attribute Summary collapse

Instance Attribute Details

#answer_format ⇒ String

How the answer is structured, including how sources are cited.

Returns:

  • (String) 


10556
10557
10558
10559
10560
10561
10562
10563
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 10556

class RetrievalInstructionContent < Struct.new(
  :retrieval_guidance,
  :persona,
  :answer_format,
  :answer_policy)
  SENSITIVE = [:retrieval_guidance, :persona, :answer_format, :answer_policy]
  include Aws::Structure
end

#answer_policy ⇒ String

Whether and how to answer: how strongly an answer must be supported, and what to do with questions outside scope.

Returns:

  • (String) 


10556
10557
10558
10559
10560
10561
10562
10563
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 10556

class RetrievalInstructionContent < Struct.new(
  :retrieval_guidance,
  :persona,
  :answer_format,
  :answer_policy)
  SENSITIVE = [:retrieval_guidance, :persona, :answer_format, :answer_policy]
  include Aws::Structure
end

#persona ⇒ String

Who the assistant is: identity, tone and language.

Returns:

  • (String) 


10556
10557
10558
10559
10560
10561
10562
10563
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 10556

class RetrievalInstructionContent < Struct.new(
  :retrieval_guidance,
  :persona,
  :answer_format,
  :answer_policy)
  SENSITIVE = [:retrieval_guidance, :persona, :answer_format, :answer_policy]
  include Aws::Structure
end

#retrieval_guidance ⇒ String

How to interpret and decompose the question, and what to prioritise when searching.

Returns:

  • (String) 


10556
10557
10558
10559
10560
10561
10562
10563
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/types.rb', line 10556

class RetrievalInstructionContent < Struct.new(
  :retrieval_guidance,
  :persona,
  :answer_format,
  :answer_policy)
  SENSITIVE = [:retrieval_guidance, :persona, :answer_format, :answer_policy]
  include Aws::Structure
end