Enterprise knowledge graph (L2) — optional PyPI package split from AIECS
Project description
aiecs-kg
Enterprise knowledge graph (L2) for AIECS, split from the monorepo as an optional PyPI package.
Status
0.9.0 (Beta) — first non-prerelease PyPI cut (Development Status :: 4 - Beta; tag v0.9.0). Includes SPG OpenAPI/write-token work, live gates/F1a, and packaging integrity fixes. Core graph store, reasoning (heuristic + Logic DSL), builder paths, and OpenSPG ([spg]) integration are usable; PostgreSQL / Neo4j dual-store and LLM features require optional extras and caller configuration.
Not GA: treat as Beta until maintainers attest PostgreSQL, Neo4j/pg_neo4j, and SPG live paths outside default CI. Security reporting: SECURITY.md.
See docs/development_plan/archive/KNOWLEDGE_GRAPH_OPTIONAL_PACKAGING.md for the full split checklist.
CI verification scope
GitHub Actions (pip install -e ".[dev]", no external services) validates:
| Area | CI | Requires local / maintainer setup |
|---|---|---|
| In-memory graph store | Yes | — |
| SQLite backend | Yes | — |
| Reasoning (Logic DSL, orchestrator) | Yes | — |
| Structured builder import | Yes | — |
| LLM injection (mock clients) | Yes | Real LLM keys: manual / nightly |
PostgreSQL ([postgres]) |
No (skip) | KG_POSTGRES_URL + .env.test |
Neo4j / pg_neo4j / GDS ([graph]) |
No (skip) | KG_NEO4J_URI + system Neo4j 5.26+ |
| AIECS integrations | No (skip) | pip install -r requirements/optional-aiecs.txt (or pip install aiecs) |
SPG / OpenSPG ([spg]) |
Unit + mock only | pip install aiecs-kg[spg] + compose; see docs/spg/README.md |
Release gate (tag v*): unit tests + deptry + build + twine check + artifact smoke (LICENSE + package data) + verify-install (Logic DSL from wheel). Does not run Postgres/Neo4j/SPG live integration (see scripts/README.md).
Install
# Core (in-memory graph store)
pip install -e .
# With backends
pip install -e ".[postgres,sqlite,reasoning]"
# Neo4j graph compute + PostgreSQL dual-store (Phase NG)
pip install -e ".[graph]" # neo4j + postgres extras
# or: pip install -e ".[neo4j,postgres]"
# Development
pip install -e ".[dev,sqlite]"
# OpenSPG / aiecs-spg HTTP client + Profile B bridge
pip install -e ".[dev,spg]"
Optional extras (pyproject.toml)
| Extra | Installs | LLM / AIECS |
|---|---|---|
| (core) | Graph store, reasoning heuristics | No LLM — pass llm_client= / embedding_client= yourself |
postgres / sqlite / neo4j / graph |
Storage backends (graph = neo4j + postgres) |
No LLM |
reasoning |
Lark Logic DSL parser | No LLM |
builder |
Structured data import (pandas, etc.) | No LLM; GraphBuilder accepts injected embedding_client= |
fusion |
Redis-backed fusion helpers | No LLM |
spg |
urllib3/six/dateutil for OpenSPG HTTP SDK | client/spg/*, KG_STORAGE_MODE=spg; see docs/spg/README.md |
all |
Union of runtime extras above (not dev / release) |
No LLM |
dev / release |
Test/lint tools; build/twine | Maintainers |
Heavy optional stacks stay out of PyPI extras (keeps lock/resolve light). Install from the repo:
pip install -r requirements/optional-aiecs.txt # aiecs integrations helpers
pip install -r requirements/optional-nlp.txt # spaCy NER
pip install -r requirements/optional-rerank.txt # CrossEncoder rerank
For LLM usage patterns see LLM integration and LLM_CLIENT_INJECTION_PLAN.md §7.
Deprecated factory methods (GraphBuilder.from_config, LLMEntityExtractor.from_config) remain for compatibility but do not resolve AIECS clients in core — use explicit injection or aiecs_kg.integrations.aiecs.
Storage modes (KG_STORAGE_MODE)
| Mode | PostgreSQL | Neo4j | Use case |
|---|---|---|---|
pg_only (default) |
authority + vector | — | Zero Neo4j regression; Python graph fallback |
pg_neo4j |
authority + pgvector RAG | traverse + GDS projection | Recommended production embed path |
neo4j_only |
— | single store | POC / graph-only dev |
Design: AIECS_KG_NEO4J_PG_DUAL_STORE_DESIGN.md · ADR: ADR-004
pg_neo4j quick example
export KG_STORAGE_MODE=pg_neo4j
export KG_STORAGE_BACKEND=postgresql
export KG_POSTGRES_URL=postgresql://user:pass@localhost:5432/aiecs_knowledge_graph
export KG_NEO4J_URI=bolt://localhost:7687
export KG_NEO4J_USER=neo4j
export KG_NEO4J_PASSWORD=your-password
export KG_NEO4J_DATABASE=aiecs_graph
from aiecs_kg import create_graph_store, create_graph_algorithm_service
store = create_graph_store() # CompositeGraphStore when pg_neo4j
await store.initialize()
algo = create_graph_algorithm_service(graph_store=store)
scores = await algo.pagerank(seed_entity_ids=["entity-a"], top_k=10)
See .env.example for all KG_* variables.
Quick start
from aiecs_kg import create_graph_store, Entity
store = create_graph_store() # KG_STORAGE_BACKEND=inmemory (default)
await store.initialize()
entity = Entity(id="e1", entity_type="Person", properties={"name": "Alice"})
await store.add_entity(entity)
Reasoning (Phase R0–R2)
Prefer ReasoningOrchestrator over ReasoningEngine for NL, Logic DSL, and hybrid pipelines:
import asyncio
from aiecs_kg import create_reasoning_orchestrator, ReasoningOrchestrator
from aiecs_kg.application.reasoning import ReasoningPipelineConfig
async def main():
orchestrator = create_reasoning_orchestrator() # or ReasoningOrchestrator(store, ...)
result = await orchestrator.query(
"Find all people older than 30",
mode="hybrid", # nl | logic_dsl | hybrid
context={"start_entity_id": "alice"},
)
print(result.answer, result.evidence_count)
asyncio.run(main())
Install Logic DSL support: pip install -e ".[reasoning]". Optional rerank: pip install -r requirements/optional-rerank.txt.
LLM integration
pip install aiecs-kg does not install or import AIECS. LLM-powered features (entity/relation extraction, NL→DSL, QueryPlan, embeddings) require a caller-provided client via constructor or factory parameters (llm_client=, embedding_client=).
from aiecs_kg import create_reasoning_orchestrator
from aiecs_kg.ports.llm_client import LLMMessage # use this, not aiecs.llm.LLMMessage
# Heuristic / retrieval-only — no LLM required
orchestrator = create_reasoning_orchestrator()
# With an injected client (AIECS resolve_llm_client, OpenAI SDK wrapper, etc.)
orchestrator = create_reasoning_orchestrator(llm_client=my_client)
All generate_text messages in core code use aiecs_kg.ports.llm_client.LLMMessage. Clients must implement at least generate_text and/or get_embeddings (see LLMClientProtocol). For a minimal OpenAI SDK example without AIECS, see LLM_CLIENT_INJECTION_PLAN.md §7.4.
Optional AIECS convenience helpers (when both packages are installed) live under aiecs_kg.integrations.aiecs — not exported from core __init__.py.
Configuration
All settings use KG_* environment variables. See .env.example.
export KG_STORAGE_BACKEND=inmemory # inmemory | sqlite | postgresql
export KG_ENABLED=true # consumed by AIECS core (not this package)
OpenSPG / SPG mode (KG_STORAGE_MODE=spg)
Install: pip install aiecs-kg[spg]. Set KG_STORAGE_MODE=spg plus:
| Variable | Required | Description |
|---|---|---|
KG_SPG_HOST |
Yes | Server URL (e.g. http://127.0.0.1:8887) |
KG_SPG_PROJECT_ID |
Yes | OpenSPG project id |
KG_SPG_WRITE_TOKEN |
Yes | Write-graph token (request body only — never log) |
KG_SPG_NAMESPACE |
Recommended | Schema/type namespace |
KG_SPG_WRITE_TOKEN_NEXT |
Optional | Dual-token rotation |
KG_REASONING_MODE |
Optional | Default orchestrator mode |
KG_SPG_WRITE_GRAPH_THRESHOLD |
Optional | Bulk vs write_graph threshold (default 500) |
KG_SPG_BRIDGE_ENABLED |
Optional | Profile B deployment flag |
Profile A — GraphBuilder / ReasoningOrchestrator → client/spg HTTP (no kag wheel).
Profile B — Pemja → integrations/spg_bridge.SpgServerBridge → same L3 paths. F1a (UI DAG → Neo4jSinkWriter) is documented only; F1b (bridge → HTTP) is the Repo B contract. See docs/spg/README.md.
Project layout
src/aiecs_kg/
├── domain/ # Entity, Relation, schema models
├── application/ # search, reasoning, builder, fusion, …
├── client/spg/ # OpenSPG HTTP SDK (L2, optional [spg])
├── integrations/ # spg_bridge (Profile B), aiecs helpers
├── storage/ # GraphStore backends (in-memory, SQLite, Postgres)
├── config.py # KGSettings / get_kg_settings()
└── factory.py # create_graph_store()
Tests
# 1) 依赖(见 .env.test 注释)
pip install -e ".[dev]"
pip install -r requirements/optional-rerank.txt
pip install -r requirements/optional-nlp.txt
python -m spacy download en_core_web_sm
# aiecs:prefer requirements/optional-aiecs.txt; if resolve conflicts, editable install
pip install -r requirements/optional-aiecs.txt
# or: pip install -e /path/to/python-middleware-dev
# 2) 环境
set -a && source .env.test && set +a # KG_USE_AIECS_STUB=false + XAI_API_KEY 等
pytest tests/unit -q
pytest tests/integration/spg/ -q # SPG mock + skipped live without KG_SPG_HOST
pytest tests/integration/neo4j_graph/ -q # 需系统 Neo4j 5.26.x + GDS(ADR-004)
Pre-commit
Same hook set as AI-Execute-Services: license header, black, flake8, mypy, and deptry (no AIECS-specific schema hooks).
Runtime extras are declared in pyproject.toml; heavy optional stacks use requirements/optional-*.txt. CI installs pip install -e ".[dev]" (+ optional-dev-heavy as needed). See .cursor/rules/dependency-maintenance.mdc.
pip install -e ".[dev]"
pre-commit install
pre-commit run --all-files
License
Apache-2.0 — see LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aiecs_kg-0.9.0.tar.gz.
File metadata
- Download URL: aiecs_kg-0.9.0.tar.gz
- Upload date:
- Size: 457.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9d95c4521e7217620af46e23aabc877e4bbfb21942ff2a55b744ce574631d673
|
|
| MD5 |
ee1f8ea7aab42cae87daf742887e42e2
|
|
| BLAKE2b-256 |
dbf4b1d610da388b9e260187a8c9b921aa4a49d06de4a3dc1cb51d0618798b1e
|
Provenance
The following attestation bundles were made for aiecs_kg-0.9.0.tar.gz:
Publisher:
publish-pypi.yml on Howmany-Zeta/AI-Execute-Services-KnowledgeGraph
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aiecs_kg-0.9.0.tar.gz -
Subject digest:
9d95c4521e7217620af46e23aabc877e4bbfb21942ff2a55b744ce574631d673 - Sigstore transparency entry: 2227043160
- Sigstore integration time:
-
Permalink:
Howmany-Zeta/AI-Execute-Services-KnowledgeGraph@d2b0d1bf0e8584878c049a455460d3c79c0a2399 -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/Howmany-Zeta
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@d2b0d1bf0e8584878c049a455460d3c79c0a2399 -
Trigger Event:
push
-
Statement type:
File details
Details for the file aiecs_kg-0.9.0-py3-none-any.whl.
File metadata
- Download URL: aiecs_kg-0.9.0-py3-none-any.whl
- Upload date:
- Size: 761.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
11e84d2a9d8aede8f997c5c5c23a5cdfa1310478392cf96c77990b69f9f53632
|
|
| MD5 |
4f3979b7a779bcb6793923f69a90c28c
|
|
| BLAKE2b-256 |
0ec9232fd9ebe5e8a12a9ec8f5da7ce1a9f3ae8aa1749faf13fa3445824693ab
|
Provenance
The following attestation bundles were made for aiecs_kg-0.9.0-py3-none-any.whl:
Publisher:
publish-pypi.yml on Howmany-Zeta/AI-Execute-Services-KnowledgeGraph
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aiecs_kg-0.9.0-py3-none-any.whl -
Subject digest:
11e84d2a9d8aede8f997c5c5c23a5cdfa1310478392cf96c77990b69f9f53632 - Sigstore transparency entry: 2227043192
- Sigstore integration time:
-
Permalink:
Howmany-Zeta/AI-Execute-Services-KnowledgeGraph@d2b0d1bf0e8584878c049a455460d3c79c0a2399 -
Branch / Tag:
refs/tags/v0.9.0 - Owner: https://github.com/Howmany-Zeta
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-pypi.yml@d2b0d1bf0e8584878c049a455460d3c79c0a2399 -
Trigger Event:
push
-
Statement type: