groundx 2.0.19__tar.gz → 2.0.21__tar.gz

{groundx-2.0.19 → groundx-2.0.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: groundx
-Version: 2.0.19
+Version: 2.0.21
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0
@@ -52,19 +52,18 @@ A full reference for this library is available [here](./reference.md).
 Instantiate and use the client with the following:
 
 ```python
-from groundx import GroundX, IngestDocument
+from groundx import GroundX, IngestRemoteDocument
 
 client = GroundX(
     api_key="YOUR_API_KEY",
 )
-client.documents.ingest(
+client.documents.ingest_remote(
     documents=[
-        IngestDocument(
+        IngestRemoteDocument(
             bucket_id=1234,
-            file_name="my_file.txt",
-            file_path="https://my.source.url.com/file.txt",
+            file_name="my_file1.txt",
             file_type="txt",
-            search_data={"key": "value"},
+            source_url="https://my.source.url.com/file1.txt",
         )
     ],
 )
@@ -77,7 +76,7 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
 ```python
 import asyncio
 
-from groundx import AsyncGroundX, IngestDocument
+from groundx import AsyncGroundX, IngestRemoteDocument
 
 client = AsyncGroundX(
     api_key="YOUR_API_KEY",
@@ -85,14 +84,13 @@ client = AsyncGroundX(
 
 
 async def main() -> None:
-    await client.documents.ingest(
+    await client.documents.ingest_remote(
         documents=[
-            IngestDocument(
+            IngestRemoteDocument(
                 bucket_id=1234,
-                file_name="my_file.txt",
-                file_path="https://my.source.url.com/file.txt",
+                file_name="my_file1.txt",
                 file_type="txt",
-                search_data={"key": "value"},
+                source_url="https://my.source.url.com/file1.txt",
             )
         ],
     )
@@ -110,7 +108,7 @@ will be thrown.
 from groundx.core.api_error import ApiError
 
 try:
-    client.documents.ingest(...)
+    client.documents.ingest_remote(...)
 except ApiError as e:
     print(e.status_code)
     print(e.body)
@@ -133,7 +131,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
 Use the `max_retries` request option to configure this behavior.
 
 ```python
-client.documents.ingest(..., request_options={
+client.documents.ingest_remote(..., request_options={
     "max_retries": 1
 })
 ```
@@ -153,7 +151,7 @@ client = GroundX(
 
 
 # Override timeout for a specific method
-client.documents.ingest(..., request_options={
+client.documents.ingest_remote(..., request_options={
     "timeout_in_seconds": 1
 })
 ```

{groundx-2.0.19 → groundx-2.0.21}/README.md

@@ -24,19 +24,18 @@ A full reference for this library is available [here](./reference.md).
 Instantiate and use the client with the following:
 
 ```python
-from groundx import GroundX, IngestDocument
+from groundx import GroundX, IngestRemoteDocument
 
 client = GroundX(
     api_key="YOUR_API_KEY",
 )
-client.documents.ingest(
+client.documents.ingest_remote(
     documents=[
-        IngestDocument(
+        IngestRemoteDocument(
             bucket_id=1234,
-            file_name="my_file.txt",
-            file_path="https://my.source.url.com/file.txt",
+            file_name="my_file1.txt",
             file_type="txt",
-            search_data={"key": "value"},
+            source_url="https://my.source.url.com/file1.txt",
         )
     ],
 )
@@ -49,7 +48,7 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
 ```python
 import asyncio
 
-from groundx import AsyncGroundX, IngestDocument
+from groundx import AsyncGroundX, IngestRemoteDocument
 
 client = AsyncGroundX(
     api_key="YOUR_API_KEY",
@@ -57,14 +56,13 @@ client = AsyncGroundX(
 
 
 async def main() -> None:
-    await client.documents.ingest(
+    await client.documents.ingest_remote(
         documents=[
-            IngestDocument(
+            IngestRemoteDocument(
                 bucket_id=1234,
-                file_name="my_file.txt",
-                file_path="https://my.source.url.com/file.txt",
+                file_name="my_file1.txt",
                 file_type="txt",
-                search_data={"key": "value"},
+                source_url="https://my.source.url.com/file1.txt",
             )
         ],
     )
@@ -82,7 +80,7 @@ will be thrown.
 from groundx.core.api_error import ApiError
 
 try:
-    client.documents.ingest(...)
+    client.documents.ingest_remote(...)
 except ApiError as e:
     print(e.status_code)
     print(e.body)
@@ -105,7 +103,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
 Use the `max_retries` request option to configure this behavior.
 
 ```python
-client.documents.ingest(..., request_options={
+client.documents.ingest_remote(..., request_options={
     "max_retries": 1
 })
 ```
@@ -125,7 +123,7 @@ client = GroundX(
 
 
 # Override timeout for a specific method
-client.documents.ingest(..., request_options={
+client.documents.ingest_remote(..., request_options={
     "timeout_in_seconds": 1
 })
 ```

{groundx-2.0.19 → groundx-2.0.21}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "groundx"
-version = "2.0.19"
+version = "2.0.21"
 description = ""
 readme = "README.md"
 authors = []

{groundx-2.0.19 → groundx-2.0.21}/src/groundx/__init__.py

@@ -7,11 +7,11 @@ from .types import (
     BucketResponse,
     BucketUpdateDetail,
     BucketUpdateResponse,
-    CrawlWebsiteSource,
     CustomerDetail,
     CustomerResponse,
     DocumentDetail,
     DocumentListResponse,
+    DocumentLocalIngestRequest,
     DocumentLookupResponse,
     DocumentResponse,
     DocumentType,
@@ -22,8 +22,8 @@ from .types import (
     HealthResponseHealth,
     HealthService,
     HealthServiceStatus,
-    IngestDocument,
     IngestLocalDocument,
+    IngestLocalDocumentMetadata,
     IngestRemoteDocument,
     IngestResponse,
     IngestResponseIngest,
@@ -44,6 +44,7 @@ from .types import (
     SortOrder,
     SubscriptionDetail,
     SubscriptionDetailMeters,
+    WebsiteSource,
 )
 from .errors import BadRequestError, UnauthorizedError
 from . import buckets, customer, documents, groups, health, search
@@ -61,11 +62,11 @@ __all__ = [
     "BucketResponse",
     "BucketUpdateDetail",
     "BucketUpdateResponse",
-    "CrawlWebsiteSource",
     "CustomerDetail",
     "CustomerResponse",
     "DocumentDetail",
     "DocumentListResponse",
+    "DocumentLocalIngestRequest",
     "DocumentLookupResponse",
     "DocumentResponse",
     "DocumentType",
@@ -78,8 +79,8 @@ __all__ = [
     "HealthResponseHealth",
     "HealthService",
     "HealthServiceStatus",
-    "IngestDocument",
     "IngestLocalDocument",
+    "IngestLocalDocumentMetadata",
     "IngestRemoteDocument",
     "IngestResponse",
     "IngestResponseIngest",
@@ -102,6 +103,7 @@ __all__ = [
     "SubscriptionDetail",
     "SubscriptionDetailMeters",
     "UnauthorizedError",
+    "WebsiteSource",
     "__version__",
     "buckets",
     "customer",

{groundx-2.0.19 → groundx-2.0.21}/src/groundx/core/client_wrapper.py

@@ -16,7 +16,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "groundx",
-            "X-Fern-SDK-Version": "2.0.19",
+            "X-Fern-SDK-Version": "2.0.21",
         }
         headers["X-API-Key"] = self.api_key
         return headers