groundx 2.0.11__py3-none-any.whl

groundx/documents/types/__init__.py

@@ -0,0 +1,6 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .document_remote_ingest_request_documents_item import DocumentRemoteIngestRequestDocumentsItem
+from .website_crawl_request_websites_item import WebsiteCrawlRequestWebsitesItem
+
+__all__ = ["DocumentRemoteIngestRequestDocumentsItem", "WebsiteCrawlRequestWebsitesItem"]

groundx/documents/types/document_remote_ingest_request_documents_item.py

@@ -0,0 +1,45 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+from ...core.serialization import FieldMetadata
+import pydantic
+import typing
+from ...types.document_type import DocumentType
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class DocumentRemoteIngestRequestDocumentsItem(UniversalBaseModel):
+    bucket_id: typing_extensions.Annotated[int, FieldMetadata(alias="bucketId")] = pydantic.Field()
+    """
+    the bucketId of the bucket which this remote file will be ingested to.
+    """
+
+    file_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="fileName")] = pydantic.Field(
+        default=None
+    )
+    """
+    The name of the file being ingested
+    """
+
+    file_type: typing_extensions.Annotated[typing.Optional[DocumentType], FieldMetadata(alias="fileType")] = None
+    search_data: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]], FieldMetadata(alias="searchData")
+    ] = pydantic.Field(default=None)
+    """
+    Custom metadata which can be used to influence GroundX's search functionality. This data can be used to further hone GroundX search.
+    """
+
+    source_url: typing_extensions.Annotated[str, FieldMetadata(alias="sourceUrl")] = pydantic.Field()
+    """
+    The URL of the document being ingested by GroundX.
+    """
+
+    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/documents/types/website_crawl_request_websites_item.py

@@ -0,0 +1,46 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ...core.pydantic_utilities import UniversalBaseModel
+import typing_extensions
+from ...core.serialization import FieldMetadata
+import pydantic
+import typing
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class WebsiteCrawlRequestWebsitesItem(UniversalBaseModel):
+    bucket_id: typing_extensions.Annotated[int, FieldMetadata(alias="bucketId")] = pydantic.Field()
+    """
+    the bucketId of the bucket which this website will be ingested to.
+    """
+
+    cap: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The maximum number of pages to crawl
+    """
+
+    depth: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The maximum depth of linked pages to follow from the sourceUrl
+    """
+
+    search_data: typing_extensions.Annotated[
+        typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]], FieldMetadata(alias="searchData")
+    ] = pydantic.Field(default=None)
+    """
+    Custom metadata which can be used to influence GroundX's search functionality. This data can be used to further hone GroundX search.
+    """
+
+    source_url: typing_extensions.Annotated[str, FieldMetadata(alias="sourceUrl")] = pydantic.Field()
+    """
+    The URL from which the crawl is initiated.
+    """
+
+    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/environment.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+
+
+class GroundXEnvironment(enum.Enum):
+    DEFAULT = "https://api.groundx.ai/api"

groundx/errors/__init__.py

@@ -0,0 +1,6 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .bad_request_error import BadRequestError
+from .unauthorized_error import UnauthorizedError
+
+__all__ = ["BadRequestError", "UnauthorizedError"]

groundx/errors/bad_request_error.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.api_error import ApiError
+import typing
+
+
+class BadRequestError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any]):
+        super().__init__(status_code=400, body=body)

groundx/errors/unauthorized_error.py

@@ -0,0 +1,9 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from ..core.api_error import ApiError
+import typing
+
+
+class UnauthorizedError(ApiError):
+    def __init__(self, body: typing.Optional[typing.Any]):
+        super().__init__(status_code=401, body=body)

groundx/groups/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+