Skip to content

Add exclude location fields #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ipenywis merged 2 commits into from
Jan 5, 2026
Merged

Add exclude location fields #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbd05b8
feat: add new exclusion fields for the articles endpoint
ipenywis Jan 5, 2026
a274971
fix: the api.mustache template to always include exclude_none=True fo…
ipenywis Jan 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 74 additions & 7 deletions perigon/api/v1_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -747,9 +747,13 @@ def search_articles(
lon: Optional[float] = None,
max_distance: Optional[float] = None,
source_city: Optional[List[str]] = None,
exclude_source_city: Optional[List[str]] = None,
source_county: Optional[List[str]] = None,
exclude_source_county: Optional[List[str]] = None,
source_country: Optional[List[str]] = None,
exclude_source_country: Optional[List[str]] = None,
source_state: Optional[List[str]] = None,
exclude_source_state: Optional[List[str]] = None,
source_lat: Optional[float] = None,
source_lon: Optional[float] = None,
source_max_distance: Optional[float] = None,
Expand Down Expand Up @@ -841,9 +845,13 @@ def search_articles(
lon (Optional[float]): Float. Longitude of the center point to search places
max_distance (Optional[float]): Float. Maximum distance (in km) from starting point to search articles by tagged places
source_city (Optional[List[str]]): String Array. Find articles published by sources that are located within a given city.
exclude_source_city (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified cities.
source_county (Optional[List[str]]): String Array. Find articles published by sources that are located within a given county.
exclude_source_county (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified counties.
source_country (Optional[List[str]]): String Array. Find articles published by sources that are located within a given country. Must be 2 character country code (i.e. us, gb, etc).
exclude_source_country (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified countries. Must be 2 character country codes (e.g., us, gb).
source_state (Optional[List[str]]): String Array. Find articles published by sources that are located within a given state.
exclude_source_state (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified states.
source_lat (Optional[float]): Float. Latitude of the center point to search articles created by local publications.
source_lon (Optional[float]): Float. Latitude of the center point to search articles created by local publications.
source_max_distance (Optional[float]): Float. Maximum distance from starting point to search articles created by local publications.
Expand Down Expand Up @@ -996,12 +1004,20 @@ def search_articles(
params["maxDistance"] = max_distance
if source_city is not None:
params["sourceCity"] = source_city
if exclude_source_city is not None:
params["excludeSourceCity"] = exclude_source_city
if source_county is not None:
params["sourceCounty"] = source_county
if exclude_source_county is not None:
params["excludeSourceCounty"] = exclude_source_county
if source_country is not None:
params["sourceCountry"] = source_country
if exclude_source_country is not None:
params["excludeSourceCountry"] = exclude_source_country
if source_state is not None:
params["sourceState"] = source_state
if exclude_source_state is not None:
params["excludeSourceState"] = exclude_source_state
if source_lat is not None:
params["sourceLat"] = source_lat
if source_lon is not None:
Expand Down Expand Up @@ -1126,9 +1142,13 @@ async def search_articles_async(
lon: Optional[float] = None,
max_distance: Optional[float] = None,
source_city: Optional[List[str]] = None,
exclude_source_city: Optional[List[str]] = None,
source_county: Optional[List[str]] = None,
exclude_source_county: Optional[List[str]] = None,
source_country: Optional[List[str]] = None,
exclude_source_country: Optional[List[str]] = None,
source_state: Optional[List[str]] = None,
exclude_source_state: Optional[List[str]] = None,
source_lat: Optional[float] = None,
source_lon: Optional[float] = None,
source_max_distance: Optional[float] = None,
Expand Down Expand Up @@ -1220,9 +1240,13 @@ async def search_articles_async(
lon (Optional[float]): Float. Longitude of the center point to search places
max_distance (Optional[float]): Float. Maximum distance (in km) from starting point to search articles by tagged places
source_city (Optional[List[str]]): String Array. Find articles published by sources that are located within a given city.
exclude_source_city (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified cities.
source_county (Optional[List[str]]): String Array. Find articles published by sources that are located within a given county.
exclude_source_county (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified counties.
source_country (Optional[List[str]]): String Array. Find articles published by sources that are located within a given country. Must be 2 character country code (i.e. us, gb, etc).
exclude_source_country (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified countries. Must be 2 character country codes (e.g., us, gb).
source_state (Optional[List[str]]): String Array. Find articles published by sources that are located within a given state.
exclude_source_state (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified states.
source_lat (Optional[float]): Float. Latitude of the center point to search articles created by local publications.
source_lon (Optional[float]): Float. Latitude of the center point to search articles created by local publications.
source_max_distance (Optional[float]): Float. Maximum distance from starting point to search articles created by local publications.
Expand Down Expand Up @@ -1374,12 +1398,20 @@ async def search_articles_async(
params["maxDistance"] = max_distance
if source_city is not None:
params["sourceCity"] = source_city
if exclude_source_city is not None:
params["excludeSourceCity"] = exclude_source_city
if source_county is not None:
params["sourceCounty"] = source_county
if exclude_source_county is not None:
params["excludeSourceCounty"] = exclude_source_county
if source_country is not None:
params["sourceCountry"] = source_country
if exclude_source_country is not None:
params["excludeSourceCountry"] = exclude_source_country
if source_state is not None:
params["sourceState"] = source_state
if exclude_source_state is not None:
params["excludeSourceState"] = exclude_source_state
if source_lat is not None:
params["sourceLat"] = source_lat
if source_lon is not None:
Expand Down Expand Up @@ -1904,7 +1936,7 @@ def search_sources(
show_num_results: Optional[bool] = None,
) -> SourceSearchResult:
"""
Search and filter the 142,000+ media sources available via the Perigon API. The result includes a list of individual media sources that were matched to your specific criteria.
Search and filter the 200,000+ media sources available via the Perigon API. The result includes a list of individual media sources that were matched to your specific criteria.

Args:
domain (Optional[List[str]]): String Array. Filter by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com, us?.nytimes.com). Multiple values create an OR filter.
Expand Down Expand Up @@ -2023,7 +2055,7 @@ async def search_sources_async(
show_num_results: Optional[bool] = None,
) -> SourceSearchResult:
"""
Async variant of search_sources. Search and filter the 142,000+ media sources available via the Perigon API. The result includes a list of individual media sources that were matched to your specific criteria.
Async variant of search_sources. Search and filter the 200,000+ media sources available via the Perigon API. The result includes a list of individual media sources that were matched to your specific criteria.

Args:
domain (Optional[List[str]]): String Array. Filter by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com, us?.nytimes.com). Multiple values create an OR filter.
Expand Down Expand Up @@ -2602,9 +2634,13 @@ def search_summarizer(
lon: Optional[float] = None,
max_distance: Optional[float] = None,
source_city: Optional[List[str]] = None,
exclude_source_city: Optional[List[str]] = None,
source_county: Optional[List[str]] = None,
exclude_source_county: Optional[List[str]] = None,
source_country: Optional[List[str]] = None,
exclude_source_country: Optional[List[str]] = None,
source_state: Optional[List[str]] = None,
exclude_source_state: Optional[List[str]] = None,
source_lat: Optional[float] = None,
source_lon: Optional[float] = None,
source_max_distance: Optional[float] = None,
Expand Down Expand Up @@ -2697,9 +2733,13 @@ def search_summarizer(
lon (Optional[float]): Float. Longitude of the center point to search places
max_distance (Optional[float]): Float. Maximum distance (in km) from starting point to search articles by tagged places
source_city (Optional[List[str]]): String Array. Find articles published by sources that are located within a given city.
exclude_source_city (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified cities.
source_county (Optional[List[str]]): String Array. Find articles published by sources that are located within a given county.
exclude_source_county (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified counties.
source_country (Optional[List[str]]): String Array. Find articles published by sources that are located within a given country. Must be 2 character country code (i.e. us, gb, etc).
exclude_source_country (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified countries. Must be 2 character country codes (e.g., us, gb).
source_state (Optional[List[str]]): String Array. Find articles published by sources that are located within a given state.
exclude_source_state (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified states.
source_lat (Optional[float]): Float. Latitude of the center point to search articles created by local publications.
source_lon (Optional[float]): Float. Latitude of the center point to search articles created by local publications.
source_max_distance (Optional[float]): Float. Maximum distance from starting point to search articles created by local publications.
Expand Down Expand Up @@ -2852,12 +2892,20 @@ def search_summarizer(
params["maxDistance"] = max_distance
if source_city is not None:
params["sourceCity"] = source_city
if exclude_source_city is not None:
params["excludeSourceCity"] = exclude_source_city
if source_county is not None:
params["sourceCounty"] = source_county
if exclude_source_county is not None:
params["excludeSourceCounty"] = exclude_source_county
if source_country is not None:
params["sourceCountry"] = source_country
if exclude_source_country is not None:
params["excludeSourceCountry"] = exclude_source_country
if source_state is not None:
params["sourceState"] = source_state
if exclude_source_state is not None:
params["excludeSourceState"] = exclude_source_state
if source_lat is not None:
params["sourceLat"] = source_lat
if source_lon is not None:
Expand Down Expand Up @@ -2988,9 +3036,13 @@ async def search_summarizer_async(
lon: Optional[float] = None,
max_distance: Optional[float] = None,
source_city: Optional[List[str]] = None,
exclude_source_city: Optional[List[str]] = None,
source_county: Optional[List[str]] = None,
exclude_source_county: Optional[List[str]] = None,
source_country: Optional[List[str]] = None,
exclude_source_country: Optional[List[str]] = None,
source_state: Optional[List[str]] = None,
exclude_source_state: Optional[List[str]] = None,
source_lat: Optional[float] = None,
source_lon: Optional[float] = None,
source_max_distance: Optional[float] = None,
Expand Down Expand Up @@ -3083,9 +3135,13 @@ async def search_summarizer_async(
lon (Optional[float]): Float. Longitude of the center point to search places
max_distance (Optional[float]): Float. Maximum distance (in km) from starting point to search articles by tagged places
source_city (Optional[List[str]]): String Array. Find articles published by sources that are located within a given city.
exclude_source_city (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified cities.
source_county (Optional[List[str]]): String Array. Find articles published by sources that are located within a given county.
exclude_source_county (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified counties.
source_country (Optional[List[str]]): String Array. Find articles published by sources that are located within a given country. Must be 2 character country code (i.e. us, gb, etc).
exclude_source_country (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified countries. Must be 2 character country codes (e.g., us, gb).
source_state (Optional[List[str]]): String Array. Find articles published by sources that are located within a given state.
exclude_source_state (Optional[List[str]]): String Array. Excludes articles published by sources that are located within the specified states.
source_lat (Optional[float]): Float. Latitude of the center point to search articles created by local publications.
source_lon (Optional[float]): Float. Latitude of the center point to search articles created by local publications.
source_max_distance (Optional[float]): Float. Maximum distance from starting point to search articles created by local publications.
Expand Down Expand Up @@ -3237,12 +3293,20 @@ async def search_summarizer_async(
params["maxDistance"] = max_distance
if source_city is not None:
params["sourceCity"] = source_city
if exclude_source_city is not None:
params["excludeSourceCity"] = exclude_source_city
if source_county is not None:
params["sourceCounty"] = source_county
if exclude_source_county is not None:
params["excludeSourceCounty"] = exclude_source_county
if source_country is not None:
params["sourceCountry"] = source_country
if exclude_source_country is not None:
params["excludeSourceCountry"] = exclude_source_country
if source_state is not None:
params["sourceState"] = source_state
if exclude_source_state is not None:
params["excludeSourceState"] = exclude_source_state
if source_lat is not None:
params["sourceLat"] = source_lat
if source_lon is not None:
Expand Down Expand Up @@ -3304,7 +3368,10 @@ async def search_summarizer_async(
params = _normalise_query(params)

resp = await self.api_client.request_async(
"POST", path, params=params, json=summary_body.model_dump(by_alias=True)
"POST",
path,
params=params,
json=summary_body.model_dump(by_alias=True, exclude_none=True),
)
resp.raise_for_status()
return SummarySearchResult.model_validate(resp.json())
Expand Down Expand Up @@ -3673,7 +3740,7 @@ def vector_search_articles(
"POST",
path,
params=params,
json=article_search_params.model_dump(by_alias=True),
json=article_search_params.model_dump(by_alias=True, exclude_none=True),
)
resp.raise_for_status()
return ArticlesVectorSearchResult.model_validate(resp.json())
Expand Down Expand Up @@ -3701,7 +3768,7 @@ async def vector_search_articles_async(
"POST",
path,
params=params,
json=article_search_params.model_dump(by_alias=True),
json=article_search_params.model_dump(by_alias=True, exclude_none=True),
)
resp.raise_for_status()
return ArticlesVectorSearchResult.model_validate(resp.json())
Expand Down Expand Up @@ -3730,7 +3797,7 @@ def vector_search_wikipedia(
"POST",
path,
params=params,
json=wikipedia_search_params.model_dump(by_alias=True),
json=wikipedia_search_params.model_dump(by_alias=True, exclude_none=True),
)
resp.raise_for_status()
return WikipediaVectorSearchResult.model_validate(resp.json())
Expand Down Expand Up @@ -3758,7 +3825,7 @@ async def vector_search_wikipedia_async(
"POST",
path,
params=params,
json=wikipedia_search_params.model_dump(by_alias=True),
json=wikipedia_search_params.model_dump(by_alias=True, exclude_none=True),
)
resp.raise_for_status()
return WikipediaVectorSearchResult.model_validate(resp.json())
6 changes: 4 additions & 2 deletions templates/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,8 @@ class {{classname}}:
resp = self.api_client.request(
"{{httpMethod}}",
path,
params=params{{#bodyParam}}, json={{paramName}}.model_dump(by_alias=True){{/bodyParam}}
params=params{{#bodyParam}},
json={{paramName}}.model_dump(by_alias=True, exclude_none=True),{{/bodyParam}}
)
resp.raise_for_status()
{{#returnType}}
Expand Down Expand Up @@ -157,7 +158,8 @@ class {{classname}}:
resp = await self.api_client.request_async(
"{{httpMethod}}",
path,
params=params{{#bodyParam}}, json={{paramName}}.model_dump(by_alias=True){{/bodyParam}}
params=params{{#bodyParam}},
json={{paramName}}.model_dump(by_alias=True, exclude_none=True),{{/bodyParam}}
)
resp.raise_for_status()
{{#returnType}}
Expand Down
4 changes: 2 additions & 2 deletions tests/integration/test_v1api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ def test_vector_search(api: V1Api):


def test_summarizer(api: V1Api):
# Use gpt-4o-mini which is more stable and widely supported
summary_body = SummaryBody()
# Uses gpt-4o-mini by default which is more stable and widely supported
summary_body = SummaryBody(model="gpt-4o-mini")
result = api.search_summarizer(
summary_body=summary_body,
q="AI",
Expand Down