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

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/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.6",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "groundx",
-            "X-Fern-SDK-Version": "2.3.5",
+            "X-Fern-SDK-Version": "2.3.6",
         }
         headers["X-API-Key"] = self.api_key
         return headers

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/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/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/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

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

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

{groundx-2.3.5.dist-info → groundx-2.3.6.dist-info}/RECORD

@@ -1,11 +1,11 @@
-groundx/__init__.py,sha256=MWIVXsUXk75FZaVpUMUCs6vn5niRWDsKwSULcGxn8V4,2881
+groundx/__init__.py,sha256=0ysG1bUu9YHhB92o5bZdxvLKTLPzmYb_Lk06fDC-Dww,2945
 groundx/buckets/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
 groundx/buckets/client.py,sha256=OGD9D7SkaeBvS7aWDGTLmTUHt0cgnvn15eJq-5WWGoo,11324
 groundx/buckets/raw_client.py,sha256=T2Ty5obN7eHbaxHGAimzjM8MGOmSOQEckhciyZkzcjE,23873
 groundx/client.py,sha256=FsVhPSZ1kd70pOVv37zTbNSwBM7XdttSx4aEPobPoew,6412
 groundx/core/__init__.py,sha256=lTcqUPXcx4112yLDd70RAPeqq6tu3eFMe1pKOqkW9JQ,1562
 groundx/core/api_error.py,sha256=44vPoTyWN59gonCIZMdzw7M1uspygiLnr3GNFOoVL2Q,614
-groundx/core/client_wrapper.py,sha256=8zwdWhu0fj4LgeLSkd_NlCrfjBA3brzHFKRkF_fNBIE,1822
+groundx/core/client_wrapper.py,sha256=Pc236_8QSvkPW0XDXxHE4N4ot7DhDL4O4795nIu-ES0,1822
 groundx/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
 groundx/core/file.py,sha256=d4NNbX8XvXP32z8KpK2Xovv33nFfruIrpz0QWxlgpZk,2663
 groundx/core/force_multipart.py,sha256=awxh5MtcRYe74ehY8U76jzv6fYM_w_D3Rur7KQQzSDk,429
@@ -41,7 +41,7 @@ groundx/search/client.py,sha256=P4-oektRdgtfxoi_NiGDSOrB2dDWfO9M5kVy61CnCPQ,1359
 groundx/search/raw_client.py,sha256=_qO5u62e1d0rVbRUeyJFdt85v7WT_bSHcSLf8wJvfgQ,19545
 groundx/search/types/__init__.py,sha256=sy0s9qFdeT4Q3SJxK6hrulnsPirVpKkjxI29OqLTY0s,185
 groundx/search/types/search_content_request_id.py,sha256=us7mYdzR0qPur_wR5I9BhHaLEzC5nLBRna6-xq4M1ec,128
-groundx/types/__init__.py,sha256=m0r3rnMwQjkVrb0eAxL6bnUTCfUoIWzvklXn_iVS_HY,3604
+groundx/types/__init__.py,sha256=H8B-l1oxrOtnLCGJ-lESncpcxACFsfUDBIh608P8pWY,3706
 groundx/types/bounding_box_detail.py,sha256=5_l3vFNIs2n-U2VXEpyPRcTcFKpMWrpvzQiIL88XNEs,1796
 groundx/types/bucket_detail.py,sha256=sYKzUCPCAosh2jTFfSDtSn0bEsLL228kLjA51jFEYwY,1475
 groundx/types/bucket_list_response.py,sha256=m1lO4PElbxc5VFCLchPtdWfCTlfrm8enpTe3bg1ng7Y,1060
@@ -50,7 +50,7 @@ groundx/types/bucket_update_detail.py,sha256=S4wOHozr5o3XyD-a-dP4fM1DqdFPh_HC0OZ
 groundx/types/bucket_update_response.py,sha256=2gSJ77lwb12YPBnDXFflZTtFa6vIen1jdifRFmH1nFc,597
 groundx/types/customer_detail.py,sha256=yvSzH-6YZviBNGgeAk3uB1Tvrpp5FW1bEI_wmKklF2c,1058
 groundx/types/customer_response.py,sha256=jIU8Q5hAFJA3Bt1-3E4p00blQLbjeNAF5-pfXSiih1w,582
-groundx/types/document.py,sha256=NQm6jHmb6Zm-5nb5oKL5koETxwPhnPH9RXCDSJw_N1s,1833
+groundx/types/document.py,sha256=eO1hcklCSp8buUaqjBT6gYQsxVl85HvIEAa4iJdw4ms,2052
 groundx/types/document_detail.py,sha256=ENAeaf6shIHpIsDbOdDjX6DRrC6ButKfLMrgw-vANsM,2506
 groundx/types/document_list_response.py,sha256=n8yfjEA_k-_dPmRxsOAK2vXa7HtDkPNO8FF0dB4LFI4,803
 groundx/types/document_local_ingest_request.py,sha256=y3rIqid4VXWNgb6wTis7zQmxsnKYIwOiFQwv5GLmpsQ,198
@@ -82,14 +82,15 @@ groundx/types/processes_status_response.py,sha256=twks7OK0EriUl8xSgCe41rudjPlIH1
 groundx/types/processing_status.py,sha256=nUvsnKcDOFcT6NRDCTQ1vpm4KDNiKy8_b7PxaiKxnZM,226
 groundx/types/search_response.py,sha256=IvGBcItUHYUpaglEbhklPRsQ9YbmoMjSM-mTrAwQkSk,597
 groundx/types/search_response_search.py,sha256=zBWZfRp99e4bd5TR-CMbAvr3aC9S2OQEIoKfp6M38G4,1649
-groundx/types/search_result_item.py,sha256=6OMgxySjj517ijLvZiamhnM0UnvmXr6-gNTDzp0L_g4,3047
+groundx/types/search_result_item.py,sha256=rV6NqA_bRa9Hn3oSSevE_LcIlVv4WuwS-F7yHVQwFMI,3190
+groundx/types/search_result_item_pages_item.py,sha256=h-VbGW50iUxolcoKk7ohz6GTaSKTkLNbEo2r3qhrAv8,1125
 groundx/types/sort.py,sha256=oXap7qO8jI5I2wRhjdEfei4x0sEk2OEId2ll92EFOF8,147
 groundx/types/sort_order.py,sha256=hfJkStz6zHf3iWQFaVLkNCZPdyj5JS7TsQlN4Ij8Q5A,148
 groundx/types/subscription_detail.py,sha256=GEEivqyiLsZtd8Ow7mqqwF1y0m0tHD-t9r9dnZsDKAw,732
 groundx/types/subscription_detail_meters.py,sha256=vGqiR2uupVh5177DfOghjoe5mwzVhoWljKzPF-twUc0,794
 groundx/types/website_source.py,sha256=53jWDBtSrJVOsBVtVbZbjhEAsd0QGkXa7IuKO4AooLs,1542
 groundx/version.py,sha256=1yVogKaq260fQfckM2RYN2144SEw0QROsZW8ICtkG4U,74
-groundx-2.3.5.dist-info/LICENSE,sha256=dFE6nY1bHnSn6NqmdlghlU1gQqLqYNphrceGVehSa7o,1065
-groundx-2.3.5.dist-info/METADATA,sha256=MnH4Udsl_l3_pHEpD7aY-X9UB1t5sszxXkx8_hr2YR0,5173
-groundx-2.3.5.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-groundx-2.3.5.dist-info/RECORD,,
+groundx-2.3.6.dist-info/LICENSE,sha256=dFE6nY1bHnSn6NqmdlghlU1gQqLqYNphrceGVehSa7o,1065
+groundx-2.3.6.dist-info/METADATA,sha256=aCP4OnU8XjmPzQTkeuSYoLKXY01o4MLnqss5eldwAbc,5173
+groundx-2.3.6.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+groundx-2.3.6.dist-info/RECORD,,