/AWS1/CL_QQBTEXTOUTPUTEVENT¶
An output event for an AI-generated response in an Amazon Q Business web experience.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_systemmessagetype TYPE /AWS1/QQBSYSTEMMESSAGETYPE /AWS1/QQBSYSTEMMESSAGETYPE¶
The type of AI-generated message in a
TextOutputEvent. Amazon Q Business currently supports two types of messages:
RESPONSE- The Amazon Q Business system response.
GROUNDED_RESPONSE- The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.
iv_conversationid TYPE /AWS1/QQBCONVERSATIONID /AWS1/QQBCONVERSATIONID¶
The identifier of the conversation with which the text output event is associated.
iv_usermessageid TYPE /AWS1/QQBMESSAGEID /AWS1/QQBMESSAGEID¶
The identifier of an end user message in a
TextOutputEvent.
iv_systemmessageid TYPE /AWS1/QQBMESSAGEID /AWS1/QQBMESSAGEID¶
The identifier of an AI-generated message in a
TextOutputEvent.
iv_systemmessage TYPE /AWS1/QQBSTRING /AWS1/QQBSTRING¶
An AI-generated message in a
TextOutputEvent.
Queryable Attributes¶
systemMessageType¶
The type of AI-generated message in a
TextOutputEvent. Amazon Q Business currently supports two types of messages:
RESPONSE- The Amazon Q Business system response.
GROUNDED_RESPONSE- The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SYSTEMMESSAGETYPE() |
Getter for SYSTEMMESSAGETYPE, with configurable default |
ASK_SYSTEMMESSAGETYPE() |
Getter for SYSTEMMESSAGETYPE w/ exceptions if field has no v |
HAS_SYSTEMMESSAGETYPE() |
Determine if SYSTEMMESSAGETYPE has a value |
conversationId¶
The identifier of the conversation with which the text output event is associated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONVERSATIONID() |
Getter for CONVERSATIONID, with configurable default |
ASK_CONVERSATIONID() |
Getter for CONVERSATIONID w/ exceptions if field has no valu |
HAS_CONVERSATIONID() |
Determine if CONVERSATIONID has a value |
userMessageId¶
The identifier of an end user message in a
TextOutputEvent.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERMESSAGEID() |
Getter for USERMESSAGEID, with configurable default |
ASK_USERMESSAGEID() |
Getter for USERMESSAGEID w/ exceptions if field has no value |
HAS_USERMESSAGEID() |
Determine if USERMESSAGEID has a value |
systemMessageId¶
The identifier of an AI-generated message in a
TextOutputEvent.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SYSTEMMESSAGEID() |
Getter for SYSTEMMESSAGEID, with configurable default |
ASK_SYSTEMMESSAGEID() |
Getter for SYSTEMMESSAGEID w/ exceptions if field has no val |
HAS_SYSTEMMESSAGEID() |
Determine if SYSTEMMESSAGEID has a value |
systemMessage¶
An AI-generated message in a
TextOutputEvent.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SYSTEMMESSAGE() |
Getter for SYSTEMMESSAGE, with configurable default |
ASK_SYSTEMMESSAGE() |
Getter for SYSTEMMESSAGE w/ exceptions if field has no value |
HAS_SYSTEMMESSAGE() |
Determine if SYSTEMMESSAGE has a value |