feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 37
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-6dfc33639ef5ad1fd0fa05f9f00fcdd59940188ef625252c6ee9db85c6f8fc59.yml
-openapi_spec_hash: fb66e1f80fb2aad8adc4ae37d69bdc02
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-cdff38301573d05fdad8416847402472ff6cb1ce75a9de9f99e8673ddec7c4a6.yml
+openapi_spec_hash: 387fe6f53599abb0341764e00bcd0b26
 config_hash: 2bea1743c84d63bd61f8501a6ea63065

api.md

@@ -150,8 +150,8 @@ from context.dev.types import (
 
 Methods:
 
-- <code title="get /batch/{batch_id}">client.batch.<a href="./src/context/dev/resources/batch.py">retrieve</a>(batch_id, \*\*<a href="src/context/dev/types/batch_retrieve_params.py">params</a>) -> <a href="./src/context/dev/types/batch_retrieve_response.py">BatchRetrieveResponse</a></code>
+- <code title="get /batch/{batch_id}">client.batch.<a href="./src/context/dev/resources/batch.py">retrieve</a>(batch_id) -> <a href="./src/context/dev/types/batch_retrieve_response.py">BatchRetrieveResponse</a></code>
 - <code title="get /batch/list">client.batch.<a href="./src/context/dev/resources/batch.py">list</a>(\*\*<a href="src/context/dev/types/batch_list_params.py">params</a>) -> <a href="./src/context/dev/types/batch_list_response.py">BatchListResponse</a></code>
-- <code title="post /batch/{batch_id}/cancel">client.batch.<a href="./src/context/dev/resources/batch.py">cancel</a>(batch_id, \*\*<a href="src/context/dev/types/batch_cancel_params.py">params</a>) -> <a href="./src/context/dev/types/batch_cancel_response.py">BatchCancelResponse</a></code>
+- <code title="post /batch/{batch_id}/cancel">client.batch.<a href="./src/context/dev/resources/batch.py">cancel</a>(batch_id) -> <a href="./src/context/dev/types/batch_cancel_response.py">BatchCancelResponse</a></code>
 - <code title="get /batch/{batch_id}/results">client.batch.<a href="./src/context/dev/resources/batch.py">get_results</a>(batch_id, \*\*<a href="src/context/dev/types/batch_get_results_params.py">params</a>) -> <a href="./src/context/dev/types/batch_get_results_response.py">BatchGetResultsResponse</a></code>
 - <code title="post /people/retrieve">client.batch.<a href="./src/context/dev/resources/batch.py">submit</a>(\*\*<a href="src/context/dev/types/batch_submit_params.py">params</a>) -> <a href="./src/context/dev/types/batch_submit_response.py">BatchSubmitResponse</a></code>

src/context/dev/resources/batch.py

@@ -6,13 +6,7 @@
 
 import httpx
 
-from ..types import (
-    batch_list_params,
-    batch_cancel_params,
-    batch_submit_params,
-    batch_retrieve_params,
-    batch_get_results_params,
-)
+from ..types import batch_list_params, batch_submit_params, batch_get_results_params
 from .._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
 from .._utils import path_template, maybe_transform, async_maybe_transform
 from .._compat import cached_property
@@ -57,7 +51,6 @@ def retrieve(
         self,
         batch_id: str,
         *,
-        tags: SequenceNotStr[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -74,10 +67,6 @@ def retrieve(
         Args:
           batch_id: ID of the batch to retrieve or cancel.
 
-          tags: Optional comma-separated caller-defined tags for tracking this request. Tags are
-              recorded on the request's usage log and can be used to filter usage on the
-              dashboard usage page. Up to 20 tags, each 1-50 characters.
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -91,11 +80,7 @@ def retrieve(
         return self._get(
             path_template("/batch/{batch_id}", batch_id=batch_id),
             options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                query=maybe_transform({"tags": tags}, batch_retrieve_params.BatchRetrieveParams),
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
             cast_to=BatchRetrieveResponse,
         )
@@ -105,8 +90,10 @@ def list(
         *,
         cursor: str | Omit = omit,
         limit: int | Omit = omit,
+        q: str | Omit = omit,
+        search_type: Literal["exact", "prefix"] | Omit = omit,
         status: Literal["queued", "running", "cancelling", "completed", "cancelled", "failed"] | Omit = omit,
-        tags: SequenceNotStr[str] | Omit = omit,
+        tags: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -124,11 +111,15 @@ def list(
 
           limit: Batches per page. Defaults to 25.
 
+          q: Free-text search term, matched against the batch id, crawl source (start URL or
+              sitemap domain), and tags.
+
+          search_type: `prefix` for as-you-type prefix matching (default), `exact` for full-token
+              matching.
+
           status: Filter by status.
 
-          tags: Optional comma-separated caller-defined tags for tracking this request. Tags are
-              recorded on the request's usage log and can be used to filter usage on the
-              dashboard usage page. Up to 20 tags, each 1-50 characters.
+          tags: Comma-separated list of tags to filter by (matches batches having any of them).
 
           extra_headers: Send extra headers
 
@@ -149,6 +140,8 @@ def list(
                     {
                         "cursor": cursor,
                         "limit": limit,
+                        "q": q,
+                        "search_type": search_type,
                         "status": status,
                         "tags": tags,
                     },
@@ -162,7 +155,6 @@ def cancel(
         self,
         batch_id: str,
         *,
-        tags: SequenceNotStr[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -178,10 +170,6 @@ def cancel(
         Args:
           batch_id: ID of the batch to retrieve or cancel.
 
-          tags: Optional comma-separated caller-defined tags for tracking this request. Tags are
-              recorded on the request's usage log and can be used to filter usage on the
-              dashboard usage page. Up to 20 tags, each 1-50 characters.
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -195,11 +183,7 @@ def cancel(
         return self._post(
             path_template("/batch/{batch_id}/cancel", batch_id=batch_id),
             options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                query=maybe_transform({"tags": tags}, batch_cancel_params.BatchCancelParams),
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
             cast_to=BatchCancelResponse,
         )
@@ -210,7 +194,6 @@ def get_results(
         *,
         cursor: str | Omit = omit,
         limit: int | Omit = omit,
-        tags: SequenceNotStr[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -231,10 +214,6 @@ def get_results(
           limit: Records per page. Defaults to 25. A page can close early so its payload stays
               under ~8 MB; rely on next_cursor rather than counting records.
 
-          tags: Optional comma-separated caller-defined tags for tracking this request. Tags are
-              recorded on the request's usage log and can be used to filter usage on the
-              dashboard usage page. Up to 20 tags, each 1-50 characters.
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -256,7 +235,6 @@ def get_results(
                     {
                         "cursor": cursor,
                         "limit": limit,
-                        "tags": tags,
                     },
                     batch_get_results_params.BatchGetResultsParams,
                 ),
@@ -338,7 +316,6 @@ async def retrieve(
         self,
         batch_id: str,
         *,
-        tags: SequenceNotStr[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -355,10 +332,6 @@ async def retrieve(
         Args:
           batch_id: ID of the batch to retrieve or cancel.
 
-          tags: Optional comma-separated caller-defined tags for tracking this request. Tags are
-              recorded on the request's usage log and can be used to filter usage on the
-              dashboard usage page. Up to 20 tags, each 1-50 characters.
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -372,11 +345,7 @@ async def retrieve(
         return await self._get(
             path_template("/batch/{batch_id}", batch_id=batch_id),
             options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                query=await async_maybe_transform({"tags": tags}, batch_retrieve_params.BatchRetrieveParams),
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
             cast_to=BatchRetrieveResponse,
         )
@@ -386,8 +355,10 @@ async def list(
         *,
         cursor: str | Omit = omit,
         limit: int | Omit = omit,
+        q: str | Omit = omit,
+        search_type: Literal["exact", "prefix"] | Omit = omit,
         status: Literal["queued", "running", "cancelling", "completed", "cancelled", "failed"] | Omit = omit,
-        tags: SequenceNotStr[str] | Omit = omit,
+        tags: str | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -405,11 +376,15 @@ async def list(
 
           limit: Batches per page. Defaults to 25.
 
+          q: Free-text search term, matched against the batch id, crawl source (start URL or
+              sitemap domain), and tags.
+
+          search_type: `prefix` for as-you-type prefix matching (default), `exact` for full-token
+              matching.
+
           status: Filter by status.
 
-          tags: Optional comma-separated caller-defined tags for tracking this request. Tags are
-              recorded on the request's usage log and can be used to filter usage on the
-              dashboard usage page. Up to 20 tags, each 1-50 characters.
+          tags: Comma-separated list of tags to filter by (matches batches having any of them).
 
           extra_headers: Send extra headers
 
@@ -430,6 +405,8 @@ async def list(
                     {
                         "cursor": cursor,
                         "limit": limit,
+                        "q": q,
+                        "search_type": search_type,
                         "status": status,
                         "tags": tags,
                     },
@@ -443,7 +420,6 @@ async def cancel(
         self,
         batch_id: str,
         *,
-        tags: SequenceNotStr[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -459,10 +435,6 @@ async def cancel(
         Args:
           batch_id: ID of the batch to retrieve or cancel.
 
-          tags: Optional comma-separated caller-defined tags for tracking this request. Tags are
-              recorded on the request's usage log and can be used to filter usage on the
-              dashboard usage page. Up to 20 tags, each 1-50 characters.
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -476,11 +448,7 @@ async def cancel(
         return await self._post(
             path_template("/batch/{batch_id}/cancel", batch_id=batch_id),
             options=make_request_options(
-                extra_headers=extra_headers,
-                extra_query=extra_query,
-                extra_body=extra_body,
-                timeout=timeout,
-                query=await async_maybe_transform({"tags": tags}, batch_cancel_params.BatchCancelParams),
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
             cast_to=BatchCancelResponse,
         )
@@ -491,7 +459,6 @@ async def get_results(
         *,
         cursor: str | Omit = omit,
         limit: int | Omit = omit,
-        tags: SequenceNotStr[str] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -512,10 +479,6 @@ async def get_results(
           limit: Records per page. Defaults to 25. A page can close early so its payload stays
               under ~8 MB; rely on next_cursor rather than counting records.
 
-          tags: Optional comma-separated caller-defined tags for tracking this request. Tags are
-              recorded on the request's usage log and can be used to filter usage on the
-              dashboard usage page. Up to 20 tags, each 1-50 characters.
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -537,7 +500,6 @@ async def get_results(
                     {
                         "cursor": cursor,
                         "limit": limit,
-                        "tags": tags,
                     },
                     batch_get_results_params.BatchGetResultsParams,
                 ),

src/context/dev/types/__init__.py

@@ -6,7 +6,6 @@
 from .batch_list_params import BatchListParams as BatchListParams
 from .web_search_params import WebSearchParams as WebSearchParams
 from .web_extract_params import WebExtractParams as WebExtractParams
-from .batch_cancel_params import BatchCancelParams as BatchCancelParams
 from .batch_list_response import BatchListResponse as BatchListResponse
 from .batch_submit_params import BatchSubmitParams as BatchSubmitParams
 from .monitor_list_params import MonitorListParams as MonitorListParams
@@ -15,7 +14,6 @@
 from .monitor_run_response import MonitorRunResponse as MonitorRunResponse
 from .web_extract_response import WebExtractResponse as WebExtractResponse
 from .batch_cancel_response import BatchCancelResponse as BatchCancelResponse
-from .batch_retrieve_params import BatchRetrieveParams as BatchRetrieveParams
 from .batch_submit_response import BatchSubmitResponse as BatchSubmitResponse
 from .brand_retrieve_params import BrandRetrieveParams as BrandRetrieveParams
 from .monitor_create_params import MonitorCreateParams as MonitorCreateParams

src/context/dev/types/batch_cancel_params.py

@@ -147,6 +147,9 @@ class BatchCancelResponse(BaseModel):
     status: Literal["queued", "running", "cancelling", "completed", "cancelled", "failed"]
     """Current state. `completed`, `cancelled`, and `failed` are final."""
 
+    tags: List[str]
+    """Tags stored on the batch at submission."""
+
     timing: Timing
 
     type: Literal["markdown", "html"]

src/context/dev/types/batch_cancel_response.py

@@ -4,8 +4,6 @@
 
 from typing_extensions import TypedDict
 
-from .._types import SequenceNotStr
-
 __all__ = ["BatchGetResultsParams"]
 
 
@@ -19,10 +17,3 @@ class BatchGetResultsParams(TypedDict, total=False):
     Defaults to 25. A page can close early so its payload stays under ~8 MB; rely on
     next_cursor rather than counting records.
     """
-
-    tags: SequenceNotStr[str]
-    """Optional comma-separated caller-defined tags for tracking this request.
-
-    Tags are recorded on the request's usage log and can be used to filter usage on
-    the dashboard usage page. Up to 20 tags, each 1-50 characters.
-    """

src/context/dev/types/batch_get_results_params.py

@@ -4,8 +4,6 @@
 
 from typing_extensions import Literal, TypedDict
 
-from .._types import SequenceNotStr
-
 __all__ = ["BatchListParams"]
 
 
@@ -16,12 +14,20 @@ class BatchListParams(TypedDict, total=False):
     limit: int
     """Batches per page. Defaults to 25."""
 
+    q: str
+    """
+    Free-text search term, matched against the batch id, crawl source (start URL or
+    sitemap domain), and tags.
+    """
+
+    search_type: Literal["exact", "prefix"]
+    """
+    `prefix` for as-you-type prefix matching (default), `exact` for full-token
+    matching.
+    """
+
     status: Literal["queued", "running", "cancelling", "completed", "cancelled", "failed"]
     """Filter by status."""
 
-    tags: SequenceNotStr[str]
-    """Optional comma-separated caller-defined tags for tracking this request.
-
-    Tags are recorded on the request's usage log and can be used to filter usage on
-    the dashboard usage page. Up to 20 tags, each 1-50 characters.
-    """
+    tags: str
+    """Comma-separated list of tags to filter by (matches batches having any of them)."""