diff --git a/CHANGELOG.md b/CHANGELOG.md index c41c468795..3eb4d1cc57 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -63,6 +63,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - **BREAKING**: `BaseExtractionEngine` no longer catches exceptions and returns `ErrorArtifact`s. - **BREAKING**: `JsonExtractionEngine.template_schema` is now required. - **BREAKING**: `CsvExtractionEngine.column_names` is now required. +- **BREAKING**: Renamed `GriptapeCloudKnowledgeBaseVectorStoreDriver` to `GriptapeCloudVectorStoreDriver`. - `JsonExtractionEngine.extract_artifacts` now returns a `ListArtifact[JsonArtifact]`. - `CsvExtractionEngine.extract_artifacts` now returns a `ListArtifact[CsvRowArtifact]`. - Remove `manifest.yml` requirements for custom tool creation. diff --git a/MIGRATION.md b/MIGRATION.md index d40c1bdfe5..a82b8c6c94 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -152,6 +152,21 @@ image_artifact = ImageArtifact( print(image_artifact.meta["prompt"], image_artifact.meta["model"]) # Generate an image of a cat, DALL-E ``` +Renamed `GriptapeCloudKnowledgeBaseVectorStoreDriver` to `GriptapeCloudVectorStoreDriver`. + +#### Before +```python +from griptape.drivers.griptape_cloud_knowledge_base_vector_store_driver import GriptapeCloudKnowledgeBaseVectorStoreDriver + +driver = GriptapeCloudKnowledgeBaseVectorStoreDriver(...) +``` + +#### After +```python +from griptape.drivers.griptape_cloud_vector_store_driver import GriptapeCloudVectorStoreDriver + +driver = GriptapeCloudVectorStoreDriver(...) +``` ## 0.31.X to 0.32.X diff --git a/docs/griptape-cloud/knowledge-bases/accessing-data.md b/docs/griptape-cloud/knowledge-bases/accessing-data.md index 8cb2f7e7bf..8343933ddc 100644 --- a/docs/griptape-cloud/knowledge-bases/accessing-data.md +++ b/docs/griptape-cloud/knowledge-bases/accessing-data.md @@ -30,4 +30,4 @@ curl -H "Authorization: Bearer ${GT_CLOUD_API_KEY}" --json '{"query": "test ques ## Using the Griptape Framework -You can use the [GriptapeCloudKnowledgeBaseVectorStoreDriver](../../griptape-framework/drivers/vector-store-drivers.md/#griptape-cloud-knowledge-base) to query your Knowledge Base with Griptape and the [GriptapeCloudKnowledgeBaseTool](../../griptape-tools/official-tools/griptape-cloud-knowledge-base-tool.md) to search. +You can use the [GriptapeCloudVectorStoreDriver](../../griptape-framework/drivers/vector-store-drivers.md/#griptape-cloud-knowledge-base) to query your Knowledge Base with Griptape and the [GriptapeCloudKnowledgeBaseTool](../../griptape-tools/official-tools/griptape-cloud-knowledge-base-tool.md) to search. diff --git a/docs/griptape-framework/drivers/vector-store-drivers.md b/docs/griptape-framework/drivers/vector-store-drivers.md index 7cca64a46e..6a76a8cf51 100644 --- a/docs/griptape-framework/drivers/vector-store-drivers.md +++ b/docs/griptape-framework/drivers/vector-store-drivers.md @@ -33,7 +33,7 @@ The [LocalVectorStoreDriver](../../reference/griptape/drivers/vector/local_vecto ### Griptape Cloud Knowledge Base -The [GriptapeCloudKnowledgeBaseVectorStoreDriver](../../reference/griptape/drivers/vector/griptape_cloud_knowledge_base_vector_store_driver.md) can be used to query data from a Griptape Cloud Knowledge Base. Loading into Knowledge Bases is not supported at this time, only querying. Here is a complete example of how the Driver can be used to query an existing Knowledge Base: +The [GriptapeCloudVectorStoreDriver](../../reference/griptape/drivers/vector/griptape_cloud_vector_store_driver.md) can be used to query data from a Griptape Cloud Knowledge Base. Loading into Knowledge Bases is not supported at this time, only querying. Here is a complete example of how the Driver can be used to query an existing Knowledge Base: ```python --8<-- "docs/griptape-framework/drivers/src/vector_store_drivers_2.py" diff --git a/griptape/drivers/__init__.py b/griptape/drivers/__init__.py index af81801f40..9abcc11321 100644 --- a/griptape/drivers/__init__.py +++ b/griptape/drivers/__init__.py @@ -43,7 +43,7 @@ from .vector.dummy_vector_store_driver import DummyVectorStoreDriver from .vector.qdrant_vector_store_driver import QdrantVectorStoreDriver from .vector.astradb_vector_store_driver import AstraDbVectorStoreDriver -from .vector.griptape_cloud_knowledge_base_vector_store_driver import GriptapeCloudVectorStoreDriver +from .vector.griptape_cloud_vector_store_driver import GriptapeCloudVectorStoreDriver from .sql.base_sql_driver import BaseSqlDriver from .sql.amazon_redshift_sql_driver import AmazonRedshiftSqlDriver diff --git a/griptape/drivers/vector/griptape_cloud_knowledge_base_vector_store_driver.py b/griptape/drivers/vector/griptape_cloud_vector_store_driver.py similarity index 100% rename from griptape/drivers/vector/griptape_cloud_knowledge_base_vector_store_driver.py rename to griptape/drivers/vector/griptape_cloud_vector_store_driver.py diff --git a/tests/unit/drivers/vector/test_griptape_cloud_knowledge_base_vector_store_driver.py b/tests/unit/drivers/vector/test_griptape_cloud_knowledge_base_vector_store_driver.py index 093334b559..f87b30444a 100644 --- a/tests/unit/drivers/vector/test_griptape_cloud_knowledge_base_vector_store_driver.py +++ b/tests/unit/drivers/vector/test_griptape_cloud_knowledge_base_vector_store_driver.py @@ -5,7 +5,7 @@ from griptape.drivers import GriptapeCloudVectorStoreDriver -class TestGriptapeCloudKnowledgeBaseVectorStoreDriver: +class TestGriptapeCloudVectorStoreDriver: test_ids = [str(uuid.uuid4()), str(uuid.uuid4())] test_vecs = [[0.1, 0.2, 0.3], [0.4, 0.5, 0.6]] test_namespaces = [str(uuid.uuid4()), str(uuid.uuid4())]