InstructionCollection¶
Structure Class¶
dataclass
¶
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.
Attributes¶
class-attribute
instance-attribute
¶
custom_instructions: str | None = None
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.
class-attribute
instance-attribute
¶
examples: str | None = None
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.
class-attribute
instance-attribute
¶
identity: str | None = None
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.
class-attribute
instance-attribute
¶
output_style: str | None = None
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.
class-attribute
instance-attribute
¶
perspective: str | None = None
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.
class-attribute
instance-attribute
¶
response_length: str | None = None
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.
class-attribute
instance-attribute
¶
target_audience: str | None = None
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.
class-attribute
instance-attribute
¶
tone: str | None = None
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.