User GuidesΒΆ
Read these pages in order if you are new to the package:
Getting Startedexplains the GoodMem concepts that show up in the public API and helps you choose the right entry point.Connect To An Existing Spaceis the simplest workflow when you already have a GoodMem space.Create A Spaceexplains the package-owned create helper and when to chooseembedders=versusembedding=.Manage GoodMem RAG Resourcesexplains the resource facade for embedders, spaces, memories, and clean-slate vector-store bootstrap.Embeddings Workflowexplains whenGoodMemEmbeddingsis necessary and when it is not.Examplespoints to the runnable scripts underexamples/and clarifies which workflow each one demonstrates.
Two cross-cutting rules are worth remembering before you dive in:
writes create GoodMem memories, while searches return chunk-level LangChain
DocumentvaluesGoodMem metadata filters apply to memory-level JSON metadata, not to chunk-level result objects