TextOutputEvent - Amazon Q Business

TextOutputEvent

An output event for an AI-generated response in an Amazon Q Business web experience.

Contents

conversationId

The identifier of the conversation with which the text output event is associated.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Required: No

systemMessage

An AI-generated message in a TextOutputEvent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

systemMessageId

The identifier of an AI-generated message in a TextOutputEvent.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Required: No

userMessageId

The identifier of an end user message in a TextOutputEvent.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]{35}$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: