groundx 2.0.15__py3-none-any.whl → 2.7.7__py3-none-any.whl

groundx/search/__init__.py

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

groundx/search/client.py

@@ -1,17 +1,12 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-from ..core.client_wrapper import SyncClientWrapper
-from .types.search_content_request_id import SearchContentRequestId
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
 from ..types.search_response import SearchResponse
-from ..core.jsonable_encoder import jsonable_encoder
-from ..core.pydantic_utilities import parse_obj_as
-from ..errors.bad_request_error import BadRequestError
-from ..errors.unauthorized_error import UnauthorizedError
-from json.decoder import JSONDecodeError
-from ..core.api_error import ApiError
-from ..core.client_wrapper import AsyncClientWrapper
+from .raw_client import AsyncRawSearchClient, RawSearchClient
+from .types.search_content_request_id import SearchContentRequestId
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -19,7 +14,18 @@ OMIT = typing.cast(typing.Any, ...)
 
 class SearchClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = RawSearchClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawSearchClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawSearchClient
+        """
+        return self._raw_client
 
     def content(
         self,
@@ -29,20 +35,18 @@ class SearchClient:
         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,
     ) -> 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.
-
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
+        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, projectId, 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.
+            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.
@@ -56,6 +60,9 @@ class SearchClient:
         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.
 
@@ -76,61 +83,23 @@ class SearchClient:
         )
         client.search.content(
             id=1,
+            n=1,
             next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+            verbosity=1,
             query="my search query",
         )
         """
-        _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,
-                "relevance": relevance,
-            },
-            headers={
-                "content-type": "application/json",
-            },
+        _response = self._raw_client.content(
+            id,
+            query=query,
+            n=n,
+            next_token=next_token,
+            verbosity=verbosity,
+            filter=filter,
+            relevance=relevance,
             request_options=request_options,
-            omit=OMIT,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    SearchResponse,
-                    parse_obj_as(
-                        type_=SearchResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 400:
-                raise BadRequestError(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        return _response.data
 
     def documents(
         self,
@@ -140,15 +109,13 @@ class SearchClient:
         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,
     ) -> 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.
-
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
+        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
         ----------
@@ -167,6 +134,9 @@ class SearchClient:
         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.
 
@@ -186,68 +156,40 @@ class SearchClient:
             api_key="YOUR_API_KEY",
         )
         client.search.documents(
+            n=1,
             next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+            verbosity=1,
             query="my search query",
             document_ids=["docUUID1", "docUUID2"],
         )
         """
-        _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,
-                "relevance": relevance,
-            },
-            headers={
-                "content-type": "application/json",
-            },
+        _response = self._raw_client.documents(
+            query=query,
+            document_ids=document_ids,
+            n=n,
+            next_token=next_token,
+            verbosity=verbosity,
+            filter=filter,
+            relevance=relevance,
             request_options=request_options,
-            omit=OMIT,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    SearchResponse,
-                    parse_obj_as(
-                        type_=SearchResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 400:
-                raise BadRequestError(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        return _response.data
 
 
 class AsyncSearchClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._client_wrapper = client_wrapper
+        self._raw_client = AsyncRawSearchClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawSearchClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawSearchClient
+        """
+        return self._raw_client
 
     async def content(
         self,
@@ -257,20 +199,18 @@ class AsyncSearchClient:
         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,
     ) -> 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.
-
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
+        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, projectId, 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.
+            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.
@@ -284,6 +224,9 @@ class AsyncSearchClient:
         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.
 
@@ -309,64 +252,26 @@ class AsyncSearchClient:
         async def main() -> None:
             await client.search.content(
                 id=1,
+                n=1,
                 next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+                verbosity=1,
                 query="my search query",
             )
 
 
         asyncio.run(main())
         """
-        _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,
-                "relevance": relevance,
-            },
-            headers={
-                "content-type": "application/json",
-            },
+        _response = await self._raw_client.content(
+            id,
+            query=query,
+            n=n,
+            next_token=next_token,
+            verbosity=verbosity,
+            filter=filter,
+            relevance=relevance,
             request_options=request_options,
-            omit=OMIT,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    SearchResponse,
-                    parse_obj_as(
-                        type_=SearchResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 400:
-                raise BadRequestError(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        return _response.data
 
     async def documents(
         self,
@@ -376,15 +281,13 @@ class AsyncSearchClient:
         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,
     ) -> 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.
-
-        Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.
+        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
         ----------
@@ -403,6 +306,9 @@ class AsyncSearchClient:
         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.
 
@@ -427,7 +333,9 @@ class AsyncSearchClient:
 
         async def main() -> None:
             await client.search.documents(
+                n=1,
                 next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+                verbosity=1,
                 query="my search query",
                 document_ids=["docUUID1", "docUUID2"],
             )
@@ -435,55 +343,14 @@ class AsyncSearchClient:
 
         asyncio.run(main())
         """
-        _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,
-                "relevance": relevance,
-            },
-            headers={
-                "content-type": "application/json",
-            },
+        _response = await self._raw_client.documents(
+            query=query,
+            document_ids=document_ids,
+            n=n,
+            next_token=next_token,
+            verbosity=verbosity,
+            filter=filter,
+            relevance=relevance,
             request_options=request_options,
-            omit=OMIT,
         )
-        try:
-            if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    SearchResponse,
-                    parse_obj_as(
-                        type_=SearchResponse,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
-            if _response.status_code == 400:
-                raise BadRequestError(
-                    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(
-                    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, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)
+        return _response.data