groundx 2.3.5__tar.gz → 2.3.7__tar.gz

{groundx-2.3.5 → groundx-2.3.7}/PKG-INFO

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

{groundx-2.3.5 → groundx-2.3.7}/pyproject.toml

@@ -3,7 +3,7 @@ name = "groundx"
 
 [tool.poetry]
 name = "groundx"
-version = "2.3.5"
+version = "2.3.7"
 description = ""
 readme = "README.md"
 authors = []

{groundx-2.3.5 → groundx-2.3.7}/src/groundx/__init__.py

@@ -44,6 +44,7 @@ from .types import (
     SearchResponse,
     SearchResponseSearch,
     SearchResultItem,
+    SearchResultItemPagesItem,
     Sort,
     SortOrder,
     SubscriptionDetail,
@@ -104,6 +105,7 @@ __all__ = [
     "SearchResponse",
     "SearchResponseSearch",
     "SearchResultItem",
+    "SearchResultItemPagesItem",
     "Sort",
     "SortOrder",
     "SubscriptionDetail",

{groundx-2.3.5 → groundx-2.3.7}/src/groundx/core/client_wrapper.py

@@ -14,10 +14,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "groundx/2.3.5",
+            "User-Agent": "groundx/2.3.7",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "groundx",
-            "X-Fern-SDK-Version": "2.3.5",
+            "X-Fern-SDK-Version": "2.3.7",
         }
         headers["X-API-Key"] = self.api_key
         return headers

{groundx-2.3.5 → groundx-2.3.7}/src/groundx/ingest.py

@@ -111,6 +111,7 @@ def prep_documents(
                 bucket_id=document.bucket_id,
                 file_name=document.file_name,
                 file_type=document.file_type,
+                filter=document.filter,
                 process_level=document.process_level,
                 search_data=document.search_data,
                 source_url=document.file_path,
@@ -431,6 +432,7 @@ class GroundX(GroundXBase):
                         bucket_id=d.bucket_id,
                         file_name=fn,
                         file_type=ft,
+                        filter=d.filter,
                         process_level=d.process_level,
                         search_data=d.search_data,
                         source_url=url,
@@ -610,6 +612,7 @@ class AsyncGroundX(AsyncGroundXBase):
                         bucket_id=d.bucket_id,
                         file_name=fn,
                         file_type=ft,
+                        filter=d.filter,
                         process_level=d.process_level,
                         search_data=d.search_data,
                         source_url=url,

{groundx-2.3.5 → groundx-2.3.7}/src/groundx/types/__init__.py

@@ -43,6 +43,7 @@ from .processing_status import ProcessingStatus
 from .search_response import SearchResponse
 from .search_response_search import SearchResponseSearch
 from .search_result_item import SearchResultItem
+from .search_result_item_pages_item import SearchResultItemPagesItem
 from .sort import Sort
 from .sort_order import SortOrder
 from .subscription_detail import SubscriptionDetail
@@ -91,6 +92,7 @@ __all__ = [
     "SearchResponse",
     "SearchResponseSearch",
     "SearchResultItem",
+    "SearchResultItemPagesItem",
     "Sort",
     "SortOrder",
     "SubscriptionDetail",

{groundx-2.3.5 → groundx-2.3.7}/src/groundx/types/document.py

@@ -29,6 +29,11 @@ class Document(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-2.3.5 → groundx-2.3.7}/src/groundx/types/search_result_item.py

@@ -7,6 +7,7 @@ import typing_extensions
 from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ..core.serialization import FieldMetadata
 from .bounding_box_detail import BoundingBoxDetail
+from .search_result_item_pages_item import SearchResultItemPagesItem
 
 
 class SearchResultItem(UniversalBaseModel):
@@ -55,6 +56,7 @@ class SearchResultItem(UniversalBaseModel):
     page_images: typing_extensions.Annotated[typing.Optional[typing.List[str]], FieldMetadata(alias="pageImages")] = (
         None
     )
+    pages: typing.Optional[typing.List[SearchResultItemPagesItem]] = None
     score: typing.Optional[float] = pydantic.Field(default=None)
     """
     Confidence score in the search result

groundx-2.3.7/src/groundx/types/search_result_item_pages_item.py

@@ -0,0 +1,41 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+
+
+class SearchResultItemPagesItem(UniversalBaseModel):
+    height: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    The height of the page image
+    """
+
+    image_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="imageUrl")] = pydantic.Field(
+        default=None
+    )
+    """
+    A jpg of the page the chunk appears on
+    """
+
+    number: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    The page number
+    """
+
+    width: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    The width of the page image
+    """
+
+    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