trovegen 0.3.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,76 @@
1
+ node_modules/
2
+ dist/
3
+ build/
4
+ .next/
5
+ out/
6
+ coverage/
7
+ *.tsbuildinfo
8
+
9
+ # env / secrets
10
+ .env
11
+ .env.*
12
+ !.env.example
13
+ !.env.docker.example
14
+
15
+ # Credential files that are NOT env vars. `Secrets/` holds provider-issued
16
+ # JSON (e.g. the Google OAuth client secret) — real keys, never publishable.
17
+ Secrets/
18
+ *client_secret*.json
19
+ *.pem
20
+ *.key
21
+ !**/lib/*.key
22
+
23
+ # Ingested document images written by the asset store. Customer content plus
24
+ # tens of MB of test fixtures — regenerated on ingest, never source.
25
+ .trove-assets/
26
+
27
+ # OCR/embedding model caches — large binaries fetched on first run.
28
+ *.traineddata
29
+ *.traineddata.gz
30
+ .cache/
31
+
32
+ # Windows crash dumps
33
+ *.stackdump
34
+
35
+ # logs
36
+ *.log
37
+ npm-debug.log*
38
+ pnpm-debug.log*
39
+
40
+ # os / editor
41
+ .DS_Store
42
+ Thumbs.db
43
+ .idea/
44
+ .vscode/*
45
+ !.vscode/extensions.json
46
+
47
+ # local data
48
+ /data/
49
+ *.local
50
+ .ocr-cache/
51
+
52
+ # packed SDK/MCP tarballs (scripts/pack-packages.mjs)
53
+ apps/api/downloads/
54
+ .embed-local.log
55
+ .embed-local*.log
56
+ .deploy-tag
57
+ .deploy.log
58
+ .docker-*.log
59
+ .state.json
60
+ .state-bgem3.json
61
+
62
+ # Quality benchmark: run outputs and embedding caches stay local; the two reference results are kept
63
+ scripts/quality/results/*
64
+ !scripts/quality/results/baseline.json
65
+ !scripts/quality/results/bge-m3.json
66
+
67
+ # troveGEN AI/Chat local originals
68
+ .chat-files/
69
+
70
+ apps/chat-api/models.local.json
71
+
72
+ # Python SDK build and test artefacts
73
+ __pycache__/
74
+ .pytest_cache/
75
+ *.egg-info/
76
+ packages/sdk-python/dist/
trovegen-0.3.0/LICENSE ADDED
@@ -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.
@@ -0,0 +1,187 @@
1
+ Metadata-Version: 2.5
2
+ Name: trovegen
3
+ Version: 0.3.0
4
+ Summary: Python SDK for troveGEN: ingestion, hybrid search and grounded, cited answers (sync and async, with streaming).
5
+ Project-URL: Homepage, https://trovegen.com
6
+ Project-URL: Documentation, https://trovegen.com/developers
7
+ Author: Intellara Technologies Private Limited
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE
10
+ Keywords: agents,hybrid-search,rag,retrieval-augmented-generation,trovegen,vector-search
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Topic :: Software Development :: Libraries
14
+ Classifier: Typing :: Typed
15
+ Requires-Python: >=3.9
16
+ Requires-Dist: httpx<1,>=0.27
17
+ Provides-Extra: test
18
+ Requires-Dist: pytest-asyncio>=0.23; extra == 'test'
19
+ Requires-Dist: pytest>=8; extra == 'test'
20
+ Description-Content-Type: text/markdown
21
+
22
+ # troveGEN Python SDK
23
+
24
+ Python client for [troveGEN](https://trovegen.com): ingestion, hybrid search and grounded, cited answers, for apps and agents.
25
+ Sync (`TroveGen`) and asyncio (`AsyncTroveGen`) clients, streaming answers, retries, and a per-call time budget.
26
+
27
+ ```bash
28
+ pip install trovegen
29
+ ```
30
+
31
+ Python 3.9 or newer; one dependency (`httpx`).
32
+
33
+ ## Quick start
34
+
35
+ ```python
36
+ from trovegen import TroveGen, TroveGenError
37
+
38
+ tg = TroveGen(api_key="trv_...", base_url="https://trovegen.com")
39
+
40
+ project = tg.projects.create("Classical texts")
41
+ pid = project["id"]
42
+
43
+ # Your own id for the document: sending it again replaces the earlier copy,
44
+ # and the same text with new metadata only updates the metadata (nothing is re-embedded or billed).
45
+ tg.documents.ingest_text(
46
+ pid,
47
+ "Gaja Kesari yoga arises when Jupiter is in a kendra from the Moon ...",
48
+ title="Phaladeepika, chapter 6",
49
+ external_id="phaladeepika/6",
50
+ metadata={"tradition": "parashari", "topics": ["yoga", "wealth"]}, # lists of strings are allowed
51
+ )
52
+
53
+ hits = tg.search(pid, "which yoga gives fame", filter={"topics": "yoga"}, top_k=5)
54
+ for r in hits["results"]:
55
+ print(round(r["score"], 3), r["content"][:80])
56
+ ```
57
+
58
+ Keyword arguments are written in snake_case (`top_k`, `recency_bias`, `external_id`) and sent under the API's own names
59
+ (`topK`, ...). Filters and metadata are sent exactly as you write them.
60
+
61
+ ## Metadata
62
+
63
+ - A value is a string, number, boolean, or a **list of strings** (at most 100 items). At most 50 keys and 8 KB per document.
64
+ - Metadata is copied to every chunk and can be filtered on, on both halves of hybrid search.
65
+ - On a list field every filter operator applies to its elements: `{"topics": "yoga"}` means "topics contains yoga",
66
+ `$in` contains any, `$all` contains every one, `$nin` contains none. Also `$eq $ne $gt $gte $lt $lte $exists $and $or`.
67
+ - `tg.projects.metadata_keys(pid)` lists the keys in a project, their type (`array` for lists), whether you or troveGEN wrote them,
68
+ and sample values.
69
+
70
+ ### Passages with their own metadata (segments)
71
+
72
+ When you already know where each passage starts and ends (a chapter, a verse, one combination), send segments. troveGEN still
73
+ chunks inside each segment, so chunks fit the embedding model, but a chunk never crosses two segments and every chunk carries
74
+ its segment's metadata on top of the document's.
75
+
76
+ ```python
77
+ tg.documents.ingest_text(
78
+ pid,
79
+ title="Saravali (extract)",
80
+ external_id="saravali/yogas",
81
+ metadata={"tradition": "parashari"},
82
+ segments=[
83
+ {"text": "...", "heading": "Gaja Kesari yoga", "page": 12, "metadata": {"planets": ["moon", "jupiter"], "house": 1}},
84
+ {"text": "...", "heading": "Budha Aditya yoga", "page": 13, "metadata": {"planets": ["sun", "mercury"]}},
85
+ ],
86
+ )
87
+ tg.search(pid, "yoga of Moon and Jupiter", filter={"planets": {"$all": ["moon", "jupiter"]}})
88
+ ```
89
+
90
+ ### Changing metadata later (no re-upload)
91
+
92
+ ```python
93
+ doc = tg.documents.find_by_external_id(pid, "saravali/yogas")
94
+ tg.documents.update_metadata(pid, doc["id"], {"topics": ["yoga", "dasha"], "draft": None}) # None removes a key
95
+ tg.documents.update_metadata(pid, doc["id"], segments=[{"index": 0, "metadata": {"planets": ["saturn"]}}])
96
+ ```
97
+
98
+ Chunk rows and vector payloads are changed in place; nothing is read, chunked or embedded again. A vector store that cannot
99
+ change payloads in place (Pinecone) refuses with `METADATA_UPDATE_UNSUPPORTED`; send the document again with `force=True`.
100
+
101
+ ## Files
102
+
103
+ ```python
104
+ with open("book.pdf", "rb") as f:
105
+ result = tg.documents.ingest_file(pid, f, "book.pdf", content_type="application/pdf",
106
+ external_id="books/brihat", layout="book", book_title="Brihat Parashara Hora Shastra",
107
+ metadata={"topics": ["yoga", "dasha"]})
108
+
109
+ # Large files: return at once and wait separately
110
+ job = tg.documents.ingest_file(pid, open("big.pdf", "rb"), "big.pdf", wait=False)
111
+ tg.documents.wait_for_job(pid, job["id"])
112
+ ```
113
+
114
+ ## Deadlines and fallback
115
+
116
+ A call's `timeout` is its whole budget in seconds, retries included. When it runs out the SDK raises `TroveGenError` with code
117
+ `TIMEOUT`, so an app with a deadline can fall back to another retriever instead of waiting:
118
+
119
+ ```python
120
+ try:
121
+ hits = tg.search(pid, question, timeout=2.0, max_retries=0, ranking="standard")
122
+ except TroveGenError as e:
123
+ if e.is_transient: # TIMEOUT, NETWORK_ERROR, 429 or 5xx
124
+ hits = fallback_search(question)
125
+ else:
126
+ raise
127
+ ```
128
+
129
+ `ranking="standard"` keeps a model out of the search path; smart ranking adds a model call (about 1 to 3 seconds).
130
+
131
+ ## Measuring troveGEN (shadow mode)
132
+
133
+ ```python
134
+ def log(info):
135
+ print(info.path, info.status, f"client {info.ms:.0f} ms", f"server {info.server_ms} ms", info.server_stages)
136
+
137
+ tg = TroveGen(api_key="trv_...", base_url="https://trovegen.com", on_response=log)
138
+ ```
139
+
140
+ `server_ms` comes from troveGEN's `Server-Timing` header; a search response also carries `pipeline.tookMs`.
141
+
142
+ ## Answers
143
+
144
+ ```python
145
+ answer = tg.ask(pid, "What does Gaja Kesari yoga give?")
146
+ print(answer.get("answer"), answer.get("citations"))
147
+
148
+ for event in tg.ask_stream(pid, "What does Gaja Kesari yoga give?"):
149
+ if event["event"] == "delta":
150
+ print(event["data"]["text"], end="")
151
+ ```
152
+
153
+ The workspace must allow generation (Settings, General). Each event is `{"event": ..., "data": ...}`: meta, delta, citations,
154
+ groundedness, figures, done.
155
+
156
+ ## Per-user access
157
+
158
+ ```python
159
+ from trovegen import mint_end_user_token
160
+ secret = tg.projects.rotate_acl_secret(pid)["secret"] # store it on your server
161
+ token = mint_end_user_token(secret, "u_42", ["user:u_42", "group:finance"])
162
+ tg.search(pid, "salary bands", end_user_token=token) # sees only what u_42 may see
163
+ ```
164
+
165
+ ## Async
166
+
167
+ ```python
168
+ import asyncio
169
+ from trovegen import AsyncTroveGen
170
+
171
+ async def main():
172
+ async with AsyncTroveGen(api_key="trv_...", base_url="https://trovegen.com") as tg:
173
+ hits = await tg.search(pid, "remedies for Saturn", timeout=2.0)
174
+ async for event in tg.ask_stream(pid, "What are the remedies for Saturn?"):
175
+ ...
176
+
177
+ asyncio.run(main())
178
+ ```
179
+
180
+ ## Errors
181
+
182
+ Every failure is a `TroveGenError` with `code`, `message`, `status` (0 when there was no response), `request_id` (quote it when
183
+ you report a problem) and `details`.
184
+
185
+ ## Licence
186
+
187
+ Apache-2.0.
@@ -0,0 +1,166 @@
1
+ # troveGEN Python SDK
2
+
3
+ Python client for [troveGEN](https://trovegen.com): ingestion, hybrid search and grounded, cited answers, for apps and agents.
4
+ Sync (`TroveGen`) and asyncio (`AsyncTroveGen`) clients, streaming answers, retries, and a per-call time budget.
5
+
6
+ ```bash
7
+ pip install trovegen
8
+ ```
9
+
10
+ Python 3.9 or newer; one dependency (`httpx`).
11
+
12
+ ## Quick start
13
+
14
+ ```python
15
+ from trovegen import TroveGen, TroveGenError
16
+
17
+ tg = TroveGen(api_key="trv_...", base_url="https://trovegen.com")
18
+
19
+ project = tg.projects.create("Classical texts")
20
+ pid = project["id"]
21
+
22
+ # Your own id for the document: sending it again replaces the earlier copy,
23
+ # and the same text with new metadata only updates the metadata (nothing is re-embedded or billed).
24
+ tg.documents.ingest_text(
25
+ pid,
26
+ "Gaja Kesari yoga arises when Jupiter is in a kendra from the Moon ...",
27
+ title="Phaladeepika, chapter 6",
28
+ external_id="phaladeepika/6",
29
+ metadata={"tradition": "parashari", "topics": ["yoga", "wealth"]}, # lists of strings are allowed
30
+ )
31
+
32
+ hits = tg.search(pid, "which yoga gives fame", filter={"topics": "yoga"}, top_k=5)
33
+ for r in hits["results"]:
34
+ print(round(r["score"], 3), r["content"][:80])
35
+ ```
36
+
37
+ Keyword arguments are written in snake_case (`top_k`, `recency_bias`, `external_id`) and sent under the API's own names
38
+ (`topK`, ...). Filters and metadata are sent exactly as you write them.
39
+
40
+ ## Metadata
41
+
42
+ - A value is a string, number, boolean, or a **list of strings** (at most 100 items). At most 50 keys and 8 KB per document.
43
+ - Metadata is copied to every chunk and can be filtered on, on both halves of hybrid search.
44
+ - On a list field every filter operator applies to its elements: `{"topics": "yoga"}` means "topics contains yoga",
45
+ `$in` contains any, `$all` contains every one, `$nin` contains none. Also `$eq $ne $gt $gte $lt $lte $exists $and $or`.
46
+ - `tg.projects.metadata_keys(pid)` lists the keys in a project, their type (`array` for lists), whether you or troveGEN wrote them,
47
+ and sample values.
48
+
49
+ ### Passages with their own metadata (segments)
50
+
51
+ When you already know where each passage starts and ends (a chapter, a verse, one combination), send segments. troveGEN still
52
+ chunks inside each segment, so chunks fit the embedding model, but a chunk never crosses two segments and every chunk carries
53
+ its segment's metadata on top of the document's.
54
+
55
+ ```python
56
+ tg.documents.ingest_text(
57
+ pid,
58
+ title="Saravali (extract)",
59
+ external_id="saravali/yogas",
60
+ metadata={"tradition": "parashari"},
61
+ segments=[
62
+ {"text": "...", "heading": "Gaja Kesari yoga", "page": 12, "metadata": {"planets": ["moon", "jupiter"], "house": 1}},
63
+ {"text": "...", "heading": "Budha Aditya yoga", "page": 13, "metadata": {"planets": ["sun", "mercury"]}},
64
+ ],
65
+ )
66
+ tg.search(pid, "yoga of Moon and Jupiter", filter={"planets": {"$all": ["moon", "jupiter"]}})
67
+ ```
68
+
69
+ ### Changing metadata later (no re-upload)
70
+
71
+ ```python
72
+ doc = tg.documents.find_by_external_id(pid, "saravali/yogas")
73
+ tg.documents.update_metadata(pid, doc["id"], {"topics": ["yoga", "dasha"], "draft": None}) # None removes a key
74
+ tg.documents.update_metadata(pid, doc["id"], segments=[{"index": 0, "metadata": {"planets": ["saturn"]}}])
75
+ ```
76
+
77
+ Chunk rows and vector payloads are changed in place; nothing is read, chunked or embedded again. A vector store that cannot
78
+ change payloads in place (Pinecone) refuses with `METADATA_UPDATE_UNSUPPORTED`; send the document again with `force=True`.
79
+
80
+ ## Files
81
+
82
+ ```python
83
+ with open("book.pdf", "rb") as f:
84
+ result = tg.documents.ingest_file(pid, f, "book.pdf", content_type="application/pdf",
85
+ external_id="books/brihat", layout="book", book_title="Brihat Parashara Hora Shastra",
86
+ metadata={"topics": ["yoga", "dasha"]})
87
+
88
+ # Large files: return at once and wait separately
89
+ job = tg.documents.ingest_file(pid, open("big.pdf", "rb"), "big.pdf", wait=False)
90
+ tg.documents.wait_for_job(pid, job["id"])
91
+ ```
92
+
93
+ ## Deadlines and fallback
94
+
95
+ A call's `timeout` is its whole budget in seconds, retries included. When it runs out the SDK raises `TroveGenError` with code
96
+ `TIMEOUT`, so an app with a deadline can fall back to another retriever instead of waiting:
97
+
98
+ ```python
99
+ try:
100
+ hits = tg.search(pid, question, timeout=2.0, max_retries=0, ranking="standard")
101
+ except TroveGenError as e:
102
+ if e.is_transient: # TIMEOUT, NETWORK_ERROR, 429 or 5xx
103
+ hits = fallback_search(question)
104
+ else:
105
+ raise
106
+ ```
107
+
108
+ `ranking="standard"` keeps a model out of the search path; smart ranking adds a model call (about 1 to 3 seconds).
109
+
110
+ ## Measuring troveGEN (shadow mode)
111
+
112
+ ```python
113
+ def log(info):
114
+ print(info.path, info.status, f"client {info.ms:.0f} ms", f"server {info.server_ms} ms", info.server_stages)
115
+
116
+ tg = TroveGen(api_key="trv_...", base_url="https://trovegen.com", on_response=log)
117
+ ```
118
+
119
+ `server_ms` comes from troveGEN's `Server-Timing` header; a search response also carries `pipeline.tookMs`.
120
+
121
+ ## Answers
122
+
123
+ ```python
124
+ answer = tg.ask(pid, "What does Gaja Kesari yoga give?")
125
+ print(answer.get("answer"), answer.get("citations"))
126
+
127
+ for event in tg.ask_stream(pid, "What does Gaja Kesari yoga give?"):
128
+ if event["event"] == "delta":
129
+ print(event["data"]["text"], end="")
130
+ ```
131
+
132
+ The workspace must allow generation (Settings, General). Each event is `{"event": ..., "data": ...}`: meta, delta, citations,
133
+ groundedness, figures, done.
134
+
135
+ ## Per-user access
136
+
137
+ ```python
138
+ from trovegen import mint_end_user_token
139
+ secret = tg.projects.rotate_acl_secret(pid)["secret"] # store it on your server
140
+ token = mint_end_user_token(secret, "u_42", ["user:u_42", "group:finance"])
141
+ tg.search(pid, "salary bands", end_user_token=token) # sees only what u_42 may see
142
+ ```
143
+
144
+ ## Async
145
+
146
+ ```python
147
+ import asyncio
148
+ from trovegen import AsyncTroveGen
149
+
150
+ async def main():
151
+ async with AsyncTroveGen(api_key="trv_...", base_url="https://trovegen.com") as tg:
152
+ hits = await tg.search(pid, "remedies for Saturn", timeout=2.0)
153
+ async for event in tg.ask_stream(pid, "What are the remedies for Saturn?"):
154
+ ...
155
+
156
+ asyncio.run(main())
157
+ ```
158
+
159
+ ## Errors
160
+
161
+ Every failure is a `TroveGenError` with `code`, `message`, `status` (0 when there was no response), `request_id` (quote it when
162
+ you report a problem) and `details`.
163
+
164
+ ## Licence
165
+
166
+ Apache-2.0.
@@ -0,0 +1,35 @@
1
+ [build-system]
2
+ requires = ["hatchling>=1.24"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "trovegen"
7
+ version = "0.3.0"
8
+ description = "Python SDK for troveGEN: ingestion, hybrid search and grounded, cited answers (sync and async, with streaming)."
9
+ readme = "README.md"
10
+ license = "Apache-2.0"
11
+ requires-python = ">=3.9"
12
+ authors = [{ name = "Intellara Technologies Private Limited" }]
13
+ keywords = ["rag", "retrieval-augmented-generation", "vector-search", "hybrid-search", "trovegen", "agents"]
14
+ classifiers = [
15
+ "Programming Language :: Python :: 3",
16
+ "Typing :: Typed",
17
+ "Intended Audience :: Developers",
18
+ "Topic :: Software Development :: Libraries",
19
+ ]
20
+ dependencies = ["httpx>=0.27,<1"]
21
+
22
+ [project.optional-dependencies]
23
+ test = ["pytest>=8", "pytest-asyncio>=0.23"]
24
+
25
+ [project.urls]
26
+ Homepage = "https://trovegen.com"
27
+ Documentation = "https://trovegen.com/developers"
28
+
29
+ [tool.hatch.build.targets.wheel]
30
+ packages = ["src/trovegen"]
31
+
32
+ [tool.pytest.ini_options]
33
+ testpaths = ["tests"]
34
+ asyncio_mode = "auto"
35
+ asyncio_default_fixture_loop_scope = "function"