Skip to content

Commit 39d9836

Browse files
Remove "pdf" from Summarize method names
1 parent 81345e0 commit 39d9836

3 files changed

Lines changed: 24 additions & 24 deletions

File tree

src/pdfrest/client.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2132,7 +2132,7 @@ def query_pdf_info(
21322132
raw_payload = self._send_request(request)
21332133
return PdfRestInfoResponse.model_validate(raw_payload)
21342134

2135-
def summarize_pdf_text(
2135+
def summarize_text(
21362136
self,
21372137
file: PdfRestFile | Sequence[PdfRestFile],
21382138
*,
@@ -2179,7 +2179,7 @@ def summarize_pdf_text(
21792179
raw_payload = self._send_request(request)
21802180
return SummarizePdfTextResponse.model_validate(raw_payload)
21812181

2182-
def summarize_pdf_text_to_file(
2182+
def summarize_text_to_file(
21832183
self,
21842184
file: PdfRestFile | Sequence[PdfRestFile],
21852185
*,
@@ -3142,7 +3142,7 @@ async def query_pdf_info(
31423142
raw_payload = await self._send_request(request)
31433143
return PdfRestInfoResponse.model_validate(raw_payload)
31443144

3145-
async def summarize_pdf_text(
3145+
async def summarize_text(
31463146
self,
31473147
file: PdfRestFile | Sequence[PdfRestFile],
31483148
*,
@@ -3189,7 +3189,7 @@ async def summarize_pdf_text(
31893189
raw_payload = await self._send_request(request)
31903190
return SummarizePdfTextResponse.model_validate(raw_payload)
31913191

3192-
async def summarize_pdf_text_to_file(
3192+
async def summarize_text_to_file(
31933193
self,
31943194
file: PdfRestFile | Sequence[PdfRestFile],
31953195
*,

tests/live/test_live_summarize_pdf_text.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
from ..resources import get_test_resource_path
99

1010

11-
def test_live_summarize_pdf_text_success(
11+
def test_live_summarize_text_success(
1212
pdfrest_api_key: str,
1313
pdfrest_live_base_url: str,
1414
) -> None:
@@ -18,7 +18,7 @@ def test_live_summarize_pdf_text_success(
1818
base_url=pdfrest_live_base_url,
1919
) as client:
2020
uploaded = client.files.create_from_paths([resource])[0]
21-
response = client.summarize_pdf_text(
21+
response = client.summarize_text(
2222
uploaded,
2323
target_word_count=40,
2424
summary_format="overview",
@@ -29,7 +29,7 @@ def test_live_summarize_pdf_text_success(
2929
assert response.input_id == uploaded.id
3030

3131

32-
def test_live_summarize_pdf_text_to_file_success(
32+
def test_live_summarize_text_to_file_success(
3333
pdfrest_api_key: str,
3434
pdfrest_live_base_url: str,
3535
) -> None:
@@ -39,7 +39,7 @@ def test_live_summarize_pdf_text_to_file_success(
3939
base_url=pdfrest_live_base_url,
4040
) as client:
4141
uploaded = client.files.create_from_paths([resource])[0]
42-
response = client.summarize_pdf_text_to_file(
42+
response = client.summarize_text_to_file(
4343
uploaded,
4444
target_word_count=40,
4545
summary_format="overview",
@@ -56,7 +56,7 @@ def test_live_summarize_pdf_text_to_file_success(
5656

5757

5858
@pytest.mark.asyncio
59-
async def test_live_async_summarize_pdf_text_success(
59+
async def test_live_async_summarize_text_success(
6060
pdfrest_api_key: str,
6161
pdfrest_live_base_url: str,
6262
) -> None:
@@ -66,7 +66,7 @@ async def test_live_async_summarize_pdf_text_success(
6666
base_url=pdfrest_live_base_url,
6767
) as client:
6868
uploaded = (await client.files.create_from_paths([resource]))[0]
69-
response = await client.summarize_pdf_text(
69+
response = await client.summarize_text(
7070
uploaded,
7171
target_word_count=30,
7272
summary_format="overview",
@@ -77,7 +77,7 @@ async def test_live_async_summarize_pdf_text_success(
7777
assert response.input_id == uploaded.id
7878

7979

80-
def test_live_summarize_pdf_text_invalid_format(
80+
def test_live_summarize_text_invalid_format(
8181
pdfrest_api_key: str,
8282
pdfrest_live_base_url: str,
8383
) -> None:
@@ -88,14 +88,14 @@ def test_live_summarize_pdf_text_invalid_format(
8888
) as client:
8989
uploaded = client.files.create_from_paths([resource])[0]
9090
with pytest.raises(PdfRestApiError, match=r"(?i)summary"):
91-
client.summarize_pdf_text(
91+
client.summarize_text(
9292
uploaded,
9393
extra_body={"summary_format": "invalid-style"},
9494
)
9595

9696

9797
@pytest.mark.asyncio
98-
async def test_live_async_summarize_pdf_text_invalid_format(
98+
async def test_live_async_summarize_text_invalid_format(
9999
pdfrest_api_key: str,
100100
pdfrest_live_base_url: str,
101101
) -> None:
@@ -106,7 +106,7 @@ async def test_live_async_summarize_pdf_text_invalid_format(
106106
) as client:
107107
uploaded = (await client.files.create_from_paths([resource]))[0]
108108
with pytest.raises(PdfRestApiError, match=r"(?i)summary"):
109-
await client.summarize_pdf_text(
109+
await client.summarize_text(
110110
uploaded,
111111
extra_body={"summary_format": "invalid-style"},
112112
)

tests/test_summarize_pdf_text.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ def test_summarize_payload_invalid_page_range() -> None:
6666
SummarizePdfTextPayload.model_validate({"files": [file_repr], "pages": ["5-2"]})
6767

6868

69-
def test_summarize_pdf_text_json_success(monkeypatch: pytest.MonkeyPatch) -> None:
69+
def test_summarize_text_json_success(monkeypatch: pytest.MonkeyPatch) -> None:
7070
monkeypatch.delenv("PDFREST_API_KEY", raising=False)
7171
input_file = _make_text_file(str(PdfRestFileID.generate(1)))
7272
payload_dump = SummarizePdfTextPayload.model_validate(
@@ -100,7 +100,7 @@ def handler(request: httpx.Request) -> httpx.Response:
100100

101101
transport = httpx.MockTransport(handler)
102102
with PdfRestClient(api_key=VALID_API_KEY, transport=transport) as client:
103-
response = client.summarize_pdf_text(
103+
response = client.summarize_text(
104104
input_file,
105105
target_word_count=120,
106106
summary_format="bullet_points",
@@ -115,7 +115,7 @@ def handler(request: httpx.Request) -> httpx.Response:
115115
assert response.input_id == input_file.id
116116

117117

118-
def test_summarize_pdf_text_to_file_success(
118+
def test_summarize_text_to_file_success(
119119
monkeypatch: pytest.MonkeyPatch,
120120
) -> None:
121121
monkeypatch.delenv("PDFREST_API_KEY", raising=False)
@@ -158,7 +158,7 @@ def handler(request: httpx.Request) -> httpx.Response:
158158

159159
transport = httpx.MockTransport(handler)
160160
with PdfRestClient(api_key=VALID_API_KEY, transport=transport) as client:
161-
response = client.summarize_pdf_text_to_file(
161+
response = client.summarize_text_to_file(
162162
input_file,
163163
target_word_count=200,
164164
summary_format="bullet_points",
@@ -174,7 +174,7 @@ def handler(request: httpx.Request) -> httpx.Response:
174174
assert response.input_id == input_file.id
175175

176176

177-
def test_summarize_pdf_text_to_file_request_customization(
177+
def test_summarize_text_to_file_request_customization(
178178
monkeypatch: pytest.MonkeyPatch,
179179
) -> None:
180180
monkeypatch.delenv("PDFREST_API_KEY", raising=False)
@@ -223,7 +223,7 @@ def handler(request: httpx.Request) -> httpx.Response:
223223

224224
transport = httpx.MockTransport(handler)
225225
with PdfRestClient(api_key=VALID_API_KEY, transport=transport) as client:
226-
response = client.summarize_pdf_text_to_file(
226+
response = client.summarize_text_to_file(
227227
input_file,
228228
extra_query={"trace": "true"},
229229
extra_headers={"X-Debug": "sync"},
@@ -246,7 +246,7 @@ def handler(request: httpx.Request) -> httpx.Response:
246246

247247

248248
@pytest.mark.asyncio
249-
async def test_async_summarize_pdf_text_success(
249+
async def test_async_summarize_text_success(
250250
monkeypatch: pytest.MonkeyPatch,
251251
) -> None:
252252
monkeypatch.delenv("PDFREST_API_KEY", raising=False)
@@ -275,7 +275,7 @@ def handler(request: httpx.Request) -> httpx.Response:
275275

276276
transport = httpx.MockTransport(handler)
277277
async with AsyncPdfRestClient(api_key=ASYNC_API_KEY, transport=transport) as client:
278-
response = await client.summarize_pdf_text(input_file)
278+
response = await client.summarize_text(input_file)
279279

280280
assert seen == {"post": 1}
281281
assert isinstance(response, SummarizePdfTextResponse)
@@ -284,7 +284,7 @@ def handler(request: httpx.Request) -> httpx.Response:
284284

285285

286286
@pytest.mark.asyncio
287-
async def test_async_summarize_pdf_text_to_file_success(
287+
async def test_async_summarize_text_to_file_success(
288288
monkeypatch: pytest.MonkeyPatch,
289289
) -> None:
290290
monkeypatch.delenv("PDFREST_API_KEY", raising=False)
@@ -322,7 +322,7 @@ def handler(request: httpx.Request) -> httpx.Response:
322322

323323
transport = httpx.MockTransport(handler)
324324
async with AsyncPdfRestClient(api_key=ASYNC_API_KEY, transport=transport) as client:
325-
response = await client.summarize_pdf_text_to_file(input_file)
325+
response = await client.summarize_text_to_file(input_file)
326326

327327
assert seen == {"post": 1, "get": 1}
328328
assert isinstance(response, PdfRestFileBasedResponse)

0 commit comments

Comments
 (0)