feat: Polish and publish the Config Registry API

Stainless-Generated-From: c13de5a1ff00481bd0125cfd74527f4bae1a301f

Author: kernel-internal[bot]

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 163
+configured_endpoints: 164

api.md

@@ -109,6 +109,7 @@ Methods:
 
 - <code title="get /config-registry/analyses/{id}">client.config_registry.analyses.<a href="./src/kernel/resources/config_registry/analyses.py">retrieve</a>(id) -> <a href="./src/kernel/types/config_registry_response.py">ConfigRegistryResponse</a></code>
 - <code title="get /config-registry/analyses">client.config_registry.analyses.<a href="./src/kernel/resources/config_registry/analyses.py">list</a>(\*\*<a href="src/kernel/types/config_registry/analysis_list_params.py">params</a>) -> <a href="./src/kernel/types/analysis_summary.py">SyncOffsetPagination[AnalysisSummary]</a></code>
+- <code title="post /config-registry/analyses/{id}/cancel">client.config_registry.analyses.<a href="./src/kernel/resources/config_registry/analyses.py">cancel</a>(id) -> <a href="./src/kernel/types/config_registry_response.py">ConfigRegistryResponse</a></code>
 
 # Browsers
 

src/kernel/resources/config_registry/analyses.py

@@ -126,6 +126,43 @@ def list(
             model=AnalysisSummary,
         )
 
+    def cancel(
+        self,
+        id: str,
+        *,
+        # 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,
+    ) -> ConfigRegistryResponse:
+        """Requests cancellation of a running project-scoped analysis.
+
+        Cancellation is
+        asynchronous; poll the analysis until its status becomes canceled. Repeating the
+        request after the analysis reaches a terminal state returns the existing
+        outcome.
+
+        Args:
+          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
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._post(
+            path_template("/config-registry/analyses/{id}/cancel", id=id),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ConfigRegistryResponse,
+        )
+
 
 class AsyncAnalysesResource(AsyncAPIResource):
     """Resolve browser and proxy recommendations for bot-protected sites."""
@@ -230,6 +267,43 @@ def list(
             model=AnalysisSummary,
         )
 
+    async def cancel(
+        self,
+        id: str,
+        *,
+        # 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,
+    ) -> ConfigRegistryResponse:
+        """Requests cancellation of a running project-scoped analysis.
+
+        Cancellation is
+        asynchronous; poll the analysis until its status becomes canceled. Repeating the
+        request after the analysis reaches a terminal state returns the existing
+        outcome.
+
+        Args:
+          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
+        """
+        if not id:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._post(
+            path_template("/config-registry/analyses/{id}/cancel", id=id),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=ConfigRegistryResponse,
+        )
+
 
 class AnalysesResourceWithRawResponse:
     def __init__(self, analyses: AnalysesResource) -> None:
@@ -241,6 +315,9 @@ def __init__(self, analyses: AnalysesResource) -> None:
         self.list = to_raw_response_wrapper(
             analyses.list,
         )
+        self.cancel = to_raw_response_wrapper(
+            analyses.cancel,
+        )
 
 
 class AsyncAnalysesResourceWithRawResponse:
@@ -253,6 +330,9 @@ def __init__(self, analyses: AsyncAnalysesResource) -> None:
         self.list = async_to_raw_response_wrapper(
             analyses.list,
         )
+        self.cancel = async_to_raw_response_wrapper(
+            analyses.cancel,
+        )
 
 
 class AnalysesResourceWithStreamingResponse:
@@ -265,6 +345,9 @@ def __init__(self, analyses: AnalysesResource) -> None:
         self.list = to_streamed_response_wrapper(
             analyses.list,
         )
+        self.cancel = to_streamed_response_wrapper(
+            analyses.cancel,
+        )
 
 
 class AsyncAnalysesResourceWithStreamingResponse:
@@ -277,3 +360,6 @@ def __init__(self, analyses: AsyncAnalysesResource) -> None:
         self.list = async_to_streamed_response_wrapper(
             analyses.list,
         )
+        self.cancel = async_to_streamed_response_wrapper(
+            analyses.cancel,
+        )

src/kernel/resources/config_registry/config_registry.py

@@ -190,8 +190,9 @@ def resolve(
               any non-HTTPS destination as off-site and will not drive an http one. Kernel
               uses it to drive the browser further into the site, where it can observe
               protections that only appear once a session interacts. When this target already
-              has a verified configuration, the run confirms that one instead of re-deriving
-              the whole matrix, so supplying an intent narrows what can be recommended.
+              has a recommended configuration, the run confirms that one instead of
+              re-deriving the whole matrix, so supplying an intent narrows what can be
+              recommended.
 
           extra_headers: Send extra headers
 
@@ -374,8 +375,9 @@ async def resolve(
               any non-HTTPS destination as off-site and will not drive an http one. Kernel
               uses it to drive the browser further into the site, where it can observe
               protections that only appear once a session interacts. When this target already
-              has a verified configuration, the run confirms that one instead of re-deriving
-              the whole matrix, so supplying an intent narrows what can be recommended.
+              has a recommended configuration, the run confirms that one instead of
+              re-deriving the whole matrix, so supplying an intent narrows what can be
+              recommended.
 
           extra_headers: Send extra headers
 

src/kernel/types/config_registry_resolve_params.py

@@ -27,6 +27,7 @@ class ConfigRegistryResolveParams(TypedDict, total=False):
     any non-HTTPS destination as off-site and will not drive an http one. Kernel
     uses it to drive the browser further into the site, where it can observe
     protections that only appear once a session interacts. When this target already
-    has a verified configuration, the run confirms that one instead of re-deriving
-    the whole matrix, so supplying an intent narrows what can be recommended.
+    has a recommended configuration, the run confirms that one instead of
+    re-deriving the whole matrix, so supplying an intent narrows what can be
+    recommended.
     """

src/kernel/types/evidence.py

@@ -30,9 +30,9 @@ class Evidence(BaseModel):
     success_rate: float
     """Accessed trials divided by judged trials. Inconclusive trials are excluded."""
 
-    last_verified_at: Optional[datetime] = None
-    """Most recent contributing run where this config met the success threshold.
-
-    Omitted for knowledge assembled from runs that did not independently meet the
-    threshold.
+    last_supported_at: Optional[datetime] = None
+    """
+    Most recent contributing run whose evidence supported recommending this
+    configuration. Omitted when no individual run independently met the
+    recommendation threshold.
     """

src/kernel/types/recommendation.py

@@ -17,7 +17,11 @@ class Recommendation(BaseModel):
     evidence: Evidence
 
     match_scope: Literal["exact", "host", "domain"]
-    """Specificity of knowledge matched for this recommendation."""
+    """Specificity of knowledge matched for this recommendation.
+
+    Exact matches use knowledge for the requested target; host and domain matches
+    use broader fallback knowledge.
+    """
 
     matched_target: str
     """Target value that supplied the recommendation."""
@@ -26,10 +30,3 @@ class Recommendation(BaseModel):
     """Proxy recipe for the recommended browser."""
 
     type: Literal["recommendation"]
-
-    verification: Literal["verified", "inferred"]
-    """
-    Exact matches meet the evidence threshold; host and domain fallbacks are
-    inferred. Check evidence.last_verified_at for successful verification age and
-    last_observed_at for the latest evidence.
-    """

tests/api_resources/config_registry/test_analyses.py

@@ -98,6 +98,48 @@ def test_streaming_response_list(self, client: Kernel) -> None:
 
         assert cast(Any, response.is_closed) is True
 
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_method_cancel(self, client: Kernel) -> None:
+        analysis = client.config_registry.analyses.cancel(
+            "id",
+        )
+        assert_matches_type(ConfigRegistryResponse, analysis, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_raw_response_cancel(self, client: Kernel) -> None:
+        response = client.config_registry.analyses.with_raw_response.cancel(
+            "id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        analysis = response.parse()
+        assert_matches_type(ConfigRegistryResponse, analysis, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_streaming_response_cancel(self, client: Kernel) -> None:
+        with client.config_registry.analyses.with_streaming_response.cancel(
+            "id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            analysis = response.parse()
+            assert_matches_type(ConfigRegistryResponse, analysis, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    def test_path_params_cancel(self, client: Kernel) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
+            client.config_registry.analyses.with_raw_response.cancel(
+                "",
+            )
+
 
 class TestAsyncAnalyses:
     parametrize = pytest.mark.parametrize(
@@ -183,3 +225,45 @@ async def test_streaming_response_list(self, async_client: AsyncKernel) -> None:
             assert_matches_type(AsyncOffsetPagination[AnalysisSummary], analysis, path=["response"])
 
         assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_method_cancel(self, async_client: AsyncKernel) -> None:
+        analysis = await async_client.config_registry.analyses.cancel(
+            "id",
+        )
+        assert_matches_type(ConfigRegistryResponse, analysis, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_raw_response_cancel(self, async_client: AsyncKernel) -> None:
+        response = await async_client.config_registry.analyses.with_raw_response.cancel(
+            "id",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        analysis = await response.parse()
+        assert_matches_type(ConfigRegistryResponse, analysis, path=["response"])
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_streaming_response_cancel(self, async_client: AsyncKernel) -> None:
+        async with async_client.config_registry.analyses.with_streaming_response.cancel(
+            "id",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            analysis = await response.parse()
+            assert_matches_type(ConfigRegistryResponse, analysis, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @pytest.mark.skip(reason="Mock server tests are disabled")
+    @parametrize
+    async def test_path_params_cancel(self, async_client: AsyncKernel) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `id` but received ''"):
+            await async_client.config_registry.analyses.with_raw_response.cancel(
+                "",
+            )