strands.types.media

Media-related type definitions for the SDK.

These types are modeled after the Bedrock API.

• Bedrock docs: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_Types_Amazon_Bedrock_Runtime.html

DocumentFormat = Literal['pdf', 'csv', 'doc', 'docx', 'xls', 'xlsx', 'html', 'txt', 'md'] module-attribute

Supported document formats.

ImageFormat = Literal['png', 'jpeg', 'gif', 'webp'] module-attribute

Supported image formats.

VideoFormat = Literal['flv', 'mkv', 'mov', 'mpeg', 'mpg', 'mp4', 'three_gp', 'webm', 'wmv'] module-attribute

Supported video formats.

CitationsConfig

Bases: TypedDict

Configuration for enabling citations on documents.

Attributes:

Name	Type	Description
enabled	bool	Whether citations are enabled for this document.

Source code in strands/types/citations.py

class CitationsConfig(TypedDict):
    """Configuration for enabling citations on documents.

    Attributes:
        enabled: Whether citations are enabled for this document.
    """

    enabled: bool

DocumentContent

Bases: TypedDict

A document to include in a message.

Attributes:

Name	Type	Description
format	Literal['pdf', 'csv', 'doc', 'docx', 'xls', 'xlsx', 'html', 'txt', 'md']	The format of the document (e.g., "pdf", "txt").
name	str	The name of the document.
source	DocumentSource	The source containing the document's binary content.

Source code in strands/types/media.py

class DocumentContent(TypedDict, total=False):
    """A document to include in a message.

    Attributes:
        format: The format of the document (e.g., "pdf", "txt").
        name: The name of the document.
        source: The source containing the document's binary content.
    """

    format: Literal["pdf", "csv", "doc", "docx", "xls", "xlsx", "html", "txt", "md"]
    name: str
    source: DocumentSource
    citations: Optional[CitationsConfig]
    context: Optional[str]

DocumentSource

Bases: TypedDict

Contains the content of a document.

Attributes:

Name	Type	Description
bytes	bytes	The binary content of the document.

Source code in strands/types/media.py

class DocumentSource(TypedDict):
    """Contains the content of a document.

    Attributes:
        bytes: The binary content of the document.
    """

    bytes: bytes

ImageContent

Bases: TypedDict

An image to include in a message.

Attributes:

Name	Type	Description
format	ImageFormat	The format of the image (e.g., "png", "jpeg").
source	ImageSource	The source containing the image's binary content.

Source code in strands/types/media.py

class ImageContent(TypedDict):
    """An image to include in a message.

    Attributes:
        format: The format of the image (e.g., "png", "jpeg").
        source: The source containing the image's binary content.
    """

    format: ImageFormat
    source: ImageSource

ImageSource

Bases: TypedDict

Contains the content of an image.

Attributes:

Name	Type	Description
bytes	bytes	The binary content of the image.

Source code in strands/types/media.py

class ImageSource(TypedDict):
    """Contains the content of an image.

    Attributes:
        bytes: The binary content of the image.
    """

    bytes: bytes

VideoContent

Bases: TypedDict

A video to include in a message.

Attributes:

Name	Type	Description
format	VideoFormat	The format of the video (e.g., "mp4", "avi").
source	VideoSource	The source containing the video's binary content.

Source code in strands/types/media.py

class VideoContent(TypedDict):
    """A video to include in a message.

    Attributes:
        format: The format of the video (e.g., "mp4", "avi").
        source: The source containing the video's binary content.
    """

    format: VideoFormat
    source: VideoSource

VideoSource

Bases: TypedDict

Contains the content of a video.

Attributes:

Name	Type	Description
bytes	bytes	The binary content of the video.

Source code in strands/types/media.py

class VideoSource(TypedDict):
    """Contains the content of a video.

    Attributes:
        bytes: The binary content of the video.
    """

    bytes: bytes