groundx 2.0.17__tar.gz → 2.0.19__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.
Files changed (82) hide show
  1. {groundx-2.0.17 → groundx-2.0.19}/PKG-INFO +12 -12
  2. {groundx-2.0.17 → groundx-2.0.19}/README.md +11 -11
  3. {groundx-2.0.17 → groundx-2.0.19}/pyproject.toml +1 -1
  4. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/__init__.py +2 -0
  5. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/client_wrapper.py +1 -1
  6. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/documents/client.py +451 -268
  7. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/__init__.py +2 -0
  8. groundx-2.0.19/src/groundx/types/ingest_document.py +45 -0
  9. {groundx-2.0.17 → groundx-2.0.19}/LICENSE +0 -0
  10. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/buckets/__init__.py +0 -0
  11. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/buckets/client.py +0 -0
  12. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/client.py +0 -0
  13. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/__init__.py +0 -0
  14. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/api_error.py +0 -0
  15. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/datetime_utils.py +0 -0
  16. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/file.py +0 -0
  17. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/http_client.py +0 -0
  18. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/jsonable_encoder.py +0 -0
  19. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/pydantic_utilities.py +0 -0
  20. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/query_encoder.py +0 -0
  21. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/remove_none_from_dict.py +0 -0
  22. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/request_options.py +0 -0
  23. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/core/serialization.py +0 -0
  24. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/customer/__init__.py +0 -0
  25. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/customer/client.py +0 -0
  26. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/documents/__init__.py +0 -0
  27. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/environment.py +0 -0
  28. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/errors/__init__.py +0 -0
  29. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/errors/bad_request_error.py +0 -0
  30. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/errors/unauthorized_error.py +0 -0
  31. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/groups/__init__.py +0 -0
  32. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/groups/client.py +0 -0
  33. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/health/__init__.py +0 -0
  34. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/health/client.py +0 -0
  35. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/py.typed +0 -0
  36. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/search/__init__.py +0 -0
  37. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/search/client.py +0 -0
  38. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/search/types/__init__.py +0 -0
  39. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/search/types/search_content_request_id.py +0 -0
  40. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/bounding_box_detail.py +0 -0
  41. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/bucket_detail.py +0 -0
  42. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/bucket_list_response.py +0 -0
  43. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/bucket_response.py +0 -0
  44. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/bucket_update_detail.py +0 -0
  45. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/bucket_update_response.py +0 -0
  46. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/crawl_website_source.py +0 -0
  47. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/customer_detail.py +0 -0
  48. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/customer_response.py +0 -0
  49. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/document_detail.py +0 -0
  50. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/document_list_response.py +0 -0
  51. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/document_lookup_response.py +0 -0
  52. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/document_response.py +0 -0
  53. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/document_type.py +0 -0
  54. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/group_detail.py +0 -0
  55. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/group_list_response.py +0 -0
  56. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/group_response.py +0 -0
  57. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/health_response.py +0 -0
  58. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/health_response_health.py +0 -0
  59. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/health_service.py +0 -0
  60. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/health_service_status.py +0 -0
  61. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/ingest_local_document.py +0 -0
  62. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/ingest_remote_document.py +0 -0
  63. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/ingest_response.py +0 -0
  64. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/ingest_response_ingest.py +0 -0
  65. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/message_response.py +0 -0
  66. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/meter_detail.py +0 -0
  67. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/process_status_response.py +0 -0
  68. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/process_status_response_ingest.py +0 -0
  69. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/process_status_response_ingest_progress.py +0 -0
  70. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/process_status_response_ingest_progress_cancelled.py +0 -0
  71. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/process_status_response_ingest_progress_complete.py +0 -0
  72. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/process_status_response_ingest_progress_errors.py +0 -0
  73. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/process_status_response_ingest_progress_processing.py +0 -0
  74. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/processing_status.py +0 -0
  75. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/search_response.py +0 -0
  76. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/search_response_search.py +0 -0
  77. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/search_result_item.py +0 -0
  78. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/sort.py +0 -0
  79. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/sort_order.py +0 -0
  80. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/subscription_detail.py +0 -0
  81. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/types/subscription_detail_meters.py +0 -0
  82. {groundx-2.0.17 → groundx-2.0.19}/src/groundx/version.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: groundx
3
- Version: 2.0.17
3
+ Version: 2.0.19
4
4
  Summary:
5
5
  License: MIT
6
6
  Requires-Python: >=3.8,<4.0
@@ -52,19 +52,19 @@ A full reference for this library is available [here](./reference.md).
52
52
  Instantiate and use the client with the following:
53
53
 
54
54
  ```python
55
- from groundx import GroundX, IngestRemoteDocument
55
+ from groundx import GroundX, IngestDocument
56
56
 
57
57
  client = GroundX(
58
58
  api_key="YOUR_API_KEY",
59
59
  )
60
- client.documents.ingest_remote(
60
+ client.documents.ingest(
61
61
  documents=[
62
- IngestRemoteDocument(
62
+ IngestDocument(
63
63
  bucket_id=1234,
64
64
  file_name="my_file.txt",
65
+ file_path="https://my.source.url.com/file.txt",
65
66
  file_type="txt",
66
67
  search_data={"key": "value"},
67
- source_url="https://my.source.url.com/file.txt",
68
68
  )
69
69
  ],
70
70
  )
@@ -77,7 +77,7 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
77
77
  ```python
78
78
  import asyncio
79
79
 
80
- from groundx import AsyncGroundX, IngestRemoteDocument
80
+ from groundx import AsyncGroundX, IngestDocument
81
81
 
82
82
  client = AsyncGroundX(
83
83
  api_key="YOUR_API_KEY",
@@ -85,14 +85,14 @@ client = AsyncGroundX(
85
85
 
86
86
 
87
87
  async def main() -> None:
88
- await client.documents.ingest_remote(
88
+ await client.documents.ingest(
89
89
  documents=[
90
- IngestRemoteDocument(
90
+ IngestDocument(
91
91
  bucket_id=1234,
92
92
  file_name="my_file.txt",
93
+ file_path="https://my.source.url.com/file.txt",
93
94
  file_type="txt",
94
95
  search_data={"key": "value"},
95
- source_url="https://my.source.url.com/file.txt",
96
96
  )
97
97
  ],
98
98
  )
@@ -110,7 +110,7 @@ will be thrown.
110
110
  from groundx.core.api_error import ApiError
111
111
 
112
112
  try:
113
- client.documents.ingest_remote(...)
113
+ client.documents.ingest(...)
114
114
  except ApiError as e:
115
115
  print(e.status_code)
116
116
  print(e.body)
@@ -133,7 +133,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
133
133
  Use the `max_retries` request option to configure this behavior.
134
134
 
135
135
  ```python
136
- client.documents.ingest_remote(..., request_options={
136
+ client.documents.ingest(..., request_options={
137
137
  "max_retries": 1
138
138
  })
139
139
  ```
@@ -153,7 +153,7 @@ client = GroundX(
153
153
 
154
154
 
155
155
  # Override timeout for a specific method
156
- client.documents.ingest_remote(..., request_options={
156
+ client.documents.ingest(..., request_options={
157
157
  "timeout_in_seconds": 1
158
158
  })
159
159
  ```
@@ -24,19 +24,19 @@ A full reference for this library is available [here](./reference.md).
24
24
  Instantiate and use the client with the following:
25
25
 
26
26
  ```python
27
- from groundx import GroundX, IngestRemoteDocument
27
+ from groundx import GroundX, IngestDocument
28
28
 
29
29
  client = GroundX(
30
30
  api_key="YOUR_API_KEY",
31
31
  )
32
- client.documents.ingest_remote(
32
+ client.documents.ingest(
33
33
  documents=[
34
- IngestRemoteDocument(
34
+ IngestDocument(
35
35
  bucket_id=1234,
36
36
  file_name="my_file.txt",
37
+ file_path="https://my.source.url.com/file.txt",
37
38
  file_type="txt",
38
39
  search_data={"key": "value"},
39
- source_url="https://my.source.url.com/file.txt",
40
40
  )
41
41
  ],
42
42
  )
@@ -49,7 +49,7 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
49
49
  ```python
50
50
  import asyncio
51
51
 
52
- from groundx import AsyncGroundX, IngestRemoteDocument
52
+ from groundx import AsyncGroundX, IngestDocument
53
53
 
54
54
  client = AsyncGroundX(
55
55
  api_key="YOUR_API_KEY",
@@ -57,14 +57,14 @@ client = AsyncGroundX(
57
57
 
58
58
 
59
59
  async def main() -> None:
60
- await client.documents.ingest_remote(
60
+ await client.documents.ingest(
61
61
  documents=[
62
- IngestRemoteDocument(
62
+ IngestDocument(
63
63
  bucket_id=1234,
64
64
  file_name="my_file.txt",
65
+ file_path="https://my.source.url.com/file.txt",
65
66
  file_type="txt",
66
67
  search_data={"key": "value"},
67
- source_url="https://my.source.url.com/file.txt",
68
68
  )
69
69
  ],
70
70
  )
@@ -82,7 +82,7 @@ will be thrown.
82
82
  from groundx.core.api_error import ApiError
83
83
 
84
84
  try:
85
- client.documents.ingest_remote(...)
85
+ client.documents.ingest(...)
86
86
  except ApiError as e:
87
87
  print(e.status_code)
88
88
  print(e.body)
@@ -105,7 +105,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
105
105
  Use the `max_retries` request option to configure this behavior.
106
106
 
107
107
  ```python
108
- client.documents.ingest_remote(..., request_options={
108
+ client.documents.ingest(..., request_options={
109
109
  "max_retries": 1
110
110
  })
111
111
  ```
@@ -125,7 +125,7 @@ client = GroundX(
125
125
 
126
126
 
127
127
  # Override timeout for a specific method
128
- client.documents.ingest_remote(..., request_options={
128
+ client.documents.ingest(..., request_options={
129
129
  "timeout_in_seconds": 1
130
130
  })
131
131
  ```
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "groundx"
3
- version = "2.0.17"
3
+ version = "2.0.19"
4
4
  description = ""
5
5
  readme = "README.md"
6
6
  authors = []
@@ -22,6 +22,7 @@ from .types import (
22
22
  HealthResponseHealth,
23
23
  HealthService,
24
24
  HealthServiceStatus,
25
+ IngestDocument,
25
26
  IngestLocalDocument,
26
27
  IngestRemoteDocument,
27
28
  IngestResponse,
@@ -77,6 +78,7 @@ __all__ = [
77
78
  "HealthResponseHealth",
78
79
  "HealthService",
79
80
  "HealthServiceStatus",
81
+ "IngestDocument",
80
82
  "IngestLocalDocument",
81
83
  "IngestRemoteDocument",
82
84
  "IngestResponse",
@@ -16,7 +16,7 @@ class BaseClientWrapper:
16
16
  headers: typing.Dict[str, str] = {
17
17
  "X-Fern-Language": "Python",
18
18
  "X-Fern-SDK-Name": "groundx",
19
- "X-Fern-SDK-Version": "2.0.17",
19
+ "X-Fern-SDK-Version": "2.0.19",
20
20
  }
21
21
  headers["X-API-Key"] = self.api_key
22
22
  return headers