Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

TextSegment - Amazon Q Business

TextSegment

Provides information about a text extract in a chat response that can be attributed to a source document.

Contents

beginOffset

The zero-based location in the response string where the source attribution starts.

Type: Integer

Required: No

endOffset

The zero-based location in the response string where the source attribution ends.

Type: Integer

Required: No

mediaId

The identifier of the media object associated with the text segment in the source attribution.

Type: String

Length Constraints: Fixed length of 36.

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

Required: No

mediaMimeType

The MIME type (image/png) of the media object associated with the text segment in the source attribution.

Type: String

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

Required: No

snippetExcerpt

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

Type: SnippetExcerpt object

Required: No

See Also

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

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.