Artifacts
__all__ = ['BaseArtifact', 'ErrorArtifact', 'InfoArtifact', 'TextArtifact', 'BlobArtifact', 'CsvRowArtifact', 'ListArtifact', 'ImageArtifact', 'MediaArtifact']
module-attribute
BaseArtifact
Bases: SerializableMixin
, ABC
Source code in griptape/artifacts/base_artifact.py
id: str = field(default=Factory(lambda: uuid.uuid4().hex), kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
name: str = field(default=Factory(lambda self: self.id, takes_self=True), kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
value: Any = field()
class-attribute
instance-attribute
__add__(other)
abstractmethod
__bool__()
__len__()
__str__()
to_text()
value_to_bytes(value)
classmethod
BlobArtifact
Bases: BaseArtifact
Source code in griptape/artifacts/blob_artifact.py
dir_name: Optional[str] = field(default=None, kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
encoding: str = field(default='utf-8', kw_only=True)
class-attribute
instance-attribute
encoding_error_handler: str = field(default='strict', kw_only=True)
class-attribute
instance-attribute
full_path: str
property
value: bytes = field(converter=BaseArtifact.value_to_bytes, metadata={'serializable': True})
class-attribute
instance-attribute
__add__(other)
CsvRowArtifact
Bases: TextArtifact
Source code in griptape/artifacts/csv_row_artifact.py
delimiter: str = field(default=',', kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
value: dict[str, str] = field(converter=BaseArtifact.value_to_dict, metadata={'serializable': True})
class-attribute
instance-attribute
__add__(other)
__bool__()
to_text()
Source code in griptape/artifacts/csv_row_artifact.py
ErrorArtifact
Bases: BaseArtifact
Source code in griptape/artifacts/error_artifact.py
exception: Optional[Exception] = field(default=None, kw_only=True, metadata={'serializable': False})
class-attribute
instance-attribute
value: str = field(converter=str, metadata={'serializable': True})
class-attribute
instance-attribute
ImageArtifact
Bases: MediaArtifact
ImageArtifact is a type of MediaArtifact representing an image.
Attributes:
Name | Type | Description |
---|---|---|
value |
Raw bytes representing media data. |
|
media_type |
str
|
The type of media, defaults to "image". |
format |
str
|
The format of the media, like png, jpeg, or gif. |
name |
str
|
Artifact name, generated using creation time and a random string. |
model |
str
|
Optionally specify the model used to generate the media. |
prompt |
str
|
Optionally specify the prompt used to generate the media. |
Source code in griptape/artifacts/image_artifact.py
height: int = field(kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
media_type: str = 'image'
class-attribute
instance-attribute
width: int = field(kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
InfoArtifact
Bases: BaseArtifact
Source code in griptape/artifacts/info_artifact.py
ListArtifact
Bases: BaseArtifact
Source code in griptape/artifacts/list_artifact.py
child_type: Optional[type]
property
item_separator: str = field(default='\n\n', kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
value: Sequence[BaseArtifact] = field(factory=list, metadata={'serializable': True})
class-attribute
instance-attribute
__add__(other)
__bool__()
__getitem__(key)
has_items()
is_type(target_type)
to_text()
validate_value(_, value)
Source code in griptape/artifacts/list_artifact.py
MediaArtifact
Bases: BlobArtifact
MediaArtifact is a type of BlobArtifact that represents media (image, audio, video, etc.) and can be extended to support a specific media type.
Attributes:
Name | Type | Description |
---|---|---|
value |
Raw bytes representing media data. |
|
media_type |
str
|
The type of media, like image, audio, or video. |
format |
str
|
The format of the media, like png, wav, or mp4. |
name |
str
|
Artifact name, generated using creation time and a random string. |
model |
Optional[str]
|
Optionally specify the model used to generate the media. |
prompt |
Optional[str]
|
Optionally specify the prompt used to generate the media. |
Source code in griptape/artifacts/media_artifact.py
base64: str
property
format: str = field(kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
media_type: str = field(default='media', kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
mime_type: str
property
model: Optional[str] = field(default=None, kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
prompt: Optional[str] = field(default=None, kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
__attrs_post_init__()
make_name()
Source code in griptape/artifacts/media_artifact.py
TextArtifact
Bases: BaseArtifact