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

groundx/search/raw_client.py

@@ -0,0 +1,442 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import jsonable_encoder
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..errors.bad_request_error import BadRequestError
+from ..errors.unauthorized_error import UnauthorizedError
+from ..types.search_response import SearchResponse
+from .types.search_content_request_id import SearchContentRequestId
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawSearchClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def content(
+        self,
+        id: SearchContentRequestId,
+        *,
+        query: str,
+        n: typing.Optional[int] = None,
+        next_token: typing.Optional[str] = None,
+        verbosity: typing.Optional[int] = None,
+        filter: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        relevance: typing.Optional[float] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[SearchResponse]:
+        """
+        Search documents on GroundX for the most relevant information to a given query.
+        The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
+
+        Parameters
+        ----------
+        id : SearchContentRequestId
+            The bucketId, groupId, or documentId to be searched. The document or documents within the specified container will be compared to the query, and relevant information will be extracted.
+
+        query : str
+            The search query to be used to find relevant documentation.
+
+        n : typing.Optional[int]
+            The maximum number of returned search results. Accepts 1-100 with a default of 20.
+
+        next_token : typing.Optional[str]
+            A token for pagination. If the number of search results for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n search results.
+
+        verbosity : typing.Optional[int]
+            The amount of data returned with each search result. 0 == no search results, only the recommended context. 1 == search results but no searchData. 2 == search results and searchData.
+
+        filter : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            A dictionary of key-value pairs that can be used to pre-filter documents prior to a search.
+
+        relevance : typing.Optional[float]
+            The minimum search relevance score required to include the result. By default, this is 10.0.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[SearchResponse]
+            Search query success
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/search/{jsonable_encoder(id)}",
+            method="POST",
+            params={
+                "n": n,
+                "nextToken": next_token,
+                "verbosity": verbosity,
+            },
+            json={
+                "query": query,
+                "filter": filter,
+                "relevance": relevance,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SearchResponse,
+                    parse_obj_as(
+                        type_=SearchResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def documents(
+        self,
+        *,
+        query: str,
+        document_ids: typing.Sequence[str],
+        n: typing.Optional[int] = None,
+        next_token: typing.Optional[str] = None,
+        verbosity: typing.Optional[int] = None,
+        filter: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        relevance: typing.Optional[float] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[SearchResponse]:
+        """
+        Search documents on GroundX for the most relevant information to a given query by documentId(s).
+        The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
+
+        Parameters
+        ----------
+        query : str
+            The search query to be used to find relevant documentation.
+
+        document_ids : typing.Sequence[str]
+            An array of unique documentIds to be searched.
+
+        n : typing.Optional[int]
+            The maximum number of returned search results. Accepts 1-100 with a default of 20.
+
+        next_token : typing.Optional[str]
+            A token for pagination. If the number of search results for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n search results.
+
+        verbosity : typing.Optional[int]
+            The amount of data returned with each search result. 0 == no search results, only the recommended context. 1 == search results but no searchData. 2 == search results and searchData.
+
+        filter : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            A dictionary of key-value pairs that can be used to pre-filter documents prior to a search.
+
+        relevance : typing.Optional[float]
+            The minimum search relevance score required to include the result. By default, this is 10.0.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[SearchResponse]
+            Search query success
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/search/documents",
+            method="POST",
+            params={
+                "n": n,
+                "nextToken": next_token,
+                "verbosity": verbosity,
+            },
+            json={
+                "query": query,
+                "documentIds": document_ids,
+                "filter": filter,
+                "relevance": relevance,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SearchResponse,
+                    parse_obj_as(
+                        type_=SearchResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawSearchClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def content(
+        self,
+        id: SearchContentRequestId,
+        *,
+        query: str,
+        n: typing.Optional[int] = None,
+        next_token: typing.Optional[str] = None,
+        verbosity: typing.Optional[int] = None,
+        filter: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        relevance: typing.Optional[float] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[SearchResponse]:
+        """
+        Search documents on GroundX for the most relevant information to a given query.
+        The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
+
+        Parameters
+        ----------
+        id : SearchContentRequestId
+            The bucketId, groupId, or documentId to be searched. The document or documents within the specified container will be compared to the query, and relevant information will be extracted.
+
+        query : str
+            The search query to be used to find relevant documentation.
+
+        n : typing.Optional[int]
+            The maximum number of returned search results. Accepts 1-100 with a default of 20.
+
+        next_token : typing.Optional[str]
+            A token for pagination. If the number of search results for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n search results.
+
+        verbosity : typing.Optional[int]
+            The amount of data returned with each search result. 0 == no search results, only the recommended context. 1 == search results but no searchData. 2 == search results and searchData.
+
+        filter : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            A dictionary of key-value pairs that can be used to pre-filter documents prior to a search.
+
+        relevance : typing.Optional[float]
+            The minimum search relevance score required to include the result. By default, this is 10.0.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[SearchResponse]
+            Search query success
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/search/{jsonable_encoder(id)}",
+            method="POST",
+            params={
+                "n": n,
+                "nextToken": next_token,
+                "verbosity": verbosity,
+            },
+            json={
+                "query": query,
+                "filter": filter,
+                "relevance": relevance,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SearchResponse,
+                    parse_obj_as(
+                        type_=SearchResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def documents(
+        self,
+        *,
+        query: str,
+        document_ids: typing.Sequence[str],
+        n: typing.Optional[int] = None,
+        next_token: typing.Optional[str] = None,
+        verbosity: typing.Optional[int] = None,
+        filter: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT,
+        relevance: typing.Optional[float] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[SearchResponse]:
+        """
+        Search documents on GroundX for the most relevant information to a given query by documentId(s).
+        The result of this query is typically used in one of two ways; `result.search.text` can be used to provide context to a language model, facilitating RAG, or `result.search.results` can be used to observe chunks of text which are relevant to the query, facilitating citation.
+
+        Parameters
+        ----------
+        query : str
+            The search query to be used to find relevant documentation.
+
+        document_ids : typing.Sequence[str]
+            An array of unique documentIds to be searched.
+
+        n : typing.Optional[int]
+            The maximum number of returned search results. Accepts 1-100 with a default of 20.
+
+        next_token : typing.Optional[str]
+            A token for pagination. If the number of search results for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n search results.
+
+        verbosity : typing.Optional[int]
+            The amount of data returned with each search result. 0 == no search results, only the recommended context. 1 == search results but no searchData. 2 == search results and searchData.
+
+        filter : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]
+            A dictionary of key-value pairs that can be used to pre-filter documents prior to a search.
+
+        relevance : typing.Optional[float]
+            The minimum search relevance score required to include the result. By default, this is 10.0.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[SearchResponse]
+            Search query success
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/search/documents",
+            method="POST",
+            params={
+                "n": n,
+                "nextToken": next_token,
+                "verbosity": verbosity,
+            },
+            json={
+                "query": query,
+                "documentIds": document_ids,
+                "filter": filter,
+                "relevance": relevance,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SearchResponse,
+                    parse_obj_as(
+                        type_=SearchResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Optional[typing.Any],
+                        parse_obj_as(
+                            type_=typing.Optional[typing.Any],  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

groundx/search/types/__init__.py

@@ -1,5 +1,7 @@
 # This file was auto-generated by Fern from our API Definition.
 
+# isort: skip_file
+
 from .search_content_request_id import SearchContentRequestId
 
 __all__ = ["SearchContentRequestId"]

groundx/types/__init__.py

@@ -1,5 +1,7 @@
 # This file was auto-generated by Fern from our API Definition.
 
+# isort: skip_file
+
 from .bounding_box_detail import BoundingBoxDetail
 from .bucket_detail import BucketDetail
 from .bucket_list_response import BucketListResponse
@@ -41,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
@@ -89,6 +92,7 @@ __all__ = [
     "SearchResponse",
     "SearchResponseSearch",
     "SearchResultItem",
+    "SearchResultItemPagesItem",
     "Sort",
     "SortOrder",
     "SubscriptionDetail",

groundx/types/bounding_box_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_extensions
 import typing
-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
 
 
 class BoundingBoxDetail(UniversalBaseModel):

groundx/types/bucket_detail.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
-from ..core.serialization import FieldMetadata
-import typing
 import datetime as dt
+import typing
+
 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
 
 
 class BucketDetail(UniversalBaseModel):

groundx/types/bucket_list_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 .bucket_detail import BucketDetail
+
 import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .bucket_detail import BucketDetail
 
 
 class BucketListResponse(UniversalBaseModel):

groundx/types/bucket_response.py

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

groundx/types/bucket_update_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_extensions
-from ..core.serialization import FieldMetadata
 import typing
-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
 
 
 class BucketUpdateDetail(UniversalBaseModel):

groundx/types/bucket_update_response.py

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

groundx/types/customer_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
+
 import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from .subscription_detail import SubscriptionDetail
-from ..core.pydantic_utilities import IS_PYDANTIC_V2
 
 
 class CustomerDetail(UniversalBaseModel):

groundx/types/customer_response.py

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

groundx/types/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 Document(UniversalBaseModel):
@@ -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/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):

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]