Skip to content

base_artifact

BaseArtifact

Bases: SerializableMixin, ABC

Serves as the base class for all Artifacts.

Artifacts are used to encapsulate data and enhance it with metadata.

Attributes:

Name Type Description
id str

The unique identifier of the Artifact. Defaults to a random UUID.
reference Optional[Reference]

The optional Reference to the Artifact.
meta dict[str, Any]

The metadata associated with the Artifact. Defaults to an empty dictionary.
name str

The name of the Artifact. Defaults to the id.
value Any

The value of the Artifact.
encoding str

The encoding to use when encoding/decoding the value.
encoding_error_handler str

The error on_event to use when encoding/decoding the value.
Source code in griptape/artifacts/base_artifact.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
@define
class BaseArtifact(SerializableMixin, ABC):
    """Serves as the base class for all Artifacts.

    Artifacts are used to encapsulate data and enhance it with metadata.

    Attributes:
        id: The unique identifier of the Artifact. Defaults to a random UUID.
        reference: The optional Reference to the Artifact.
        meta: The metadata associated with the Artifact. Defaults to an empty dictionary.
        name: The name of the Artifact. Defaults to the id.
        value: The value of the Artifact.
        encoding: The encoding to use when encoding/decoding the value.
        encoding_error_handler: The error on_event to use when encoding/decoding the value.
    """

    id: str = field(default=Factory(lambda: uuid.uuid4().hex), kw_only=True, metadata={"serializable": True})
    reference: Optional[Reference] = field(default=None, kw_only=True, metadata={"serializable": True})
    meta: dict[str, Any] = field(factory=dict, kw_only=True, metadata={"serializable": True})
    name: str = field(
        default=Factory(lambda self: self.id, takes_self=True),
        kw_only=True,
        metadata={"serializable": True},
    )
    value: Any = field()
    encoding_error_handler: str = field(default="strict", kw_only=True)
    encoding: str = field(default="utf-8", kw_only=True)

    def __str__(self) -> str:
        return self.to_text()

    def __bool__(self) -> bool:
        return bool(self.value)

    def __len__(self) -> int:
        return len(self.value)

    def to_bytes(self, **kwargs) -> bytes:
        return self.to_text().encode(encoding=self.encoding, errors=self.encoding_error_handler)

    @abstractmethod
    def to_text(self) -> str: ...

encoding = field(default='utf-8', kw_only=True) class-attribute instance-attribute

encoding_error_handler = field(default='strict', kw_only=True) class-attribute instance-attribute

id = field(default=Factory(lambda: uuid.uuid4().hex), kw_only=True, metadata={'serializable': True}) class-attribute instance-attribute

meta = field(factory=dict, kw_only=True, metadata={'serializable': True}) class-attribute instance-attribute

name = field(default=Factory(lambda self: self.id, takes_self=True), kw_only=True, metadata={'serializable': True}) class-attribute instance-attribute

reference = field(default=None, kw_only=True, metadata={'serializable': True}) class-attribute instance-attribute

value = field() class-attribute instance-attribute

__bool__()

Source code in griptape/artifacts/base_artifact.py 
46
47
def __bool__(self) -> bool:
    return bool(self.value)

__len__()

Source code in griptape/artifacts/base_artifact.py 
49
50
def __len__(self) -> int:
    return len(self.value)

__str__()

Source code in griptape/artifacts/base_artifact.py 
43
44
def __str__(self) -> str:
    return self.to_text()

to_bytes(**kwargs)

Source code in griptape/artifacts/base_artifact.py 
52
53
def to_bytes(self, **kwargs) -> bytes:
    return self.to_text().encode(encoding=self.encoding, errors=self.encoding_error_handler)

to_text() abstractmethod

Source code in griptape/artifacts/base_artifact.py 
55
56
@abstractmethod
def to_text(self) -> str: ...