Skip to content

Commit 8e2a7fc

Browse files
VinciGit00claude
andcommitted
fix: align search defaults and migration doc with v2 API contract
- Default num_results changed from 5 to 3 to match API schema - Fix migration doc: location_geo_code and time_range are NOT removed - Add prompt, location_geo_code, time_range to migration example Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 5b62652 commit 8e2a7fc

5 files changed

Lines changed: 16 additions & 11 deletions

File tree

scrapegraph-py/MIGRATION_V2.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -153,22 +153,27 @@ result = client.get_searchscraper(request_id)
153153
response = client.search(
154154
query="What is the latest version of Python?",
155155
num_results=5,
156+
prompt="Extract key findings",
156157
schema=MyModel,
158+
location_geo_code="us",
159+
time_range="past_week",
157160
)
158161
```
159162

160163
| v1 parameter | v2 equivalent |
161164
|---|---|
162165
| `user_prompt` | `query` |
163-
| `num_results` | `num_results` (unchanged) |
164-
| `output_schema` | `schema` |
166+
| `num_results` | `num_results` (unchanged, default changed from 5 to 3) |
167+
| `output_schema` | `schema` (now requires `prompt`) |
165168
| `extraction_mode` | Removed (always AI extraction) |
166-
| `stealth` | Removed (use `fetch_config=FetchConfig(mode=...)` on other endpoints) |
167-
| `location_geo_code` | Removed |
168-
| `time_range` | Removed |
169+
| `stealth` | Removed (use `fetch_config=FetchConfig(mode=...)`) |
170+
| `location_geo_code` | `location_geo_code` (unchanged) |
171+
| `time_range` | `time_range` (values: `past_hour`, `past_24_hours`, `past_week`, `past_month`, `past_year`) |
169172
| `mock` | Removed |
170173
| `return_toon` | Removed |
171174

175+
New parameters in v2: `format`, `mode`, `prompt`, `fetch_config`.
176+
172177
> **Note:** `get_searchscraper()` has been removed.
173178
174179
---

scrapegraph-py/scrapegraph_py/async_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ async def extract(
369369
async def search(
370370
self,
371371
query: str,
372-
num_results: int = 5,
372+
num_results: int = 3,
373373
location_geo_code: Optional[str] = None,
374374
*,
375375
schema: Optional[Any] = None,
@@ -383,7 +383,7 @@ async def search(
383383
384384
Args:
385385
query: The search query
386-
num_results: Number of results (3-20, default 5)
386+
num_results: Number of results (1-20, default 3)
387387
location_geo_code: Geo code for geo-targeted results
388388
"""
389389
logger.info(f"Searching: {query}")

scrapegraph-py/scrapegraph_py/client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ def extract(
413413
def search(
414414
self,
415415
query: str,
416-
num_results: int = 5,
416+
num_results: int = 3,
417417
location_geo_code: Optional[str] = None,
418418
*,
419419
schema: Optional[Any] = None,
@@ -427,7 +427,7 @@ def search(
427427
428428
Args:
429429
query: The search query
430-
num_results: Number of results (1-20, default 5)
430+
num_results: Number of results (1-20, default 3)
431431
location_geo_code: Geo code for geo-targeted results
432432
"""
433433
logger.info(f"Searching: {query}")

scrapegraph-py/scrapegraph_py/models/search.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ class SearchRequest(CamelModel):
1212

1313
query: str = Field(..., description="The search query")
1414
num_results: conint(ge=1, le=20) = Field(
15-
default=5, description="Number of results to return (1-20)"
15+
default=3, description="Number of results to return (1-20)"
1616
)
1717
format: str = Field(default="markdown", description="Search scrape format")
1818
mode: str = Field(default="prune", description="HTML processing mode")

scrapegraph-py/scrapegraph_py/utils/request_builders.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ def build_extract_payload(
130130
def build_search_payload(
131131
*,
132132
query: str,
133-
num_results: int = 5,
133+
num_results: int = 3,
134134
location_geo_code: Optional[str] = None,
135135
schema: Optional[Any] = None,
136136
prompt: Optional[str] = None,

0 commit comments

Comments
 (0)