foldback-ai 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.
- foldback_ai-0.1.0/.gitignore +15 -0
- foldback_ai-0.1.0/.hypothesis/.gitignore +9 -0
- foldback_ai-0.1.0/.hypothesis/constants/141d69a8f062fd8d +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/16cd3f61b9b1b6e8 +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/1ca61fee157c9feb +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/5cc7a17a788d9c78 +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/8db86f62215f82dd +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/9c5e2b265b040d0d +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/9f462cc739af9635 +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/a5c2aaee06c34450 +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/b24e939752d0d3a5 +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/c828fa69d642c553 +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/d002fca073705cfa +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/d3298b062769fee5 +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/e26f09a1a7a915dc +4 -0
- foldback_ai-0.1.0/.hypothesis/constants/fbf78aac36af7e9a +4 -0
- foldback_ai-0.1.0/.hypothesis/unicode_data/15.1.0/charmap.json.gz +0 -0
- foldback_ai-0.1.0/.hypothesis/unicode_data/15.1.0/codec-utf-8.json.gz +0 -0
- foldback_ai-0.1.0/CHANGELOG.md +37 -0
- foldback_ai-0.1.0/LICENSE +202 -0
- foldback_ai-0.1.0/NOTICE +16 -0
- foldback_ai-0.1.0/PKG-INFO +169 -0
- foldback_ai-0.1.0/README.md +133 -0
- foldback_ai-0.1.0/benchmarks/run.py +77 -0
- foldback_ai-0.1.0/docs/ci-workflow.yml.example +64 -0
- foldback_ai-0.1.0/examples/demo.py +43 -0
- foldback_ai-0.1.0/foldback/__init__.py +37 -0
- foldback_ai-0.1.0/foldback/compactors/__init__.py +29 -0
- foldback_ai-0.1.0/foldback/compactors/json_columnar.py +109 -0
- foldback_ai-0.1.0/foldback/compactors/logs.py +40 -0
- foldback_ai-0.1.0/foldback/compactors/text.py +21 -0
- foldback_ai-0.1.0/foldback/compress.py +225 -0
- foldback_ai-0.1.0/foldback/detect.py +59 -0
- foldback_ai-0.1.0/foldback/integrations/__init__.py +27 -0
- foldback_ai-0.1.0/foldback/integrations/wrappers.py +91 -0
- foldback_ai-0.1.0/foldback/livezone.py +52 -0
- foldback_ai-0.1.0/foldback/py.typed +0 -0
- foldback_ai-0.1.0/foldback/tokens.py +52 -0
- foldback_ai-0.1.0/pyproject.toml +68 -0
- foldback_ai-0.1.0/tests/test_compress.py +177 -0
- foldback_ai-0.1.0/tests/test_integrations.py +101 -0
- foldback_ai-0.1.0/tests/test_roundtrip.py +91 -0
- foldback_ai-0.1.0/tests/test_tokens.py +33 -0
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# This .gitignore file was automatically created by Hypothesis. Hypothesis gitignores
|
|
2
|
+
# .hypothesis by default, because we generally recommend that .hypothesis not be checked
|
|
3
|
+
# into version control.
|
|
4
|
+
#
|
|
5
|
+
# If you *would* like to check .hypothesis into version control, you should delete this
|
|
6
|
+
# file. Hypothesis will not re-create this .gitignore unless .hypothesis is deleted (and
|
|
7
|
+
# if it does, that's a bug - please report it!)
|
|
8
|
+
|
|
9
|
+
*
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to FoldBack are documented here. The format follows
|
|
4
|
+
[Keep a Changelog](https://keepachangelog.com/) and the project adheres to
|
|
5
|
+
[Semantic Versioning](https://semver.org/).
|
|
6
|
+
|
|
7
|
+
## [0.1.0] — 2026-06-20
|
|
8
|
+
|
|
9
|
+
First production-ready release.
|
|
10
|
+
|
|
11
|
+
### Added
|
|
12
|
+
- `compress(messages, model=...)` — live-zone-only, content-preserving
|
|
13
|
+
compression returning a `CompressResult` (`messages`, `tokens_saved`,
|
|
14
|
+
`ratio`, `transforms`).
|
|
15
|
+
- `CompressConfig` — `model`, `min_savings` token-savings gate, per-transform
|
|
16
|
+
`enabled` toggles.
|
|
17
|
+
- Reversible JSON columnar compactor with a proven inverse (`restore_columnar`)
|
|
18
|
+
and Hypothesis property tests guaranteeing exact round-trips.
|
|
19
|
+
- Normalizing log compactor (ANSI strip + consecutive-line run-length dedup)
|
|
20
|
+
and text compactor (trailing whitespace, blank-line runs).
|
|
21
|
+
- Optional exact token counting via `tiktoken` (`foldback[exact]`); zero-dep
|
|
22
|
+
char/4 heuristic by default.
|
|
23
|
+
- Drop-in SDK wrappers `with_anthropic()` / `with_openai()`.
|
|
24
|
+
- Full quality gate: ruff, mypy `--strict`, pytest with coverage, Python
|
|
25
|
+
3.10–3.13, packaged wheel + sdist (`twine check` clean).
|
|
26
|
+
|
|
27
|
+
### Correctness
|
|
28
|
+
- Token-based savings gate: a transform is applied only when it reduces
|
|
29
|
+
tokens (not merely bytes).
|
|
30
|
+
- Cache hot zone (everything before the last `cache_control` breakpoint) is
|
|
31
|
+
forwarded as the identical objects received — never re-serialized.
|
|
32
|
+
|
|
33
|
+
### Fixed (vs. the pre-release prototype)
|
|
34
|
+
- JSON compaction was not reversible: string `"1"` and integer `1` rendered
|
|
35
|
+
identically, and the absent-key sentinel collided with real values. The
|
|
36
|
+
columnar format now keeps every cell as a typed JSON token and only
|
|
37
|
+
compacts uniform-schema arrays, so the round-trip is exact.
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
foldback_ai-0.1.0/NOTICE
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
FoldBack
|
|
2
|
+
Copyright 2026 SudarshanTechLabs
|
|
3
|
+
|
|
4
|
+
This product includes software developed by SudarshanTechLabs.
|
|
5
|
+
|
|
6
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
+
you may not use this file except in compliance with the License.
|
|
8
|
+
You may obtain a copy of the License at
|
|
9
|
+
|
|
10
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
|
|
12
|
+
Unless required by applicable law or agreed to in writing, software
|
|
13
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
+
See the License for the specific language governing permissions and
|
|
16
|
+
limitations under the License.
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: foldback-ai
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Lossless context compression for LLM agents. Fold it down, fold it back. No data dropped, prompt cache preserved.
|
|
5
|
+
Project-URL: Homepage, https://github.com/SUDARSHANCHAUDHARI/FoldBack
|
|
6
|
+
Project-URL: Repository, https://github.com/SUDARSHANCHAUDHARI/FoldBack
|
|
7
|
+
Project-URL: Issues, https://github.com/SUDARSHANCHAUDHARI/FoldBack/issues
|
|
8
|
+
Author: SudarshanTechLabs
|
|
9
|
+
License: Apache-2.0
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
License-File: NOTICE
|
|
12
|
+
Keywords: agents,compression,context,llm,prompt-cache,tokens
|
|
13
|
+
Classifier: Development Status :: 4 - Beta
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
20
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
21
|
+
Classifier: Typing :: Typed
|
|
22
|
+
Requires-Python: >=3.10
|
|
23
|
+
Provides-Extra: anthropic
|
|
24
|
+
Requires-Dist: anthropic>=0.40; extra == 'anthropic'
|
|
25
|
+
Provides-Extra: dev
|
|
26
|
+
Requires-Dist: hypothesis>=6.100; extra == 'dev'
|
|
27
|
+
Requires-Dist: mypy>=1.11; extra == 'dev'
|
|
28
|
+
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
|
|
29
|
+
Requires-Dist: pytest>=8.0; extra == 'dev'
|
|
30
|
+
Requires-Dist: ruff>=0.6; extra == 'dev'
|
|
31
|
+
Provides-Extra: exact
|
|
32
|
+
Requires-Dist: tiktoken>=0.7; extra == 'exact'
|
|
33
|
+
Provides-Extra: openai
|
|
34
|
+
Requires-Dist: openai>=1.40; extra == 'openai'
|
|
35
|
+
Description-Content-Type: text/markdown
|
|
36
|
+
|
|
37
|
+
# FoldBack
|
|
38
|
+
|
|
39
|
+
**Context compression for LLM agents.** Fold it down, fold it back.
|
|
40
|
+
|
|
41
|
+
FoldBack shrinks what your agent sends to the model — JSON tool outputs, logs,
|
|
42
|
+
search results — using content-preserving transforms. No row is dropped, no
|
|
43
|
+
value is discarded, and the provider prompt cache keeps hitting.
|
|
44
|
+
|
|
45
|
+
```python
|
|
46
|
+
from foldback import compress
|
|
47
|
+
|
|
48
|
+
result = compress(messages, model="gpt-4o")
|
|
49
|
+
result.messages # same format, fewer tokens — send these to the model
|
|
50
|
+
result.tokens_saved # tokens saved
|
|
51
|
+
result.ratio # 0.45 == 55% saved; 1.0 == nothing changed
|
|
52
|
+
result.transforms # e.g. ["json:columnar"]
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Why it exists
|
|
56
|
+
|
|
57
|
+
Most "context compression" tools made two expensive mistakes:
|
|
58
|
+
|
|
59
|
+
1. **They compressed conversation history**, dropping old messages — which
|
|
60
|
+
busts the provider prompt cache on every call. On Anthropic that's a 90%
|
|
61
|
+
discount thrown away.
|
|
62
|
+
2. **They dropped data and hoped the model would ask for it back** via a
|
|
63
|
+
retrieval tool. If it doesn't realize data is missing, you get a
|
|
64
|
+
confidently wrong answer with no error.
|
|
65
|
+
|
|
66
|
+
FoldBack refuses both:
|
|
67
|
+
|
|
68
|
+
- **Passthrough is sacred.** Everything before the last `cache_control`
|
|
69
|
+
breakpoint is forwarded as the *same objects* — never copied, never
|
|
70
|
+
re-serialized — so caches keep hitting.
|
|
71
|
+
- **Only the live zone is touched** (the latest user message / tool result).
|
|
72
|
+
- **Token-gated.** A transform is applied only when it actually reduces
|
|
73
|
+
tokens. Otherwise the original is returned unchanged.
|
|
74
|
+
|
|
75
|
+
## Guarantees, stated honestly
|
|
76
|
+
|
|
77
|
+
Two transform categories with different promises:
|
|
78
|
+
|
|
79
|
+
| Content | Transform | Guarantee |
|
|
80
|
+
|---------|-----------|-----------|
|
|
81
|
+
| JSON array of uniform objects | columnar (keys written once, rows as JSON arrays) | **Reversible** — exact round-trip, proven by property tests. `restore_columnar()` reconstructs the original. |
|
|
82
|
+
| Logs | strip ANSI, run-length-collapse consecutive identical lines to `(xN)` | **Normalizing** — no textual content lost; removes non-semantic bytes. Not byte-reversible. |
|
|
83
|
+
| Plain text | trim trailing whitespace, collapse blank-line runs | **Normalizing** — words and punctuation untouched. |
|
|
84
|
+
|
|
85
|
+
The columnar transform only fires on **uniform-schema** arrays, so each row
|
|
86
|
+
maps back to its keys unambiguously and `"1"` (string) never collides with `1`
|
|
87
|
+
(number). Mixed-schema arrays are left untouched rather than compacted lossily.
|
|
88
|
+
|
|
89
|
+
```python
|
|
90
|
+
from foldback import compress, restore_columnar
|
|
91
|
+
# round-trip proof
|
|
92
|
+
compressed = compress(messages).messages
|
|
93
|
+
# any columnar block is exactly restorable:
|
|
94
|
+
# json.loads(restore_columnar(block)) == original_rows
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Measured savings
|
|
98
|
+
|
|
99
|
+
Reproduce with `python benchmarks/run.py --model gpt-4o` (exact gpt-4o tokens):
|
|
100
|
+
|
|
101
|
+
| Workload | Before | After | Saved |
|
|
102
|
+
|----------|-------:|------:|------:|
|
|
103
|
+
| API response (100 rows) | 2,803 | 1,421 | **49%** |
|
|
104
|
+
| Build log (200 lines) | 2,729 | 499 | **82%** |
|
|
105
|
+
| Code search (50 hits) | 1,892 | 1,159 | **39%** |
|
|
106
|
+
|
|
107
|
+
No marketing numbers — these come straight from the benchmark script.
|
|
108
|
+
|
|
109
|
+
## Install
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
pip install foldback # zero dependencies
|
|
113
|
+
pip install "foldback[exact]" # + tiktoken for exact token counts
|
|
114
|
+
pip install "foldback[anthropic]" # + Anthropic SDK for the wrapper
|
|
115
|
+
pip install "foldback[openai]" # + OpenAI SDK for the wrapper
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Use it
|
|
119
|
+
|
|
120
|
+
**Inline:**
|
|
121
|
+
```python
|
|
122
|
+
from foldback import compress, CompressConfig
|
|
123
|
+
|
|
124
|
+
result = compress(messages, model="claude-sonnet-4-5")
|
|
125
|
+
# or with options:
|
|
126
|
+
cfg = CompressConfig(model="gpt-4o", min_savings=0.2) # require >=20% win
|
|
127
|
+
result = compress(messages, config=cfg)
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
**Drop-in SDK wrappers** (system prompt / tool defs stay frozen → cache-safe):
|
|
131
|
+
```python
|
|
132
|
+
from anthropic import Anthropic
|
|
133
|
+
from foldback.integrations import with_anthropic
|
|
134
|
+
|
|
135
|
+
client = with_anthropic(Anthropic())
|
|
136
|
+
client.messages.create(model="claude-sonnet-4-5", messages=[...]) # auto-compressed
|
|
137
|
+
|
|
138
|
+
from openai import OpenAI
|
|
139
|
+
from foldback.integrations import with_openai
|
|
140
|
+
|
|
141
|
+
client = with_openai(OpenAI())
|
|
142
|
+
client.chat.completions.create(model="gpt-4o", messages=[...]) # auto-compressed
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
## Develop
|
|
146
|
+
|
|
147
|
+
```bash
|
|
148
|
+
pip install -e ".[dev,exact]"
|
|
149
|
+
pytest # tests + coverage
|
|
150
|
+
ruff check foldback tests # lint
|
|
151
|
+
mypy foldback # strict type-check
|
|
152
|
+
python benchmarks/run.py # savings table
|
|
153
|
+
python examples/demo.py
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## Deliberately NOT built
|
|
157
|
+
|
|
158
|
+
A network proxy, SSE streaming parser, Bedrock/Vertex signing, message
|
|
159
|
+
scoring / relevance, a HuggingFace compression model, lossy row-dropping with
|
|
160
|
+
retrieval. FoldBack is a library you call before your own SDK call — so it can
|
|
161
|
+
never corrupt the wire.
|
|
162
|
+
|
|
163
|
+
## Roadmap
|
|
164
|
+
|
|
165
|
+
- [ ] Diff / patch compaction
|
|
166
|
+
- [ ] CSV / Markdown-table input detection
|
|
167
|
+
- [ ] Rust core for the columnar path (only if profiling demands it)
|
|
168
|
+
|
|
169
|
+
Apache 2.0.
|