groundx 2.3.0__py3-none-any.whl → 2.3.5__py3-none-any.whl

groundx/types/document_detail.py

@@ -1,13 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-import typing_extensions
 import typing
-from ..core.serialization import FieldMetadata
+
 import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
 from .document_type import DocumentType
 from .processing_status import ProcessingStatus
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class DocumentDetail(UniversalBaseModel):
@@ -26,6 +26,11 @@ class DocumentDetail(UniversalBaseModel):
     """
 
     file_type: typing_extensions.Annotated[typing.Optional[DocumentType], FieldMetadata(alias="fileType")] = None
+    filter: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    A dictionary of key-value pairs that can be used to pre-filter documents prior to a search.
+    """
+
     process_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="processId")] = pydantic.Field(
         default=None
     )

groundx/types/document_list_response.py

@@ -1,12 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from .document_detail import DocumentDetail
+
+import pydantic
 import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-import pydantic
+from .document_detail import DocumentDetail
 
 
 class DocumentListResponse(UniversalBaseModel):

groundx/types/document_local_ingest_request.py

@@ -1,6 +1,7 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
+
 from .ingest_local_document import IngestLocalDocument
 
 DocumentLocalIngestRequest = typing.List[IngestLocalDocument]

groundx/types/document_lookup_response.py

@@ -1,12 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
+
 import pydantic
-from .document_detail import DocumentDetail
 import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from .document_detail import DocumentDetail
 
 
 class DocumentLookupResponse(UniversalBaseModel):
@@ -17,6 +17,11 @@ class DocumentLookupResponse(UniversalBaseModel):
 
     documents: typing.Optional[typing.List[DocumentDetail]] = None
     next_token: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="nextToken")] = None
+    remaining: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The number of results that have not been returned yet. Will be null if there are no remaining results.
+    """
+
     total: typing.Optional[int] = pydantic.Field(default=None)
     """
     The total number of results found

groundx/types/document_response.py

@@ -1,10 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from .document_detail import DocumentDetail
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .document_detail import DocumentDetail
 
 
 class DocumentResponse(UniversalBaseModel):

groundx/types/group_detail.py

@@ -1,13 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+import datetime as dt
 import typing
-from .bucket_detail import BucketDetail
+
 import pydantic
-import datetime as dt
 import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from .bucket_detail import BucketDetail
 
 
 class GroupDetail(UniversalBaseModel):

groundx/types/group_list_response.py

@@ -1,14 +1,28 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from .group_detail import GroupDetail
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .group_detail import GroupDetail
 
 
 class GroupListResponse(UniversalBaseModel):
     groups: typing.Optional[typing.List[GroupDetail]] = None
+    count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The number of groups returned in the current response
+    """
+
+    remaining: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The number of groups that have not been returned yet, will be null if there are no remaining groups
+    """
+
+    total: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The total number of groups found
+    """
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

groundx/types/group_response.py

@@ -1,10 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-from .group_detail import GroupDetail
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import typing
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .group_detail import GroupDetail
 
 
 class GroupResponse(UniversalBaseModel):

groundx/types/health_response.py

@@ -1,10 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-from .health_response_health import HealthResponseHealth
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import typing
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .health_response_health import HealthResponseHealth
 
 
 class HealthResponse(UniversalBaseModel):

groundx/types/health_response_health.py

@@ -1,10 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from .health_service import HealthService
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .health_service import HealthService
 
 
 class HealthResponseHealth(UniversalBaseModel):

groundx/types/health_service.py

@@ -1,13 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-import typing_extensions
 import datetime as dt
-from ..core.serialization import FieldMetadata
+import typing
+
 import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
 from .health_service_status import HealthServiceStatus
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-import typing
 
 
 class HealthService(UniversalBaseModel):

groundx/types/ingest_local_document.py

@@ -1,10 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .ingest_local_document_metadata import IngestLocalDocumentMetadata
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-import typing
 
 
 class IngestLocalDocument(UniversalBaseModel):

groundx/types/ingest_local_document_metadata.py

@@ -1,13 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-import typing_extensions
 import typing
-from ..core.serialization import FieldMetadata
+
 import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
 from .document_type import DocumentType
 from .process_level import ProcessLevel
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class IngestLocalDocumentMetadata(UniversalBaseModel):
@@ -26,6 +26,11 @@ class IngestLocalDocumentMetadata(UniversalBaseModel):
     """
 
     file_type: typing_extensions.Annotated[typing.Optional[DocumentType], FieldMetadata(alias="fileType")] = None
+    filter: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    A dictionary of key-value pairs that can be used to pre-filter documents prior to a search.
+    """
+
     process_level: typing_extensions.Annotated[typing.Optional[ProcessLevel], FieldMetadata(alias="processLevel")] = (
         None
     )

groundx/types/ingest_remote_document.py

@@ -1,13 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+
+import pydantic
 import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-import pydantic
-import typing
 from .document_type import DocumentType
 from .process_level import ProcessLevel
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class IngestRemoteDocument(UniversalBaseModel):
@@ -20,10 +20,15 @@ class IngestRemoteDocument(UniversalBaseModel):
         default=None
     )
     """
-    The name of the file being ingested
+    The name of the file being ingested.
     """
 
     file_type: typing_extensions.Annotated[typing.Optional[DocumentType], FieldMetadata(alias="fileType")] = None
+    filter: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None)
+    """
+    A dictionary of key-value pairs that can be used to pre-filter documents prior to a search.
+    """
+
     process_level: typing_extensions.Annotated[typing.Optional[ProcessLevel], FieldMetadata(alias="processLevel")] = (
         None
     )

groundx/types/ingest_response.py

@@ -1,14 +1,14 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-from .ingest_response_ingest import IngestResponseIngest
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import typing
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .ingest_status import IngestStatus
 
 
 class IngestResponse(UniversalBaseModel):
-    ingest: IngestResponseIngest
+    ingest: IngestStatus
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

groundx/types/{process_status_response_ingest.py → ingest_status.py}

@@ -1,18 +1,19 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+
+import pydantic
 import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-import typing
-from .process_status_response_ingest_progress import ProcessStatusResponseIngestProgress
+from .ingest_status_progress import IngestStatusProgress
 from .processing_status import ProcessingStatus
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-import pydantic
 
 
-class ProcessStatusResponseIngest(UniversalBaseModel):
+class IngestStatus(UniversalBaseModel):
+    id: typing.Optional[int] = None
     process_id: typing_extensions.Annotated[str, FieldMetadata(alias="processId")]
-    progress: typing.Optional[ProcessStatusResponseIngestProgress] = None
+    progress: typing.Optional[IngestStatusProgress] = None
     status: ProcessingStatus
     status_message: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="statusMessage")] = None
 

groundx/types/{ingest_response_ingest.py → ingest_status_light.py}

@@ -1,17 +1,19 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+
+import pydantic
 import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
 from .processing_status import ProcessingStatus
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
-import typing
-import pydantic
 
 
-class IngestResponseIngest(UniversalBaseModel):
+class IngestStatusLight(UniversalBaseModel):
+    id: typing.Optional[int] = None
     process_id: typing_extensions.Annotated[str, FieldMetadata(alias="processId")]
     status: ProcessingStatus
+    status_message: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="statusMessage")] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

groundx/types/ingest_status_progress.py

@@ -0,0 +1,26 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .ingest_status_progress_cancelled import IngestStatusProgressCancelled
+from .ingest_status_progress_complete import IngestStatusProgressComplete
+from .ingest_status_progress_errors import IngestStatusProgressErrors
+from .ingest_status_progress_processing import IngestStatusProgressProcessing
+
+
+class IngestStatusProgress(UniversalBaseModel):
+    cancelled: typing.Optional[IngestStatusProgressCancelled] = None
+    complete: typing.Optional[IngestStatusProgressComplete] = None
+    errors: typing.Optional[IngestStatusProgressErrors] = None
+    processing: typing.Optional[IngestStatusProgressProcessing] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/{process_status_response_ingest_progress_errors.py → ingest_status_progress_cancelled.py}

@@ -1,13 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from .document_detail import DocumentDetail
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .document_detail import DocumentDetail
 
 
-class ProcessStatusResponseIngestProgressErrors(UniversalBaseModel):
+class IngestStatusProgressCancelled(UniversalBaseModel):
     documents: typing.Optional[typing.List[DocumentDetail]] = None
     total: typing.Optional[int] = None
 

groundx/types/{process_status_response_ingest_progress_complete.py → ingest_status_progress_complete.py}

@@ -1,13 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from .document_detail import DocumentDetail
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .document_detail import DocumentDetail
 
 
-class ProcessStatusResponseIngestProgressComplete(UniversalBaseModel):
+class IngestStatusProgressComplete(UniversalBaseModel):
     documents: typing.Optional[typing.List[DocumentDetail]] = None
     total: typing.Optional[int] = None
 

groundx/types/{process_status_response_ingest_progress_cancelled.py → ingest_status_progress_errors.py}

@@ -1,13 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from .document_detail import DocumentDetail
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .document_detail import DocumentDetail
 
 
-class ProcessStatusResponseIngestProgressCancelled(UniversalBaseModel):
+class IngestStatusProgressErrors(UniversalBaseModel):
     documents: typing.Optional[typing.List[DocumentDetail]] = None
     total: typing.Optional[int] = None
 

groundx/types/{process_status_response_ingest_progress_processing.py → ingest_status_progress_processing.py}

@@ -1,13 +1,13 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from .document_detail import DocumentDetail
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .document_detail import DocumentDetail
 
 
-class ProcessStatusResponseIngestProgressProcessing(UniversalBaseModel):
+class IngestStatusProgressProcessing(UniversalBaseModel):
     documents: typing.Optional[typing.List[DocumentDetail]] = None
     total: typing.Optional[int] = None
 

groundx/types/message_response.py

@@ -1,9 +1,9 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 
 
 class MessageResponse(UniversalBaseModel):

groundx/types/meter_detail.py

@@ -1,11 +1,11 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
+
 import pydantic
 import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class MeterDetail(UniversalBaseModel):

groundx/types/processes_status_response.py

@@ -1,6 +1,23 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-from .process_status_response import ProcessStatusResponse
 
-ProcessesStatusResponse = typing.List[ProcessStatusResponse]
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .ingest_status_light import IngestStatusLight
+
+
+class ProcessesStatusResponse(UniversalBaseModel):
+    processes: typing.List[IngestStatusLight] = pydantic.Field()
+    """
+    Processes
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

groundx/types/search_response.py

@@ -1,10 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-from .search_response_search import SearchResponseSearch
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 import typing
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .search_response_search import SearchResponseSearch
 
 
 class SearchResponse(UniversalBaseModel):

groundx/types/search_response_search.py

@@ -1,12 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
+
 import pydantic
-from .search_result_item import SearchResultItem
 import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from .search_result_item import SearchResultItem
 
 
 class SearchResponseSearch(UniversalBaseModel):

groundx/types/search_result_item.py

@@ -1,12 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-import typing_extensions
 import typing
-from .bounding_box_detail import BoundingBoxDetail
-from ..core.serialization import FieldMetadata
+
 import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .bounding_box_detail import BoundingBoxDetail
 
 
 class SearchResultItem(UniversalBaseModel):

groundx/types/subscription_detail.py

@@ -1,10 +1,10 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
 import typing
-from .subscription_detail_meters import SubscriptionDetailMeters
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .subscription_detail_meters import SubscriptionDetailMeters
 
 
 class SubscriptionDetail(UniversalBaseModel):

groundx/types/subscription_detail_meters.py

@@ -1,12 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
-import typing_extensions
 import typing
-from .meter_detail import MeterDetail
-from ..core.serialization import FieldMetadata
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .meter_detail import MeterDetail
 
 
 class SubscriptionDetailMeters(UniversalBaseModel):

groundx/types/website_source.py

@@ -1,11 +1,11 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ..core.pydantic_utilities import UniversalBaseModel
+import typing
+
+import pydantic
 import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
-import pydantic
-import typing
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class WebsiteSource(UniversalBaseModel):

{groundx-2.3.0.dist-info → groundx-2.3.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: groundx
-Version: 2.3.0
+Version: 2.3.5
 Summary: 
 License: MIT
 Requires-Python: >=3.8,<4.0