Quickstart
Source mirrored from
seocho/QUICKSTART.md
This is the shortest path to a working ontology-aligned graph memory.
You will:
- define a tiny ontology
- add one sentence
- ask a question against the graph memory
1. Install
Section titled “1. Install”uv pip install "seocho[local]"seocho[local] includes the local SDK engine, agent dependencies, and the
embedded LadybugDB graph path. You do not need to run a server for this first
example.
2. Run The Smallest Example
Section titled “2. Run The Smallest Example”from seocho import Seocho, Ontology, NodeDef, RelDef, Property
ontology = Ontology( name="work", nodes={ "Person": NodeDef(properties={"name": Property(str, unique=True)}), "Company": NodeDef(properties={"name": Property(str, unique=True)}), }, relationships={ "WORKS_AT": RelDef(source="Person", target="Company"), },)
client = Seocho.local(ontology)client.add("Marie Curie worked at the University of Paris.")
print(client.ask("Where did Marie Curie work?"))What happened:
- the ontology declared the allowed graph shape
add()extracted graph facts that fit that shapeask()queried the graph memory and produced an ontology-grounded answer
3. Run A Real Example
Section titled “3. Run A Real Example”The finance-compliance example is the fastest complete project-shaped path:
export OPENAI_API_KEY=...python examples/finance-compliance/quickstart.pyIt ships:
examples/finance-compliance/ontology.py- six short mock compliance documents
- a script that ingests them and asks cross-document questions
4. Connect To A Runtime
Section titled “4. Connect To A Runtime”If a SEOCHO runtime is already running:
from seocho import Seocho
client = Seocho.remote("http://localhost:8001")print(client.ask("What do we know about ACME?"))To start the local UI/API/DozerDB stack from a cloned repository:
make setup-envmake upThen open:
- UI:
http://localhost:8501 - API docs:
http://localhost:8001/docs - DozerDB browser:
http://localhost:7474
| Need | Start here |
|---|---|
| Understand the project | README.md |
| Use your own ontology and files | docs/APPLY_YOUR_DATA.md |
| Learn the Python SDK | docs/PYTHON_INTERFACE_QUICKSTART.md |
| Run the full platform | docs/RUNTIME_DEPLOYMENT.md |
| See generated files and traces | docs/FILES_AND_ARTIFACTS.md |