Skip to content

Commit

Permalink
Rename GriptapeCloudKnowledgeBaseVectorStoreDriver to GriptapeCloudVe…
Browse files Browse the repository at this point in the history
…ctorStoreDriver
  • Loading branch information
collindutter committed Oct 7, 2024
1 parent 522d4a9 commit c70c4b6
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
15 changes: 15 additions & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/griptape-cloud/knowledge-bases/accessing-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/griptape-framework/drivers/vector-store-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion griptape/drivers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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())]
Expand Down

0 comments on commit c70c4b6

Please sign in to comment.