Skip to content

/AWS1/CL_QQBINSTRUCTIONCOLL

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_responselength TYPE /AWS1/QQBINSTRUCTION /AWS1/QQBINSTRUCTION

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.

iv_targetaudience TYPE /AWS1/QQBINSTRUCTION /AWS1/QQBINSTRUCTION

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.

iv_perspective TYPE /AWS1/QQBINSTRUCTION /AWS1/QQBINSTRUCTION

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.

iv_outputstyle TYPE /AWS1/QQBINSTRUCTION /AWS1/QQBINSTRUCTION

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.

iv_identity TYPE /AWS1/QQBINSTRUCTION /AWS1/QQBINSTRUCTION

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.

iv_tone TYPE /AWS1/QQBINSTRUCTION /AWS1/QQBINSTRUCTION

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.

iv_custominstructions TYPE /AWS1/QQBINSTRUCTION /AWS1/QQBINSTRUCTION

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.

iv_examples TYPE /AWS1/QQBINSTRUCTION /AWS1/QQBINSTRUCTION

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.

Queryable Attributes

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.

Accessible with the following methods

Method Description
GET_RESPONSELENGTH() Getter for RESPONSELENGTH, with configurable default
ASK_RESPONSELENGTH() Getter for RESPONSELENGTH w/ exceptions if field has no valu
HAS_RESPONSELENGTH() Determine if RESPONSELENGTH has a value

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.

Accessible with the following methods

Method Description
GET_TARGETAUDIENCE() Getter for TARGETAUDIENCE, with configurable default
ASK_TARGETAUDIENCE() Getter for TARGETAUDIENCE w/ exceptions if field has no valu
HAS_TARGETAUDIENCE() Determine if TARGETAUDIENCE has a value

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.

Accessible with the following methods

Method Description
GET_PERSPECTIVE() Getter for PERSPECTIVE, with configurable default
ASK_PERSPECTIVE() Getter for PERSPECTIVE w/ exceptions if field has no value
HAS_PERSPECTIVE() Determine if PERSPECTIVE has a value

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.

Accessible with the following methods

Method Description
GET_OUTPUTSTYLE() Getter for OUTPUTSTYLE, with configurable default
ASK_OUTPUTSTYLE() Getter for OUTPUTSTYLE w/ exceptions if field has no value
HAS_OUTPUTSTYLE() Determine if OUTPUTSTYLE has a value

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.

Accessible with the following methods

Method Description
GET_IDENTITY() Getter for IDENTITY, with configurable default
ASK_IDENTITY() Getter for IDENTITY w/ exceptions if field has no value
HAS_IDENTITY() Determine if IDENTITY has a value

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.

Accessible with the following methods

Method Description
GET_TONE() Getter for TONE, with configurable default
ASK_TONE() Getter for TONE w/ exceptions if field has no value
HAS_TONE() Determine if TONE has a value

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.

Accessible with the following methods

Method Description
GET_CUSTOMINSTRUCTIONS() Getter for CUSTOMINSTRUCTIONS, with configurable default
ASK_CUSTOMINSTRUCTIONS() Getter for CUSTOMINSTRUCTIONS w/ exceptions if field has no
HAS_CUSTOMINSTRUCTIONS() Determine if CUSTOMINSTRUCTIONS has a value

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.

Accessible with the following methods

Method Description
GET_EXAMPLES() Getter for EXAMPLES, with configurable default
ASK_EXAMPLES() Getter for EXAMPLES w/ exceptions if field has no value
HAS_EXAMPLES() Determine if EXAMPLES has a value