Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/griptape-framework/data/loaders.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Loads text files into [TextArtifact](../../griptape-framework/data/artifacts.md#

!!! info

This driver requires the `loaders-pdf` [extra](../index.md#extras).
This driver requires the `loaders-pdf` [extra](../index.md#installing-optional-dependencies).

Loads PDF files into [ListArtifact](../../griptape-framework/data/artifacts.md#list)s, where each element is a [TextArtifact](../../griptape-framework/data/artifacts.md#text) containing a page of the PDF:

Expand All @@ -51,7 +51,7 @@ Loads CSV files into [ListArtifact](../../griptape-framework/data/artifacts.md#l

!!! info

This driver requires the `loaders-image` [extra](../index.md#extras).
This driver requires the `loaders-image` [extra](../index.md#installing-optional-dependencies).

Loads images into [ImageArtifact](../../griptape-framework/data/artifacts.md#image)s:

Expand Down Expand Up @@ -88,7 +88,7 @@ Loads JSON files into [JsonArtifact](../../griptape-framework/data/artifacts.md#

!!! info

This driver requires the `loaders-web` [extra](../index.md#extras).
This driver requires the `loaders-web` [extra](../index.md#installing-optional-dependencies).

Scrapes web pages using a [WebScraperDriver](../drivers/web-scraper-drivers.md) and loads the resulting text into [TextArtifact](../../griptape-framework/data/artifacts.md#text)s.

Expand All @@ -108,7 +108,7 @@ Loads data from a SQL database using a [SQLDriver](../drivers/sql-drivers.md) an

!!! info

This driver requires the `loaders-email` [extra](../index.md#extras).
This driver requires the `loaders-email` [extra](../index.md#installing-optional-dependencies).

Loads data from an imap email server into a [ListArtifact](../../reference/griptape/artifacts/list_artifact.md)s, where each element is a [TextArtifact](../../reference/griptape/artifacts/text_artifact.md) containing an email.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The [LocalConversationMemoryDriver](../../reference/griptape/drivers/memory/conv

!!! info

This driver requires the `drivers-memory-conversation-amazon-dynamodb` [extra](../index.md#extras).
This driver requires the `drivers-memory-conversation-amazon-dynamodb` [extra](../index.md#installing-optional-dependencies).

The [AmazonDynamoDbConversationMemoryDriver](../../reference/griptape/drivers/memory/conversation/amazon_dynamodb_conversation_memory_driver.md) allows you to persist Conversation Memory in [Amazon DynamoDb](https://aws.amazon.com/dynamodb/).

Expand All @@ -67,7 +67,7 @@ Optional parameters `sort_key` and `sort_key_value` can be supplied for tables w

!!! info

This driver requires the `drivers-memory-conversation-redis` [extra](../index.md#extras).
This driver requires the `drivers-memory-conversation-redis` [extra](../index.md#installing-optional-dependencies).

The [RedisConversationMemoryDriver](../../reference/griptape/drivers/memory/conversation/redis_conversation_memory_driver.md) allows you to persist Conversation Memory in [Redis](https://redis.io/).

Expand Down
14 changes: 7 additions & 7 deletions docs/griptape-framework/drivers/embedding-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ with updated defaults.

!!! info

This driver requires the `drivers-embedding-amazon-bedrock` [extra](../index.md#extras).
This driver requires the `drivers-embedding-amazon-bedrock` [extra](../index.md#installing-optional-dependencies).

The [AmazonBedrockTitanEmbeddingDriver](../../reference/griptape/drivers/embedding/amazon_bedrock_titan_embedding_driver.md) uses the [Amazon Bedrock Embeddings API](https://docs.aws.amazon.com/bedrock/latest/userguide/embeddings.html).

Expand All @@ -76,7 +76,7 @@ The [AmazonBedrockTitanEmbeddingDriver](../../reference/griptape/drivers/embeddi

!!! info

This driver requires the `drivers-embedding-google` [extra](../index.md#extras).
This driver requires the `drivers-embedding-google` [extra](../index.md#installing-optional-dependencies).

The [GoogleEmbeddingDriver](../../reference/griptape/drivers/embedding/google_embedding_driver.md) uses the [Google Embeddings API](https://ai.google.dev/tutorials/python_quickstart#use_embeddings).

Expand All @@ -100,7 +100,7 @@ The [GoogleEmbeddingDriver](../../reference/griptape/drivers/embedding/google_em

!!! info

This driver requires the `drivers-embedding-huggingface` [extra](../index.md#extras).
This driver requires the `drivers-embedding-huggingface` [extra](../index.md#installing-optional-dependencies).

The [HuggingFaceHubEmbeddingDriver](../../reference/griptape/drivers/embedding/huggingface_hub_embedding_driver.md) connects to the [Hugging Face Hub API](https://huggingface.co/docs/hub/api). It supports models with the following tasks:

Expand All @@ -122,7 +122,7 @@ The [HuggingFaceHubEmbeddingDriver](../../reference/griptape/drivers/embedding/h

!!! info

This driver requires the `drivers-embedding-ollama` [extra](../index.md#extras).
This driver requires the `drivers-embedding-ollama` [extra](../index.md#installing-optional-dependencies).

The [OllamaEmbeddingDriver](../../reference/griptape/drivers/embedding/ollama_embedding_driver.md) uses the [Ollama Embeddings API](https://ollama.com/blog/embedding-models).

Expand All @@ -136,7 +136,7 @@ The [AmazonSageMakerJumpstartEmbeddingDriver](../../reference/griptape/drivers/e

!!! info

This driver requires the `drivers-embedding-amazon-sagemaker` [extra](../index.md#extras).
This driver requires the `drivers-embedding-amazon-sagemaker` [extra](../index.md#installing-optional-dependencies).

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_7.py"
Expand All @@ -148,7 +148,7 @@ The [VoyageAiEmbeddingDriver](../../reference/griptape/drivers/embedding/voyagea

!!! info

This driver requires the `drivers-embedding-voyageai` [extra](../index.md#extras).
This driver requires the `drivers-embedding-voyageai` [extra](../index.md#installing-optional-dependencies).

=== "Code"

Expand All @@ -168,7 +168,7 @@ The [CohereEmbeddingDriver](../../reference/griptape/drivers/embedding/cohere_em

!!! info

This driver requires the `drivers-embedding-cohere` [extra](../index.md#extras).
This driver requires the `drivers-embedding-cohere` [extra](../index.md#installing-optional-dependencies).

=== "Code"

Expand Down
6 changes: 3 additions & 3 deletions docs/griptape-framework/drivers/event-listener-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Griptape offers the following Event Listener Drivers for forwarding Griptape Eve

!!! info

This driver requires the `drivers-event-listener-amazon-sqs` [extra](../index.md#extras).
This driver requires the `drivers-event-listener-amazon-sqs` [extra](../index.md#installing-optional-dependencies).

The [AmazonSqsEventListenerDriver](../../reference/griptape/drivers/event_listener/amazon_sqs_event_listener_driver.md) sends Events to an [Amazon SQS](https://aws.amazon.com/sqs/) queue.

Expand All @@ -55,7 +55,7 @@ The [AmazonSqsEventListenerDriver](../../reference/griptape/drivers/event_listen

!!! info

This driver requires the `drivers-event-listener-amazon-iot` [extra](../index.md#extras).
This driver requires the `drivers-event-listener-amazon-iot` [extra](../index.md#installing-optional-dependencies).

The [AwsIotCoreEventListenerDriver](../../reference/griptape/drivers/event_listener/aws_iot_core_event_listener_driver.md) sends Events to the [AWS IoT Message Broker](https://aws.amazon.com/iot-core/).

Expand Down Expand Up @@ -111,7 +111,7 @@ The [WebhookEventListenerDriver](../../reference/griptape/drivers/event_listener

!!! info

This driver requires the `drivers-event-listener-pusher` [extra](../index.md#extras).
This driver requires the `drivers-event-listener-pusher` [extra](../index.md#installing-optional-dependencies).

The [PusherEventListenerDriver](../../reference/griptape/drivers/event_listener/pusher_event_listener_driver.md) sends Events to [Pusher](https://pusher.com).

Expand Down
2 changes: 1 addition & 1 deletion docs/griptape-framework/drivers/file-manager-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The [LocalFileManagerDriver](../../reference/griptape/drivers/file_manager/local

!!! info

This driver requires the `drivers-file-manager-amazon-s3` [extra](../index.md#extras).
This driver requires the `drivers-file-manager-amazon-s3` [extra](../index.md#installing-optional-dependencies).

The [LocalFile ManagerDriver](../../reference/griptape/drivers/file_manager/amazon_s3_file_manager_driver.md) allows you to load and save files sourced from an Amazon S3 bucket.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ This Driver supports image generation configurations like style presets, image q

!!! info

This driver requires the `drivers-image-generation-huggingface` [extra](../index.md#extras).
This driver requires the `drivers-image-generation-huggingface` [extra](../index.md#installing-optional-dependencies).

The [HuggingFace Pipelines Image Generation Driver](../../reference/griptape/drivers/image_generation/huggingface_pipeline_image_generation_driver.md) enables image generation through locally-hosted models using the HuggingFace [Diffusers](https://huggingface.co/docs/diffusers/en/index) library. This Driver requires a [Pipeline Driver](../../reference/griptape/drivers/image_generation_pipeline/index.md) to prepare the appropriate Pipeline.

Expand Down
4 changes: 2 additions & 2 deletions docs/griptape-framework/drivers/observability-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Observability Drivers are used by [Observability](../structures/observability.md

!!! info

This driver requires the `drivers-observability-griptape-cloud` [extra](../index.md#extras).
This driver requires the `drivers-observability-griptape-cloud` [extra](../index.md#installing-optional-dependencies).

The Griptape Cloud Observability Driver instruments `@observable` functions and methods with metrics and traces for use with the Griptape Cloud.

Expand All @@ -36,7 +36,7 @@ Here is an example of how to use the `GriptapeCloudObservabilityDriver` with the

!!! info

This driver requires the `drivers-observability-opentelemetry` [extra](../index.md#extras).
This driver requires the `drivers-observability-opentelemetry` [extra](../index.md#installing-optional-dependencies).

The [OpenTelemetry](https://opentelemetry.io/) Observability Driver instruments `@observable` functions and methods with metrics and traces for use with OpenTelemetry. You must configure a destination for the telemetry by providing a `SpanProcessor` to the Driver.

Expand Down
16 changes: 8 additions & 8 deletions docs/griptape-framework/drivers/prompt-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ This driver uses [Cohere tool use](https://docs.cohere.com/docs/tools) when usin

!!! info

This driver requires the `drivers-prompt-cohere` [extra](../index.md#extras).
This driver requires the `drivers-prompt-cohere` [extra](../index.md#installing-optional-dependencies).

=== "Code"

Expand All @@ -206,7 +206,7 @@ This driver uses [Cohere tool use](https://docs.cohere.com/docs/tools) when usin

!!! info

This driver requires the `drivers-prompt-anthropic` [extra](../index.md#extras).
This driver requires the `drivers-prompt-anthropic` [extra](../index.md#installing-optional-dependencies).

The [AnthropicPromptDriver](../../reference/griptape/drivers/prompt/anthropic_prompt_driver.md) connects to the Anthropic [Messages](https://docs.anthropic.com/claude/reference/messages_post) API.
This driver uses [Anthropic tool use](https://docs.anthropic.com/en/docs/build-with-claude/tool-use) when using [Tools](../tools/index.md).
Expand All @@ -227,7 +227,7 @@ This driver uses [Anthropic tool use](https://docs.anthropic.com/en/docs/build-w

!!! info

This driver requires the `drivers-prompt-google` [extra](../index.md#extras).
This driver requires the `drivers-prompt-google` [extra](../index.md#installing-optional-dependencies).

The [GooglePromptDriver](../../reference/griptape/drivers/prompt/google_prompt_driver.md) connects to the [Google Generative AI](https://ai.google.dev/tutorials/python_quickstart#generate_text_from_text_inputs) API.
This driver uses [Gemini function calling](https://ai.google.dev/gemini-api/docs/function-calling) when using [Tools](../tools/index.md).
Expand All @@ -248,7 +248,7 @@ This driver uses [Gemini function calling](https://ai.google.dev/gemini-api/docs

!!! info

This driver requires the `drivers-prompt-amazon-bedrock` [extra](../index.md#extras).
This driver requires the `drivers-prompt-amazon-bedrock` [extra](../index.md#installing-optional-dependencies).

The [AmazonBedrockPromptDriver](../../reference/griptape/drivers/prompt/amazon_bedrock_prompt_driver.md) uses [Amazon Bedrock](https://aws.amazon.com/bedrock/)'s [Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html).
This driver uses [Bedrock tool use](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) when using [Tools](../tools/index.md).
Expand All @@ -271,7 +271,7 @@ All models supported by the Converse API are available for use with this driver.

!!! info

This driver requires the `drivers-prompt-ollama` [extra](../index.md#extras).
This driver requires the `drivers-prompt-ollama` [extra](../index.md#installing-optional-dependencies).

The [OllamaPromptDriver](../../reference/griptape/drivers/prompt/ollama_prompt_driver.md) connects to the [Ollama Chat Completion API](https://github.com/ollama/ollama/blob/main/docs/api.md#generate-a-chat-completion).
This driver uses [Ollama tool calling](https://ollama.com/blog/tool-support) when using [Tools](../tools/index.md).
Expand All @@ -284,7 +284,7 @@ This driver uses [Ollama tool calling](https://ollama.com/blog/tool-support) whe

!!! info

This driver requires the `drivers-prompt-huggingface` [extra](../index.md#extras).
This driver requires the `drivers-prompt-huggingface` [extra](../index.md#installing-optional-dependencies).

The [HuggingFaceHubPromptDriver](../../reference/griptape/drivers/prompt/huggingface_hub_prompt_driver.md) connects to the [Hugging Face Hub API](https://huggingface.co/docs/hub/api).

Expand Down Expand Up @@ -318,7 +318,7 @@ The [HuggingFaceHubPromptDriver](#hugging-face-hub) also supports [Text Generati

!!! info

This driver requires the `drivers-prompt-huggingface-pipeline` [extra](../index.md#extras).
This driver requires the `drivers-prompt-huggingface-pipeline` [extra](../index.md#installing-optional-dependencies).

The [HuggingFacePipelinePromptDriver](../../reference/griptape/drivers/prompt/huggingface_pipeline_prompt_driver.md) uses [Hugging Face Pipelines](https://huggingface.co/docs/transformers/main_classes/pipelines) for inference locally.

Expand All @@ -342,7 +342,7 @@ The [HuggingFacePipelinePromptDriver](../../reference/griptape/drivers/prompt/hu

!!! info

This driver requires the `drivers-prompt-amazon-sagemaker` [extra](../index.md#extras).
This driver requires the `drivers-prompt-amazon-sagemaker` [extra](../index.md#installing-optional-dependencies).

The [AmazonSageMakerJumpstartPromptDriver](../../reference/griptape/drivers/prompt/amazon_sagemaker_jumpstart_prompt_driver.md) uses [Amazon SageMaker Jumpstart](https://docs.aws.amazon.com/sagemaker/latest/dg/studio-jumpstart.html) for inference on AWS.

Expand Down
4 changes: 2 additions & 2 deletions docs/griptape-framework/drivers/rerank-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The [CohereRerankDriver](../../reference/griptape/drivers/rerank/cohere_rerank_d

!!! info

This driver requires the `drivers-rerank-amazon-bedrock` [extra](../index.md#extras).
This driver requires the `drivers-rerank-amazon-bedrock` [extra](../index.md#installing-optional-dependencies).

The [AmazonBedrockRerankDriver](../../reference/griptape/drivers/rerank/amazon_bedrock_rerank_driver.md) uses [Amazon Bedrock](https://aws.amazon.com/bedrock/)'s Rerank API.

Expand All @@ -73,7 +73,7 @@ The [NvidiaNimRerankDriver](../../reference/griptape/drivers/rerank/nvidia_nim_r

!!! info

This driver requires the `drivers-rerank-voyageai` [extra](../index.md#extras).
This driver requires the `drivers-rerank-voyageai` [extra](../index.md#installing-optional-dependencies).

The [VoyageAiRerankDriver](../../reference/griptape/drivers/rerank/voyageai_rerank_driver.md) uses [Voyage AI's Rerank](https://docs.voyageai.com/docs/reranker) API.

Expand Down
6 changes: 3 additions & 3 deletions docs/griptape-framework/drivers/sql-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ SQL drivers can be used to make SQL queries and load table schemas. They are use

!!! info

This driver requires the `drivers-sql` [extra](../index.md#extras).
This driver requires the `drivers-sql` [extra](../index.md#installing-optional-dependencies).

Note that you may need to install the appropriate database driver for your SQL database.
For example, to use the `psycopg2` driver for PostgreSQL, you can install it with `pip install psycopg2-binary`.
Expand All @@ -32,7 +32,7 @@ This is a basic SQL loader based on [SQLAlchemy 2.0](https://docs.sqlalchemy.org

!!! info

This driver requires the `drivers-sql-amazon-redshift` [extra](../index.md#extras).
This driver requires the `drivers-sql-amazon-redshift` [extra](../index.md#installing-optional-dependencies).

This is a SQL driver for interacting with the [Amazon Redshift Data API](https://docs.aws.amazon.com/redshift-data/latest/APIReference/Welcome.html)
to execute statements. Here is an example of how to use it for Redshift Serverless:
Expand All @@ -45,7 +45,7 @@ to execute statements. Here is an example of how to use it for Redshift Serverle

!!! info

This driver requires the `drivers-sql-snowflake` [extra](../index.md#extras).
This driver requires the `drivers-sql-snowflake` [extra](../index.md#installing-optional-dependencies).

This is a SQL driver based on the [Snowflake SQLAlchemy Toolkit](https://docs.snowflake.com/en/developer-guide/python-connector/sqlalchemy) which runs on top of the Snowflake Connector for Python. Here is an example of how to use it:

Expand Down
2 changes: 1 addition & 1 deletion docs/griptape-framework/drivers/text-to-speech-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The [Eleven Labs Text to Speech Driver](../../reference/griptape/drivers/text_to

!!! info

This driver requires the `drivers-text-to-speech-elevenlabs` [extra](../index.md#extras).
This driver requires the `drivers-text-to-speech-elevenlabs` [extra](../index.md#installing-optional-dependencies).

=== "Code"

Expand Down
Loading
Loading