InstructionCollection
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.
Contents
- customInstructions
-
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.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 1000.
Pattern:
[\s\S]*Required: No
- examples
-
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.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 1000.
Pattern:
[\s\S]*Required: No
- identity
-
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.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 1000.
Pattern:
[\s\S]*Required: No
- outputStyle
-
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.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 1000.
Pattern:
[\s\S]*Required: No
- perspective
-
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.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 1000.
Pattern:
[\s\S]*Required: No
- responseLength
-
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.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 1000.
Pattern:
[\s\S]*Required: No
- targetAudience
-
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.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 1000.
Pattern:
[\s\S]*Required: No
- tone
-
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.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 1000.
Pattern:
[\s\S]*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
