Skip to content

Commit 41aff0f

Browse files
VinciGit00claude
andcommitted
refactor: rename location_geo_code to country in search
Matches FetchConfig.country naming convention. Serializes as locationGeoCode on the wire for API compatibility. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 8e2a7fc commit 41aff0f

7 files changed

Lines changed: 15 additions & 14 deletions

File tree

scrapegraph-py/MIGRATION_V2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ response = client.search(
155155
num_results=5,
156156
prompt="Extract key findings",
157157
schema=MyModel,
158-
location_geo_code="us",
158+
country="us",
159159
time_range="past_week",
160160
)
161161
```
@@ -167,7 +167,7 @@ response = client.search(
167167
| `output_schema` | `schema` (now requires `prompt`) |
168168
| `extraction_mode` | Removed (always AI extraction) |
169169
| `stealth` | Removed (use `fetch_config=FetchConfig(mode=...)`) |
170-
| `location_geo_code` | `location_geo_code` (unchanged) |
170+
| `location_geo_code` | `country` (renamed, matches `FetchConfig.country`) |
171171
| `time_range` | `time_range` (values: `past_hour`, `past_24_hours`, `past_week`, `past_month`, `past_year`) |
172172
| `mock` | Removed |
173173
| `return_toon` | Removed |

scrapegraph-py/scrapegraph_py/async_client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ async def search(
370370
self,
371371
query: str,
372372
num_results: int = 3,
373-
location_geo_code: Optional[str] = None,
373+
country: Optional[str] = None,
374374
*,
375375
schema: Optional[Any] = None,
376376
prompt: Optional[str] = None,
@@ -384,7 +384,7 @@ async def search(
384384
Args:
385385
query: The search query
386386
num_results: Number of results (1-20, default 3)
387-
location_geo_code: Geo code for geo-targeted results
387+
country: Two-letter country code for geo-targeted results (e.g. 'us', 'it')
388388
"""
389389
logger.info(f"Searching: {query}")
390390
return await self._make_request(
@@ -393,7 +393,7 @@ async def search(
393393
json=build_search_payload(
394394
query=query,
395395
num_results=num_results,
396-
location_geo_code=location_geo_code,
396+
country=country,
397397
schema=schema,
398398
prompt=prompt,
399399
format=format,

scrapegraph-py/scrapegraph_py/client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ def search(
414414
self,
415415
query: str,
416416
num_results: int = 3,
417-
location_geo_code: Optional[str] = None,
417+
country: Optional[str] = None,
418418
*,
419419
schema: Optional[Any] = None,
420420
prompt: Optional[str] = None,
@@ -428,7 +428,7 @@ def search(
428428
Args:
429429
query: The search query
430430
num_results: Number of results (1-20, default 3)
431-
location_geo_code: Geo code for geo-targeted results
431+
country: Two-letter country code for geo-targeted results (e.g. 'us', 'it')
432432
"""
433433
logger.info(f"Searching: {query}")
434434
return self._make_request(
@@ -437,7 +437,7 @@ def search(
437437
json=build_search_payload(
438438
query=query,
439439
num_results=num_results,
440-
location_geo_code=location_geo_code,
440+
country=country,
441441
schema=schema,
442442
prompt=prompt,
443443
format=format,

scrapegraph-py/scrapegraph_py/models/search.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,11 @@ class SearchRequest(CamelModel):
3030
validation_alias="schema",
3131
description="JSON Schema defining the structure of extracted search data",
3232
)
33-
location_geo_code: Optional[str] = Field(
33+
country: Optional[str] = Field(
3434
default=None,
3535
max_length=10,
36-
description="Geo code for localized search results",
36+
serialization_alias="locationGeoCode",
37+
description="Two-letter country code for geo-targeted results (e.g. 'us', 'it')",
3738
)
3839
time_range: Optional[str] = Field(
3940
default=None,

scrapegraph-py/scrapegraph_py/utils/request_builders.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ def build_search_payload(
131131
*,
132132
query: str,
133133
num_results: int = 3,
134-
location_geo_code: Optional[str] = None,
134+
country: Optional[str] = None,
135135
schema: Optional[Any] = None,
136136
prompt: Optional[str] = None,
137137
format: str = "markdown",
@@ -148,7 +148,7 @@ def build_search_payload(
148148
format=format,
149149
mode=mode,
150150
fetch_config=fetch_config,
151-
location_geo_code=location_geo_code,
151+
country=country,
152152
time_range=time_range,
153153
)
154154
return request.model_dump()

scrapegraph-py/tests/test_async_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ async def fake_request(method, url, **kwargs):
123123
num_results=1,
124124
prompt="Extract titles",
125125
schema={"type": "object", "properties": {"title": {"type": "string"}}},
126-
location_geo_code="it",
126+
country="it",
127127
time_range="past_week",
128128
)
129129

scrapegraph-py/tests/test_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ def fake_request(method, url, **kwargs):
144144
num_results=1,
145145
prompt="Extract titles",
146146
schema={"type": "object", "properties": {"title": {"type": "string"}}},
147-
location_geo_code="it",
147+
country="it",
148148
time_range="past_week",
149149
)
150150

0 commit comments

Comments
 (0)