feat(scrape): enable highlights with zero data retention (#1246)

Stainless-Generated-From: ccb4e99

Author: stlc-bot

src/context/dev/resources/web.py

@@ -465,8 +465,7 @@ def scrape(
               when using return-partial.
 
           zdr: Zero data retention. Bypasses caches and uploads; excludes request/response
-              content and tags from logs. Must be enabled for your organization. Not available
-              with the highlights output.
+              content and tags from logs. Must be enabled for your organization.
 
           extra_headers: Send extra headers
 
@@ -1961,8 +1960,7 @@ async def scrape(
               when using return-partial.
 
           zdr: Zero data retention. Bypasses caches and uploads; excludes request/response
-              content and tags from logs. Must be enabled for your organization. Not available
-              with the highlights output.
+              content and tags from logs. Must be enabled for your organization.
 
           extra_headers: Send extra headers
 

src/context/dev/types/web_scrape_params.py

@@ -96,8 +96,7 @@ class WebScrapeParams(TypedDict, total=False):
     """Zero data retention.
 
     Bypasses caches and uploads; excludes request/response content and tags from
-    logs. Must be enabled for your organization. Not available with the highlights
-    output.
+    logs. Must be enabled for your organization.
     """
 
 
@@ -108,11 +107,7 @@ class Formats(TypedDict, total=False):
     """The original HTTP response body."""
 
     highlights: bool
-    """
-    Plain-text passages from the page that are most relevant to
-    highlightsParams.query, each prefixed with its section heading. Adds 3 credits.
-    Not available with zdr enabled.
-    """
+    """Relevant passages for your question or topic. Adds 3 credits."""
 
     html: bool
     """Rendered HTML."""
@@ -121,12 +116,7 @@ class Formats(TypedDict, total=False):
     """Images found on the page."""
 
     json: bool
-    """
-    Page data extracted by an LLM from the page Markdown into jsonParams.schema;
-    values carried only in attributes or CSS classes need formats.parse instead.
-    Adds four credits when the page has text to extract; when shared content filters
-    leave no text the result is an empty object and only the base price applies.
-    """
+    """Page data extracted using your schema. Adds 4 credits."""
 
     markdown: bool
     """Page content as Markdown."""
@@ -135,7 +125,7 @@ class Formats(TypedDict, total=False):
     """Fields selected by parseParams.rules."""
 
     product: bool
-    """Structured product data for product detail pages. Adds one credit."""
+    """Product details such as name, price, and availability. Adds 1 credit."""
 
     screenshot: bool
     """An inline image of the page."""

src/context/dev/types/web_scrape_response.py

@@ -69,9 +69,7 @@ class CacheMetadata(BaseModel):
 
 
 class Highlights(BaseModel):
-    """
-    Plain-text passages relevant to highlightsParams.query, in page order, each prefixed with its section heading in square brackets. Empty when the page has no text.
-    """
+    """Relevant passages for your question or topic."""
 
     data: Optional[List[str]] = None
 
@@ -117,10 +115,7 @@ class Images(BaseModel):
 
 
 class Json(BaseModel):
-    """Page data extracted into jsonParams.schema, after shared content filters.
-
-    Values are grounded in the page; optional fields the page does not state are omitted, or null when their type allows null. An empty object when the filters leave no text.
-    """
+    """Page data extracted using your schema."""
 
     data: Optional[Dict[str, object]] = None
 
@@ -311,7 +306,7 @@ class ProductData(BaseModel):
 
 
 class Product(BaseModel):
-    """Product detail page classification and the extracted product."""
+    """Product details found on the page."""
 
     data: Optional[ProductData] = None
 
@@ -351,11 +346,7 @@ class WebScrapeResponse(BaseModel):
     """
 
     highlights: Highlights
-    """
-    Plain-text passages relevant to highlightsParams.query, in page order, each
-    prefixed with its section heading in square brackets. Empty when the page has no
-    text.
-    """
+    """Relevant passages for your question or topic."""
 
     html: HTML
     """Rendered HTML after content filters."""
@@ -364,12 +355,7 @@ class WebScrapeResponse(BaseModel):
     """Images after content filters. Empty when none are found."""
 
     json_: Json = FieldInfo(alias="json")
-    """Page data extracted into jsonParams.schema, after shared content filters.
-
-    Values are grounded in the page; optional fields the page does not state are
-    omitted, or null when their type allows null. An empty object when the filters
-    leave no text.
-    """
+    """Page data extracted using your schema."""
 
     markdown: Markdown
     """Markdown after content filters."""
@@ -381,7 +367,7 @@ class WebScrapeResponse(BaseModel):
     """Fields produced by parseParams.rules, after shared content filters."""
 
     product: Product
-    """Product detail page classification and the extracted product."""
+    """Product details found on the page."""
 
     request_id: str
     """Unique id of this API call, also sent in the X-Request-Id response header.