nimble_python 0.10.0__tar.gz → 0.12.0__tar.gz

nimble_python-0.12.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.12.0"
+}

{nimble_python-0.10.0 → nimble_python-0.12.0}/CHANGELOG.md

@@ -1,5 +1,44 @@
 # Changelog
 
+## 0.12.0 (2026-03-18)
+
+Full Changelog: [v0.11.0...v0.12.0](https://github.com/Nimbleway/nimble-python/compare/v0.11.0...v0.12.0)
+
+### Features
+
+* **api:** manual updates ([2ea15a2](https://github.com/Nimbleway/nimble-python/commit/2ea15a25dbbaecd0d19f81900c09b3cafc66aa56))
+
+
+### Bug Fixes
+
+* **deps:** bump minimum typing-extensions version ([05fce2b](https://github.com/Nimbleway/nimble-python/commit/05fce2b345c4758ec79c97b11f3ed92d53036b61))
+* **pydantic:** do not pass `by_alias` unless set ([1700093](https://github.com/Nimbleway/nimble-python/commit/170009336ff559e375736dbee881002fc4d5c0fe))
+
+
+### Chores
+
+* **internal:** tweak CI branches ([8f134ca](https://github.com/Nimbleway/nimble-python/commit/8f134ca188d5af80631adf9865f5799ca8fe0f93))
+
+## 0.11.0 (2026-03-10)
+
+Full Changelog: [v0.10.0...v0.11.0](https://github.com/Nimbleway/nimble-python/compare/v0.10.0...v0.11.0)
+
+### Features
+
+* **api:** api update ([5920fac](https://github.com/Nimbleway/nimble-python/commit/5920facd8a20c83c88ef893e7dafef6dea115239))
+* **api:** api update ([802ba25](https://github.com/Nimbleway/nimble-python/commit/802ba250e6e4681b18259305b7f9d9fac28569b6))
+
+
+### Chores
+
+* **ci:** bump uv version ([146ce46](https://github.com/Nimbleway/nimble-python/commit/146ce4600e65bd53d9dfaed8faa27483d0b13b2c))
+* **ci:** skip uploading artifacts on stainless-internal branches ([0367a98](https://github.com/Nimbleway/nimble-python/commit/0367a9816cb6178e9c769d09eff4b26bd4b8cd29))
+
+
+### Refactors
+
+* **types:** use `extra_items` from PEP 728 ([4c233b7](https://github.com/Nimbleway/nimble-python/commit/4c233b70e9763d97f5e03d196d28d951a37d1609))
+
 ## 0.10.0 (2026-02-25)
 
 Full Changelog: [v0.9.1...v0.10.0](https://github.com/Nimbleway/nimble-python/compare/v0.9.1...v0.10.0)

{nimble_python-0.10.0 → nimble_python-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nimble_python
-Version: 0.10.0
+Version: 0.12.0
 Summary: The official Python library for the nimble API
 Project-URL: Homepage, https://github.com/Nimbleway/nimble-python
 Project-URL: Repository, https://github.com/Nimbleway/nimble-python
@@ -27,7 +27,7 @@ Requires-Dist: distro<2,>=1.7.0
 Requires-Dist: httpx<1,>=0.23.0
 Requires-Dist: pydantic<3,>=1.9.0
 Requires-Dist: sniffio
-Requires-Dist: typing-extensions<5,>=4.10
+Requires-Dist: typing-extensions<5,>=4.14
 Provides-Extra: aiohttp
 Requires-Dist: aiohttp; extra == 'aiohttp'
 Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'

{nimble_python-0.10.0 → nimble_python-0.12.0}/api.md

@@ -23,13 +23,20 @@ from nimble_python.types import (
 Types:
 
 ```python
-from nimble_python.types import ExtractResponse, ExtractAsyncResponse, MapResponse, SearchResponse
+from nimble_python.types import (
+    ExtractResponse,
+    ExtractAsyncResponse,
+    ExtractBatchResponse,
+    MapResponse,
+    SearchResponse,
+)
 ```
 
 Methods:
 
 - <code title="post /v1/extract">client.<a href="./src/nimble_python/_client.py">extract</a>(\*\*<a href="src/nimble_python/types/client_extract_params.py">params</a>) -> <a href="./src/nimble_python/types/extract_response.py">ExtractResponse</a></code>
 - <code title="post /v1/extract/async">client.<a href="./src/nimble_python/_client.py">extract_async</a>(\*\*<a href="src/nimble_python/types/client_extract_async_params.py">params</a>) -> <a href="./src/nimble_python/types/extract_async_response.py">ExtractAsyncResponse</a></code>
+- <code title="post /v1/extract/batch">client.<a href="./src/nimble_python/_client.py">extract_batch</a>(\*\*<a href="src/nimble_python/types/client_extract_batch_params.py">params</a>) -> <a href="./src/nimble_python/types/extract_batch_response.py">ExtractBatchResponse</a></code>
 - <code title="post /v1/map">client.<a href="./src/nimble_python/_client.py">map</a>(\*\*<a href="src/nimble_python/types/client_map_params.py">params</a>) -> <a href="./src/nimble_python/types/map_response.py">MapResponse</a></code>
 - <code title="post /v1/search">client.<a href="./src/nimble_python/_client.py">search</a>(\*\*<a href="src/nimble_python/types/client_search_params.py">params</a>) -> <a href="./src/nimble_python/types/search_response.py">SearchResponse</a></code>
 

{nimble_python-0.10.0 → nimble_python-0.12.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nimble_python"
-version = "0.10.0"
+version = "0.12.0"
 description = "The official Python library for the nimble API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -11,7 +11,7 @@ authors = [
 dependencies = [
   "httpx>=0.23.0, <1",
   "pydantic>=1.9.0, <3",
-  "typing-extensions>=4.10, <5",
+  "typing-extensions>=4.14, <5",
   "anyio>=3.5.0, <5",
   "distro>=1.7.0, <2",
   "sniffio",

{nimble_python-0.10.0 → nimble_python-0.12.0}/src/nimble_python/_client.py

@@ -10,7 +10,13 @@ import httpx
 
 from . import _exceptions
 from ._qs import Querystring
-from .types import client_map_params, client_search_params, client_extract_params, client_extract_async_params
+from .types import (
+    client_map_params,
+    client_search_params,
+    client_extract_params,
+    client_extract_async_params,
+    client_extract_batch_params,
+)
 from ._types import (
     Body,
     Omit,
@@ -51,6 +57,7 @@ from .types.map_response import MapResponse
 from .types.search_response import SearchResponse
 from .types.extract_response import ExtractResponse
 from .types.extract_async_response import ExtractAsyncResponse
+from .types.extract_batch_response import ExtractBatchResponse
 
 if TYPE_CHECKING:
     from .resources import agent, crawl, tasks
@@ -2220,6 +2227,52 @@ class Nimble(SyncAPIClient):
             cast_to=ExtractAsyncResponse,
         )
 
+    def extract_batch(
+        self,
+        *,
+        params: Iterable[client_extract_batch_params.Param],
+        shared_params: client_extract_batch_params.SharedParams | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> ExtractBatchResponse:
+        """Extract Batch Endpoint
+
+        Args:
+          params: Array of extraction requests.
+
+        Each object represents one extraction with its own
+              parameters.
+
+          shared_params: Shared parameters applied to the entire batch, such as storage and callback
+              configuration.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self.post(
+            "/v1/extract/batch",
+            body=maybe_transform(
+                {
+                    "params": params,
+                    "shared_params": shared_params,
+                },
+                client_extract_batch_params.ClientExtractBatchParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ExtractBatchResponse,
+        )
+
     def map(
         self,
         *,
@@ -3072,7 +3125,7 @@ class Nimble(SyncAPIClient):
         query: str,
         content_type: Optional[SequenceNotStr[str]] | Omit = omit,
         country: str | Omit = omit,
-        deep_search: bool | Omit = omit,
+        deep_search: Optional[bool] | Omit = omit,
         end_date: Optional[str] | Omit = omit,
         exclude_domains: Optional[SequenceNotStr[str]] | Omit = omit,
         focus: Union[str, SequenceNotStr[str]] | Omit = omit,
@@ -3082,6 +3135,7 @@ class Nimble(SyncAPIClient):
         max_results: int | Omit = omit,
         max_subagents: int | Omit = omit,
         output_format: Literal["plain_text", "markdown", "simplified_html"] | Omit = omit,
+        search_depth: Optional[Literal["lite", "fast", "deep"]] | Omit = omit,
         start_date: Optional[str] | Omit = omit,
         time_range: Optional[Literal["hour", "day", "week", "month", "year"]] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -3103,9 +3157,7 @@ class Nimble(SyncAPIClient):
 
           country: Country code for geo-targeted results (e.g., 'US', 'GB', 'IL')
 
-          deep_search: Deep Mode (true, default): fetches full-page content for deeper analysis. Fast
-              Mode (false): returns metadata only (title, snippet, URL) for quick,
-              token-efficient results.
+          deep_search: Deprecated. Use search_depth instead. true maps to 'deep', false maps to 'lite'.
 
           end_date: Filter results before this date (format: YYYY-MM-DD or YYYY)
 
@@ -3128,6 +3180,13 @@ class Nimble(SyncAPIClient):
 
           output_format: Output format: plain_text, markdown, or simplified_html
 
+          search_depth: Controls content richness and latency of search results.
+
+              - lite: Token-efficient metadata for high-volume pipelines (title, URL,
+                description only)
+              - fast: Rich content (~2K chars) optimized for AI agents
+              - deep: Full page content via Webit scraping for comprehensive analysis
+
           start_date: Filter results after this date (format: YYYY-MM-DD or YYYY)
 
           time_range: Time range filters passed to Webit SERP API as 'time' parameter.
@@ -3157,6 +3216,7 @@ class Nimble(SyncAPIClient):
                     "max_results": max_results,
                     "max_subagents": max_subagents,
                     "output_format": output_format,
+                    "search_depth": search_depth,
                     "start_date": start_date,
                     "time_range": time_range,
                 },
@@ -5361,6 +5421,52 @@ class AsyncNimble(AsyncAPIClient):
             cast_to=ExtractAsyncResponse,
         )
 
+    async def extract_batch(
+        self,
+        *,
+        params: Iterable[client_extract_batch_params.Param],
+        shared_params: client_extract_batch_params.SharedParams | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> ExtractBatchResponse:
+        """Extract Batch Endpoint
+
+        Args:
+          params: Array of extraction requests.
+
+        Each object represents one extraction with its own
+              parameters.
+
+          shared_params: Shared parameters applied to the entire batch, such as storage and callback
+              configuration.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self.post(
+            "/v1/extract/batch",
+            body=await async_maybe_transform(
+                {
+                    "params": params,
+                    "shared_params": shared_params,
+                },
+                client_extract_batch_params.ClientExtractBatchParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ExtractBatchResponse,
+        )
+
     async def map(
         self,
         *,
@@ -6213,7 +6319,7 @@ class AsyncNimble(AsyncAPIClient):
         query: str,
         content_type: Optional[SequenceNotStr[str]] | Omit = omit,
         country: str | Omit = omit,
-        deep_search: bool | Omit = omit,
+        deep_search: Optional[bool] | Omit = omit,
         end_date: Optional[str] | Omit = omit,
         exclude_domains: Optional[SequenceNotStr[str]] | Omit = omit,
         focus: Union[str, SequenceNotStr[str]] | Omit = omit,
@@ -6223,6 +6329,7 @@ class AsyncNimble(AsyncAPIClient):
         max_results: int | Omit = omit,
         max_subagents: int | Omit = omit,
         output_format: Literal["plain_text", "markdown", "simplified_html"] | Omit = omit,
+        search_depth: Optional[Literal["lite", "fast", "deep"]] | Omit = omit,
         start_date: Optional[str] | Omit = omit,
         time_range: Optional[Literal["hour", "day", "week", "month", "year"]] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -6244,9 +6351,7 @@ class AsyncNimble(AsyncAPIClient):
 
           country: Country code for geo-targeted results (e.g., 'US', 'GB', 'IL')
 
-          deep_search: Deep Mode (true, default): fetches full-page content for deeper analysis. Fast
-              Mode (false): returns metadata only (title, snippet, URL) for quick,
-              token-efficient results.
+          deep_search: Deprecated. Use search_depth instead. true maps to 'deep', false maps to 'lite'.
 
           end_date: Filter results before this date (format: YYYY-MM-DD or YYYY)
 
@@ -6269,6 +6374,13 @@ class AsyncNimble(AsyncAPIClient):
 
           output_format: Output format: plain_text, markdown, or simplified_html
 
+          search_depth: Controls content richness and latency of search results.
+
+              - lite: Token-efficient metadata for high-volume pipelines (title, URL,
+                description only)
+              - fast: Rich content (~2K chars) optimized for AI agents
+              - deep: Full page content via Webit scraping for comprehensive analysis
+
           start_date: Filter results after this date (format: YYYY-MM-DD or YYYY)
 
           time_range: Time range filters passed to Webit SERP API as 'time' parameter.
@@ -6298,6 +6410,7 @@ class AsyncNimble(AsyncAPIClient):
                     "max_results": max_results,
                     "max_subagents": max_subagents,
                     "output_format": output_format,
+                    "search_depth": search_depth,
                     "start_date": start_date,
                     "time_range": time_range,
                 },
@@ -6355,6 +6468,9 @@ class NimbleWithRawResponse:
         self.extract_async = to_raw_response_wrapper(
             client.extract_async,
         )
+        self.extract_batch = to_raw_response_wrapper(
+            client.extract_batch,
+        )
         self.map = to_raw_response_wrapper(
             client.map,
         )
@@ -6393,6 +6509,9 @@ class AsyncNimbleWithRawResponse:
         self.extract_async = async_to_raw_response_wrapper(
             client.extract_async,
         )
+        self.extract_batch = async_to_raw_response_wrapper(
+            client.extract_batch,
+        )
         self.map = async_to_raw_response_wrapper(
             client.map,
         )
@@ -6431,6 +6550,9 @@ class NimbleWithStreamedResponse:
         self.extract_async = to_streamed_response_wrapper(
             client.extract_async,
         )
+        self.extract_batch = to_streamed_response_wrapper(
+            client.extract_batch,
+        )
         self.map = to_streamed_response_wrapper(
             client.map,
         )
@@ -6469,6 +6591,9 @@ class AsyncNimbleWithStreamedResponse:
         self.extract_async = async_to_streamed_response_wrapper(
             client.extract_async,
         )
+        self.extract_batch = async_to_streamed_response_wrapper(
+            client.extract_batch,
+        )
         self.map = async_to_streamed_response_wrapper(
             client.map,
         )

{nimble_python-0.10.0 → nimble_python-0.12.0}/src/nimble_python/_compat.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Union, Generic, TypeVar, Callable, cast, overload
 from datetime import date, datetime
-from typing_extensions import Self, Literal
+from typing_extensions import Self, Literal, TypedDict
 
 import pydantic
 from pydantic.fields import FieldInfo
@@ -131,6 +131,10 @@ def model_json(model: pydantic.BaseModel, *, indent: int | None = None) -> str:
     return model.model_dump_json(indent=indent)
 
 
+class _ModelDumpKwargs(TypedDict, total=False):
+    by_alias: bool
+
+
 def model_dump(
     model: pydantic.BaseModel,
     *,
@@ -142,6 +146,9 @@ def model_dump(
     by_alias: bool | None = None,
 ) -> dict[str, Any]:
     if (not PYDANTIC_V1) or hasattr(model, "model_dump"):
+        kwargs: _ModelDumpKwargs = {}
+        if by_alias is not None:
+            kwargs["by_alias"] = by_alias
         return model.model_dump(
             mode=mode,
             exclude=exclude,
@@ -149,7 +156,7 @@ def model_dump(
             exclude_defaults=exclude_defaults,
             # warnings are not supported in Pydantic v1
             warnings=True if PYDANTIC_V1 else warnings,
-            by_alias=by_alias,
+            **kwargs,
         )
     return cast(
         "dict[str, Any]",

{nimble_python-0.10.0 → nimble_python-0.12.0}/src/nimble_python/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "nimble_python"
-__version__ = "0.10.0"  # x-release-please-version
+__version__ = "0.12.0"  # x-release-please-version

{nimble_python-0.10.0 → nimble_python-0.12.0}/src/nimble_python/resources/agent.py

@@ -51,9 +51,10 @@ class AgentResource(SyncAPIResource):
         self,
         *,
         limit: int | Omit = omit,
-        managed_by: Optional[Literal["nimble", "community"]] | Omit = omit,
+        managed_by: Optional[Literal["nimble", "community", "self_managed"]] | Omit = omit,
         offset: int | Omit = omit,
-        privacy: Literal["public", "private", "all"] | Omit = omit,
+        privacy: Optional[Literal["public", "private", "all"]] | Omit = omit,
+        search: Optional[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,
@@ -67,12 +68,14 @@ class AgentResource(SyncAPIResource):
         Args:
           limit: Number of results per page
 
-          managed_by: Filter public templates by attribution
+          managed_by: Filter templates by attribution
 
           offset: Pagination offset
 
           privacy: Filter by privacy level
 
+          search: Search templates by name, domain, or vertical
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -94,6 +97,7 @@ class AgentResource(SyncAPIResource):
                         "managed_by": managed_by,
                         "offset": offset,
                         "privacy": privacy,
+                        "search": search,
                     },
                     agent_list_params.AgentListParams,
                 ),
@@ -261,9 +265,10 @@ class AsyncAgentResource(AsyncAPIResource):
         self,
         *,
         limit: int | Omit = omit,
-        managed_by: Optional[Literal["nimble", "community"]] | Omit = omit,
+        managed_by: Optional[Literal["nimble", "community", "self_managed"]] | Omit = omit,
         offset: int | Omit = omit,
-        privacy: Literal["public", "private", "all"] | Omit = omit,
+        privacy: Optional[Literal["public", "private", "all"]] | Omit = omit,
+        search: Optional[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,
@@ -277,12 +282,14 @@ class AsyncAgentResource(AsyncAPIResource):
         Args:
           limit: Number of results per page
 
-          managed_by: Filter public templates by attribution
+          managed_by: Filter templates by attribution
 
           offset: Pagination offset
 
           privacy: Filter by privacy level
 
+          search: Search templates by name, domain, or vertical
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -304,6 +311,7 @@ class AsyncAgentResource(AsyncAPIResource):
                         "managed_by": managed_by,
                         "offset": offset,
                         "privacy": privacy,
+                        "search": search,
                     },
                     agent_list_params.AgentListParams,
                 ),

{nimble_python-0.10.0 → nimble_python-0.12.0}/src/nimble_python/types/__init__.py

@@ -39,6 +39,8 @@ from .crawl_status_response import CrawlStatusResponse as CrawlStatusResponse
 from .task_results_response import TaskResultsResponse as TaskResultsResponse
 from .agent_run_async_params import AgentRunAsyncParams as AgentRunAsyncParams
 from .extract_async_response import ExtractAsyncResponse as ExtractAsyncResponse
+from .extract_batch_response import ExtractBatchResponse as ExtractBatchResponse
 from .agent_run_async_response import AgentRunAsyncResponse as AgentRunAsyncResponse
 from .crawl_terminate_response import CrawlTerminateResponse as CrawlTerminateResponse
 from .client_extract_async_params import ClientExtractAsyncParams as ClientExtractAsyncParams
+from .client_extract_batch_params import ClientExtractBatchParams as ClientExtractBatchParams

{nimble_python-0.10.0 → nimble_python-0.12.0}/src/nimble_python/types/agent_get_response.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, List, Optional
+from typing import List, Optional
 
 from .._models import BaseModel
 
@@ -50,6 +50,6 @@ class AgentGetResponse(BaseModel):
 
     managed_by: Optional[str] = None
 
-    output_schema: Optional[Dict[str, object]] = None
+    output_schema: Optional[object] = None
 
     vertical: Optional[str] = None

{nimble_python-0.10.0 → nimble_python-0.12.0}/src/nimble_python/types/agent_list_params.py

@@ -12,11 +12,14 @@ class AgentListParams(TypedDict, total=False):
     limit: int
     """Number of results per page"""
 
-    managed_by: Optional[Literal["nimble", "community"]]
-    """Filter public templates by attribution"""
+    managed_by: Optional[Literal["nimble", "community", "self_managed"]]
+    """Filter templates by attribution"""
 
     offset: int
     """Pagination offset"""
 
-    privacy: Literal["public", "private", "all"]
+    privacy: Optional[Literal["public", "private", "all"]]
     """Filter by privacy level"""
+
+    search: Optional[str]
+    """Search templates by name, domain, or vertical"""

{nimble_python-0.10.0 → nimble_python-0.12.0}/src/nimble_python/types/client_extract_async_params.py

@@ -999,7 +999,7 @@ BrowserAction: TypeAlias = Union[
 ]
 
 
-class CookiesUnionMember0Typed(TypedDict, total=False):
+class CookiesUnionMember0(TypedDict, total=False, extra_items=object):  # type: ignore[call-arg]
     creation: Optional[str]
 
     domain: Optional[str]
@@ -1029,9 +1029,6 @@ class CookiesUnionMember0Typed(TypedDict, total=False):
     value: str
 
 
-CookiesUnionMember0: TypeAlias = Union[CookiesUnionMember0Typed, Dict[str, object]]
-
-
 class NetworkCaptureURL(TypedDict, total=False):
     value: Required[str]