feat: Accept a workload intent and use it to widen vendor coverage

Stainless-Generated-From: 3973041af0408ac2efd51b5cfe1c472ab6708c7b

Author: kernel-internal[bot]

src/kernel/resources/config_registry/config_registry.py

@@ -165,6 +165,7 @@ def resolve(
         *,
         url: str,
         allowed_proxy_countries: SequenceNotStr[str] | Omit = omit,
+        intent: 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,
@@ -184,6 +185,14 @@ def resolve(
               configuration. Kernel may test a subset of allowed countries. When omitted,
               Kernel uses its default country selection.
 
+          intent: Plain-language description of the workload you intend to run against this
+              target, in a sentence or two. Requires an https target, because the pass treats
+              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.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -198,6 +207,7 @@ def resolve(
                 {
                     "url": url,
                     "allowed_proxy_countries": allowed_proxy_countries,
+                    "intent": intent,
                 },
                 config_registry_resolve_params.ConfigRegistryResolveParams,
             ),
@@ -339,6 +349,7 @@ async def resolve(
         *,
         url: str,
         allowed_proxy_countries: SequenceNotStr[str] | Omit = omit,
+        intent: 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,
@@ -358,6 +369,14 @@ async def resolve(
               configuration. Kernel may test a subset of allowed countries. When omitted,
               Kernel uses its default country selection.
 
+          intent: Plain-language description of the workload you intend to run against this
+              target, in a sentence or two. Requires an https target, because the pass treats
+              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.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -372,6 +391,7 @@ async def resolve(
                 {
                     "url": url,
                     "allowed_proxy_countries": allowed_proxy_countries,
+                    "intent": intent,
                 },
                 config_registry_resolve_params.ConfigRegistryResolveParams,
             ),

src/kernel/types/config_registry_resolve_params.py

@@ -19,3 +19,14 @@ class ConfigRegistryResolveParams(TypedDict, total=False):
     configuration. Kernel may test a subset of allowed countries. When omitted,
     Kernel uses its default country selection.
     """
+
+    intent: str
+    """
+    Plain-language description of the workload you intend to run against this
+    target, in a sentence or two. Requires an https target, because the pass treats
+    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.
+    """

src/kernel/types/config_registry_response.py

@@ -1,6 +1,7 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 from typing import Optional
+from typing_extensions import Literal
 
 from .target import Target
 from .._models import BaseModel
@@ -29,3 +30,12 @@ class ConfigRegistryResponse(BaseModel):
     prevented success is useful without a configuration. Not verified against this
     target. Null when nothing applicable was observed or no notes exist.
     """
+
+    workload_outcome: Optional[
+        Literal["completed", "turn_limit", "auth_required", "payment_required", "blocked", "error"]
+    ] = None
+    """How far the workload pass got, when an intent was supplied and a pass ran.
+
+    A run outcome rather than advice, so it is reported whether or not any guidance
+    could be assembled. Null when no intent was supplied or no pass ran.
+    """

tests/api_resources/test_config_registry.py

@@ -119,6 +119,7 @@ def test_method_resolve_with_all_params(self, client: Kernel) -> None:
         config_registry = client.config_registry.resolve(
             url="https://example.com",
             allowed_proxy_countries=["US"],
+            intent="search for a black hoodie and add it to the cart",
         )
         assert_matches_type(ConfigRegistryResponse, config_registry, path=["response"])
 
@@ -251,6 +252,7 @@ async def test_method_resolve_with_all_params(self, async_client: AsyncKernel) -
         config_registry = await async_client.config_registry.resolve(
             url="https://example.com",
             allowed_proxy_countries=["US"],
+            intent="search for a black hoodie and add it to the cart",
         )
         assert_matches_type(ConfigRegistryResponse, config_registry, path=["response"])