Skip to content

TextSegment

Source code in docs_src/capo_qbusiness/types/text_segment.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class TextSegment(TypedDict, closed=True):
    begin_offset: NotRequired["capo_qbusiness.types.integer.Integer"]
    """<p>The zero-based location in the response string where the source attribution starts.</p>"""
    end_offset: NotRequired["capo_qbusiness.types.integer.Integer"]
    """<p>The zero-based location in the response string where the source attribution ends.</p>"""
    snippet_excerpt: NotRequired["capo_qbusiness.types.snippet_excerpt.SnippetExcerpt"]
    """<p>The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.</p>"""
    media_id: NotRequired[
        "capo_qbusiness.types.source_attribution_media_id.SourceAttributionMediaId"
    ]
    """<p>The identifier of the media object associated with the text segment in the source attribution.</p>"""
    media_mime_type: NotRequired["capo_qbusiness.types.string.String"]
    """<p>The MIME type (image/png) of the media object associated with the text segment in the source attribution.</p>"""
    source_details: NotRequired["capo_qbusiness.types.source_details.SourceDetails"]
    """<p>Source information for a segment of extracted text, including its media type.</p>"""

begin_offset instance-attribute 

begin_offset: NotRequired[Integer]

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

end_offset instance-attribute 

end_offset: NotRequired[Integer]

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

media_id instance-attribute 

media_id: NotRequired[SourceAttributionMediaId]

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

media_mime_type instance-attribute 

media_mime_type: NotRequired[String]

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

snippet_excerpt instance-attribute 

snippet_excerpt: NotRequired[SnippetExcerpt]

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

source_details instance-attribute 

source_details: NotRequired[SourceDetails]

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