Firestore

Use Firestore for agent session storage and persistence.

Kern supports using Firestore as a database with the FirestoreDb class.

You can get started with Firestore following their Get Started guide.

Usage

You need to provide a project_id parameter to the FirestoreDb class. Firestore will connect automatically using your Google Cloud credentials.

1from kern.agent import Agent
2from kern.db.firestore import FirestoreDb
3
4PROJECT_ID = "kern-os-test"  # Use your project ID here
5
6# Setup the Firestore database
7db = FirestoreDb(project_id=PROJECT_ID)
8
9# Setup your Agent with the Database
10agent = Agent(db=db)

Prerequisites

Ensure your gcloud project is enabled with Firestore. Reference Firestore documentation
Install dependencies: uv pip install openai google-cloud-firestore kern-ai
Make sure your gcloud project is set up and you have the necessary permissions to access Firestore

Params

Parameter	Type	Default	Description
`id`	`Optional[str]`	-	The ID of the database instance. UUID by default.
`db_client`	`Optional[Client]`	-	The Firestore client to use.
`project_id`	`Optional[str]`	-	The GCP project ID for Firestore.
`session_collection`	`Optional[str]`	-	Name of the collection to store sessions.
`memory_collection`	`Optional[str]`	-	Name of the collection to store memories.
`metrics_collection`	`Optional[str]`	-	Name of the collection to store metrics.
`eval_collection`	`Optional[str]`	-	Name of the collection to store evaluation runs.
`knowledge_collection`	`Optional[str]`	-	Name of the collection to store knowledge documents.
`traces_collection`	`Optional[str]`	-	Name of the collection to store traces.
`spans_collection`	`Optional[str]`	-	Name of the collection to store spans.