groundx 2.0.11__py3-none-any.whl

groundx/search/client.py

@@ -0,0 +1,489 @@
+# 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.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
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class SearchClient:
+    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,
+        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.
+
+        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.
+
+        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.
+
+        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
+        -------
+        SearchResponse
+            Search query success
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.search.content(
+            id=1,
+            next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+            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",
+            },
+            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)
+
+    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,
+        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.
+
+        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.
+
+        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
+        -------
+        SearchResponse
+            Search query success
+
+        Examples
+        --------
+        from groundx import GroundX
+
+        client = GroundX(
+            api_key="YOUR_API_KEY",
+        )
+        client.search.documents(
+            next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+            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",
+            },
+            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)
+
+
+class AsyncSearchClient:
+    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,
+        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.
+
+        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.
+
+        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.
+
+        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
+        -------
+        SearchResponse
+            Search query success
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.search.content(
+                id=1,
+                next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+                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",
+            },
+            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)
+
+    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,
+        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.
+
+        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.
+
+        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
+        -------
+        SearchResponse
+            Search query success
+
+        Examples
+        --------
+        import asyncio
+
+        from groundx import AsyncGroundX
+
+        client = AsyncGroundX(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.search.documents(
+                next_token="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
+                query="my search query",
+                document_ids=["docUUID1", "docUUID2"],
+            )
+
+
+        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",
+            },
+            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)

groundx/search/types/__init__.py

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

groundx/search/types/search_content_request_id.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+SearchContentRequestId = typing.Union[int, str]

groundx/types/__init__.py

@@ -0,0 +1,83 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .bounding_box_detail import BoundingBoxDetail
+from .bucket_detail import BucketDetail
+from .bucket_list_response import BucketListResponse
+from .bucket_response import BucketResponse
+from .bucket_update_detail import BucketUpdateDetail
+from .bucket_update_response import BucketUpdateResponse
+from .customer_detail import CustomerDetail
+from .customer_response import CustomerResponse
+from .document_detail import DocumentDetail
+from .document_list_response import DocumentListResponse
+from .document_lookup_response import DocumentLookupResponse
+from .document_response import DocumentResponse
+from .document_type import DocumentType
+from .group_detail import GroupDetail
+from .group_list_response import GroupListResponse
+from .group_response import GroupResponse
+from .health_response import HealthResponse
+from .health_response_health import HealthResponseHealth
+from .health_service import HealthService
+from .health_service_status import HealthServiceStatus
+from .ingest_response import IngestResponse
+from .ingest_response_ingest import IngestResponseIngest
+from .message_response import MessageResponse
+from .meter_detail import MeterDetail
+from .process_status_response import ProcessStatusResponse
+from .process_status_response_ingest import ProcessStatusResponseIngest
+from .process_status_response_ingest_progress import ProcessStatusResponseIngestProgress
+from .process_status_response_ingest_progress_cancelled import ProcessStatusResponseIngestProgressCancelled
+from .process_status_response_ingest_progress_complete import ProcessStatusResponseIngestProgressComplete
+from .process_status_response_ingest_progress_errors import ProcessStatusResponseIngestProgressErrors
+from .process_status_response_ingest_progress_processing import ProcessStatusResponseIngestProgressProcessing
+from .processing_status import ProcessingStatus
+from .search_response import SearchResponse
+from .search_response_search import SearchResponseSearch
+from .search_result_item import SearchResultItem
+from .sort import Sort
+from .sort_order import SortOrder
+from .subscription_detail import SubscriptionDetail
+from .subscription_detail_meters import SubscriptionDetailMeters
+
+__all__ = [
+    "BoundingBoxDetail",
+    "BucketDetail",
+    "BucketListResponse",
+    "BucketResponse",
+    "BucketUpdateDetail",
+    "BucketUpdateResponse",
+    "CustomerDetail",
+    "CustomerResponse",
+    "DocumentDetail",
+    "DocumentListResponse",
+    "DocumentLookupResponse",
+    "DocumentResponse",
+    "DocumentType",
+    "GroupDetail",
+    "GroupListResponse",
+    "GroupResponse",
+    "HealthResponse",
+    "HealthResponseHealth",
+    "HealthService",
+    "HealthServiceStatus",
+    "IngestResponse",
+    "IngestResponseIngest",
+    "MessageResponse",
+    "MeterDetail",
+    "ProcessStatusResponse",
+    "ProcessStatusResponseIngest",
+    "ProcessStatusResponseIngestProgress",
+    "ProcessStatusResponseIngestProgressCancelled",
+    "ProcessStatusResponseIngestProgressComplete",
+    "ProcessStatusResponseIngestProgressErrors",
+    "ProcessStatusResponseIngestProgressProcessing",
+    "ProcessingStatus",
+    "SearchResponse",
+    "SearchResponseSearch",
+    "SearchResultItem",
+    "Sort",
+    "SortOrder",
+    "SubscriptionDetail",
+    "SubscriptionDetailMeters",
+]

groundx/types/bounding_box_detail.py

@@ -0,0 +1,54 @@
+# 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
+
+
+class BoundingBoxDetail(UniversalBaseModel):
+    bottom_right_x: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="bottomRightX")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The x coordinate of the lower right corner of the bounding box
+    """
+
+    bottom_right_y: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="bottomRightY")] = (
+        pydantic.Field(default=None)
+    )
+    """
+    The y coordinate of the lower right corner of the bounding box
+    """
+
+    page_number: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="pageNumber")] = pydantic.Field(
+        default=None
+    )
+    """
+    The page number the bounding box appears on, using a 1-based array indexing (starts with page 1, not page 0)
+    """
+
+    top_left_x: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="topLeftX")] = pydantic.Field(
+        default=None
+    )
+    """
+    The x coordinate of the upper left corner of the bounding box
+    """
+
+    top_left_y: typing_extensions.Annotated[typing.Optional[float], FieldMetadata(alias="topLeftY")] = pydantic.Field(
+        default=None
+    )
+    """
+    The y coordinate of the upper left corner of the bounding box
+    """
+
+    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/types/bucket_detail.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 typing
+import datetime as dt
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+
+
+class BucketDetail(UniversalBaseModel):
+    bucket_id: typing_extensions.Annotated[int, FieldMetadata(alias="bucketId")]
+    created: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The data time when the bucket was created, in RFC3339 format
+    """
+
+    file_count: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="fileCount")] = pydantic.Field(
+        default=None
+    )
+    """
+    The number of files contained in the content bucket
+    """
+
+    file_size: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="fileSize")] = pydantic.Field(
+        default=None
+    )
+    """
+    The total file size of files contained in the content bucket
+    """
+
+    name: typing.Optional[str] = None
+    updated: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The data time when the bucket was last updated, in RFC3339 format
+    """
+
+    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