pulse-python-sdk 1.0.1__tar.gz → 1.0.4__tar.gz

{pulse_python_sdk-1.0.1 → pulse_python_sdk-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pulse-python-sdk
-Version: 1.0.1
+Version: 1.0.4
 Summary: 
 Requires-Python: >=3.8,<4.0
 Classifier: Intended Audience :: Developers

{pulse_python_sdk-1.0.1 → pulse_python_sdk-1.0.4}/pyproject.toml

@@ -4,7 +4,7 @@ dynamic = ["version"]
 
 [tool.poetry]
 name = "pulse-python-sdk"
-version = "1.0.1"
+version = "1.0.4"
 description = ""
 readme = "README.md"
 authors = []

{pulse_python_sdk-1.0.1 → pulse_python_sdk-1.0.4}/src/pulse/client.py

@@ -28,6 +28,8 @@ from .types.schema_config import SchemaConfig
 from .types.schema_response import SchemaResponse
 from .types.split_config import SplitConfig
 from .types.split_response import SplitResponse
+from .types.tables_config import TablesConfig
+from .types.tables_response import TablesResponse
 from .types.topic_schema_config import TopicSchemaConfig
 
 if typing.TYPE_CHECKING:
@@ -507,6 +509,59 @@ class Pulse:
         )
         return _response.data
 
+    def tables(
+        self,
+        *,
+        extraction_id: str,
+        tables_config: typing.Optional[TablesConfig] = OMIT,
+        async_: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> TablesResponse:
+        """
+        Extract tables from a previously completed extraction. Processes the
+        extraction's document content and returns structured table data.
+
+        Requires the `tables_endpoint` feature flag to be enabled for your
+        organization.
+
+        Set `async: true` to return immediately with a `tables_id` for
+        polling via `GET /job/{tables_id}`.
+
+        Parameters
+        ----------
+        extraction_id : str
+            ID of a completed extraction to extract tables from.
+
+        tables_config : typing.Optional[TablesConfig]
+            Table extraction configuration. If omitted, defaults are used (`merge: false`, `table_format: "html"`).
+
+        async_ : typing.Optional[bool]
+            When true, returns immediately with a job ID. Poll `GET /job/{tables_id}` for the result.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        TablesResponse
+            Table extraction result (when async=false or omitted).
+
+        Examples
+        --------
+        from pulse import Pulse
+
+        client = Pulse(
+            api_key="YOUR_API_KEY",
+        )
+        client.tables(
+            extraction_id="extraction_id",
+        )
+        """
+        _response = self._raw_client.tables(
+            extraction_id=extraction_id, tables_config=tables_config, async_=async_, request_options=request_options
+        )
+        return _response.data
+
     @property
     def jobs(self):
         if self._jobs is None:
@@ -1026,6 +1081,67 @@ class AsyncPulse:
         )
         return _response.data
 
+    async def tables(
+        self,
+        *,
+        extraction_id: str,
+        tables_config: typing.Optional[TablesConfig] = OMIT,
+        async_: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> TablesResponse:
+        """
+        Extract tables from a previously completed extraction. Processes the
+        extraction's document content and returns structured table data.
+
+        Requires the `tables_endpoint` feature flag to be enabled for your
+        organization.
+
+        Set `async: true` to return immediately with a `tables_id` for
+        polling via `GET /job/{tables_id}`.
+
+        Parameters
+        ----------
+        extraction_id : str
+            ID of a completed extraction to extract tables from.
+
+        tables_config : typing.Optional[TablesConfig]
+            Table extraction configuration. If omitted, defaults are used (`merge: false`, `table_format: "html"`).
+
+        async_ : typing.Optional[bool]
+            When true, returns immediately with a job ID. Poll `GET /job/{tables_id}` for the result.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        TablesResponse
+            Table extraction result (when async=false or omitted).
+
+        Examples
+        --------
+        import asyncio
+
+        from pulse import AsyncPulse
+
+        client = AsyncPulse(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.tables(
+                extraction_id="extraction_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.tables(
+            extraction_id=extraction_id, tables_config=tables_config, async_=async_, request_options=request_options
+        )
+        return _response.data
+
     @property
     def jobs(self):
         if self._jobs is None:

{pulse_python_sdk-1.0.1 → pulse_python_sdk-1.0.4}/src/pulse/core/client_wrapper.py

@@ -22,10 +22,10 @@ class BaseClientWrapper:
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
-            "User-Agent": "pulse-python-sdk/1.0.1",
+            "User-Agent": "pulse-python-sdk/1.0.4",
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "pulse-python-sdk",
-            "X-Fern-SDK-Version": "1.0.1",
+            "X-Fern-SDK-Version": "1.0.4",
             **(self.get_custom_headers() or {}),
         }
         headers["x-api-key"] = self.api_key

{pulse_python_sdk-1.0.1 → pulse_python_sdk-1.0.4}/src/pulse/environment.py

@@ -4,4 +4,4 @@ import enum
 
 
 class PulseEnvironment(enum.Enum):
-    DEFAULT = "https://dev.api.runpulse.com"
+    DEFAULT = "https://api.runpulse.com"

{pulse_python_sdk-1.0.1 → pulse_python_sdk-1.0.4}/src/pulse/raw_client.py

@@ -11,6 +11,7 @@ from .core.request_options import RequestOptions
 from .core.serialization import convert_and_respect_annotation_metadata
 from .core.unchecked_base_model import construct_type
 from .errors.bad_request_error import BadRequestError
+from .errors.forbidden_error import ForbiddenError
 from .errors.internal_server_error import InternalServerError
 from .errors.not_found_error import NotFoundError
 from .errors.too_many_requests_error import TooManyRequestsError
@@ -31,6 +32,8 @@ from .types.schema_config import SchemaConfig
 from .types.schema_response import SchemaResponse
 from .types.split_config import SplitConfig
 from .types.split_response import SplitResponse
+from .types.tables_config import TablesConfig
+from .types.tables_response import TablesResponse
 from .types.topic_schema_config import TopicSchemaConfig
 
 # this is used as the default value for optional parameters
@@ -657,6 +660,140 @@ class RawPulse:
             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 tables(
+        self,
+        *,
+        extraction_id: str,
+        tables_config: typing.Optional[TablesConfig] = OMIT,
+        async_: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[TablesResponse]:
+        """
+        Extract tables from a previously completed extraction. Processes the
+        extraction's document content and returns structured table data.
+
+        Requires the `tables_endpoint` feature flag to be enabled for your
+        organization.
+
+        Set `async: true` to return immediately with a `tables_id` for
+        polling via `GET /job/{tables_id}`.
+
+        Parameters
+        ----------
+        extraction_id : str
+            ID of a completed extraction to extract tables from.
+
+        tables_config : typing.Optional[TablesConfig]
+            Table extraction configuration. If omitted, defaults are used (`merge: false`, `table_format: "html"`).
+
+        async_ : typing.Optional[bool]
+            When true, returns immediately with a job ID. Poll `GET /job/{tables_id}` for the result.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[TablesResponse]
+            Table extraction result (when async=false or omitted).
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "tables",
+            method="POST",
+            json={
+                "extraction_id": extraction_id,
+                "tables_config": convert_and_respect_annotation_metadata(
+                    object_=tables_config, annotation=TablesConfig, direction="write"
+                ),
+                "async": async_,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    TablesResponse,
+                    construct_type(
+                        type_=TablesResponse,  # 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.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=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 AsyncRawPulse:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
@@ -1277,3 +1414,137 @@ class AsyncRawPulse:
         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 tables(
+        self,
+        *,
+        extraction_id: str,
+        tables_config: typing.Optional[TablesConfig] = OMIT,
+        async_: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[TablesResponse]:
+        """
+        Extract tables from a previously completed extraction. Processes the
+        extraction's document content and returns structured table data.
+
+        Requires the `tables_endpoint` feature flag to be enabled for your
+        organization.
+
+        Set `async: true` to return immediately with a `tables_id` for
+        polling via `GET /job/{tables_id}`.
+
+        Parameters
+        ----------
+        extraction_id : str
+            ID of a completed extraction to extract tables from.
+
+        tables_config : typing.Optional[TablesConfig]
+            Table extraction configuration. If omitted, defaults are used (`merge: false`, `table_format: "html"`).
+
+        async_ : typing.Optional[bool]
+            When true, returns immediately with a job ID. Poll `GET /job/{tables_id}` for the result.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[TablesResponse]
+            Table extraction result (when async=false or omitted).
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "tables",
+            method="POST",
+            json={
+                "extraction_id": extraction_id,
+                "tables_config": convert_and_respect_annotation_metadata(
+                    object_=tables_config, annotation=TablesConfig, direction="write"
+                ),
+                "async": async_,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    TablesResponse,
+                    construct_type(
+                        type_=TablesResponse,  # 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.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 403:
+                raise ForbiddenError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 429:
+                raise TooManyRequestsError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=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)

pulse_python_sdk-1.0.4/src/pulse/types/tables_config.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .tables_config_table_format import TablesConfigTableFormat
+
+
+class TablesConfig(UncheckedBaseModel):
+    """
+    Configuration for table extraction.
+    """
+
+    merge: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    When true, adjacent tables that appear to be continuations of each other are merged into a single table.
+    """
+
+    table_format: typing.Optional[TablesConfigTableFormat] = pydantic.Field(default=None)
+    """
+    Output format for table content. Currently only `html` is supported.
+    """
+
+    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

pulse_python_sdk-1.0.4/src/pulse/types/tables_config_table_format.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+TablesConfigTableFormat = typing.Union[typing.Literal["html"], typing.Any]

pulse_python_sdk-1.0.4/src/pulse/types/tables_response.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .tables_response_tables_output import TablesResponseTablesOutput
+
+
+class TablesResponse(UncheckedBaseModel):
+    """
+    Result of table extraction.
+    """
+
+    tables_id: str = pydantic.Field()
+    """
+    Persisted tables version ID. Can be used to retrieve the tables result later.
+    """
+
+    tables_output: TablesResponseTablesOutput = pydantic.Field()
+    """
+    The extracted tables data.
+    """
+
+    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

pulse_python_sdk-1.0.4/src/pulse/types/tables_response_tables_output.py

@@ -0,0 +1,28 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .tables_response_tables_output_tables_item import TablesResponseTablesOutputTablesItem
+
+
+class TablesResponseTablesOutput(UncheckedBaseModel):
+    """
+    The extracted tables data.
+    """
+
+    tables: typing.Optional[typing.List[TablesResponseTablesOutputTablesItem]] = pydantic.Field(default=None)
+    """
+    Array of extracted table objects. Each table includes its content, citations, and whether it was derived from a chart.
+    """
+
+    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

pulse_python_sdk-1.0.4/src/pulse/types/tables_response_tables_output_tables_item.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class TablesResponseTablesOutputTablesItem(UncheckedBaseModel):
+    table_content: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The table content in the requested format (e.g. HTML).
+    """
+
+    citations: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Bounding box table IDs indicating where this table was found (e.g. "tbl-1"). Merged tables list all source IDs.
+    """
+
+    from_chart: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether this table was extracted from a chart or figure rather than a native table.
+    """
+
+    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