Skip to content

InstructionCollectionDict

Dictionary Type

InstructionCollectionDict

Bases: TypedDict

Dictionary form of InstructionCollection.

Attributes

custom_instructions instance-attribute
custom_instructions: str | 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.

examples instance-attribute
examples: str | 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.

identity instance-attribute
identity: str | 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.

output_style instance-attribute
output_style: str | 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.

perspective instance-attribute
perspective: str | 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.

response_length instance-attribute
response_length: str | 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.

target_audience instance-attribute
target_audience: str | 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.

tone instance-attribute
tone: str | 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.