Migration Guide

This document provides instructions for migrating your codebase to accommodate breaking changes introduced in new versions of Griptape.

Next Version (Security Hardening)

`CommandRunner` now executes commands directly (`shell=False`).

To prevent shell injection, CommandRunner no longer uses a system shell to execute commands. This means shell metacharacters such as pipes (|), redirects (>, >>), and logical operators (&&, ||) are no longer supported.

Before

runner = CommandRunner()
runner.run("ls -l | grep .py")

After

If you need to process command output, you should do so in Python or ensure the command itself handles the logic without shell metacharacters.

runner = CommandRunner()
# Run commands directly without shell metacharacters
runner.run("ls -l")

0.34.X to 1.0.X

Removed ability to pass `bytes` to `BaseFileLoader.fetch`.

BaseFileLoader.fetch no longer accepts bytes as an argument. If you need to fetch a file from bytes, use BaseFileLoader.parse.

Before

loader = TextLoader()
data = loader.fetch(b"data")

After

loader = TextLoader()
data = loader.parse(b"data")

Removed `ImageQueryEngine`, `ImageQueryDriver`

ImageQueryEngine has been removed. Use PromptDriver instead.

Before

from griptape.drivers import OpenAiImageQueryDriver
from griptape.engines import ImageQueryEngine
from griptape.loaders import ImageLoader

engine = ImageQueryEngine(
    image_query_driver=OpenAiImageQueryDriver(model="gpt-4o", max_tokens=256)
)

image_artifact = ImageLoader().load("mountain.png")

engine.run("Describe the weather in the image", [image_artifact])`

After

from griptape.artifacts import ListArtifact, TextArtifact
from griptape.drivers import OpenAiChatPromptDriver
from griptape.loaders import ImageLoader

driver = OpenAiChatPromptDriver(model="gpt-4o", max_tokens=256)

image_artifact = ImageLoader().load("./assets/mountain.jpg")

driver.run(ListArtifact([TextArtifact("Describe the weather in the image"), image_artifact]))

Removed `InpaintingImageGenerationEngine`

InpaintingImageGenerationEngine has been removed. Use InpaintingImageGenerationDriver instead.

Before

from griptape.drivers import OpenAiImageGenerationDriver
from griptape.engines import InpaintingImageGenerationEngine
from griptape.loaders import ImageLoader


engine = InpaintingImageGenerationEngine(
    image_generation_driver=OpenAiImageGenerationDriver(),
)

image_artifact = ImageLoader().load("mountain.png")

mask_artifact = ImageLoader().load("mountain-mask.png")

engine.run(
    prompts=["A photo of a castle built into the side of a mountain"],
    image=image_artifact,
    mask=mask_artifact,
)```

#### After
```python
from griptape.drivers import OpenAiImageGenerationDriver
from griptape.loaders import ImageLoader

driver = OpenAiImageGenerationDriver()

image_artifact = ImageLoader().load("mountain.png")

mask_artifact = ImageLoader().load("mountain-mask.png")

driver.run_image_inpainting(
    prompts=["A photo of a castle built into the side of a mountain"],
    image=image_artifact,
    mask=mask_artifact,
)

Removed `OutpaintingImageGenerationEngine`

OutpaintingImageGenerationEngine has been removed. Use OutpaintingImageGenerationDriver instead.

Before

from griptape.drivers import OpenAiImageGenerationDriver
from griptape.engines import OutpaintingImageGenerationEngine
from griptape.loaders import ImageLoader

engine = OutpaintingImageGenerationEngine(
    image_generation_driver=OpenAiImageGenerationDriver(),
)

image_artifact = ImageLoader().load("mountain.png")

engine.run(
    prompts=["A photo of a castle built into the side of a mountain"],
    image=image_artifact,
)

After

from griptape.drivers import OpenAiImageGenerationDriver
from griptape.loaders import ImageLoader

driver = OpenAiImageGenerationDriver()

image_artifact = ImageLoader().load("mountain.png")

driver.run_image_outpainting(
    prompts=["A photo of a castle built into the side of a mountain"],
    image=image_artifact,
)

Removed `VariationImageGenerationEngine`

VariationImageGenerationEngine has been removed. Use VariationImageGenerationDriver instead.

Before

from griptape.drivers import OpenAiImageGenerationDriver
from griptape.engines import VariationImageGenerationEngine
from griptape.loaders import ImageLoader

engine = VariationImageGenerationEngine(
    image_generation_driver=OpenAiImageGenerationDriver(),
)

image_artifact = ImageLoader().load("mountain.png")

engine.run(
    prompts=["A photo of a mountain landscape in winter"],
    image=image_artifact,
)

After

from griptape.drivers import OpenAiImageGenerationDriver
from griptape.loaders import ImageLoader

driver = OpenAiImageGenerationDriver()

image_artifact = ImageLoader().load("mountain.png")

driver.run_image_variation(
    prompts=["A photo of a mountain landscape in winter"],
    image=image_artifact,
)

Removed `PromptImageGenerationEngine`

PromptImageGenerationEngine has been removed. Use PromptImageGenerationDriver instead.

Before

from griptape.drivers import OpenAiImageGenerationDriver
from griptape.engines import PromptImageGenerationEngine

engine = PromptImageGenerationEngine(
    image_generation_driver=OpenAiImageGenerationDriver(),
)

engine.run(
    prompts=["A watercolor painting of a dog riding a skateboard"],
)

After

from griptape.drivers import OpenAiImageGenerationDriver

driver = OpenAiImageGenerationDriver()

driver.run_text_to_image(
    prompts=["A watercolor painting of a dog riding a skateboard"],
)

Removed `ImageQueryTask`, use `PromptTask` instead

ImageQueryTask has been removed. Use PromptTask instead.

Before

from griptape.loaders import ImageLoader
from griptape.structures import Pipeline
from griptape.tasks import ImageQueryTask

image_artifact = ImageLoader().load("mountain.png")

pipeline = Pipeline(
    tasks=[
        ImageQueryTask(
            input=("Describe the weather in the image", [image_artifact]),
        )
    ]
)

pipeline.run("Describe the weather in the image")

After

from griptape.loaders import ImageLoader
from griptape.structures import Pipeline
from griptape.tasks import PromptTask

image_artifact = ImageLoader().load("mountain.png")

pipeline = Pipeline(
    tasks=[
        PromptTask(
            input=("Describe the weather in the image", image_artifact),
        )
    ]
)

pipeline.run("Describe the weather in the image")

Renamed `StructureRunTask.driver`/`StructureRunTool.driver` to `StructureRunTask.structure_run_driver`/`StructureRunTool.structure_run_driver`

StructureRunTask.driver and StructureRunTool.driver have been renamed to StructureRunTask.structure_run_driver and StructureRunTool.structure_run_driver respectively.

Before

StructureRunTask(
    driver=LocalStructureRunDriver(),
)
StructureRunTool(
    driver=LocalStructureRunDriver(),
)

After

StructureRunTask(
    structure_run_driver=LocalStructureRunDriver(),
)
StructureRunTool(
    structure_run_driver=LocalStructureRunDriver(),
)

Moved Google Tools To Griptape Google Extension

Google tools have been moved to the griptape-google extension. Install the extension to use Google tools.

poetry add git+https://github.com/griptape-ai/griptape-google.git

Before

from griptape.tools import GoogleGmailTool

After

from griptape.google.tools import GoogleGmailTool

Moved AWS Tools To Griptape AWS Extension

AWS tools have been moved to the griptape-aws extension. Install the extension to use AWS tools.

poetry add git+https://github.com/griptape-ai/griptape-aws.git

Before

from griptape.tools import AwsS3Tool

After

from griptape.aws.tools import AwsS3Tool

Moved `OpenWeatherTool` To Griptape OpenWeather Extension

OpenWeatherTool has been moved to the griptape-openweather extension. Install the extension to use the tool.

poetry add git+https://github.com/griptape-ai/griptape-open-weather.git

Before

from griptape.tools import OpenWeatherTool

After

from griptape.openweather.tools import OpenWeatherTool

Removed `GriptapeCloudKnowledgeBaseTool`

GriptapeCloudKnowledgeBaseTool has been removed. Build a RAG Engine with a GriptapeCloudVectorStoreDriver instead.

Before

import os

from griptape.structures import Agent
from griptape.tools import GriptapeCloudKnowledgeBaseTool

knowledge_base_client = GriptapeCloudKnowledgeBaseTool(
    description="Contains information about the company and its operations",
    api_key=os.environ["GT_CLOUD_API_KEY"],
    knowledge_base_id=os.environ["GT_CLOUD_KB_ID"],
)

agent = Agent(
    tools=[
        knowledge_base_client,
    ]
)

agent.run("What is the company's corporate travel policy?")

After

from __future__ import annotations

import os

from griptape.drivers import GriptapeCloudVectorStoreDriver
from griptape.engines.rag import RagEngine
from griptape.engines.rag.modules import (
    PromptResponseRagModule,
    VectorStoreRetrievalRagModule,
)
from griptape.engines.rag.stages import (
    ResponseRagStage,
    RetrievalRagStage,
)
from griptape.structures import Agent
from griptape.tools import RagTool

engine = RagEngine(
    retrieval_stage=RetrievalRagStage(
        retrieval_modules=[
            VectorStoreRetrievalRagModule(
                vector_store_driver=GriptapeCloudVectorStoreDriver(
                    api_key=os.environ["GT_CLOUD_API_KEY"],
                    knowledge_base_id=os.environ["GT_CLOUD_KB_ID"],
                )
            )
        ]
    ),
    response_stage=ResponseRagStage(
        response_modules=[PromptResponseRagModule()],
    ),
)

agent = Agent(
    tools=[
        RagTool(
            description="Contains information about the company and its operations",
            rag_engine=engine,
        ),
    ],
)
agent.run("What is the company's corporate travel policy?")

0.33.X to 0.34.X

`AnthropicDriversConfig` Embedding Driver

AnthropicDriversConfig no longer bundles VoyageAiEmbeddingDriver. If you rely on embeddings when using Anthropic, you must specify an Embedding Driver yourself.

Before

from griptape.configs import Defaults
from griptape.configs.drivers import AnthropicDriversConfig
from griptape.structures import Agent

Defaults.drivers_config = AnthropicDriversConfig()

agent = Agent()

After

from griptape.configs import Defaults
from griptape.configs.drivers import AnthropicDriversConfig
from griptape.drivers import VoyageAiEmbeddingDriver, LocalVectorStoreDriver

Defaults.drivers_config = AnthropicDriversConfig(
    embedding_driver=VoyageAiEmbeddingDriver(),
    vector_store_driver=LocalVectorStoreDriver(
        embedding_driver=VoyageAiEmbeddingDriver()
    )
)

Renamed Callables

Many callables have been renamed for consistency. Update your code to use the new names using the CHANGELOG.md as the source of truth.

Removed `CompletionChunkEvent`

CompletionChunkEvent has been removed. There is now BaseChunkEvent with children TextChunkEvent and ActionChunkEvent. BaseChunkEvent can replace completion_chunk_event.token by doing str(base_chunk_event).

Before

def handler_fn_stream(event: CompletionChunkEvent) -> None:
    print(f"CompletionChunkEvent: {event.to_json()}")

def handler_fn_stream_text(event: CompletionChunkEvent) -> None:
    # This prints out Tool actions with no easy way
    # to filter them out
    print(event.token, end="", flush=True)

EventListener(handler=handler_fn_stream, event_types=[CompletionChunkEvent])
EventListener(handler=handler_fn_stream_text, event_types=[CompletionChunkEvent])

After

def handler_fn_stream(event: BaseChunkEvent) -> None:
    print(str(e), end="", flush=True)
    # print out each child event type
    if isinstance(event, TextChunkEvent):
        print(f"TextChunkEvent: {event.to_json()}")
    if isinstance(event, ActionChunkEvent):
        print(f"ActionChunkEvent: {event.to_json()}")


def handler_fn_stream_text(event: TextChunkEvent) -> None:
    # This will only be text coming from the
    # prompt driver, not Tool actions
    print(event.token, end="", flush=True)

EventListener(handler=handler_fn_stream, event_types=[BaseChunkEvent])
EventListener(handler=handler_fn_stream_text, event_types=[TextChunkEvent])

`EventListener.handler` behavior, `driver` parameter rename

Returning None from the handler function now causes the event to not be published to the EventListenerDriver. The handler function can now return a BaseEvent object.

Before

def handler_fn_return_none(event: BaseEvent) -> Optional[dict]:
    # This causes the `BaseEvent` object to be passed to the EventListenerDriver
    return None

def handler_fn_return_dict(event: BaseEvent) -> Optional[dict]:
    # This causes the returned dictionary to be passed to the EventListenerDriver
    return {
        "key": "value
    }

EventListener(handler=handler_fn_return_none, driver=driver)
EventListener(handler=handler_fn_return_dict, driver=driver)

After

def handler_fn_return_none(event: BaseEvent) -> Optional[dict | BaseEvent]:
    # This causes the `BaseEvent` object to NOT get passed to the EventListenerDriver
    return None

def handler_fn_return_dict(event: BaseEvent) -> Optional[dict | BaseEvent]:
    # This causes the returned dictionary to be passed to the EventListenerDriver
    return {
        "key": "value
    }

def handler_fn_return_base_event(event: BaseEvent) -> Optional[dict | BaseEvent]:
    # This causes the returned `BaseEvent` object to be passed to the EventListenerDriver
    return ChildClassOfBaseEvent()

# `driver` has been renamed to `event_listener_driver`
EventListener(handler=handler_fn_return_none, event_listener_driver=driver)
EventListener(handler=handler_fn_return_dict, event_listener_driver=driver)
EventListener(handler=handler_fn_return_base_event, event_listener_driver=driver)

Removed `BaseEventListener.publish_event` `flush` argument.

BaseEventListenerDriver.publish_event no longer takes a flush argument. If you need to flush the event, call BaseEventListenerDriver.flush_events directly.

Before

event_listener_driver.publish_event(event, flush=True)

After

event_listener_driver.publish_event(event)
event_listener_driver.flush_events()

Moved `observable` decorator location.

The observable decorator has been moved to griptape.common.decorators. Update your imports accordingly.

Before

from griptape.common.observable import observable

After

from griptape.common.decorators import observable

Removed `HuggingFacePipelinePromptDriver.params`

HuggingFacePipelinePromptDriver.params has been removed. Use HuggingFacePipelinePromptDriver.extra_params instead.

Before

driver = HuggingFacePipelinePromptDriver(
    params={"max_length": 50}
)

After

driver = HuggingFacePipelinePromptDriver(
    extra_params={"max_length": 50}
)

Renamed `execute` to `run` in several places

execute has been renamed to run in several places. Update your code accordingly.

Before

task = PromptTask()
if task.can_execute():
    task.execute()

After

task = PromptTask()
if task.can_run():
    task.run()

0.32.X to 0.33.X

Removed `DataframeLoader`

DataframeLoader has been removed. Use CsvLoader.parse or build TextArtifacts from the dataframe instead.

Before

DataframeLoader().load(df)

After

# Convert the dataframe to csv bytes and parse it
CsvLoader().parse(bytes(df.to_csv(line_terminator='\r\n', index=False), encoding='utf-8'))
# Or build TextArtifacts from the dataframe
[TextArtifact(row) for row in source.to_dict(orient="records")]

`TextLoader`, `PdfLoader`, `ImageLoader`, and `AudioLoader` now take a `str | PathLike` instead of `bytes`.

Before

PdfLoader().load(Path("attention.pdf").read_bytes())
PdfLoader().load_collection([Path("attention.pdf").read_bytes(), Path("CoT.pdf").read_bytes()])

After

PdfLoader().load("attention.pdf")
PdfLoader().load_collection([Path("attention.pdf"), "CoT.pdf"])

Removed `fileutils.load_file` and `fileutils.load_files`

griptape.utils.file_utils.load_file and griptape.utils.file_utils.load_files have been removed. You can now pass the file path directly to the Loader.

Before

PdfLoader().load(load_file("attention.pdf").read_bytes())
PdfLoader().load_collection(list(load_files(["attention.pdf", "CoT.pdf"]).values()))

PdfLoader().load("attention.pdf")
PdfLoader().load_collection(["attention.pdf", "CoT.pdf"])

Loaders no longer chunk data

Loaders no longer chunk the data after loading it. If you need to chunk the data, use a Chunker after loading the data.

Before

chunks = PdfLoader().load("attention.pdf")
vector_store.upsert_text_artifacts(
    {
        "griptape": chunks,
    }
)

After

artifact = PdfLoader().load("attention.pdf")
chunks = Chunker().chunk(artifact)
vector_store.upsert_text_artifacts(
    {
        "griptape": chunks,
    }
)

Removed `torch` extra from `transformers` dependency

The torch extra has been removed from the transformers dependency. If you require torch, install it separately.

Before

pip install griptape[drivers-prompt-huggingface-hub]

After

pip install griptape[drivers-prompt-huggingface-hub]
pip install torch

`CsvLoader`, `DataframeLoader`, and `SqlLoader` return types

CsvLoader, DataframeLoader, and SqlLoader now return a list[TextArtifact] instead of list[CsvRowArtifact].

If you require a dictionary, set a custom formatter_fn and then parse the text to a dictionary.

Before

results = CsvLoader().load(Path("people.csv").read_text())

print(results[0].value) # {"name": "John", "age": 30}
print(type(results[0].value)) # <class 'dict'>

After

results = CsvLoader().load(Path("people.csv").read_text())

print(results[0].value) # name: John\nAge: 30
print(type(results[0].value)) # <class 'str'>

# Customize formatter_fn
results = CsvLoader(formatter_fn=lambda x: json.dumps(x)).load(Path("people.csv").read_text())
print(results[0].value) # {"name": "John", "age": 30}
print(type(results[0].value)) # <class 'str'>

dict_results = [json.loads(result.value) for result in results]
print(dict_results[0]) # {"name": "John", "age": 30}
print(type(dict_results[0])) # <class 'dict'>

Renamed GriptapeCloudKnowledgeBaseVectorStoreDriver to GriptapeCloudVectorStoreDriver.

Before

from griptape.drivers.griptape_cloud_knowledge_base_vector_store_driver import GriptapeCloudKnowledgeBaseVectorStoreDriver

driver = GriptapeCloudKnowledgeBaseVectorStoreDriver(...)

After

from griptape.drivers.griptape_cloud_vector_store_driver import GriptapeCloudVectorStoreDriver

driver = GriptapeCloudVectorStoreDriver(...)

`OpenAiChatPromptDriver.response_format` is now a `dict` instead of a `str`.

OpenAiChatPromptDriver.response_format is now structured as the openai SDK accepts it.

Before

driver = OpenAiChatPromptDriver(
    response_format="json_object"
)

After

driver = OpenAiChatPromptDriver(
    response_format={"type": "json_object"}
)

0.31.X to 0.32.X

Removed `MediaArtifact`

MediaArtifact has been removed. Use ImageArtifact or AudioArtifact instead.

Before

image_media = MediaArtifact(
    b"image_data",
    media_type="image",
    format="jpeg"
)

audio_media = MediaArtifact(
    b"audio_data",
    media_type="audio",
    format="wav"
)

After

image_artifact = ImageArtifact(
    b"image_data",
    format="jpeg"
)

audio_artifact = AudioArtifact(
    b"audio_data",
    format="wav"
)

`ImageArtifact.format` is now required

ImageArtifact.format is now a required parameter. Update any code that does not provide a format parameter.

Before

image_artifact = ImageArtifact(
    b"image_data"
)

After

image_artifact = ImageArtifact(
    b"image_data",
    format="jpeg"
)

Removed `CsvRowArtifact`

CsvRowArtifact has been removed. Use TextArtifact instead.

Before

artifact = CsvRowArtifact({"name": "John", "age": 30})
print(artifact.value) # {"name": "John", "age": 30}
print(type(artifact.value)) # <class 'dict'>

After

artifact = TextArtifact("name: John\nage: 30")
print(artifact.value) # name: John\nage: 30
print(type(artifact.value)) # <class 'str'>

If you require storing a dictionary as an Artifact, you can use GenericArtifact instead.

`CsvLoader`, `DataframeLoader`, and `SqlLoader` return types

CsvLoader, DataframeLoader, and SqlLoader now return a list[TextArtifact] instead of list[CsvRowArtifact].

If you require a dictionary, set a custom formatter_fn and then parse the text to a dictionary.

Before

results = CsvLoader().load(Path("people.csv").read_text())

print(results[0].value) # {"name": "John", "age": 30}
print(type(results[0].value)) # <class 'dict'>

After

results = CsvLoader().load(Path("people.csv").read_text())

print(type(results)) # <class 'griptape.artifacts.ListArtifact'>
print(results[0].value) # name: John\nAge: 30
print(type(results[0].value)) # <class 'str'>

# Customize formatter_fn
results = CsvLoader(formatter_fn=lambda x: json.dumps(x)).load(Path("people.csv").read_text())
print(results[0].value) # {"name": "John", "age": 30}
print(type(results[0].value)) # <class 'str'>

dict_results = [json.loads(result.value) for result in results]
print(dict_results[0]) # {"name": "John", "age": 30}
print(type(dict_results[0])) # <class 'dict'>

Moved `ImageArtifact.prompt` and `ImageArtifact.model` to `ImageArtifact.meta`

ImageArtifact.prompt and ImageArtifact.model have been moved to ImageArtifact.meta.

Before

image_artifact = ImageArtifact(
    b"image_data",
    format="jpeg",
    prompt="Generate an image of a cat",
    model="DALL-E"
)

print(image_artifact.prompt, image_artifact.model) # Generate an image of a cat, DALL-E

After

image_artifact = ImageArtifact(
    b"image_data",
    format="jpeg",
    meta={"prompt": "Generate an image of a cat", "model": "DALL-E"}
)

print(image_artifact.meta["prompt"], image_artifact.meta["model"]) # Generate an image of a cat, DALL-E

0.30.X to 0.31.X

Exceptions Over `ErrorArtifact`s

Drivers, Loaders, and Engines now raise exceptions rather than returning ErrorArtifacts. Update any logic that expects ErrorArtifact to handle exceptions instead.

Before

artifacts = WebLoader().load("https://www.griptape.ai")

if isinstance(artifacts, ErrorArtifact):
    raise Exception(artifacts.value)

After

try:
    artifacts = WebLoader().load("https://www.griptape.ai")
except Exception as e:
    raise e

LocalConversationMemoryDriver `file_path` renamed to `persist_file`

LocalConversationMemoryDriver.file_path has been renamed to persist_file and is now Optional[str]. If persist_file is not passed as a parameter, nothing will be persisted and no errors will be raised. LocalConversationMemoryDriver is now the default driver in the global Defaults object.

Before

local_driver_with_file = LocalConversationMemoryDriver(
    file_path="my_file.json"
)

local_driver = LocalConversationMemoryDriver()

assert local_driver_with_file.file_path == "my_file.json"
assert local_driver.file_path == "griptape_memory.json"

After

local_driver_with_file = LocalConversationMemoryDriver(
    persist_file="my_file.json"
)

local_driver = LocalConversationMemoryDriver()

assert local_driver_with_file.persist_file == "my_file.json"
assert local_driver.persist_file is None

Changes to BaseConversationMemoryDriver

BaseConversationMemoryDriver.driver has been renamed to conversation_memory_driver. Method signatures for .store and .load have been changed.

Before

memory_driver = LocalConversationMemoryDriver()

conversation_memory = ConversationMemory(
    driver=memory_driver
)

load_result: BaseConversationMemory = memory_driver.load()

memory_driver.store(conversation_memory)

After

memory_driver = LocalConversationMemoryDriver()

conversation_memory = ConversationMemory(
    conversation_memory_driver=memory_driver
)

load_result: tuple[list[Run], dict[str, Any]] = memory_driver.load()

memory_driver.store(
    conversation_memory.runs,
    conversation_memory.meta
)

Uh oh!

FilesExpand file tree

MIGRATION.md

Latest commit

History

MIGRATION.md

File metadata and controls

Migration Guide

Next Version (Security Hardening)

CommandRunner now executes commands directly (shell=False).

Before

After

0.34.X to 1.0.X

Removed ability to pass bytes to BaseFileLoader.fetch.

Before

After

Removed ImageQueryEngine, ImageQueryDriver

Before

After

Removed InpaintingImageGenerationEngine

Before

Removed OutpaintingImageGenerationEngine

Before

After

Removed VariationImageGenerationEngine

Before

After

Removed PromptImageGenerationEngine

Before

After

Removed ImageQueryTask, use PromptTask instead

Before

After

Renamed StructureRunTask.driver/StructureRunTool.driver to StructureRunTask.structure_run_driver/StructureRunTool.structure_run_driver

Before

After

Moved Google Tools To Griptape Google Extension

Before

After

Moved AWS Tools To Griptape AWS Extension

Before

After

Moved OpenWeatherTool To Griptape OpenWeather Extension

Before

After

Removed GriptapeCloudKnowledgeBaseTool

Before

After

0.33.X to 0.34.X

AnthropicDriversConfig Embedding Driver

Before

After

Renamed Callables

Removed CompletionChunkEvent

Before

After

EventListener.handler behavior, driver parameter rename

Before

After

Removed BaseEventListener.publish_event flush argument.

Before

After

Moved observable decorator location.

Before

After

Removed HuggingFacePipelinePromptDriver.params

Before

After

Renamed execute to run in several places

Before

After

0.32.X to 0.33.X

Removed DataframeLoader

Before

After

TextLoader, PdfLoader, ImageLoader, and AudioLoader now take a str | PathLike instead of bytes.

Before

After

Removed fileutils.load_file and fileutils.load_files

Before

`CommandRunner` now executes commands directly (`shell=False`).

Removed ability to pass `bytes` to `BaseFileLoader.fetch`.

Removed `ImageQueryEngine`, `ImageQueryDriver`

Removed `InpaintingImageGenerationEngine`

Removed `OutpaintingImageGenerationEngine`

Removed `VariationImageGenerationEngine`

Removed `PromptImageGenerationEngine`

Removed `ImageQueryTask`, use `PromptTask` instead

Renamed `StructureRunTask.driver`/`StructureRunTool.driver` to `StructureRunTask.structure_run_driver`/`StructureRunTool.structure_run_driver`

Moved `OpenWeatherTool` To Griptape OpenWeather Extension

Removed `GriptapeCloudKnowledgeBaseTool`

`AnthropicDriversConfig` Embedding Driver

Removed `CompletionChunkEvent`

`EventListener.handler` behavior, `driver` parameter rename

Removed `BaseEventListener.publish_event` `flush` argument.

Moved `observable` decorator location.

Removed `HuggingFacePipelinePromptDriver.params`

Renamed `execute` to `run` in several places

Removed `DataframeLoader`

`TextLoader`, `PdfLoader`, `ImageLoader`, and `AudioLoader` now take a `str | PathLike` instead of `bytes`.

Removed `fileutils.load_file` and `fileutils.load_files`

Removed `torch` extra from `transformers` dependency

`CsvLoader`, `DataframeLoader`, and `SqlLoader` return types

`OpenAiChatPromptDriver.response_format` is now a `dict` instead of a `str`.

Removed `MediaArtifact`

`ImageArtifact.format` is now required

Removed `CsvRowArtifact`

`CsvLoader`, `DataframeLoader`, and `SqlLoader` return types

Moved `ImageArtifact.prompt` and `ImageArtifact.model` to `ImageArtifact.meta`

Exceptions Over `ErrorArtifact`s

LocalConversationMemoryDriver `file_path` renamed to `persist_file`