Overview

You can use Conversation Memory to give Griptape Structures the ability to keep track of the conversation across runs. All structures are created with ConversationMemory by default.

Example

from griptape.structures import Agent
from griptape.memory.structure import ConversationMemory

agent = Agent()

agent.run("My favorite animal is a Liger.")
agent.run("What is my favorite animal?")

[09/19/23 14:21:07] INFO     PromptTask 3e64ca5d5f634a11957cbf46adce251a
                             Input: My favorite animal is a Liger.
[09/19/23 14:21:13] INFO     PromptTask 3e64ca5d5f634a11957cbf46adce251a
                             Output: That's fascinating! Ligers, a hybrid offspring of a male lion and a female tiger, are indeed unique and
                             interesting animals. They are known to be the largest of all big cats. Do you have a particular reason why you
                             like them so much?
                    INFO     PromptTask 3e64ca5d5f634a11957cbf46adce251a
                             Input: What is my favorite animal?
[09/19/23 14:21:15] INFO     PromptTask 3e64ca5d5f634a11957cbf46adce251a
                             Output: Your favorite animal is a Liger, as you previously mentioned.

You can disable conversation memory in any structure by setting it to None:

from griptape.structures import Agent
from griptape.memory.structure import ConversationMemory

Agent(conversation_memory=None)

Types of Memory

Griptape provides several types of Conversation Memory to fit various use-cases.

Conversation Memory

ConversationMemory will keep track of the full task input and output for all runs.

from griptape.structures import Agent
from griptape.memory.structure import ConversationMemory

agent = Agent(
    conversation_memory=ConversationMemory()
)

agent.run("Hello!")

print(agent.conversation_memory)

You can set the max_runs parameter to limit how many runs are kept in memory.

from griptape.structures import Agent
from griptape.memory.structure import ConversationMemory

agent = Agent(
    conversation_memory=ConversationMemory(max_runs=2)
)

agent.run("Run 1")
agent.run("Run 2")
agent.run("Run 3")
agent.run("Run 4")
agent.run("Run 5")

print(agent.conversation_memory.runs[0].input == 'run4')
print(agent.conversation_memory.runs[1].input == 'run5')

Summary Conversation Memory

SummaryConversationMemory will progressively summarize task input and output of runs.

You can choose to offset which runs are summarized with the offset parameter.

from griptape.structures import Agent
from griptape.memory.structure import SummaryConversationMemory

agent = Agent(
    conversation_memory=SummaryConversationMemory(offset=2)
)

agent.run("Hello!")

print(agent.conversation_memory.summary)

Conversation Memory Drivers

You can persist and load memory by using Conversation Memory Drivers. You can build drivers for your own data stores by extending BaseConversationMemoryDriver.

from griptape.drivers import LocalConversationMemoryDriver
from griptape.structures import Agent
from griptape.memory.structure import ConversationMemory

memory_driver = LocalConversationMemoryDriver(file_path="memory.json")

agent_1 = Agent(conversation_memory=ConversationMemory(driver=memory_driver))
agent_1.run("Skateboarding is my favorite activity.")

agent_2 = Agent(conversation_memory=memory_driver.load())
agent_2.run("What is my favorite activity?")

Local Conversation Memory Driver

The LocalConversationMemoryDriver allows you to persist Conversation Memory in a local JSON file.

from griptape.structures import Agent
from griptape.drivers import LocalConversationMemoryDriver
from griptape.memory.structure import ConversationMemory

local_driver = LocalConversationMemoryDriver(file_path="memory.json")
agent = Agent(conversation_memory=ConversationMemory(driver=local_driver))

agent.run("Surfing is my favorite sport.")
agent.run("What is my favorite sport?")

Amazon DynamoDb Conversation Memory Driver

Info

This driver requires the drivers-memory-conversation-amazon-dynamodb extra.

The AmazonDynamoDbConversationMemoryDriver allows you to persist Conversation Memory in Amazon DynamoDb.

import os
import uuid
from griptape.drivers import AmazonDynamoDbConversationMemoryDriver
from griptape.memory.structure import ConversationMemory
from griptape.structures import Agent

conversation_id = uuid.uuid4().hex
dynamodb_driver = AmazonDynamoDbConversationMemoryDriver(
    table_name=os.getenv("DYNAMODB_TABLE_NAME"),
    partition_key="id",
    value_attribute_key="memory",
    partition_key_value=conversation_id,
)

agent = Agent(conversation_memory=ConversationMemory(driver=dynamodb_driver))

agent.run("My name is Jeff.")
agent.run("What is my name?")