Skip to content

RetrievalResultContent

Source code in docs_src/capo_bedrock_agent_runtime/types/retrieval_result_content.py
class RetrievalResultContent(TypedDict, closed=True):
    type: NotRequired[
        "capo_bedrock_agent_runtime.types.retrieval_result_content_type.RetrievalResultContentType"
    ]
    """<p>The type of content in the retrieval result.</p>"""
    text: "str"
    """<p>The cited text from the data source.</p>"""
    byte_content: NotRequired["str"]
    """<p>A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: <code>data:image/jpeg;base64,${base64-encoded string}</code>.</p>"""
    video: NotRequired["capo_bedrock_agent_runtime.types.video_segment.VideoSegment"]
    """<p>Video segment information when the retrieval result contains video content.</p>"""
    audio: NotRequired["capo_bedrock_agent_runtime.types.audio_segment.AudioSegment"]
    """<p>Audio segment information when the retrieval result contains audio content.</p>"""
    row: NotRequired[
        "capo_bedrock_agent_runtime.types.retrieval_result_content_row.RetrievalResultContentRow"
    ]
    """<p>Specifies information about the rows with the cells to return in retrieval.</p>"""

audio instance-attribute

audio: NotRequired[AudioSegment]

Audio segment information when the retrieval result contains audio content.

byte_content instance-attribute

byte_content: NotRequired[str]

A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,${base64-encoded string}.

row instance-attribute

row: NotRequired[RetrievalResultContentRow]

Specifies information about the rows with the cells to return in retrieval.

text instance-attribute

text: str

The cited text from the data source.

type instance-attribute

type: NotRequired[RetrievalResultContentType]

The type of content in the retrieval result.

video instance-attribute

video: NotRequired[VideoSegment]

Video segment information when the retrieval result contains video content.