DocumentSource module-attribute

DocumentSource = Union[DocumentSourceBytes | DocumentSourceS3Location | DocumentSourceText | DocumentSourceContent | DocumentSourceUnknown]

Contains the content of a document.

Union Members

DocumentSourceBytes dataclass

The raw bytes for the document. If you use an Amazon Web Services SDK, you don't need to encode the bytes in base64.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class DocumentSourceBytes:
    """The raw bytes for the document. If you use an Amazon Web Services SDK,
    you don't need to encode the bytes in base64.
    """

    value: bytes

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_DOCUMENT_SOURCE, self)

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_blob(_SCHEMA_DOCUMENT_SOURCE.members["bytes"], self.value)

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(
            value=deserializer.read_blob(_SCHEMA_DOCUMENT_SOURCE.members["bytes"])
        )

DocumentSourceS3Location dataclass

The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see Supported models and features for Converse.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class DocumentSourceS3Location:
    """The location of a document object in an Amazon S3 bucket. To see which
    models support S3 uploads, see [Supported models and features for
    Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html).
    """

    value: S3Location

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_DOCUMENT_SOURCE, self)

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_struct(
            _SCHEMA_DOCUMENT_SOURCE.members["s3Location"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(value=S3Location.deserialize(deserializer))

DocumentSourceText dataclass

The text content of the document source.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class DocumentSourceText:
    """The text content of the document source."""

    value: str

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_DOCUMENT_SOURCE, self)

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_string(_SCHEMA_DOCUMENT_SOURCE.members["text"], self.value)

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(
            value=deserializer.read_string(_SCHEMA_DOCUMENT_SOURCE.members["text"])
        )

DocumentSourceContent dataclass

The structured content of the document source, which may include various content blocks such as text, images, or other document elements.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class DocumentSourceContent:
    """The structured content of the document source, which may include various
    content blocks such as text, images, or other document elements.
    """

    value: list[DocumentContentBlock]

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_DOCUMENT_SOURCE, self)

    def serialize_members(self, serializer: ShapeSerializer):
        _serialize_document_content_blocks(
            serializer, _SCHEMA_DOCUMENT_SOURCE.members["content"], self.value
        )

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(
            value=_deserialize_document_content_blocks(
                deserializer, _SCHEMA_DOCUMENT_SOURCE.members["content"]
            )
        )

DocumentSourceUnknown dataclass

Represents an unknown variant.

If you receive this value, you will need to update your library to receive the parsed value.

This value may not be deliberately sent.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class DocumentSourceUnknown:
    """Represents an unknown variant.

    If you receive this value, you will need to update your library to receive the
    parsed value.

    This value may not be deliberately sent.
    """

    tag: str

    def serialize(self, serializer: ShapeSerializer):
        raise SerializationError("Unknown union variants may not be serialized.")

    def serialize_members(self, serializer: ShapeSerializer):
        raise SerializationError("Unknown union variants may not be serialized.")

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        raise NotImplementedError()