ontonym-core 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,37 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+ branches: [main]
8
+
9
+ jobs:
10
+ test:
11
+ runs-on: ubuntu-latest
12
+ strategy:
13
+ matrix:
14
+ python: ["3.11", "3.12", "3.13"]
15
+ steps:
16
+ - uses: actions/checkout@v4
17
+
18
+ - name: Set up Python ${{ matrix.python }}
19
+ uses: actions/setup-python@v5
20
+ with:
21
+ python-version: ${{ matrix.python }}
22
+
23
+ - name: Install
24
+ run: |
25
+ python -m pip install --upgrade pip
26
+ pip install -e '.[dev,anthropic,server]'
27
+
28
+ - name: Lint (ruff)
29
+ run: ruff check ontonym_core tests examples
30
+
31
+ - name: Test (pytest)
32
+ run: pytest -v
33
+
34
+ - name: Build wheel
35
+ run: |
36
+ pip install build
37
+ python -m build --wheel --sdist
@@ -0,0 +1,16 @@
1
+ __pycache__/
2
+ *.py[cod]
3
+ *.egg-info/
4
+ *.egg
5
+ build/
6
+ dist/
7
+ .venv/
8
+ venv/
9
+ .env
10
+ .env.local
11
+ .pytest_cache/
12
+ .ruff_cache/
13
+ .mypy_cache/
14
+ .coverage
15
+ htmlcov/
16
+ .DS_Store
@@ -0,0 +1,17 @@
1
+ # Changelog
2
+
3
+ All notable changes to ontonym-core will be documented here.
4
+
5
+ ## 0.1.0 — 2026-05-18
6
+
7
+ Initial public release.
8
+
9
+ - `extract(text, *, mode="class"|"object"|"both", backend, prior_classes, prior_objects)` runs class extraction and/or object extraction in one call.
10
+ - `extract_classes` / `extract_objects` for finer control.
11
+ - `OllamaBackend` (default, no API key) and `AnthropicBackend` (Claude, `[anthropic]` extra).
12
+ - CLI: `ontonym-core extract --text "..."` and `ontonym-core health`.
13
+ - Pydantic models for everything — name-based references, no FK ids, no approval status.
14
+ - FastAPI example server at `examples/server.py` (`[server]` extra).
15
+ - Prompts ship with the wheel — `class.txt` (class pass) and `object.txt` (object pass).
16
+
17
+ 0.x is unstable — APIs may change between minor versions until 1.0.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for describing the origin of the Work and
141
+ reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may accept and charge a
167
+ fee for accepting support, warranty, indemnity, or other liability
168
+ obligations and/or rights consistent with this License. However, in
169
+ accepting such obligations, You may act only on Your own behalf
170
+ and on Your sole responsibility, not on behalf of any other
171
+ Contributor, and only if You agree to indemnify, defend, and hold
172
+ each Contributor harmless for any liability incurred by, or claims
173
+ asserted against, such Contributor by reason of your accepting any
174
+ such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Serkan Uz
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,211 @@
1
+ Metadata-Version: 2.4
2
+ Name: ontonym-core
3
+ Version: 0.1.0
4
+ Summary: Turn free text into a typed object graph — classes, objects, properties, actions, relationships, rules, and events — with any LLM.
5
+ Project-URL: Homepage, https://ontonym.com
6
+ Project-URL: Repository, https://github.com/serkan-uz/ontonym-core
7
+ Project-URL: Issues, https://github.com/serkan-uz/ontonym-core/issues
8
+ Author: Serkan Uz
9
+ License-Expression: Apache-2.0
10
+ License-File: LICENSE
11
+ Keywords: anthropic,extraction,knowledge-graph,llm,ollama,ontology
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
20
+ Requires-Python: >=3.11
21
+ Requires-Dist: httpx>=0.27
22
+ Requires-Dist: pydantic<3.0,>=2.0
23
+ Requires-Dist: typer>=0.12
24
+ Provides-Extra: anthropic
25
+ Requires-Dist: anthropic>=0.40.0; extra == 'anthropic'
26
+ Provides-Extra: dev
27
+ Requires-Dist: build; extra == 'dev'
28
+ Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
29
+ Requires-Dist: pytest>=8.0; extra == 'dev'
30
+ Requires-Dist: ruff>=0.5; extra == 'dev'
31
+ Requires-Dist: twine>=5.0; extra == 'dev'
32
+ Provides-Extra: server
33
+ Requires-Dist: fastapi>=0.110; extra == 'server'
34
+ Requires-Dist: uvicorn[standard]>=0.29; extra == 'server'
35
+ Description-Content-Type: text/markdown
36
+
37
+ # ontonym-core
38
+
39
+ Turn free text into a typed object graph — **classes, properties, actions, relationships, rules**, plus **objects and events** — using any LLM.
40
+
41
+ ```python
42
+ import asyncio
43
+ from ontonym_core import extract
44
+
45
+ result = asyncio.run(extract(
46
+ "Sarah deployed PaymentService at 14:02. "
47
+ "An outage hit it at 14:05, affecting the payments flow.",
48
+ backend="ollama",
49
+ ))
50
+ print(result.model_dump_json(indent=2))
51
+ ```
52
+
53
+ ```json
54
+ {
55
+ "classes": {
56
+ "classes": [
57
+ {"name": "person", "description": "A human", "inherited_from": null},
58
+ {"name": "application", "description": "A deployable service", "inherited_from": null},
59
+ {"name": "outage", "description": "A service outage", "inherited_from": "event"}
60
+ ],
61
+ "actions": [{"name": "deploy", "actor": "person", "target": "application"}],
62
+ "relationships": [{"source": "outage", "target": "application", "type": "affected"}],
63
+ "rules": []
64
+ },
65
+ "objects": {
66
+ "objects": [
67
+ {"class_name": "person", "name": "sarah", "display_name": "Sarah"},
68
+ {"class_name": "application", "name": "payment_service", "display_name": "PaymentService"}
69
+ ],
70
+ "events": [
71
+ {"class_name": "outage", "name": "outage_1405", "display_name": "outage at 14:05"}
72
+ ],
73
+ "actions": [
74
+ {"action_name": "deploy", "actor": "sarah", "target": "payment_service", "occurred_at": "14:02"}
75
+ ],
76
+ "relationships": [
77
+ {"source": "outage_1405", "target": "payment_service", "type": "affected"}
78
+ ]
79
+ }
80
+ }
81
+ ```
82
+
83
+ Local-first — run it with [Ollama](https://ollama.com) and no API key. Or switch to Anthropic Claude when you want speed.
84
+
85
+ > **Status**: 0.x is unstable. APIs may change between minor versions until 1.0.
86
+
87
+ ---
88
+
89
+ ## What it does
90
+
91
+ Two extraction passes, run in sequence:
92
+
93
+ 1. **Class layer** (`classes`, `properties`, `actions`, `relationships`, `rules`) — the schema. *What kinds of things exist in this text?*
94
+ 2. **Object layer** (`objects`, `events`, `object_properties`, `object_actions`, `object_relationships`) — the instances. *What specific things are mentioned, and what did they do?*
95
+
96
+ Events are first-class: actor-less, time-anchored happenings (incidents, outages, deployments, decisions, market events) are emitted separately from actor-driven actions.
97
+
98
+ ## Install
99
+
100
+ ```bash
101
+ pip install ontonym-core
102
+
103
+ # Optional extras:
104
+ pip install 'ontonym-core[anthropic]' # adds Anthropic Claude backend
105
+ pip install 'ontonym-core[server]' # adds FastAPI example server
106
+ ```
107
+
108
+ ## Quickstart — Ollama (local, no API key)
109
+
110
+ ```bash
111
+ # One-time setup
112
+ ollama serve # in another terminal
113
+ ollama pull llama3.1:8b
114
+ pip install ontonym-core
115
+
116
+ # CLI
117
+ ontonym-core extract --text "Sarah deployed prod at 14:02"
118
+
119
+ # Or stream from stdin
120
+ cat notes.txt | ontonym-core extract --mode both
121
+
122
+ # Health check
123
+ ontonym-core health --backend ollama
124
+ ```
125
+
126
+ ## Quickstart — Anthropic (hosted Claude)
127
+
128
+ ```bash
129
+ pip install 'ontonym-core[anthropic]'
130
+ export ANTHROPIC_API_KEY=sk-ant-...
131
+
132
+ ontonym-core extract --text "..." --backend anthropic
133
+ ```
134
+
135
+ ## Python API
136
+
137
+ ```python
138
+ import asyncio
139
+ from ontonym_core import extract, extract_classes, extract_objects, OllamaBackend
140
+
141
+ # One-shot: class pass + object pass against the resulting schema.
142
+ result = asyncio.run(extract(
143
+ "Marcus closed Acme's renewal on 2024-11-18.",
144
+ backend="ollama",
145
+ ))
146
+
147
+ # Or run passes separately for full control.
148
+ backend = OllamaBackend(model="llama3.1:8b")
149
+ schema = asyncio.run(extract_classes("...", backend=backend))
150
+ objects = asyncio.run(extract_objects("...", schema, backend=backend))
151
+
152
+ # Diff-only iteration: feed the prior accumulator to skip already-known rows.
153
+ schema_v2 = asyncio.run(extract_classes("more text...", backend=backend, prior=schema))
154
+ ```
155
+
156
+ The result models are plain Pydantic — `.model_dump_json()` for JSON, `.model_dump()` for dicts, and full type hints for IDE autocomplete.
157
+
158
+ ## Custom backends
159
+
160
+ A backend is anything implementing `Backend` from `ontonym_core.llm` — two async methods (`extract_classes`, `extract_objects`) and one health probe (`check_health`). You can wire OpenAI, Together, Groq, or your own gateway by reusing the parsers:
161
+
162
+ ```python
163
+ from ontonym_core import parse_class_json, parse_object_json, ClassExtraction
164
+
165
+ class MyBackend:
166
+ async def extract_classes(self, text, prior):
167
+ raw = await my_llm.generate(prompt_for_classes(text, prior))
168
+ return parse_class_json(raw)
169
+ # ... extract_objects, check_health similarly
170
+ ```
171
+
172
+ ## FastAPI example
173
+
174
+ ```bash
175
+ pip install 'ontonym-core[server]'
176
+ uvicorn examples.server:app --reload
177
+
178
+ curl -X POST http://localhost:8000/extract \
179
+ -H 'content-type: application/json' \
180
+ -d '{"text": "...", "mode": "both"}'
181
+ ```
182
+
183
+ See [examples/server.py](examples/server.py) — single route, ~50 lines.
184
+
185
+ ## What's not in here
186
+
187
+ Deliberately out of scope:
188
+
189
+ - **Storage** — `ontonym-core` is stateless. Persist the JSON to whatever fits your stack (Postgres, DuckDB, plain files).
190
+ - **Multi-tenancy / access control** — same.
191
+ - **Flow detection** (recurring patterns across action+event timelines) — held back.
192
+ - **Approval workflows** — what makes a graph trustworthy is a product problem, not an extractor problem.
193
+
194
+ If you want those out of the box, see [ontonym.com](https://ontonym.com) — the hosted product that this library was carved out of.
195
+
196
+ ## How this fits with ontonym (hosted)
197
+
198
+ The hosted product at ontonym.com depends on `ontonym-core`. Same prompts, same parsers, same Pydantic models. What hosted adds on top:
199
+
200
+ - Postgres + pgvector storage with provenance (every fact tied to its source document)
201
+ - Per-tenant isolation + per-row access grants
202
+ - Approval workflow (the "Object Guru" reviews / merges / rejects)
203
+ - Flow detection across time-ordered actions
204
+ - An MCP server so AI agents read the graph as a tool
205
+ - Slack / Teams / Notion / Salesforce / HubSpot / GitHub / Linear / Jira connectors
206
+
207
+ If you build something cool on top of `ontonym-core`, [drop a note](https://github.com/serkan-uz/ontonym-core/issues) — we'd love to see it.
208
+
209
+ ## License
210
+
211
+ Apache 2.0. See [LICENSE](LICENSE).
@@ -0,0 +1,175 @@
1
+ # ontonym-core
2
+
3
+ Turn free text into a typed object graph — **classes, properties, actions, relationships, rules**, plus **objects and events** — using any LLM.
4
+
5
+ ```python
6
+ import asyncio
7
+ from ontonym_core import extract
8
+
9
+ result = asyncio.run(extract(
10
+ "Sarah deployed PaymentService at 14:02. "
11
+ "An outage hit it at 14:05, affecting the payments flow.",
12
+ backend="ollama",
13
+ ))
14
+ print(result.model_dump_json(indent=2))
15
+ ```
16
+
17
+ ```json
18
+ {
19
+ "classes": {
20
+ "classes": [
21
+ {"name": "person", "description": "A human", "inherited_from": null},
22
+ {"name": "application", "description": "A deployable service", "inherited_from": null},
23
+ {"name": "outage", "description": "A service outage", "inherited_from": "event"}
24
+ ],
25
+ "actions": [{"name": "deploy", "actor": "person", "target": "application"}],
26
+ "relationships": [{"source": "outage", "target": "application", "type": "affected"}],
27
+ "rules": []
28
+ },
29
+ "objects": {
30
+ "objects": [
31
+ {"class_name": "person", "name": "sarah", "display_name": "Sarah"},
32
+ {"class_name": "application", "name": "payment_service", "display_name": "PaymentService"}
33
+ ],
34
+ "events": [
35
+ {"class_name": "outage", "name": "outage_1405", "display_name": "outage at 14:05"}
36
+ ],
37
+ "actions": [
38
+ {"action_name": "deploy", "actor": "sarah", "target": "payment_service", "occurred_at": "14:02"}
39
+ ],
40
+ "relationships": [
41
+ {"source": "outage_1405", "target": "payment_service", "type": "affected"}
42
+ ]
43
+ }
44
+ }
45
+ ```
46
+
47
+ Local-first — run it with [Ollama](https://ollama.com) and no API key. Or switch to Anthropic Claude when you want speed.
48
+
49
+ > **Status**: 0.x is unstable. APIs may change between minor versions until 1.0.
50
+
51
+ ---
52
+
53
+ ## What it does
54
+
55
+ Two extraction passes, run in sequence:
56
+
57
+ 1. **Class layer** (`classes`, `properties`, `actions`, `relationships`, `rules`) — the schema. *What kinds of things exist in this text?*
58
+ 2. **Object layer** (`objects`, `events`, `object_properties`, `object_actions`, `object_relationships`) — the instances. *What specific things are mentioned, and what did they do?*
59
+
60
+ Events are first-class: actor-less, time-anchored happenings (incidents, outages, deployments, decisions, market events) are emitted separately from actor-driven actions.
61
+
62
+ ## Install
63
+
64
+ ```bash
65
+ pip install ontonym-core
66
+
67
+ # Optional extras:
68
+ pip install 'ontonym-core[anthropic]' # adds Anthropic Claude backend
69
+ pip install 'ontonym-core[server]' # adds FastAPI example server
70
+ ```
71
+
72
+ ## Quickstart — Ollama (local, no API key)
73
+
74
+ ```bash
75
+ # One-time setup
76
+ ollama serve # in another terminal
77
+ ollama pull llama3.1:8b
78
+ pip install ontonym-core
79
+
80
+ # CLI
81
+ ontonym-core extract --text "Sarah deployed prod at 14:02"
82
+
83
+ # Or stream from stdin
84
+ cat notes.txt | ontonym-core extract --mode both
85
+
86
+ # Health check
87
+ ontonym-core health --backend ollama
88
+ ```
89
+
90
+ ## Quickstart — Anthropic (hosted Claude)
91
+
92
+ ```bash
93
+ pip install 'ontonym-core[anthropic]'
94
+ export ANTHROPIC_API_KEY=sk-ant-...
95
+
96
+ ontonym-core extract --text "..." --backend anthropic
97
+ ```
98
+
99
+ ## Python API
100
+
101
+ ```python
102
+ import asyncio
103
+ from ontonym_core import extract, extract_classes, extract_objects, OllamaBackend
104
+
105
+ # One-shot: class pass + object pass against the resulting schema.
106
+ result = asyncio.run(extract(
107
+ "Marcus closed Acme's renewal on 2024-11-18.",
108
+ backend="ollama",
109
+ ))
110
+
111
+ # Or run passes separately for full control.
112
+ backend = OllamaBackend(model="llama3.1:8b")
113
+ schema = asyncio.run(extract_classes("...", backend=backend))
114
+ objects = asyncio.run(extract_objects("...", schema, backend=backend))
115
+
116
+ # Diff-only iteration: feed the prior accumulator to skip already-known rows.
117
+ schema_v2 = asyncio.run(extract_classes("more text...", backend=backend, prior=schema))
118
+ ```
119
+
120
+ The result models are plain Pydantic — `.model_dump_json()` for JSON, `.model_dump()` for dicts, and full type hints for IDE autocomplete.
121
+
122
+ ## Custom backends
123
+
124
+ A backend is anything implementing `Backend` from `ontonym_core.llm` — two async methods (`extract_classes`, `extract_objects`) and one health probe (`check_health`). You can wire OpenAI, Together, Groq, or your own gateway by reusing the parsers:
125
+
126
+ ```python
127
+ from ontonym_core import parse_class_json, parse_object_json, ClassExtraction
128
+
129
+ class MyBackend:
130
+ async def extract_classes(self, text, prior):
131
+ raw = await my_llm.generate(prompt_for_classes(text, prior))
132
+ return parse_class_json(raw)
133
+ # ... extract_objects, check_health similarly
134
+ ```
135
+
136
+ ## FastAPI example
137
+
138
+ ```bash
139
+ pip install 'ontonym-core[server]'
140
+ uvicorn examples.server:app --reload
141
+
142
+ curl -X POST http://localhost:8000/extract \
143
+ -H 'content-type: application/json' \
144
+ -d '{"text": "...", "mode": "both"}'
145
+ ```
146
+
147
+ See [examples/server.py](examples/server.py) — single route, ~50 lines.
148
+
149
+ ## What's not in here
150
+
151
+ Deliberately out of scope:
152
+
153
+ - **Storage** — `ontonym-core` is stateless. Persist the JSON to whatever fits your stack (Postgres, DuckDB, plain files).
154
+ - **Multi-tenancy / access control** — same.
155
+ - **Flow detection** (recurring patterns across action+event timelines) — held back.
156
+ - **Approval workflows** — what makes a graph trustworthy is a product problem, not an extractor problem.
157
+
158
+ If you want those out of the box, see [ontonym.com](https://ontonym.com) — the hosted product that this library was carved out of.
159
+
160
+ ## How this fits with ontonym (hosted)
161
+
162
+ The hosted product at ontonym.com depends on `ontonym-core`. Same prompts, same parsers, same Pydantic models. What hosted adds on top:
163
+
164
+ - Postgres + pgvector storage with provenance (every fact tied to its source document)
165
+ - Per-tenant isolation + per-row access grants
166
+ - Approval workflow (the "Object Guru" reviews / merges / rejects)
167
+ - Flow detection across time-ordered actions
168
+ - An MCP server so AI agents read the graph as a tool
169
+ - Slack / Teams / Notion / Salesforce / HubSpot / GitHub / Linear / Jira connectors
170
+
171
+ If you build something cool on top of `ontonym-core`, [drop a note](https://github.com/serkan-uz/ontonym-core/issues) — we'd love to see it.
172
+
173
+ ## License
174
+
175
+ Apache 2.0. See [LICENSE](LICENSE).