WebLocation dataclass

Provides the URL and domain information for the website that was cited when performing a web search.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass(kw_only=True)
class WebLocation:
    """Provides the URL and domain information for the website that was cited
    when performing a web search.
    """

    url: str | None = None
    """The URL that was cited when performing a web search."""

    domain: str | None = None
    """The domain that was cited when performing a web search."""

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

    def serialize_members(self, serializer: ShapeSerializer):
        if self.url is not None:
            serializer.write_string(_SCHEMA_WEB_LOCATION.members["url"], self.url)

        if self.domain is not None:
            serializer.write_string(_SCHEMA_WEB_LOCATION.members["domain"], self.domain)

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(**cls.deserialize_kwargs(deserializer))

    @classmethod
    def deserialize_kwargs(cls, deserializer: ShapeDeserializer) -> dict[str, Any]:
        kwargs: dict[str, Any] = {}

        def _consumer(schema: Schema, de: ShapeDeserializer) -> None:
            match schema.expect_member_index():
                case 0:
                    kwargs["url"] = de.read_string(_SCHEMA_WEB_LOCATION.members["url"])

                case 1:
                    kwargs["domain"] = de.read_string(
                        _SCHEMA_WEB_LOCATION.members["domain"]
                    )

                case _:
                    logger.debug("Unexpected member schema: %s", schema)

        deserializer.read_struct(_SCHEMA_WEB_LOCATION, consumer=_consumer)
        return kwargs

Attributes

domain class-attribute instance-attribute

domain: str | None = None

The domain that was cited when performing a web search.

url class-attribute instance-attribute

url: str | None = None

The URL that was cited when performing a web search.