ia-rag-core 0.1.1__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.
- ia_rag_core-0.1.1/LICENSE +201 -0
- ia_rag_core-0.1.1/PKG-INFO +133 -0
- ia_rag_core-0.1.1/README.md +107 -0
- ia_rag_core-0.1.1/pyproject.toml +50 -0
- ia_rag_core-0.1.1/setup.cfg +4 -0
- ia_rag_core-0.1.1/src/ia_rag/__init__.py +102 -0
- ia_rag_core-0.1.1/src/ia_rag/assurance_protocols.py +180 -0
- ia_rag_core-0.1.1/src/ia_rag/canonical_compiler.py +1293 -0
- ia_rag_core-0.1.1/src/ia_rag/canonical_execution_adapter.py +433 -0
- ia_rag_core-0.1.1/src/ia_rag/canonical_execution_admission.py +477 -0
- ia_rag_core-0.1.1/src/ia_rag/canonical_execution_enforcement.py +965 -0
- ia_rag_core-0.1.1/src/ia_rag/canonical_execution_receipt.py +863 -0
- ia_rag_core-0.1.1/src/ia_rag/canonical_lineage.py +71 -0
- ia_rag_core-0.1.1/src/ia_rag/canonical_plan.py +768 -0
- ia_rag_core-0.1.1/src/ia_rag/canonical_semantic_contract.py +317 -0
- ia_rag_core-0.1.1/src/ia_rag/claims.py +99 -0
- ia_rag_core-0.1.1/src/ia_rag/claims_from_graph_result.py +143 -0
- ia_rag_core-0.1.1/src/ia_rag/domain.py +130 -0
- ia_rag_core-0.1.1/src/ia_rag/domain_semantic_extensions.py +206 -0
- ia_rag_core-0.1.1/src/ia_rag/domain_utils.py +89 -0
- ia_rag_core-0.1.1/src/ia_rag/planner_registry.py +190 -0
- ia_rag_core-0.1.1/src/ia_rag/protocols.py +124 -0
- ia_rag_core-0.1.1/src/ia_rag/public_rendering.py +64 -0
- ia_rag_core-0.1.1/src/ia_rag/public_runtime.py +778 -0
- ia_rag_core-0.1.1/src/ia_rag/query_router.py +221 -0
- ia_rag_core-0.1.1/src/ia_rag/reference_assurance.py +252 -0
- ia_rag_core-0.1.1/src/ia_rag/reference_domains.py +159 -0
- ia_rag_core-0.1.1/src/ia_rag_core.egg-info/PKG-INFO +133 -0
- ia_rag_core-0.1.1/src/ia_rag_core.egg-info/SOURCES.txt +30 -0
- ia_rag_core-0.1.1/src/ia_rag_core.egg-info/dependency_links.txt +1 -0
- ia_rag_core-0.1.1/src/ia_rag_core.egg-info/requires.txt +3 -0
- ia_rag_core-0.1.1/src/ia_rag_core.egg-info/top_level.txt +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 reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and 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 choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any 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 IA-RAG Core contributors.
|
|
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,133 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ia-rag-core
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Governed, structure-aware retrieval and execution planning for agentic systems.
|
|
5
|
+
Author: IA-RAG Core contributors
|
|
6
|
+
Maintainer: IA-RAG Core maintainers
|
|
7
|
+
License-Expression: Apache-2.0
|
|
8
|
+
Project-URL: Homepage, https://github.com/pmbarbas/ia-rag-core
|
|
9
|
+
Project-URL: Documentation, https://github.com/pmbarbas/ia-rag-core/tree/main/docs
|
|
10
|
+
Project-URL: Source, https://github.com/pmbarbas/ia-rag-core
|
|
11
|
+
Project-URL: Issues, https://github.com/pmbarbas/ia-rag-core/issues
|
|
12
|
+
Project-URL: Changelog, https://github.com/pmbarbas/ia-rag-core/blob/main/CHANGELOG.md
|
|
13
|
+
Classifier: Development Status :: 3 - Alpha
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
20
|
+
Requires-Python: >=3.11
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Provides-Extra: dev
|
|
24
|
+
Requires-Dist: pytest>=8; extra == "dev"
|
|
25
|
+
Dynamic: license-file
|
|
26
|
+
|
|
27
|
+
# IA-RAG Core
|
|
28
|
+
|
|
29
|
+
Governed, structure-aware retrieval and execution planning for agentic
|
|
30
|
+
systems.
|
|
31
|
+
|
|
32
|
+
IA-RAG Core makes the information architecture of a question explicit before
|
|
33
|
+
execution. A domain describes entities, relations, capabilities, bounds, and
|
|
34
|
+
world semantics. The runtime then turns a question into an inspectable
|
|
35
|
+
semantic program, a typed logical plan, and one bounded executable plan before
|
|
36
|
+
producing evidence, claims, a receipt, and a deterministic response.
|
|
37
|
+
|
|
38
|
+
## Why information architecture comes first
|
|
39
|
+
|
|
40
|
+
Ordinary vector RAG is useful for ranking relevant text, but relevance is not
|
|
41
|
+
the same as authoritative execution semantics. A similarity result does not
|
|
42
|
+
by itself say which entities and relations are allowed, whether a traversal
|
|
43
|
+
is complete, or what an empty result means.
|
|
44
|
+
|
|
45
|
+
IA-RAG Core puts those decisions in an explicit domain and plan. Retrieval
|
|
46
|
+
strategies can supply candidates through neutral protocols; the canonical
|
|
47
|
+
runtime still validates the structure, applies bounds, records evidence, and
|
|
48
|
+
binds the result to the exact plan that ran.
|
|
49
|
+
|
|
50
|
+
## Canonical pipeline
|
|
51
|
+
|
|
52
|
+
```text
|
|
53
|
+
DomainPack
|
|
54
|
+
-> PlannerRegistry
|
|
55
|
+
-> Semantic interpretation
|
|
56
|
+
-> CanonicalCompiler
|
|
57
|
+
-> LogicalPlan
|
|
58
|
+
-> deterministic lowering
|
|
59
|
+
-> ExecutablePlan
|
|
60
|
+
-> Admission and assurance
|
|
61
|
+
-> PRE enforcement
|
|
62
|
+
-> bounded execution
|
|
63
|
+
-> POST enforcement
|
|
64
|
+
-> Evidence and provenance
|
|
65
|
+
-> Claims and truth state
|
|
66
|
+
-> Receipt and lineage
|
|
67
|
+
-> deterministic rendering
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
There is one selected planner, one logical-plan lineage, one executable plan,
|
|
71
|
+
and one receipt bound to that executed plan. Plan and receipt digests are
|
|
72
|
+
deterministic for the same query, domain configuration, and input facts.
|
|
73
|
+
|
|
74
|
+
## Install and run
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
python -m pip install ia-rag-core
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
The offline reference demo is available from a repository checkout. From the
|
|
81
|
+
checkout, install the development tools and run the tests and demo with the
|
|
82
|
+
same Python interpreter:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
python -m pip install '.[dev]'
|
|
86
|
+
python -m pytest -q
|
|
87
|
+
python examples/reference_demo.py
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Using `python -m pytest` ensures the tests run with the same Python
|
|
91
|
+
interpreter and virtual environment into which IA-RAG Core was installed.
|
|
92
|
+
|
|
93
|
+
The quick-start demo is offline, uses no external credentials, and runs on a
|
|
94
|
+
small synthetic research-network domain. Its output includes the selected
|
|
95
|
+
planner, plan digests, evidence, receipt, and response.
|
|
96
|
+
|
|
97
|
+
## Truth and bounded execution
|
|
98
|
+
|
|
99
|
+
The reference domains demonstrate three explicit semantics:
|
|
100
|
+
|
|
101
|
+
- `OPEN_WORLD`: an empty search does not prove that a fact is false, so the
|
|
102
|
+
result may be `UNKNOWN`.
|
|
103
|
+
- `CLOSED_WORLD`: within the declared domain and complete evidence boundary,
|
|
104
|
+
an empty search can support a `FALSE` result.
|
|
105
|
+
- `REQUIRED_SUBGRAPH`: when a declared required relation or traversal cannot
|
|
106
|
+
be established, execution remains incomplete and the runtime does not emit a
|
|
107
|
+
positive claim from the partial result.
|
|
108
|
+
|
|
109
|
+
These semantics describe the evidence boundary and execution state. They do
|
|
110
|
+
not guarantee truth about the real world beyond the supplied domain and
|
|
111
|
+
evidence.
|
|
112
|
+
|
|
113
|
+
## Feature claim ledger
|
|
114
|
+
|
|
115
|
+
| Status | Claims supported by this candidate |
|
|
116
|
+
| --- | --- |
|
|
117
|
+
| `DEMONSTRATED` | Typed canonical plans; deterministic planning and lowering; explicit assurance allow/deny; bounded in-memory graph execution; evidence/provenance; open- and closed-world truth behavior; required-subgraph enforcement; plan-bound receipts and lineage; deterministic rendering; synthetic reference domains. |
|
|
118
|
+
| `ARCHITECTURALLY_SUPPORTED` | Neutral protocols for graph, document, lexical, vector, embedding, entity, language-model, and telemetry integrations; domain semantic extensions; injected assurance providers. |
|
|
119
|
+
| `FUTURE` | Production retrieval adapters, persistent stores, model-backed interpretation, deployment integrations, and production identity or high-assurance services. |
|
|
120
|
+
| `NOT A CLAIM` | Elimination of probabilistic retrieval, a guarantee of real-world truth, or production qualification of external services. |
|
|
121
|
+
|
|
122
|
+
## Deliberate scope
|
|
123
|
+
|
|
124
|
+
The base distribution has zero runtime dependencies and contains only the
|
|
125
|
+
canonical runtime, neutral contracts, deterministic reference assurance,
|
|
126
|
+
in-memory execution, and synthetic reference domains. External services,
|
|
127
|
+
credentials, application data, and deployment-specific integrations are not
|
|
128
|
+
part of this candidate.
|
|
129
|
+
|
|
130
|
+
IA-RAG Core is licensed under the Apache License 2.0; see [LICENSE](LICENSE).
|
|
131
|
+
|
|
132
|
+
See [the public architecture](docs/architecture.md) and [the package
|
|
133
|
+
boundary](docs/public-core-boundary.md) for the supported scope.
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# IA-RAG Core
|
|
2
|
+
|
|
3
|
+
Governed, structure-aware retrieval and execution planning for agentic
|
|
4
|
+
systems.
|
|
5
|
+
|
|
6
|
+
IA-RAG Core makes the information architecture of a question explicit before
|
|
7
|
+
execution. A domain describes entities, relations, capabilities, bounds, and
|
|
8
|
+
world semantics. The runtime then turns a question into an inspectable
|
|
9
|
+
semantic program, a typed logical plan, and one bounded executable plan before
|
|
10
|
+
producing evidence, claims, a receipt, and a deterministic response.
|
|
11
|
+
|
|
12
|
+
## Why information architecture comes first
|
|
13
|
+
|
|
14
|
+
Ordinary vector RAG is useful for ranking relevant text, but relevance is not
|
|
15
|
+
the same as authoritative execution semantics. A similarity result does not
|
|
16
|
+
by itself say which entities and relations are allowed, whether a traversal
|
|
17
|
+
is complete, or what an empty result means.
|
|
18
|
+
|
|
19
|
+
IA-RAG Core puts those decisions in an explicit domain and plan. Retrieval
|
|
20
|
+
strategies can supply candidates through neutral protocols; the canonical
|
|
21
|
+
runtime still validates the structure, applies bounds, records evidence, and
|
|
22
|
+
binds the result to the exact plan that ran.
|
|
23
|
+
|
|
24
|
+
## Canonical pipeline
|
|
25
|
+
|
|
26
|
+
```text
|
|
27
|
+
DomainPack
|
|
28
|
+
-> PlannerRegistry
|
|
29
|
+
-> Semantic interpretation
|
|
30
|
+
-> CanonicalCompiler
|
|
31
|
+
-> LogicalPlan
|
|
32
|
+
-> deterministic lowering
|
|
33
|
+
-> ExecutablePlan
|
|
34
|
+
-> Admission and assurance
|
|
35
|
+
-> PRE enforcement
|
|
36
|
+
-> bounded execution
|
|
37
|
+
-> POST enforcement
|
|
38
|
+
-> Evidence and provenance
|
|
39
|
+
-> Claims and truth state
|
|
40
|
+
-> Receipt and lineage
|
|
41
|
+
-> deterministic rendering
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
There is one selected planner, one logical-plan lineage, one executable plan,
|
|
45
|
+
and one receipt bound to that executed plan. Plan and receipt digests are
|
|
46
|
+
deterministic for the same query, domain configuration, and input facts.
|
|
47
|
+
|
|
48
|
+
## Install and run
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
python -m pip install ia-rag-core
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
The offline reference demo is available from a repository checkout. From the
|
|
55
|
+
checkout, install the development tools and run the tests and demo with the
|
|
56
|
+
same Python interpreter:
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
python -m pip install '.[dev]'
|
|
60
|
+
python -m pytest -q
|
|
61
|
+
python examples/reference_demo.py
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Using `python -m pytest` ensures the tests run with the same Python
|
|
65
|
+
interpreter and virtual environment into which IA-RAG Core was installed.
|
|
66
|
+
|
|
67
|
+
The quick-start demo is offline, uses no external credentials, and runs on a
|
|
68
|
+
small synthetic research-network domain. Its output includes the selected
|
|
69
|
+
planner, plan digests, evidence, receipt, and response.
|
|
70
|
+
|
|
71
|
+
## Truth and bounded execution
|
|
72
|
+
|
|
73
|
+
The reference domains demonstrate three explicit semantics:
|
|
74
|
+
|
|
75
|
+
- `OPEN_WORLD`: an empty search does not prove that a fact is false, so the
|
|
76
|
+
result may be `UNKNOWN`.
|
|
77
|
+
- `CLOSED_WORLD`: within the declared domain and complete evidence boundary,
|
|
78
|
+
an empty search can support a `FALSE` result.
|
|
79
|
+
- `REQUIRED_SUBGRAPH`: when a declared required relation or traversal cannot
|
|
80
|
+
be established, execution remains incomplete and the runtime does not emit a
|
|
81
|
+
positive claim from the partial result.
|
|
82
|
+
|
|
83
|
+
These semantics describe the evidence boundary and execution state. They do
|
|
84
|
+
not guarantee truth about the real world beyond the supplied domain and
|
|
85
|
+
evidence.
|
|
86
|
+
|
|
87
|
+
## Feature claim ledger
|
|
88
|
+
|
|
89
|
+
| Status | Claims supported by this candidate |
|
|
90
|
+
| --- | --- |
|
|
91
|
+
| `DEMONSTRATED` | Typed canonical plans; deterministic planning and lowering; explicit assurance allow/deny; bounded in-memory graph execution; evidence/provenance; open- and closed-world truth behavior; required-subgraph enforcement; plan-bound receipts and lineage; deterministic rendering; synthetic reference domains. |
|
|
92
|
+
| `ARCHITECTURALLY_SUPPORTED` | Neutral protocols for graph, document, lexical, vector, embedding, entity, language-model, and telemetry integrations; domain semantic extensions; injected assurance providers. |
|
|
93
|
+
| `FUTURE` | Production retrieval adapters, persistent stores, model-backed interpretation, deployment integrations, and production identity or high-assurance services. |
|
|
94
|
+
| `NOT A CLAIM` | Elimination of probabilistic retrieval, a guarantee of real-world truth, or production qualification of external services. |
|
|
95
|
+
|
|
96
|
+
## Deliberate scope
|
|
97
|
+
|
|
98
|
+
The base distribution has zero runtime dependencies and contains only the
|
|
99
|
+
canonical runtime, neutral contracts, deterministic reference assurance,
|
|
100
|
+
in-memory execution, and synthetic reference domains. External services,
|
|
101
|
+
credentials, application data, and deployment-specific integrations are not
|
|
102
|
+
part of this candidate.
|
|
103
|
+
|
|
104
|
+
IA-RAG Core is licensed under the Apache License 2.0; see [LICENSE](LICENSE).
|
|
105
|
+
|
|
106
|
+
See [the public architecture](docs/architecture.md) and [the package
|
|
107
|
+
boundary](docs/public-core-boundary.md) for the supported scope.
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=61"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "ia-rag-core"
|
|
7
|
+
version = "0.1.1"
|
|
8
|
+
description = "Governed, structure-aware retrieval and execution planning for agentic systems."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.11"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
license-files = ["LICENSE"]
|
|
13
|
+
authors = [
|
|
14
|
+
{name = "IA-RAG Core contributors"},
|
|
15
|
+
]
|
|
16
|
+
maintainers = [
|
|
17
|
+
{name = "IA-RAG Core maintainers"},
|
|
18
|
+
]
|
|
19
|
+
classifiers = [
|
|
20
|
+
"Development Status :: 3 - Alpha",
|
|
21
|
+
"Intended Audience :: Developers",
|
|
22
|
+
"Operating System :: OS Independent",
|
|
23
|
+
"Programming Language :: Python :: 3",
|
|
24
|
+
"Programming Language :: Python :: 3.11",
|
|
25
|
+
"Topic :: Software Development :: Libraries",
|
|
26
|
+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
|
27
|
+
]
|
|
28
|
+
dependencies = []
|
|
29
|
+
|
|
30
|
+
[project.urls]
|
|
31
|
+
Homepage = "https://github.com/pmbarbas/ia-rag-core"
|
|
32
|
+
Documentation = "https://github.com/pmbarbas/ia-rag-core/tree/main/docs"
|
|
33
|
+
Source = "https://github.com/pmbarbas/ia-rag-core"
|
|
34
|
+
Issues = "https://github.com/pmbarbas/ia-rag-core/issues"
|
|
35
|
+
Changelog = "https://github.com/pmbarbas/ia-rag-core/blob/main/CHANGELOG.md"
|
|
36
|
+
|
|
37
|
+
[project.optional-dependencies]
|
|
38
|
+
dev = ["pytest>=8"]
|
|
39
|
+
|
|
40
|
+
[tool.setuptools.packages.find]
|
|
41
|
+
where = ["src"]
|
|
42
|
+
|
|
43
|
+
[tool.setuptools]
|
|
44
|
+
include-package-data = false
|
|
45
|
+
|
|
46
|
+
[tool.setuptools.package-data]
|
|
47
|
+
ia_rag = []
|
|
48
|
+
|
|
49
|
+
[tool.pytest.ini_options]
|
|
50
|
+
testpaths = ["tests"]
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
"""Supported public API for IA-RAG Core 0.1.0.
|
|
2
|
+
|
|
3
|
+
The package import is hermetic: it loads only the canonical runtime, neutral
|
|
4
|
+
protocols, reference assurance, and synthetic reference-domain components.
|
|
5
|
+
External adapters are separate integrations and are not part of this release.
|
|
6
|
+
"""
|
|
7
|
+
|
|
8
|
+
from .domain import (
|
|
9
|
+
Answer, Chunk, Document, EvalItem, EvalResult, GraphEdge, GraphNode,
|
|
10
|
+
GraphResult, HybridSearchConfig, Metadata, Query, ScoredChunk,
|
|
11
|
+
)
|
|
12
|
+
from .protocols import (
|
|
13
|
+
CompilerRuntime, DocumentStore, EmbeddingProvider, EntityExtractor,
|
|
14
|
+
EntityResolver, GraphIntentHandler, GraphStore, LexicalIndex, LLMProvider,
|
|
15
|
+
PlanGovernance, RelationExtractor, TelemetrySink, VectorIndex,
|
|
16
|
+
)
|
|
17
|
+
from .assurance_protocols import (
|
|
18
|
+
ASSURANCE_PROTOCOL_ID, ASSURANCE_PROTOCOL_VERSION,
|
|
19
|
+
AssuranceConfigurationError, AssuranceMode, AssuranceProvider,
|
|
20
|
+
)
|
|
21
|
+
from .claims import Claim, ClaimBundle, ClaimPolarity, ClaimStatus
|
|
22
|
+
from .planner_registry import (
|
|
23
|
+
AmbiguousPlannerError, PlannerContext, PlannerRegistration, PlannerRegistry,
|
|
24
|
+
PlannerSelection, PlannerSelectionError, RouteResult, UnsupportedPlannerError,
|
|
25
|
+
)
|
|
26
|
+
from .canonical_compiler import CanonicalCompileResult, CanonicalCompiler, CanonicalDomainPack
|
|
27
|
+
from .canonical_plan import (
|
|
28
|
+
CanonicalExecutionPlan,
|
|
29
|
+
CanonicalLogicalPlan,
|
|
30
|
+
CanonicalPlanType,
|
|
31
|
+
execution_plan_digest,
|
|
32
|
+
logical_plan_digest,
|
|
33
|
+
)
|
|
34
|
+
from .canonical_execution_admission import CanonicalExecutionAdmission, admit_canonical_execution
|
|
35
|
+
from .canonical_execution_enforcement import (
|
|
36
|
+
CanonicalEnforcementDecision,
|
|
37
|
+
CanonicalEnforcementPhase,
|
|
38
|
+
CanonicalEnforcementStatus,
|
|
39
|
+
)
|
|
40
|
+
from .canonical_execution_receipt import (
|
|
41
|
+
CANONICAL_EXECUTION_RECEIPT_PROTOCOL_ID,
|
|
42
|
+
CANONICAL_EXECUTION_RECEIPT_PROTOCOL_VERSION,
|
|
43
|
+
CanonicalExecutionReceipt,
|
|
44
|
+
)
|
|
45
|
+
from .canonical_lineage import CanonicalLineageReadModel, lineage_metadata
|
|
46
|
+
from .query_router import QueryRouter
|
|
47
|
+
from .domain_semantic_extensions import (
|
|
48
|
+
DOMAIN_SEMANTIC_EXTENSION_PROTOCOL_ID,
|
|
49
|
+
DOMAIN_SEMANTIC_EXTENSION_PROTOCOL_VERSION,
|
|
50
|
+
DomainSemanticExtension, DomainSemanticExtensionRegistry,
|
|
51
|
+
SemanticExtensionConfigurationError,
|
|
52
|
+
)
|
|
53
|
+
from .public_runtime import (
|
|
54
|
+
InMemoryEntityResolver, InMemoryGraphStore, PUBLIC_CANONICAL_PLANNER_TYPE,
|
|
55
|
+
PUBLIC_RUNTIME_PROTOCOL_ID, PUBLIC_RUNTIME_PROTOCOL_VERSION,
|
|
56
|
+
PublicCanonicalRuntime, PublicCompilation, PublicCoreConfigurationError,
|
|
57
|
+
PublicExecutionError, PublicExecutionResult, PublicRuntimeComponents,
|
|
58
|
+
build_canonical_runtime, register_public_canonical_planner,
|
|
59
|
+
)
|
|
60
|
+
from .public_rendering import PublicResponseRenderer
|
|
61
|
+
from .reference_assurance import ReferenceAssuranceProvider
|
|
62
|
+
from .reference_domains import (
|
|
63
|
+
EQUIPMENT_NETWORK_DOMAIN, RESEARCH_NETWORK_DOMAIN, closed_world_domain,
|
|
64
|
+
load_reference_domain, load_reference_facts,
|
|
65
|
+
)
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
__all__ = [
|
|
69
|
+
"Answer", "Chunk", "Document", "EvalItem", "EvalResult", "GraphEdge", "GraphNode", "GraphResult",
|
|
70
|
+
"HybridSearchConfig", "Metadata", "Query", "ScoredChunk",
|
|
71
|
+
"CompilerRuntime", "DocumentStore", "EmbeddingProvider", "EntityExtractor", "EntityResolver",
|
|
72
|
+
"GraphIntentHandler", "GraphStore", "LexicalIndex", "LLMProvider", "PlanGovernance",
|
|
73
|
+
"RelationExtractor", "TelemetrySink", "VectorIndex",
|
|
74
|
+
"ASSURANCE_PROTOCOL_ID", "ASSURANCE_PROTOCOL_VERSION", "AssuranceConfigurationError",
|
|
75
|
+
"AssuranceMode", "AssuranceProvider",
|
|
76
|
+
"Claim", "ClaimBundle", "ClaimPolarity", "ClaimStatus",
|
|
77
|
+
"AmbiguousPlannerError", "PlannerContext", "PlannerRegistration", "PlannerRegistry",
|
|
78
|
+
"PlannerSelection", "PlannerSelectionError", "RouteResult", "UnsupportedPlannerError", "QueryRouter",
|
|
79
|
+
"CanonicalCompileResult", "CanonicalCompiler", "CanonicalDomainPack",
|
|
80
|
+
"CanonicalExecutionPlan", "CanonicalLogicalPlan", "CanonicalPlanType",
|
|
81
|
+
"execution_plan_digest", "logical_plan_digest", "CanonicalExecutionAdmission",
|
|
82
|
+
"admit_canonical_execution", "CanonicalEnforcementDecision", "CanonicalEnforcementPhase",
|
|
83
|
+
"CanonicalEnforcementStatus", "CANONICAL_EXECUTION_RECEIPT_PROTOCOL_ID",
|
|
84
|
+
"CANONICAL_EXECUTION_RECEIPT_PROTOCOL_VERSION", "CanonicalExecutionReceipt",
|
|
85
|
+
"CanonicalLineageReadModel", "lineage_metadata",
|
|
86
|
+
"DOMAIN_SEMANTIC_EXTENSION_PROTOCOL_ID", "DOMAIN_SEMANTIC_EXTENSION_PROTOCOL_VERSION",
|
|
87
|
+
"DomainSemanticExtension", "DomainSemanticExtensionRegistry", "SemanticExtensionConfigurationError",
|
|
88
|
+
"InMemoryEntityResolver", "InMemoryGraphStore", "PUBLIC_CANONICAL_PLANNER_TYPE",
|
|
89
|
+
"PUBLIC_RUNTIME_PROTOCOL_ID", "PUBLIC_RUNTIME_PROTOCOL_VERSION", "PublicCanonicalRuntime",
|
|
90
|
+
"PublicCompilation", "PublicCoreConfigurationError", "PublicExecutionError", "PublicExecutionResult",
|
|
91
|
+
"PublicRuntimeComponents", "PublicResponseRenderer", "ReferenceAssuranceProvider",
|
|
92
|
+
"build_canonical_runtime", "register_public_canonical_planner",
|
|
93
|
+
"EQUIPMENT_NETWORK_DOMAIN", "RESEARCH_NETWORK_DOMAIN", "closed_world_domain",
|
|
94
|
+
"load_reference_domain", "load_reference_facts",
|
|
95
|
+
]
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
_EXPORT_CLASSIFICATION = {
|
|
99
|
+
"PUBLIC_CORE": tuple(__all__),
|
|
100
|
+
"PUBLIC_OPTIONAL_EXTRA": (),
|
|
101
|
+
"EXCLUDED_APPLICATION_SURFACES": ("external_adapters", "application_specific_domains"),
|
|
102
|
+
}
|