update summary

Author: winzamark123

jigsawstack/summary.py

@@ -4,10 +4,11 @@
 from .async_request import AsyncRequest
 from typing import List, Union
 from ._config import ClientConfig
+from ._types import BaseResponse
 
 
 class SummaryParams(TypedDict):
-    text: Union[str, List[str]]
+    text: NotRequired[str]
     """
     The text to summarize.
     """
@@ -18,28 +19,28 @@ class SummaryParams(TypedDict):
    The summary result type. Supported values are: text, points
     """
     url: NotRequired[str]
-    file_store_key: NotRequired[str]
-    max_points: NotRequired[int]
-    max_characters: NotRequired[int]
-
-
-class SummaryResponse(TypedDict):
-    success: bool
     """
-    Indicates whether the translation was successful.
+    The URL to summarize.
     """
-    summary: str
+
+    file_store_key: NotRequired[str]
     """
-    The summarized text.
+    The file store key to summarize.
     """
 
+    max_points: NotRequired[int]
+    """
+    The maximum number of points of summary.
+    """
 
-class SummaryListResponse(TypedDict):
-    success: bool
+    max_characters: NotRequired[int]
     """
-    Indicates whether the translation was successful.
+    The maximum number of characters of summary.
     """
-    summary: List[str]
+
+
+class SummaryResponse(BaseResponse):
+    summary: Union[str, List[str]]
     """
     The summarized text.
     """
@@ -62,9 +63,7 @@ def __init__(
             disable_request_logging=disable_request_logging,
         )
 
-    def summarize(
-        self, params: SummaryParams
-    ) -> Union[SummaryResponse, SummaryListResponse]:
+    def summarize(self, params: SummaryParams) -> SummaryResponse:
         path = "/ai/summary"
         resp = Request(
             config=self.config,
@@ -92,9 +91,7 @@ def __init__(
             disable_request_logging=disable_request_logging,
         )
 
-    async def summarize(
-        self, params: SummaryParams
-    ) -> Union[SummaryResponse, SummaryListResponse]:
+    async def summarize(self, params: SummaryParams) -> SummaryResponse:
         path = "/ai/summary"
         resp = await AsyncRequest(
             config=self.config,

jigsawstack/translate.py

@@ -23,6 +23,9 @@ class TranslateImageParams(TypedDict):
     """
 
     return_type: NotRequired[Literal["url", "binary", "base64"]]
+    """
+    The return type of the response.
+    """
 
 
 class TranslateParams(TypedDict):
@@ -47,11 +50,7 @@ class TranslateResponse(BaseResponse):
     """
 
 
-class TranslateImageResponse(TypedDict):
-    success: bool
-    """
-    Indicates whether the translation was successful.
-    """
+class TranslateImageResponse(BaseResponse):
     image: bytes
     """
     The image data that was translated.