CitationLocation module-attribute

CitationLocation = Union[CitationLocationWeb | CitationLocationDocumentChar | CitationLocationDocumentPage | CitationLocationDocumentChunk | CitationLocationUnknown]

Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.

Union Members

CitationLocationWeb dataclass

The web URL that was cited for this reference.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class CitationLocationWeb:
    """The web URL that was cited for this reference."""

    value: WebLocation

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

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

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

CitationLocationDocumentChar dataclass

The character-level location within the document where the cited content is found.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class CitationLocationDocumentChar:
    """The character-level location within the document where the cited content
    is found.
    """

    value: DocumentCharLocation

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

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

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

CitationLocationDocumentPage dataclass

The page-level location within the document where the cited content is found.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class CitationLocationDocumentPage:
    """The page-level location within the document where the cited content is
    found.
    """

    value: DocumentPageLocation

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

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

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

CitationLocationDocumentChunk dataclass

The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass
class CitationLocationDocumentChunk:
    """The chunk-level location within the document where the cited content is
    found, typically used for documents that have been segmented into
    logical chunks.
    """

    value: DocumentChunkLocation

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

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

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

CitationLocationUnknown 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 CitationLocationUnknown:
    """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()