SurfSense/surfsense_backend/app/capabilities/google_maps/reviews/schemas.py
DESKTOP-RTLN3BA\$punk 80927a2872 feat(billing): meter platform scrapers per item; consolidate web scraping onto web.crawl
Add per-item, per-platform billing for the platform-native connectors (Reddit, Google Search, Google Maps places/reviews, YouTube videos/comments) through the capability gate/charge seam. Rates are config-driven with a shared wallet-credit module (wallet_credit) and a dedicated PlatformScrapeCreditService; agent and REST capability runs now record cost_micros. Google Maps scrape dual-meters places and attached reviews.

Remove the main-agent scrape_webpage tool now that the web.crawl capability covers single-page (maxCrawlDepth=0) and site crawling. The main agent now reaches crawling via task(web_crawler, ...). Update prompts, tool catalog, receipts, skills, proprietary docs, and tests; drop the obsolete chat-turn crawl fold path.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-05 17:08:01 -07:00

79 lines
2.4 KiB
Python

"""``google_maps.reviews`` I/O contracts.
A lean surface over ``GoogleMapsReviewsInput``; the scraper's ``ReviewItem`` is
reused verbatim as the output element.
"""
from __future__ import annotations
from typing import Literal
from pydantic import BaseModel, Field, model_validator
from app.proprietary.platforms.google_maps import ReviewItem
MAX_MAPS_REVIEW_SOURCES = 20
"""Per-call cap on urls + place_ids: bounds how many places one request harvests."""
class ReviewsInput(BaseModel):
urls: list[str] = Field(
default_factory=list,
max_length=MAX_MAPS_REVIEW_SOURCES,
description=(
"Google Maps place URLs to fetch reviews for. Provide these OR "
"place_ids (at least one is required)."
),
)
place_ids: list[str] = Field(
default_factory=list,
max_length=MAX_MAPS_REVIEW_SOURCES,
description=(
"Known Google place IDs (ChIJ...) to fetch reviews for. Provide "
"these OR urls."
),
)
max_reviews: int = Field(
default=20,
ge=1,
le=100_000,
description="Max reviews to return per place.",
)
sort_by: Literal["newest", "mostRelevant", "highestRanking", "lowestRanking"] = (
Field(
default="newest",
description="Review ordering.",
)
)
language: str = Field(
default="en",
description="Review language code, e.g. 'en', 'fr'.",
)
start_date: str | None = Field(
default=None,
description="Only reviews on/after this ISO date, e.g. '2024-01-01'.",
)
@model_validator(mode="after")
def _require_a_source(self) -> ReviewsInput:
if not (self.urls or self.place_ids):
raise ValueError("Provide at least one of 'urls' or 'place_ids'.")
return self
@property
def estimated_units(self) -> int:
"""Worst-case billable reviews for the pre-flight gate: up to
``max_reviews`` per source place."""
return (len(self.urls) + len(self.place_ids)) * self.max_reviews
class ReviewsOutput(BaseModel):
items: list[ReviewItem] = Field(
default_factory=list,
description="One item per review, in the scraper's emission order.",
)
@property
def billable_units(self) -> int:
"""One returned review = one billable unit."""
return len(self.items)