Remove SummarizedPdfTextResponse in favor of PdfRestFileBasedResponse

Assisted-by: Codex

Author: datalogics-cgreen

src/pdfrest/client.py

@@ -60,15 +60,14 @@
     translate_httpx_error,
 )
 from .models import (
-    PdfRestDeletionResponse,
     ConvertToMarkdownResponse,
     ExtractTextResponse,
+    PdfRestDeletionResponse,
     PdfRestErrorResponse,
     PdfRestFile,
     PdfRestFileBasedResponse,
     PdfRestFileID,
     PdfRestInfoResponse,
-    SummarizePdfTextResponse,
     TranslatePdfTextResponse,
     UpResponse,
 )
@@ -78,14 +77,14 @@
 from .models._internal import (
     BasePdfRestGraphicPayload,
     BmpPdfRestPayload,
-    DeletePayload,
     ConvertToMarkdownPayload,
+    DeletePayload,
     ExtractImagesPayload,
     ExtractTextPayload,
     GifPdfRestPayload,
     JpegPdfRestPayload,
-    PdfCompressPayload,
     OcrPdfPayload,
+    PdfCompressPayload,
     PdfFlattenAnnotationsPayload,
     PdfFlattenFormsPayload,
     PdfFlattenTransparenciesPayload,
@@ -2140,7 +2139,7 @@ def summarize_pdf_text(
         extra_headers: AnyMapping | None = None,
         extra_body: Body | None = None,
         timeout: TimeoutTypes | None = None,
-    ) -> SummarizePdfTextResponse:
+    ) -> PdfRestFileBasedResponse:
         """Summarize the textual content of a PDF, Markdown, or text document."""
 
         payload: dict[str, Any] = {
@@ -2154,21 +2153,15 @@ def summarize_pdf_text(
             payload["pages"] = pages
         if output is not None:
             payload["output"] = output
-
-        validated_payload = SummarizePdfTextPayload.model_validate(payload)
-        request = self.prepare_request(
-            "POST",
-            "/summarized-pdf-text",
-            json_body=validated_payload.model_dump(
-                mode="json", by_alias=True, exclude_none=True, exclude_unset=True
-            ),
+        return self._post_file_operation(
+            endpoint="/summarized-pdf-text",
+            payload=payload,
+            payload_model=SummarizePdfTextPayload,
             extra_query=extra_query,
             extra_headers=extra_headers,
             extra_body=extra_body,
             timeout=timeout,
         )
-        raw_payload = self._send_request(request)
-        return SummarizePdfTextResponse.model_validate(raw_payload)
 
     def convert_to_markdown(
         self,
@@ -2668,7 +2661,6 @@ def compress_pdf(
             extra_body=extra_body,
             timeout=timeout,
         )
-        
 
     def flatten_transparencies(
         self,
@@ -3089,7 +3081,7 @@ async def summarize_pdf_text(
         extra_headers: AnyMapping | None = None,
         extra_body: Body | None = None,
         timeout: TimeoutTypes | None = None,
-    ) -> SummarizePdfTextResponse:
+    ) -> PdfRestFileBasedResponse:
         """Summarize the textual content of a PDF, Markdown, or text document."""
 
         payload: dict[str, Any] = {
@@ -3103,21 +3095,15 @@ async def summarize_pdf_text(
             payload["pages"] = pages
         if output is not None:
             payload["output"] = output
-
-        validated_payload = SummarizePdfTextPayload.model_validate(payload)
-        request = self.prepare_request(
-            "POST",
-            "/summarized-pdf-text",
-            json_body=validated_payload.model_dump(
-                mode="json", by_alias=True, exclude_none=True, exclude_unset=True
-            ),
+        return await self._post_file_operation(
+            endpoint="/summarized-pdf-text",
+            payload=payload,
+            payload_model=SummarizePdfTextPayload,
             extra_query=extra_query,
             extra_headers=extra_headers,
             extra_body=extra_body,
             timeout=timeout,
         )
-        raw_payload = await self._send_request(request)
-        return SummarizePdfTextResponse.model_validate(raw_payload)
 
     async def convert_to_markdown(
         self,
@@ -3659,7 +3645,6 @@ async def compress_pdf(
             extra_body=extra_body,
             timeout=timeout,
         )
-        
 
     async def flatten_transparencies(
         self,
@@ -3687,7 +3672,7 @@ async def flatten_transparencies(
             extra_body=extra_body,
             timeout=timeout,
         )
-        
+
     async def linearize_pdf(
         self,
         file: PdfRestFile | Sequence[PdfRestFile],

src/pdfrest/models/__init__.py

@@ -1,27 +1,25 @@
 from .public import (
-    PdfRestDeletionResponse,
     ConvertToMarkdownResponse,
     ExtractTextResponse,
+    PdfRestDeletionResponse,
     PdfRestErrorResponse,
     PdfRestFile,
     PdfRestFileBasedResponse,
     PdfRestFileID,
     PdfRestInfoResponse,
-    SummarizePdfTextResponse,
     TranslatePdfTextResponse,
     UpResponse,
 )
 
 __all__ = [
-    "PdfRestDeletionResponse",
     "ConvertToMarkdownResponse",
     "ExtractTextResponse",
+    "PdfRestDeletionResponse",
     "PdfRestErrorResponse",
     "PdfRestFile",
     "PdfRestFileBasedResponse",
     "PdfRestFileID",
     "PdfRestInfoResponse",
-    "SummarizePdfTextResponse",
     "TranslatePdfTextResponse",
     "UpResponse",
 ]

src/pdfrest/models/public.py

@@ -20,15 +20,14 @@
 from typing_extensions import override
 
 __all__ = (
-    "PdfRestDeletionResponse",
     "ConvertToMarkdownResponse",
     "ExtractTextResponse",
+    "PdfRestDeletionResponse",
     "PdfRestErrorResponse",
     "PdfRestFile",
     "PdfRestFileBasedResponse",
     "PdfRestFileID",
     "PdfRestInfoResponse",
-    "SummarizePdfTextResponse",
     "TranslatePdfTextResponse",
     "UpResponse",
 )
@@ -314,43 +313,6 @@ class PdfRestDeletionResponse(BaseModel):
             min_length=1,
         ),
     ]
-class SummarizePdfTextResponse(BaseModel):
-    """Response returned by the summarize-pdf-text tool."""
-
-    model_config = ConfigDict(extra="allow")
-
-    summary: Annotated[
-        str | None,
-        Field(
-            description="Inline summary content when output_type is json.",
-            default=None,
-        ),
-    ] = None
-    input_id: Annotated[
-        PdfRestFileID,
-        Field(
-            validation_alias=AliasChoices("input_id", "inputId"),
-            description="The id of the input file.",
-        ),
-    ]
-    output_url: Annotated[
-        HttpUrl | None,
-        Field(
-            alias="outputUrl",
-            validation_alias=AliasChoices("output_url", "outputUrl"),
-            description="Download URL for file output.",
-            default=None,
-        ),
-    ] = None
-    output_id: Annotated[
-        PdfRestFileID | None,
-        Field(
-            alias="outputId",
-            validation_alias=AliasChoices("output_id", "outputId"),
-            description="The id of the generated output when output_type is file.",
-            default=None,
-        ),
-    ] = None
 
 
 class TranslatePdfTextResponse(BaseModel):

tests/live/test_live_summarize_pdf_text.py

@@ -3,7 +3,7 @@
 import pytest
 
 from pdfrest import PdfRestApiError, PdfRestClient
-from pdfrest.models import SummarizePdfTextResponse
+from pdfrest.models import PdfRestFileBasedResponse
 
 from ..resources import get_test_resource_path
 
@@ -25,8 +25,8 @@ def test_live_summarize_pdf_text_success(
             summary_format="overview",
         )
 
-    assert isinstance(response, SummarizePdfTextResponse)
-    assert response.summary
+    assert isinstance(response, PdfRestFileBasedResponse)
+    assert response.output_files
     assert response.input_id == uploaded.id