fix(scrape): retain highlight headings only when needed (#1245)

Stainless-Generated-From: ec16bbc

Author: stlc-bot

src/context/dev/types/web_scrape_params.py

@@ -107,7 +107,10 @@ class Formats(TypedDict, total=False):
     """The original HTTP response body."""
 
     highlights: bool
-    """Relevant passages for your question or topic. Adds 3 credits."""
+    """
+    Relevant passages for your question or topic, with headings included when needed
+    for context. Adds 3 credits.
+    """
 
     html: bool
     """Rendered HTML."""

src/context/dev/types/web_scrape_response.py

@@ -69,7 +69,10 @@ class CacheMetadata(BaseModel):
 
 
 class Highlights(BaseModel):
-    """Relevant passages for your question or topic."""
+    """Relevant passages for your question or topic, in page order.
+
+    A heading in square brackets is included when needed to interpret a passage. Empty when the page has no text.
+    """
 
     data: Optional[List[str]] = None
 
@@ -346,7 +349,11 @@ class WebScrapeResponse(BaseModel):
     """
 
     highlights: Highlights
-    """Relevant passages for your question or topic."""
+    """Relevant passages for your question or topic, in page order.
+
+    A heading in square brackets is included when needed to interpret a passage.
+    Empty when the page has no text.
+    """
 
     html: HTML
     """Rendered HTML after content filters."""