Standardize loaders interface

CHANGELOG.md

@@ -31,7 +31,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - Parameter `meta: dict` on `BaseEvent`.
-- `TableArtifact` for storing CSV data.
 
 ### Changed
 - **BREAKING**: Drivers, Loaders, and Engines now raise exceptions rather than returning `ErrorArtifacts`.
@@ -40,7 +39,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **BREAKING**: `BaseConversationMemoryDriver.load` now returns `tuple[list[Run], dict]`. This represents the runs and metadata.
 - **BREAKING**: `BaseConversationMemoryDriver.store` now takes `runs: list[Run]` and `metadata: dict` as input.
 - **BREAKING**: Parameter `file_path` on `LocalConversationMemoryDriver` renamed to `persist_file` and is now type `Optional[str]`.
-- **BREAKING**: `CsvLoader` now returns a `TableArtifact` instead of a `list[CsvRowArtifact]`.
 - `Defaults.drivers_config.conversation_memory_driver` now defaults to `LocalConversationMemoryDriver` instead of `None`.
 - `CsvRowArtifact.to_text()` now includes the header.
 

docs/examples/src/load_query_and_chat_marqo_1.py

@@ -1,6 +1,7 @@
 import os
 
 from griptape import utils
+from griptape.chunkers import TextChunker
 from griptape.drivers import MarqoVectorStoreDriver, OpenAiEmbeddingDriver
 from griptape.loaders import WebLoader
 from griptape.structures import Agent
@@ -25,11 +26,12 @@
 
 # Load artifacts from the web
 artifacts = WebLoader().load("https://www.griptape.ai")
+chunks = TextChunker().chunk(artifacts)
 
 # Upsert the artifacts into the vector store
 vector_store.upsert_text_artifacts(
     {
-        namespace: artifacts,
+        namespace: chunks,
     }
 )
 

docs/examples/src/query_webpage_1.py

@@ -1,13 +1,15 @@
 import os
 
+from griptape.chunkers import TextChunker
 from griptape.drivers import LocalVectorStoreDriver, OpenAiEmbeddingDriver
 from griptape.loaders import WebLoader
 
 vector_store = LocalVectorStoreDriver(embedding_driver=OpenAiEmbeddingDriver(api_key=os.environ["OPENAI_API_KEY"]))
 
-artifacts = WebLoader(max_tokens=100).load("https://www.griptape.ai")
+artifacts = WebLoader().load("https://www.griptape.ai")
+chunks = TextChunker().chunk(artifacts)
 
-for a in artifacts:
+for a in chunks:
     vector_store.upsert_text_artifact(a, namespace="griptape")
 
 results = vector_store.query("creativity", count=3, namespace="griptape")

docs/examples/src/query_webpage_astra_db_1.py

@@ -1,5 +1,6 @@
 import os
 
+from griptape.chunkers import TextChunker
 from griptape.drivers import (
     AstraDbVectorStoreDriver,
     OpenAiChatPromptDriver,
@@ -43,9 +44,9 @@
     ),
 )
 
-artifacts = WebLoader(max_tokens=256).load(input_blogpost)
-
-vector_store_driver.upsert_text_artifacts({namespace: artifacts})
+artifacts = WebLoader().load(input_blogpost)
+chunks = TextChunker().chunk(artifacts)
+vector_store_driver.upsert_text_artifacts({namespace: chunks})
 
 rag_tool = RagTool(
     description="A DataStax blog post",

docs/examples/src/talk_to_a_pdf_1.py

@@ -1,5 +1,6 @@
 import requests
 
+from griptape.chunkers import TextChunker
 from griptape.drivers import LocalVectorStoreDriver, OpenAiChatPromptDriver, OpenAiEmbeddingDriver
 from griptape.engines.rag import RagEngine
 from griptape.engines.rag.modules import PromptResponseRagModule, VectorStoreRetrievalRagModule
@@ -31,8 +32,9 @@
 )
 
 artifacts = PdfLoader().load(response.content)
+chunks = TextChunker().chunk(artifacts)
 
-vector_store.upsert_text_artifacts({namespace: artifacts})
+vector_store.upsert_text_artifacts({namespace: chunks})
 
 agent = Agent(tools=[rag_tool])
 

docs/examples/src/talk_to_a_webpage_1.py

@@ -1,3 +1,4 @@
+from griptape.chunkers import TextChunker
 from griptape.drivers import LocalVectorStoreDriver, OpenAiChatPromptDriver, OpenAiEmbeddingDriver
 from griptape.engines.rag import RagEngine
 from griptape.engines.rag.modules import PromptResponseRagModule, VectorStoreRetrievalRagModule
@@ -26,8 +27,9 @@
 )
 
 artifacts = WebLoader().load("https://en.wikipedia.org/wiki/Physics")
+chunks = TextChunker().chunk(artifacts)
 
-vector_store_driver.upsert_text_artifacts({namespace: artifacts})
+vector_store_driver.upsert_text_artifacts({namespace: chunks})
 
 rag_tool = RagTool(
     description="Contains information about physics. " "Use it to answer any physics-related questions.",

docs/griptape-framework/data/loaders.md

@@ -36,19 +36,6 @@ Can be used to load CSV files into [TextArtifact](../../reference/griptape/artif
 --8<-- "docs/griptape-framework/data/src/loaders_3.py"
 ```
 
-
-## DataFrame
-
-!!! info
-    This driver requires the `loaders-dataframe` [extra](../index.md#extras).
-
-Can be used to load [pandas](https://pandas.pydata.org/) [DataFrame](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html)s into [TextArtifact](../../reference/griptape/artifacts/text_artifact.md)s:
-
-```python
---8<-- "docs/griptape-framework/data/src/loaders_4.py"
-```
-
-
 ## Text
 
 Used to load arbitrary text and text files:

docs/griptape-framework/data/src/loaders_1.py

@@ -2,18 +2,15 @@
 from pathlib import Path
 
 from griptape.loaders import PdfLoader
-from griptape.utils import load_file, load_files
 
 urllib.request.urlretrieve("https://arxiv.org/pdf/1706.03762.pdf", "attention.pdf")
 
 # Load a single PDF file
-PdfLoader().load(Path("attention.pdf").read_bytes())
-# You can also use the load_file utility function
-PdfLoader().load(load_file("attention.pdf"))
+PdfLoader().load("attention.pdf")
+# You can also pass a Path object
+PdfLoader().load(Path("attention.pdf"))
 
 urllib.request.urlretrieve("https://arxiv.org/pdf/1706.03762.pdf", "CoT.pdf")
 
 # Load multiple PDF files
-PdfLoader().load_collection([Path("attention.pdf").read_bytes(), Path("CoT.pdf").read_bytes()])
-# You can also use the load_files utility function
-PdfLoader().load_collection(list(load_files(["attention.pdf", "CoT.pdf"]).values()))
+PdfLoader().load_collection([Path("attention.pdf"), Path("CoT.pdf")])

docs/griptape-framework/data/src/loaders_10.py

@@ -1,10 +1,9 @@
 from pathlib import Path
 
 from griptape.loaders import AudioLoader
-from griptape.utils import load_file
 
 # Load an image from disk
-audio_artifact = AudioLoader().load(Path("tests/resources/sentences.wav").read_bytes())
+AudioLoader().load("tests/resources/sentences.wav")
 
-# You can also use the load_file utility function
-AudioLoader().load(load_file("tests/resources/sentences.wav"))
+# You can also pass a Path object
+AudioLoader().load(Path("tests/resources/sentences.wav"))

docs/griptape-framework/data/src/loaders_3.py

@@ -1,16 +1,11 @@
 from pathlib import Path
 
 from griptape.loaders import CsvLoader
-from griptape.utils import load_file, load_files
 
 # Load a single CSV file
-CsvLoader().load(Path("tests/resources/cities.csv").read_text())
-# You can also use the load_file utility function
-CsvLoader().load(load_file("tests/resources/cities.csv"))
+CsvLoader().load("tests/resources/cities.csv")
+# You can also pass a Path object
+CsvLoader().load(Path("tests/resources/cities.csv"))
 
 # Load multiple CSV files
-CsvLoader().load_collection(
-    [Path("tests/resources/cities.csv").read_text(), Path("tests/resources/addresses.csv").read_text()]
-)
-# You can also use the load_files utility function
-CsvLoader().load_collection(list(load_files(["tests/resources/cities.csv", "tests/resources/addresses.csv"]).values()))
+CsvLoader().load_collection([Path("tests/resources/cities.csv"), "tests/resources/addresses.csv"])

docs/griptape-framework/data/src/loaders_7.py

@@ -1,9 +1,9 @@
 from pathlib import Path
 
 from griptape.loaders import ImageLoader
-from griptape.utils import load_file
 
 # Load an image from disk
-disk_image_artifact = ImageLoader().load(Path("tests/resources/mountain.png").read_bytes())
-# You can also use the load_file utility function
-ImageLoader().load(load_file("tests/resources/mountain.png"))
+ImageLoader().load("tests/resources/mountain.png")
+
+# You can also pass a Path object
+ImageLoader().load(Path("tests/resources/mountain.png"))

docs/griptape-framework/data/src/loaders_8.py

@@ -1,16 +1,11 @@
 from pathlib import Path
 
 from griptape.loaders import ImageLoader
-from griptape.utils import load_file, load_files
 
 # Load a single image in BMP format
-image_artifact_jpeg = ImageLoader(format="bmp").load(Path("tests/resources/mountain.png").read_bytes())
-# You can also use the load_file utility function
-ImageLoader(format="bmp").load(load_file("tests/resources/mountain.png"))
+ImageLoader(format="bmp").load("tests/resources/mountain.png")
+# You can also pass a Path object
+ImageLoader(format="bmp").load(Path("tests/resources/mountain.png"))
 
 # Load multiple images in BMP format
-ImageLoader().load_collection(
-    [Path("tests/resources/mountain.png").read_bytes(), Path("tests/resources/cow.png").read_bytes()]
-)
-# You can also use the load_files utility function
-ImageLoader().load_collection(list(load_files(["tests/resources/mountain.png", "tests/resources/cow.png"]).values()))
+ImageLoader().load_collection([Path("tests/resources/mountain.png"), "tests/resources/cow.png"])

docs/griptape-framework/drivers/src/vector_store_drivers_1.py

@@ -1,5 +1,6 @@
 import os
 
+from griptape.chunkers import TextChunker
 from griptape.drivers import LocalVectorStoreDriver, OpenAiEmbeddingDriver
 from griptape.loaders import WebLoader
 
@@ -9,10 +10,11 @@
 vector_store_driver = LocalVectorStoreDriver(embedding_driver=embedding_driver)
 
 # Load Artifacts from the web
-artifacts = WebLoader(max_tokens=100).load("https://www.griptape.ai")
+artifact = WebLoader().load("https://www.griptape.ai")
+chunks = TextChunker(max_tokens=100).chunk(artifact)
 
 # Upsert Artifacts into the Vector Store Driver
-[vector_store_driver.upsert_text_artifact(a, namespace="griptape") for a in artifacts]
+[vector_store_driver.upsert_text_artifact(a, namespace="griptape") for a in chunks]
 
 results = vector_store_driver.query(query="What is griptape?")
 

docs/griptape-framework/drivers/src/vector_store_drivers_10.py

@@ -1,5 +1,6 @@
 import os
 
+from griptape.chunkers import TextChunker
 from griptape.drivers import OpenAiEmbeddingDriver, QdrantVectorStoreDriver
 from griptape.loaders import WebLoader
 
@@ -19,7 +20,8 @@
 )
 
 # Load Artifacts from the web
-artifacts = WebLoader().load("https://www.griptape.ai")
+artifact = WebLoader().load("https://www.griptape.ai")
+chunks = TextChunker(max_tokens=100).chunk(artifact)
 
 # Recreate Qdrant collection
 vector_store_driver.client.recreate_collection(
@@ -28,7 +30,7 @@
 )
 
 # Upsert Artifacts into the Vector Store Driver
-[vector_store_driver.upsert_text_artifact(a, namespace="griptape") for a in artifacts]
+[vector_store_driver.upsert_text_artifact(a, namespace="griptape") for a in chunks]
 
 results = vector_store_driver.query(query="What is griptape?")
 

docs/griptape-framework/drivers/src/vector_store_drivers_11.py

@@ -1,5 +1,6 @@
 import os
 
+from griptape.chunkers import TextChunker
 from griptape.drivers import AstraDbVectorStoreDriver, OpenAiEmbeddingDriver
 from griptape.loaders import WebLoader
 
@@ -20,10 +21,11 @@
 )
 
 # Load Artifacts from the web
-artifacts = WebLoader().load("https://www.griptape.ai")
+artifact = WebLoader().load("https://www.griptape.ai")
+chunks = TextChunker().chunk(artifact)
 
 # Upsert Artifacts into the Vector Store Driver
-[vector_store_driver.upsert_text_artifact(a, namespace="griptape") for a in artifacts]
+[vector_store_driver.upsert_text_artifact(a, namespace="griptape") for a in chunks]
 
 results = vector_store_driver.query(query="What is griptape?")
 

docs/griptape-framework/drivers/src/vector_store_drivers_3.py

@@ -1,5 +1,6 @@
 import os
 
+from griptape.chunkers import TextChunker
 from griptape.drivers import OpenAiEmbeddingDriver, PineconeVectorStoreDriver
 from griptape.loaders import WebLoader
 
@@ -14,10 +15,11 @@
 )
 
 # Load Artifacts from the web
-artifacts = WebLoader(max_tokens=100).load("https://www.griptape.ai")
+artifact = WebLoader().load("https://www.griptape.ai")
+chunks = TextChunker(max_tokens=100).chunk(artifact)
 
 # Upsert Artifacts into the Vector Store Driver
-[vector_store_driver.upsert_text_artifact(a, namespace="griptape") for a in artifacts]
+[vector_store_driver.upsert_text_artifact(a, namespace="griptape") for a in chunks]
 
 results = vector_store_driver.query(query="What is griptape?")
 

docs/griptape-framework/drivers/src/vector_store_drivers_4.py

@@ -1,5 +1,6 @@
 import os
 
+from griptape.chunkers import TextChunker
 from griptape.drivers import MarqoVectorStoreDriver, OpenAiChatPromptDriver, OpenAiEmbeddingDriver
 from griptape.loaders import WebLoader
 
@@ -19,12 +20,13 @@
 )
 
 # Load Artifacts from the web
-artifacts = WebLoader(max_tokens=200).load("https://www.griptape.ai")
+artifact = WebLoader().load("https://www.griptape.ai")
+chunks = TextChunker(max_tokens=200).chunk(artifact)
 
 # Upsert Artifacts into the Vector Store Driver
 vector_store_driver.upsert_text_artifacts(
     {
-        "griptape": artifacts,
+        "griptape": chunks,
     }
 )
 

docs/griptape-framework/drivers/src/vector_store_drivers_5.py

@@ -1,5 +1,6 @@
 import os
 
+from griptape.chunkers import TextChunker
 from griptape.drivers import MongoDbAtlasVectorStoreDriver, OpenAiEmbeddingDriver
 from griptape.loaders import WebLoader
 
@@ -25,14 +26,11 @@
 )
 
 # Load Artifacts from the web
-artifacts = WebLoader(max_tokens=200).load("https://www.griptape.ai")
+artifact = WebLoader().load("https://www.griptape.ai")
+chunks = TextChunker(max_tokens=200).chunk(artifact)
 
 # Upsert Artifacts into the Vector Store Driver
-vector_store_driver.upsert_text_artifacts(
-    {
-        "griptape": artifacts,
-    }
-)
+vector_store_driver.upsert_text_artifacts({"griptape": chunks})
 
 results = vector_store_driver.query(query="What is griptape?")
 

docs/griptape-framework/drivers/src/vector_store_drivers_6.py

@@ -1,5 +1,6 @@
 import os
 
+from griptape.chunkers import TextChunker
 from griptape.drivers import AzureMongoDbVectorStoreDriver, OpenAiEmbeddingDriver
 from griptape.loaders import WebLoader
 
@@ -25,12 +26,13 @@
 )
 
 # Load Artifacts from the web
-artifacts = WebLoader(max_tokens=200).load("https://www.griptape.ai")
+artifact = WebLoader().load("https://www.griptape.ai")
+chunks = TextChunker(max_tokens=200).chunk(artifact)
 
 # Upsert Artifacts into the Vector Store Driver
 vector_store_driver.upsert_text_artifacts(
     {
-        "griptape": artifacts,
+        "griptape": chunks,
     }
 )