Skip to content

Commit

Permalink
chore(docs): update code snippets logs (#1722)
Browse files Browse the repository at this point in the history
* chore(docs): update code snippets logs

* chore(docs): remove manually created logs

* chore(docs): don't spell check in logs

---------

Co-authored-by: github-merge-queue[bot] <118344674+github-merge-queue[bot]@users.noreply.github.com>
Co-authored-by: Collin Dutter <[email protected]>
  • Loading branch information
3 people authored Feb 27, 2025
1 parent 0407fc7 commit f5503bd
Show file tree
Hide file tree
Showing 204 changed files with 14,357 additions and 2,252 deletions.
2 changes: 1 addition & 1 deletion _typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ ND = "ND"
mornin = "mornin"

[files]
extend-exclude = ["docs/assets", "tests/resources/"]
extend-exclude = ["docs/assets", "tests/resources/", "docs/**/logs/*.txt"]
28 changes: 22 additions & 6 deletions docs/griptape-framework/drivers/assistant-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,30 @@ Assistant Drivers can be used to interact with various "assistant" services.

The [GriptapeCloudAssistantDriver](../../reference/griptape/drivers/assistant/griptape_cloud_assistant_driver.md) is used to run Griptape Cloud Assistants.

```python
--8<-- "docs/griptape-framework/drivers/src/assistant_drivers_1.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/assistant_drivers_1.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/assistant_drivers_1.txt"
```

### OpenAI

The [OpenAiAssistantDriver](../../reference/griptape/drivers/assistant/openai_assistant_driver.md) is used to run [OpenAI Assistants](https://platform.openai.com/docs/assistants/overview).

```python
--8<-- "docs/griptape-framework/drivers/src/assistant_drivers_2.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/assistant_drivers_2.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/assistant_drivers_2.txt"
```
14 changes: 11 additions & 3 deletions docs/griptape-framework/drivers/audio-transcription-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ search:

The [OpenAI Audio Transcription Driver](../../reference/griptape/drivers/audio_transcription/openai_audio_transcription_driver.md) utilizes OpenAI's sophisticated `whisper` model to accurately transcribe spoken audio into text. This model supports multiple languages, ensuring precise transcription across a wide range of dialects.

```python
--8<-- "docs/griptape-framework/drivers/src/audio_transcription_drivers_1.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/audio_transcription_drivers_1.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/audio_transcription_drivers_1.txt"
```
56 changes: 44 additions & 12 deletions docs/griptape-framework/drivers/conversation-memory-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,33 @@ You can persist and load memory by using Conversation Memory Drivers. You can bu

The [GriptapeCloudConversationMemoryDriver](../../reference/griptape/drivers/memory/conversation/griptape_cloud_conversation_memory_driver.md) allows you to persist Conversation Memory in Griptape Cloud. It provides seamless integration with Griptape's cloud-based `Threads` and `Messages` resources.

```python
--8<-- "docs/griptape-framework/drivers/src/conversation_memory_drivers_griptape_cloud.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/conversation_memory_drivers_griptape_cloud.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/conversation_memory_drivers_griptape_cloud.txt"
```

### Local

The [LocalConversationMemoryDriver](../../reference/griptape/drivers/memory/conversation/local_conversation_memory_driver.md) allows you to persist Conversation Memory in a local JSON file.

```python
--8<-- "docs/griptape-framework/drivers/src/conversation_memory_drivers_1.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/conversation_memory_drivers_1.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/conversation_memory_drivers_1.txt"
```

### Amazon DynamoDb

Expand All @@ -33,9 +49,17 @@ The [LocalConversationMemoryDriver](../../reference/griptape/drivers/memory/conv

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/).

```python
--8<-- "docs/griptape-framework/drivers/src/conversation_memory_drivers_2.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/conversation_memory_drivers_2.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/conversation_memory_drivers_2.txt"
```

Optional parameters `sort_key` and `sort_key_value` can be supplied for tables with a composite primary key.

Expand All @@ -47,6 +71,14 @@ Optional parameters `sort_key` and `sort_key_value` can be supplied for tables w

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

```python
--8<-- "docs/griptape-framework/drivers/src/conversation_memory_drivers_3.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/conversation_memory_drivers_3.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/conversation_memory_drivers_3.txt"
```
98 changes: 77 additions & 21 deletions docs/griptape-framework/drivers/embedding-drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,17 @@ You can optionally provide a [Tokenizer](../misc/tokenizers.md) via the [tokeniz

The [OpenAiEmbeddingDriver](../../reference/griptape/drivers/embedding/openai_embedding_driver.md) uses the [OpenAI Embeddings API](https://platform.openai.com/docs/guides/embeddings).

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_1.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_1.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/embedding_drivers_1.txt"
```

```
[0.0017853748286142945, 0.006118456833064556, -0.005811543669551611]
Expand Down Expand Up @@ -54,9 +62,17 @@ with updated defaults.

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).

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_3.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_3.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/embedding_drivers_3.txt"
```

```
[-0.234375, -0.024902344, -0.14941406]
Expand All @@ -70,9 +86,17 @@ The [AmazonBedrockTitanEmbeddingDriver](../../reference/griptape/drivers/embeddi

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

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_4.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_4.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/embedding_drivers_4.txt"
```

```
[0.0588633, 0.0033929371, -0.072810836]
Expand All @@ -88,9 +112,17 @@ The [HuggingFaceHubEmbeddingDriver](../../reference/griptape/drivers/embedding/h

- feature-extraction

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_5.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_5.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/embedding_drivers_5.txt"
```

### Ollama

Expand Down Expand Up @@ -124,9 +156,17 @@ The [VoyageAiEmbeddingDriver](../../reference/griptape/drivers/embedding/voyagea

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

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_8.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_8.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/embedding_drivers_8.txt"
```

### Cohere

Expand All @@ -136,14 +176,30 @@ The [CohereEmbeddingDriver](../../reference/griptape/drivers/embedding/cohere_em

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

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_9.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_9.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/embedding_drivers_9.txt"
```

### Override Default Structure Embedding Driver

Here is how you can override the Embedding Driver that is used by default in Structures.

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_10.py"
```
=== "Code"

```python
--8<-- "docs/griptape-framework/drivers/src/embedding_drivers_10.py"
```

=== "Logs"

```text
--8<-- "docs/griptape-framework/drivers/logs/embedding_drivers_10.txt"
```
Loading

0 comments on commit f5503bd

Please sign in to comment.