Class: Aws::QBusiness::Types::InstructionCollection

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

Overview

A set of instructions that define how Amazon Q Business should generate and format responses to user queries. This collection includes parameters for controlling response characteristics such as length, audience targeting, perspective, style, identity, tone, and custom instructions.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_instructions ⇒ String

Allows administrators to provide specific, custom instructions that guide how Amazon Q Business should respond in particular scenarios or to certain types of queries, enabling fine-grained control over response generation.

Returns:

  • (String) 


5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5804

class InstructionCollection < Struct.new(
  :response_length,
  :target_audience,
  :perspective,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :examples)
  SENSITIVE = []
  include Aws::Structure
end

#examples ⇒ String

Provides sample responses or templates that Amazon Q Business can reference when generating responses, helping to establish consistent patterns and formats for different types of user queries.

Returns:

  • (String) 


5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5804

class InstructionCollection < Struct.new(
  :response_length,
  :target_audience,
  :perspective,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :examples)
  SENSITIVE = []
  include Aws::Structure
end

#identity ⇒ String

Defines the persona or identity that Amazon Q Business should adopt when responding to users, allowing for customization of the assistant's character, role, or representation within an organization.

Returns:

  • (String) 


5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5804

class InstructionCollection < Struct.new(
  :response_length,
  :target_audience,
  :perspective,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :examples)
  SENSITIVE = []
  include Aws::Structure
end

#output_style ⇒ String

Specifies the formatting and structural style of responses, such as bullet points, paragraphs, step-by-step instructions, or other organizational formats that enhance readability and comprehension.

Returns:

  • (String) 


5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5804

class InstructionCollection < Struct.new(
  :response_length,
  :target_audience,
  :perspective,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :examples)
  SENSITIVE = []
  include Aws::Structure
end

#perspective ⇒ String

Determines the point of view or perspective from which Amazon Q Business generates responses, such as first-person, second-person, or third-person perspective, affecting how information is presented to users.

Returns:

  • (String) 


5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5804

class InstructionCollection < Struct.new(
  :response_length,
  :target_audience,
  :perspective,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :examples)
  SENSITIVE = []
  include Aws::Structure
end

#response_length ⇒ String

Specifies the desired length of responses generated by Amazon Q Business. This parameter allows administrators to control whether responses are concise and brief or more detailed and comprehensive.

Returns:

  • (String) 


5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5804

class InstructionCollection < Struct.new(
  :response_length,
  :target_audience,
  :perspective,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :examples)
  SENSITIVE = []
  include Aws::Structure
end

#target_audience ⇒ String

Defines the intended audience for the responses, allowing Amazon Q Business to tailor its language, terminology, and explanations appropriately. This could range from technical experts to general users with varying levels of domain knowledge.

Returns:

  • (String) 


5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5804

class InstructionCollection < Struct.new(
  :response_length,
  :target_audience,
  :perspective,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :examples)
  SENSITIVE = []
  include Aws::Structure
end

#tone ⇒ String

Controls the emotional tone and communication style of responses, such as formal, casual, technical, friendly, or professional, to align with organizational communication standards and user expectations.

Returns:

  • (String) 


5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5804

class InstructionCollection < Struct.new(
  :response_length,
  :target_audience,
  :perspective,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :examples)
  SENSITIVE = []
  include Aws::Structure
end