groundx 2.0.29__py3-none-any.whl → 2.2.0__py3-none-any.whl
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.
- groundx/buckets/client.py +0 -20
- groundx/core/client_wrapper.py +1 -1
- groundx/documents/client.py +14 -42
- groundx/groups/client.py +0 -28
- groundx/ingest.py +1 -3
- groundx/search/client.py +4 -16
- groundx/types/document_type.py +21 -1
- {groundx-2.0.29.dist-info → groundx-2.2.0.dist-info}/LICENSE +1 -1
- {groundx-2.0.29.dist-info → groundx-2.2.0.dist-info}/METADATA +2 -2
- {groundx-2.0.29.dist-info → groundx-2.2.0.dist-info}/RECORD +11 -11
- {groundx-2.0.29.dist-info → groundx-2.2.0.dist-info}/WHEEL +0 -0
groundx/buckets/client.py
CHANGED
@@ -33,8 +33,6 @@ class BucketsClient:
|
|
33
33
|
"""
|
34
34
|
List all buckets within your GroundX account
|
35
35
|
|
36
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
37
|
-
|
38
36
|
Parameters
|
39
37
|
----------
|
40
38
|
n : typing.Optional[int]
|
@@ -87,8 +85,6 @@ class BucketsClient:
|
|
87
85
|
"""
|
88
86
|
Create a new bucket.
|
89
87
|
|
90
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
91
|
-
|
92
88
|
Parameters
|
93
89
|
----------
|
94
90
|
name : str
|
@@ -152,8 +148,6 @@ class BucketsClient:
|
|
152
148
|
"""
|
153
149
|
Look up a specific bucket by its bucketId.
|
154
150
|
|
155
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
156
|
-
|
157
151
|
Parameters
|
158
152
|
----------
|
159
153
|
bucket_id : int
|
@@ -223,8 +217,6 @@ class BucketsClient:
|
|
223
217
|
"""
|
224
218
|
Rename a bucket.
|
225
219
|
|
226
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
227
|
-
|
228
220
|
Parameters
|
229
221
|
----------
|
230
222
|
bucket_id : int
|
@@ -303,8 +295,6 @@ class BucketsClient:
|
|
303
295
|
"""
|
304
296
|
Delete a bucket.
|
305
297
|
|
306
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
307
|
-
|
308
298
|
Parameters
|
309
299
|
----------
|
310
300
|
bucket_id : int
|
@@ -383,8 +373,6 @@ class AsyncBucketsClient:
|
|
383
373
|
"""
|
384
374
|
List all buckets within your GroundX account
|
385
375
|
|
386
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
387
|
-
|
388
376
|
Parameters
|
389
377
|
----------
|
390
378
|
n : typing.Optional[int]
|
@@ -445,8 +433,6 @@ class AsyncBucketsClient:
|
|
445
433
|
"""
|
446
434
|
Create a new bucket.
|
447
435
|
|
448
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
449
|
-
|
450
436
|
Parameters
|
451
437
|
----------
|
452
438
|
name : str
|
@@ -518,8 +504,6 @@ class AsyncBucketsClient:
|
|
518
504
|
"""
|
519
505
|
Look up a specific bucket by its bucketId.
|
520
506
|
|
521
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
522
|
-
|
523
507
|
Parameters
|
524
508
|
----------
|
525
509
|
bucket_id : int
|
@@ -597,8 +581,6 @@ class AsyncBucketsClient:
|
|
597
581
|
"""
|
598
582
|
Rename a bucket.
|
599
583
|
|
600
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
601
|
-
|
602
584
|
Parameters
|
603
585
|
----------
|
604
586
|
bucket_id : int
|
@@ -687,8 +669,6 @@ class AsyncBucketsClient:
|
|
687
669
|
"""
|
688
670
|
Delete a bucket.
|
689
671
|
|
690
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
691
|
-
|
692
672
|
Parameters
|
693
673
|
----------
|
694
674
|
bucket_id : int
|
groundx/core/client_wrapper.py
CHANGED
groundx/documents/client.py
CHANGED
@@ -40,8 +40,6 @@ class DocumentsClient:
|
|
40
40
|
"""
|
41
41
|
Ingest documents hosted on public URLs into a GroundX bucket.
|
42
42
|
|
43
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
44
|
-
|
45
43
|
Parameters
|
46
44
|
----------
|
47
45
|
documents : typing.Sequence[IngestRemoteDocument]
|
@@ -126,8 +124,6 @@ class DocumentsClient:
|
|
126
124
|
"""
|
127
125
|
Upload documents hosted on a local file system into a GroundX bucket.
|
128
126
|
|
129
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
130
|
-
|
131
127
|
Parameters
|
132
128
|
----------
|
133
129
|
request : DocumentLocalIngestRequest
|
@@ -208,8 +204,8 @@ class DocumentsClient:
|
|
208
204
|
) -> IngestResponse:
|
209
205
|
"""
|
210
206
|
Upload the content of a publicly accessible website for ingestion into a GroundX bucket. This is done by following links within a specified URL, recursively, up to a specified depth or number of pages.
|
211
|
-
|
212
|
-
|
207
|
+
Note1: This endpoint is currently not supported for on-prem deployments.
|
208
|
+
Note2: The `source_url` must include the protocol, http:// or https://.
|
213
209
|
|
214
210
|
Parameters
|
215
211
|
----------
|
@@ -234,8 +230,8 @@ class DocumentsClient:
|
|
234
230
|
websites=[
|
235
231
|
WebsiteSource(
|
236
232
|
bucket_id=1234,
|
237
|
-
cap=
|
238
|
-
depth=
|
233
|
+
cap=10,
|
234
|
+
depth=2,
|
239
235
|
search_data={"key": "value"},
|
240
236
|
source_url="https://my.website.com",
|
241
237
|
)
|
@@ -304,8 +300,6 @@ class DocumentsClient:
|
|
304
300
|
"""
|
305
301
|
lookup all documents across all resources which are currently on GroundX
|
306
302
|
|
307
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
308
|
-
|
309
303
|
Parameters
|
310
304
|
----------
|
311
305
|
n : typing.Optional[int]
|
@@ -379,8 +373,6 @@ class DocumentsClient:
|
|
379
373
|
"""
|
380
374
|
Delete multiple documents hosted on GroundX
|
381
375
|
|
382
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
383
|
-
|
384
376
|
Parameters
|
385
377
|
----------
|
386
378
|
document_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
@@ -401,7 +393,9 @@ class DocumentsClient:
|
|
401
393
|
client = GroundX(
|
402
394
|
api_key="YOUR_API_KEY",
|
403
395
|
)
|
404
|
-
client.documents.delete(
|
396
|
+
client.documents.delete(
|
397
|
+
document_ids="123e4567-e89b-12d3-a456-426614174000,9f7c11a6-24b8-4d52-a9f3-90a7e70a9e49",
|
398
|
+
)
|
405
399
|
"""
|
406
400
|
_response = self._client_wrapper.httpx_client.request(
|
407
401
|
"v1/ingest/documents",
|
@@ -451,8 +445,6 @@ class DocumentsClient:
|
|
451
445
|
"""
|
452
446
|
Get the current status of an ingest, initiated with documents.ingest_remote, documents.ingest_local, or documents.crawl_website, by specifying the processId (the processId is included in the response of the documents.ingest functions).
|
453
447
|
|
454
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
455
|
-
|
456
448
|
Parameters
|
457
449
|
----------
|
458
450
|
process_id : str
|
@@ -531,8 +523,6 @@ class DocumentsClient:
|
|
531
523
|
"""
|
532
524
|
lookup the document(s) associated with a processId, bucketId, groupId, or projectId.
|
533
525
|
|
534
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
535
|
-
|
536
526
|
Parameters
|
537
527
|
----------
|
538
528
|
id : int
|
@@ -626,8 +616,6 @@ class DocumentsClient:
|
|
626
616
|
"""
|
627
617
|
Look up an existing document by documentId.
|
628
618
|
|
629
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
630
|
-
|
631
619
|
Parameters
|
632
620
|
----------
|
633
621
|
document_id : str
|
@@ -697,8 +685,6 @@ class DocumentsClient:
|
|
697
685
|
"""
|
698
686
|
Delete a single document hosted on GroundX
|
699
687
|
|
700
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
701
|
-
|
702
688
|
Parameters
|
703
689
|
----------
|
704
690
|
document_id : str
|
@@ -776,8 +762,6 @@ class AsyncDocumentsClient:
|
|
776
762
|
"""
|
777
763
|
Ingest documents hosted on public URLs into a GroundX bucket.
|
778
764
|
|
779
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
780
|
-
|
781
765
|
Parameters
|
782
766
|
----------
|
783
767
|
documents : typing.Sequence[IngestRemoteDocument]
|
@@ -870,8 +854,6 @@ class AsyncDocumentsClient:
|
|
870
854
|
"""
|
871
855
|
Upload documents hosted on a local file system into a GroundX bucket.
|
872
856
|
|
873
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
874
|
-
|
875
857
|
Parameters
|
876
858
|
----------
|
877
859
|
request : DocumentLocalIngestRequest
|
@@ -964,8 +946,8 @@ class AsyncDocumentsClient:
|
|
964
946
|
) -> IngestResponse:
|
965
947
|
"""
|
966
948
|
Upload the content of a publicly accessible website for ingestion into a GroundX bucket. This is done by following links within a specified URL, recursively, up to a specified depth or number of pages.
|
967
|
-
|
968
|
-
|
949
|
+
Note1: This endpoint is currently not supported for on-prem deployments.
|
950
|
+
Note2: The `source_url` must include the protocol, http:// or https://.
|
969
951
|
|
970
952
|
Parameters
|
971
953
|
----------
|
@@ -995,8 +977,8 @@ class AsyncDocumentsClient:
|
|
995
977
|
websites=[
|
996
978
|
WebsiteSource(
|
997
979
|
bucket_id=1234,
|
998
|
-
cap=
|
999
|
-
depth=
|
980
|
+
cap=10,
|
981
|
+
depth=2,
|
1000
982
|
search_data={"key": "value"},
|
1001
983
|
source_url="https://my.website.com",
|
1002
984
|
)
|
@@ -1068,8 +1050,6 @@ class AsyncDocumentsClient:
|
|
1068
1050
|
"""
|
1069
1051
|
lookup all documents across all resources which are currently on GroundX
|
1070
1052
|
|
1071
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
1072
|
-
|
1073
1053
|
Parameters
|
1074
1054
|
----------
|
1075
1055
|
n : typing.Optional[int]
|
@@ -1151,8 +1131,6 @@ class AsyncDocumentsClient:
|
|
1151
1131
|
"""
|
1152
1132
|
Delete multiple documents hosted on GroundX
|
1153
1133
|
|
1154
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
1155
|
-
|
1156
1134
|
Parameters
|
1157
1135
|
----------
|
1158
1136
|
document_ids : typing.Optional[typing.Union[str, typing.Sequence[str]]]
|
@@ -1178,7 +1156,9 @@ class AsyncDocumentsClient:
|
|
1178
1156
|
|
1179
1157
|
|
1180
1158
|
async def main() -> None:
|
1181
|
-
await client.documents.delete(
|
1159
|
+
await client.documents.delete(
|
1160
|
+
document_ids="123e4567-e89b-12d3-a456-426614174000,9f7c11a6-24b8-4d52-a9f3-90a7e70a9e49",
|
1161
|
+
)
|
1182
1162
|
|
1183
1163
|
|
1184
1164
|
asyncio.run(main())
|
@@ -1231,8 +1211,6 @@ class AsyncDocumentsClient:
|
|
1231
1211
|
"""
|
1232
1212
|
Get the current status of an ingest, initiated with documents.ingest_remote, documents.ingest_local, or documents.crawl_website, by specifying the processId (the processId is included in the response of the documents.ingest functions).
|
1233
1213
|
|
1234
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
1235
|
-
|
1236
1214
|
Parameters
|
1237
1215
|
----------
|
1238
1216
|
process_id : str
|
@@ -1319,8 +1297,6 @@ class AsyncDocumentsClient:
|
|
1319
1297
|
"""
|
1320
1298
|
lookup the document(s) associated with a processId, bucketId, groupId, or projectId.
|
1321
1299
|
|
1322
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
1323
|
-
|
1324
1300
|
Parameters
|
1325
1301
|
----------
|
1326
1302
|
id : int
|
@@ -1424,8 +1400,6 @@ class AsyncDocumentsClient:
|
|
1424
1400
|
"""
|
1425
1401
|
Look up an existing document by documentId.
|
1426
1402
|
|
1427
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
1428
|
-
|
1429
1403
|
Parameters
|
1430
1404
|
----------
|
1431
1405
|
document_id : str
|
@@ -1503,8 +1477,6 @@ class AsyncDocumentsClient:
|
|
1503
1477
|
"""
|
1504
1478
|
Delete a single document hosted on GroundX
|
1505
1479
|
|
1506
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
1507
|
-
|
1508
1480
|
Parameters
|
1509
1481
|
----------
|
1510
1482
|
document_id : str
|
groundx/groups/client.py
CHANGED
@@ -32,8 +32,6 @@ class GroupsClient:
|
|
32
32
|
"""
|
33
33
|
list all groups within your GroundX account.
|
34
34
|
|
35
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
36
|
-
|
37
35
|
Parameters
|
38
36
|
----------
|
39
37
|
n : typing.Optional[int]
|
@@ -92,8 +90,6 @@ class GroupsClient:
|
|
92
90
|
"""
|
93
91
|
create a new group, a group being a collection of buckets which can be searched.
|
94
92
|
|
95
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
96
|
-
|
97
93
|
Parameters
|
98
94
|
----------
|
99
95
|
name : str
|
@@ -162,8 +158,6 @@ class GroupsClient:
|
|
162
158
|
"""
|
163
159
|
look up a specific group by its groupId.
|
164
160
|
|
165
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
166
|
-
|
167
161
|
Parameters
|
168
162
|
----------
|
169
163
|
group_id : int
|
@@ -233,8 +227,6 @@ class GroupsClient:
|
|
233
227
|
"""
|
234
228
|
Rename a group
|
235
229
|
|
236
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
237
|
-
|
238
230
|
Parameters
|
239
231
|
----------
|
240
232
|
group_id : int
|
@@ -313,8 +305,6 @@ class GroupsClient:
|
|
313
305
|
"""
|
314
306
|
Delete a group.
|
315
307
|
|
316
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
317
|
-
|
318
308
|
Parameters
|
319
309
|
----------
|
320
310
|
group_id : int
|
@@ -384,8 +374,6 @@ class GroupsClient:
|
|
384
374
|
"""
|
385
375
|
Add an existing bucket to an existing group. Buckets and groups can be associated many to many.
|
386
376
|
|
387
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
388
|
-
|
389
377
|
Parameters
|
390
378
|
----------
|
391
379
|
group_id : int
|
@@ -459,8 +447,6 @@ class GroupsClient:
|
|
459
447
|
"""
|
460
448
|
remove a bucket from a group. Buckets and groups can be associated many to many, this removes one bucket to group association without disturbing others.
|
461
449
|
|
462
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
463
|
-
|
464
450
|
Parameters
|
465
451
|
----------
|
466
452
|
group_id : int
|
@@ -543,8 +529,6 @@ class AsyncGroupsClient:
|
|
543
529
|
"""
|
544
530
|
list all groups within your GroundX account.
|
545
531
|
|
546
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
547
|
-
|
548
532
|
Parameters
|
549
533
|
----------
|
550
534
|
n : typing.Optional[int]
|
@@ -611,8 +595,6 @@ class AsyncGroupsClient:
|
|
611
595
|
"""
|
612
596
|
create a new group, a group being a collection of buckets which can be searched.
|
613
597
|
|
614
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
615
|
-
|
616
598
|
Parameters
|
617
599
|
----------
|
618
600
|
name : str
|
@@ -689,8 +671,6 @@ class AsyncGroupsClient:
|
|
689
671
|
"""
|
690
672
|
look up a specific group by its groupId.
|
691
673
|
|
692
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
693
|
-
|
694
674
|
Parameters
|
695
675
|
----------
|
696
676
|
group_id : int
|
@@ -768,8 +748,6 @@ class AsyncGroupsClient:
|
|
768
748
|
"""
|
769
749
|
Rename a group
|
770
750
|
|
771
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
772
|
-
|
773
751
|
Parameters
|
774
752
|
----------
|
775
753
|
group_id : int
|
@@ -858,8 +836,6 @@ class AsyncGroupsClient:
|
|
858
836
|
"""
|
859
837
|
Delete a group.
|
860
838
|
|
861
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
862
|
-
|
863
839
|
Parameters
|
864
840
|
----------
|
865
841
|
group_id : int
|
@@ -937,8 +913,6 @@ class AsyncGroupsClient:
|
|
937
913
|
"""
|
938
914
|
Add an existing bucket to an existing group. Buckets and groups can be associated many to many.
|
939
915
|
|
940
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
941
|
-
|
942
916
|
Parameters
|
943
917
|
----------
|
944
918
|
group_id : int
|
@@ -1020,8 +994,6 @@ class AsyncGroupsClient:
|
|
1020
994
|
"""
|
1021
995
|
remove a bucket from a group. Buckets and groups can be associated many to many, this removes one bucket to group association without disturbing others.
|
1022
996
|
|
1023
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
1024
|
-
|
1025
997
|
Parameters
|
1026
998
|
----------
|
1027
999
|
group_id : int
|
groundx/ingest.py
CHANGED
@@ -58,11 +58,10 @@ def prep_documents(
|
|
58
58
|
except ValueError:
|
59
59
|
return False
|
60
60
|
|
61
|
-
idx = 0
|
62
|
-
remote_documents: typing.List[IngestRemoteDocument] = []
|
63
61
|
local_documents: typing.List[
|
64
62
|
typing.Tuple[str, typing.Tuple[typing.Union[str, None], typing.BinaryIO, str]]
|
65
63
|
] = []
|
64
|
+
remote_documents: typing.List[IngestRemoteDocument] = []
|
66
65
|
|
67
66
|
for document in documents:
|
68
67
|
if not hasattr(document, "file_path"):
|
@@ -123,7 +122,6 @@ def prep_documents(
|
|
123
122
|
),
|
124
123
|
)
|
125
124
|
)
|
126
|
-
idx += 1
|
127
125
|
else:
|
128
126
|
raise ValueError(f"Invalid file path: {document.file_path}")
|
129
127
|
|
groundx/search/client.py
CHANGED
@@ -34,10 +34,7 @@ class SearchClient:
|
|
34
34
|
) -> SearchResponse:
|
35
35
|
"""
|
36
36
|
Search documents on GroundX for the most relevant information to a given query.
|
37
|
-
|
38
|
-
The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation.
|
39
|
-
|
40
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
37
|
+
The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
|
41
38
|
|
42
39
|
Parameters
|
43
40
|
----------
|
@@ -145,10 +142,7 @@ class SearchClient:
|
|
145
142
|
) -> SearchResponse:
|
146
143
|
"""
|
147
144
|
Search documents on GroundX for the most relevant information to a given query by documentId(s).
|
148
|
-
|
149
|
-
The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation.
|
150
|
-
|
151
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
145
|
+
The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
|
152
146
|
|
153
147
|
Parameters
|
154
148
|
----------
|
@@ -262,10 +256,7 @@ class AsyncSearchClient:
|
|
262
256
|
) -> SearchResponse:
|
263
257
|
"""
|
264
258
|
Search documents on GroundX for the most relevant information to a given query.
|
265
|
-
|
266
|
-
The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation.
|
267
|
-
|
268
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
259
|
+
The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
|
269
260
|
|
270
261
|
Parameters
|
271
262
|
----------
|
@@ -381,10 +372,7 @@ class AsyncSearchClient:
|
|
381
372
|
) -> SearchResponse:
|
382
373
|
"""
|
383
374
|
Search documents on GroundX for the most relevant information to a given query by documentId(s).
|
384
|
-
|
385
|
-
The result of this query is typically used in one of two ways; result['search']['text'] can be used to provide context to a language model, facilitating RAG, or result['search']['results'] can be used to observe chunks of text which are relevant to the query, facilitating citation.
|
386
|
-
|
387
|
-
Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
|
375
|
+
The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
|
388
376
|
|
389
377
|
Parameters
|
390
378
|
----------
|
groundx/types/document_type.py
CHANGED
@@ -3,5 +3,25 @@
|
|
3
3
|
import typing
|
4
4
|
|
5
5
|
DocumentType = typing.Union[
|
6
|
-
typing.Literal[
|
6
|
+
typing.Literal[
|
7
|
+
"bmp",
|
8
|
+
"csv",
|
9
|
+
"docx",
|
10
|
+
"gif",
|
11
|
+
"heif",
|
12
|
+
"hwp",
|
13
|
+
"ico",
|
14
|
+
"jpg",
|
15
|
+
"json",
|
16
|
+
"pdf",
|
17
|
+
"png",
|
18
|
+
"pptx",
|
19
|
+
"svg",
|
20
|
+
"tiff",
|
21
|
+
"tsv",
|
22
|
+
"txt",
|
23
|
+
"xlsx",
|
24
|
+
"webp",
|
25
|
+
],
|
26
|
+
typing.Any,
|
7
27
|
]
|
@@ -1,6 +1,6 @@
|
|
1
1
|
Metadata-Version: 2.1
|
2
2
|
Name: groundx
|
3
|
-
Version: 2.0
|
3
|
+
Version: 2.2.0
|
4
4
|
Summary:
|
5
5
|
License: MIT
|
6
6
|
Requires-Python: >=3.8,<4.0
|
@@ -37,7 +37,7 @@ The GroundX Python library provides convenient access to the GroundX API from Py
|
|
37
37
|
|
38
38
|
## Documentation
|
39
39
|
|
40
|
-
API reference documentation is available [here](https://docs.
|
40
|
+
API reference documentation is available [here](https://docs.eyelevel.ai/reference).
|
41
41
|
|
42
42
|
## Installation
|
43
43
|
|
@@ -1,10 +1,10 @@
|
|
1
1
|
groundx/__init__.py,sha256=hl6bFr_FJ0R5Ux_bQErYlWDZQcOF10rkda_r3pah3NQ,3005
|
2
2
|
groundx/buckets/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
|
3
|
-
groundx/buckets/client.py,sha256=
|
3
|
+
groundx/buckets/client.py,sha256=4jlc9vfIult1mMJ4FZW4_KFJybZPStZt1FUplIgrxbU,23947
|
4
4
|
groundx/client.py,sha256=dIW9OyrMyfC1N7HSxRrHh0w_8rJ8osNUOPdYD6ueQ6g,6515
|
5
5
|
groundx/core/__init__.py,sha256=SQ85PF84B9MuKnBwHNHWemSGuy-g_515gFYNFhvEE0I,1438
|
6
6
|
groundx/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
|
7
|
-
groundx/core/client_wrapper.py,sha256=
|
7
|
+
groundx/core/client_wrapper.py,sha256=_odv_JHUR_G1PLV_TqHwVQxMoC1kMp15YPAImZU5JUE,1802
|
8
8
|
groundx/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
|
9
9
|
groundx/core/file.py,sha256=d4NNbX8XvXP32z8KpK2Xovv33nFfruIrpz0QWxlgpZk,2663
|
10
10
|
groundx/core/http_client.py,sha256=siUQ6UV0ARZALlxubqWSSAAPC9B4VW8y6MGlHStfaeo,19552
|
@@ -17,19 +17,19 @@ groundx/core/serialization.py,sha256=D9h_t-RQON3-CHWs1C4ESY9B-Yd5d-l5lnTLb_X896g
|
|
17
17
|
groundx/customer/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
|
18
18
|
groundx/customer/client.py,sha256=C_JANeDewRD1Kg-q7LPxdiOSWbYSTOiYlBYZLRYPI44,3467
|
19
19
|
groundx/documents/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
|
20
|
-
groundx/documents/client.py,sha256=
|
20
|
+
groundx/documents/client.py,sha256=JCPSsLoDcPv_OmFFKFS3kRZMpwh4btnCu4wdmwKN_mc,54741
|
21
21
|
groundx/environment.py,sha256=CInm1_DKtZ1mrxutmKb1qqv82P33r_S87hZD3Hc1VB0,159
|
22
22
|
groundx/errors/__init__.py,sha256=-prNYsFd8xxM4va0vR1raZjcd10tllOJKyEWjX_pwdU,214
|
23
23
|
groundx/errors/bad_request_error.py,sha256=_EbO8mWqN9kFZPvIap8qa1lL_EWkRcsZe1HKV9GDWJY,264
|
24
24
|
groundx/errors/unauthorized_error.py,sha256=1ewNCqSG1P-uogB5yCNwreq4Bf3VRor0woSOXS4NjPU,266
|
25
25
|
groundx/groups/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
|
26
|
-
groundx/groups/client.py,sha256=
|
26
|
+
groundx/groups/client.py,sha256=bytQRh9m7e4vIuYHb7dD1kCTQZvyBxedCqGnmmLqrsI,35237
|
27
27
|
groundx/health/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
|
28
28
|
groundx/health/client.py,sha256=fcTa21RWPyBuT77PQ0EncC6rBaW_DrYlRvudy9-0H58,7545
|
29
|
-
groundx/ingest.py,sha256=
|
29
|
+
groundx/ingest.py,sha256=5uTL3iSp3HQYSAbzUkZ6_RM0KbKuqdkPZ8_bLxMpvDM,11377
|
30
30
|
groundx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
31
31
|
groundx/search/__init__.py,sha256=RagVzjShP33mDg9o4N3kGzV0egL1RYNjCpXPE8VzMYE,145
|
32
|
-
groundx/search/client.py,sha256=
|
32
|
+
groundx/search/client.py,sha256=zrrqFy0HowDUYPsMU4nfvDV2RgmkEQ4E8WYNktu3xcs,18684
|
33
33
|
groundx/search/types/__init__.py,sha256=fNFXQloPa1PHHO8VZim6KQNMA9N5EZtfSkissdxtY_c,165
|
34
34
|
groundx/search/types/search_content_request_id.py,sha256=us7mYdzR0qPur_wR5I9BhHaLEzC5nLBRna6-xq4M1ec,128
|
35
35
|
groundx/types/__init__.py,sha256=GO3it8Adm7ZaxMnc8ZP_9CNZkKpZX7X36hUKi1NgYWA,3809
|
@@ -47,7 +47,7 @@ groundx/types/document_list_response.py,sha256=Z0Hm5VBwI0qatbSp6nYHh0RrGwJN3Gqh2
|
|
47
47
|
groundx/types/document_local_ingest_request.py,sha256=zqaT_QgYcEc8AfVwZm-O5jLTEiYSsO-i3VVgZ_7xl7w,197
|
48
48
|
groundx/types/document_lookup_response.py,sha256=hZBwUO2pI6xFfeh7DmX_l1xRoh-5oaVNgUVxd00ml14,1097
|
49
49
|
groundx/types/document_response.py,sha256=EBDrYhTYoA3Q3ZpqwFEYmTgE3tY86TScFPhBnc3_ItI,642
|
50
|
-
groundx/types/document_type.py,sha256=
|
50
|
+
groundx/types/document_type.py,sha256=JQiwb7ZQOCKHPyCR71RYBue3akPsEQj3C2T-FMDolb8,431
|
51
51
|
groundx/types/group_detail.py,sha256=ms8iEEE1d88PTNwJOHeSiyoXn0hKdMrjJhkM2tlMdMs,1754
|
52
52
|
groundx/types/group_list_response.py,sha256=mDIDaW8uWo4Wd-sk8_SzaZeUD1EC4ZqcJpbieQLRszc,645
|
53
53
|
groundx/types/group_response.py,sha256=SGqaQYPV9jaA4ET3x2adhkgL9NQQB9XwolXTuBQ1Xx0,603
|
@@ -79,7 +79,7 @@ groundx/types/subscription_detail.py,sha256=WNfUw2EMVECIvNYcV2s51zZ6T3Utc4zYXw63
|
|
79
79
|
groundx/types/subscription_detail_meters.py,sha256=lBa8-1QlMVHjr5RLGqhiTKnD1KMM0AAHTWvz9TVtG8w,830
|
80
80
|
groundx/types/website_source.py,sha256=3WeRCiilNKKBTfhwgjo3jbcVI3vLTeM-KxI6dVzpg9o,1578
|
81
81
|
groundx/version.py,sha256=1yVogKaq260fQfckM2RYN2144SEw0QROsZW8ICtkG4U,74
|
82
|
-
groundx-2.0.
|
83
|
-
groundx-2.0.
|
84
|
-
groundx-2.0.
|
85
|
-
groundx-2.0.
|
82
|
+
groundx-2.2.0.dist-info/LICENSE,sha256=dFE6nY1bHnSn6NqmdlghlU1gQqLqYNphrceGVehSa7o,1065
|
83
|
+
groundx-2.2.0.dist-info/METADATA,sha256=lYgds-yvf22A7MdNyiQW4NlV7JW5AzTWuWmI3OP13jg,5052
|
84
|
+
groundx-2.2.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
|
85
|
+
groundx-2.2.0.dist-info/RECORD,,
|
File without changes
|