TextSegment

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

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

This member has been deprecated.

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

This member has been deprecated.

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.

Required: No

sourceDetails

Source information for a segment of extracted text, including its media type.

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Contents