Skip to content

Commit 657b7cc

Browse files
committed
update readmes
1 parent 59c8443 commit 657b7cc

2 files changed

Lines changed: 23 additions & 8 deletions

File tree

integrations/cognee/README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,12 @@
33
[![PyPI](https://img.shields.io/pypi/v/cognee-haystack.svg)](https://pypi.org/project/cognee-haystack/)
44
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
55

6-
A [Haystack](https://haystack.deepset.ai/) integration for [Cognee](https://github.com/topoteretes/cognee) — memory for AI agents.
6+
A [Haystack](https://haystack.deepset.ai/) integration for [Cognee](https://github.com/topoteretes/cognee) — open-source memory for AI agents.
7+
8+
[Cognee](https://www.cognee.ai/) gives agents persistent, traceable memory by transforming raw data (e.g., unstructured documents, relational databases, etc.) into a knowledge engine that is both searchable by meaning and connected by relationships. Cognee uses an ECL (Extract, Cognify, Load) pipeline: vector search, knowledge graphs, with support for ontology-based entity grounding (e.g. OWL) and Pydantic-defined graph schemas.
9+
10+
Cognee serves developers and teams building agentic systems where agents need to retain context across sessions, learn from user feedback, and operate in multi-tenant, data-isolated environments. Cognee is available as an open-source Python library (Apache 2.0), a self-hosted/on-prem subscription tier, and a managed cloud service (Cognee Cloud at platform.cognee.ai).
11+
712

813
## Installation
914

@@ -87,7 +92,7 @@ results = store.search_memories(query="When is the deadline?")
8792
Cognee uses environment variables for its LLM and storage configuration:
8893

8994
```bash
90-
export OPENAI_API_KEY="sk-..."
95+
export LLM_API_KEY="sk-..."
9196
```
9297

9398
See the [Cognee documentation](https://docs.cognee.ai/) for additional configuration options.
@@ -102,13 +107,19 @@ See the [`examples/`](examples/) directory for runnable demos:
102107
## Development
103108

104109
```bash
105-
# Install in dev mode
106-
pip install -e "integrations/cognee[memory]"
110+
cd integrations/cognee
111+
112+
# Format and lint
113+
hatch run fmt
114+
hatch run fmt-check
115+
116+
# Type checking
117+
hatch run test:types
107118

108119
# Run tests
109-
pytest integrations/cognee/tests/
120+
hatch run test:unit
110121
```
111122

112123
## License
113124

114-
Apache 2.0 — see [LICENSE](../../LICENSE) for details.
125+
Apache 2.0 — see [LICENSE](LICENSE) for details.

integrations/cognee/examples/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,14 @@ Install the integration from the repository root:
88
pip install -e "integrations/cognee[memory]"
99
```
1010

11-
Set your LLM API key (required by cognee):
11+
Set your LLM API key (required by cognee, default OpenAI API key) and ENABLE_BACKEND_ACCESS_CONTROL=False for simplicity:
12+
13+
To integrate other LLM providers and other configuration options, see [Cognee Documentation](https://docs.cognee.ai/getting-started/installation#environment-configuration).
14+
1215

1316
```bash
14-
export LLM_API_KEY="sk-..."
17+
export LLM_API_KEY="sk-your-openai-api-key"
18+
export ENABLE_BACKEND_ACCESS_CONTROL="False"
1519
```
1620

1721
## Examples

0 commit comments

Comments
 (0)