feat: Ai-assistants: support pattern in canary deploy

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 1035
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/telnyx/telnyx-055a1979f5ac02203769967c4a310711c597b14ac7ffcb8be8e0e869ebd9ca55.yml
-openapi_spec_hash: 60bfd254a4c29087c75e7c58022db884
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/telnyx/telnyx-570b7881c5b3801b01f22d8af31055ee48aad4b73f535dd62e6d68979e6d9fdb.yml
+openapi_spec_hash: 19ff50775de609b633c05d3b834cd765
 config_hash: cfdc548410473bb526a8fc846ec89e39

api.md

@@ -698,7 +698,7 @@ Methods:
 Types:
 
 ```python
-from telnyx.types.ai.assistants import CanaryDeploy, CanaryDeployResponse, VersionConfig
+from telnyx.types.ai.assistants import CanaryDeploy, CanaryDeployResponse
 ```
 
 Methods:

src/telnyx/resources/ai/assistants/canary_deploys.py

@@ -6,7 +6,7 @@
 
 import httpx
 
-from ...._types import Body, Query, Headers, NoneType, NotGiven, not_given
+from ...._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given
 from ...._utils import path_template, maybe_transform, async_maybe_transform
 from ...._compat import cached_property
 from ...._resource import SyncAPIResource, AsyncAPIResource
@@ -18,7 +18,6 @@
 )
 from ...._base_client import make_request_options
 from ....types.ai.assistants import canary_deploy_create_params, canary_deploy_update_params
-from ....types.ai.assistants.version_config_param import VersionConfigParam
 from ....types.ai.assistants.canary_deploy_response import CanaryDeployResponse
 
 __all__ = ["CanaryDeploysResource", "AsyncCanaryDeploysResource"]
@@ -50,7 +49,7 @@ def create(
         self,
         assistant_id: str,
         *,
-        versions: Iterable[VersionConfigParam],
+        rules: Iterable[canary_deploy_create_params.Rule] | 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,
@@ -65,8 +64,6 @@ def create(
         traffic percentages for A/B testing or gradual rollouts of assistant versions.
 
         Args:
-          versions: List of version configurations
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -79,7 +76,7 @@ def create(
             raise ValueError(f"Expected a non-empty value for `assistant_id` but received {assistant_id!r}")
         return self._post(
             path_template("/ai/assistants/{assistant_id}/canary-deploys", assistant_id=assistant_id),
-            body=maybe_transform({"versions": versions}, canary_deploy_create_params.CanaryDeployCreateParams),
+            body=maybe_transform({"rules": rules}, canary_deploy_create_params.CanaryDeployCreateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -126,7 +123,7 @@ def update(
         self,
         assistant_id: str,
         *,
-        versions: Iterable[VersionConfigParam],
+        rules: Iterable[canary_deploy_update_params.Rule] | 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,
@@ -142,8 +139,6 @@ def update(
         request.
 
         Args:
-          versions: List of version configurations
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -156,7 +151,7 @@ def update(
             raise ValueError(f"Expected a non-empty value for `assistant_id` but received {assistant_id!r}")
         return self._put(
             path_template("/ai/assistants/{assistant_id}/canary-deploys", assistant_id=assistant_id),
-            body=maybe_transform({"versions": versions}, canary_deploy_update_params.CanaryDeployUpdateParams),
+            body=maybe_transform({"rules": rules}, canary_deploy_update_params.CanaryDeployUpdateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -226,7 +221,7 @@ async def create(
         self,
         assistant_id: str,
         *,
-        versions: Iterable[VersionConfigParam],
+        rules: Iterable[canary_deploy_create_params.Rule] | 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,
@@ -241,8 +236,6 @@ async def create(
         traffic percentages for A/B testing or gradual rollouts of assistant versions.
 
         Args:
-          versions: List of version configurations
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -255,9 +248,7 @@ async def create(
             raise ValueError(f"Expected a non-empty value for `assistant_id` but received {assistant_id!r}")
         return await self._post(
             path_template("/ai/assistants/{assistant_id}/canary-deploys", assistant_id=assistant_id),
-            body=await async_maybe_transform(
-                {"versions": versions}, canary_deploy_create_params.CanaryDeployCreateParams
-            ),
+            body=await async_maybe_transform({"rules": rules}, canary_deploy_create_params.CanaryDeployCreateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -304,7 +295,7 @@ async def update(
         self,
         assistant_id: str,
         *,
-        versions: Iterable[VersionConfigParam],
+        rules: Iterable[canary_deploy_update_params.Rule] | 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,
@@ -320,8 +311,6 @@ async def update(
         request.
 
         Args:
-          versions: List of version configurations
-
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -334,9 +323,7 @@ async def update(
             raise ValueError(f"Expected a non-empty value for `assistant_id` but received {assistant_id!r}")
         return await self._put(
             path_template("/ai/assistants/{assistant_id}/canary-deploys", assistant_id=assistant_id),
-            body=await async_maybe_transform(
-                {"versions": versions}, canary_deploy_update_params.CanaryDeployUpdateParams
-            ),
+            body=await async_maybe_transform({"rules": rules}, canary_deploy_update_params.CanaryDeployUpdateParams),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

src/telnyx/types/ai/assistants/__init__.py

@@ -5,7 +5,6 @@
 from .event_status import EventStatus as EventStatus
 from .assistant_test import AssistantTest as AssistantTest
 from .tag_add_params import TagAddParams as TagAddParams
-from .version_config import VersionConfig as VersionConfig
 from .tag_add_response import TagAddResponse as TagAddResponse
 from .test_list_params import TestListParams as TestListParams
 from .tool_test_params import ToolTestParams as ToolTestParams
@@ -14,7 +13,6 @@
 from .test_update_params import TestUpdateParams as TestUpdateParams
 from .tool_test_response import ToolTestResponse as ToolTestResponse
 from .tag_remove_response import TagRemoveResponse as TagRemoveResponse
-from .version_config_param import VersionConfigParam as VersionConfigParam
 from .version_update_params import VersionUpdateParams as VersionUpdateParams
 from .canary_deploy_response import CanaryDeployResponse as CanaryDeployResponse
 from .version_retrieve_params import VersionRetrieveParams as VersionRetrieveParams

src/telnyx/types/ai/assistants/canary_deploy_create_params.py

@@ -3,13 +3,69 @@
 from __future__ import annotations
 
 from typing import Iterable
-from typing_extensions import Required, TypedDict
+from typing_extensions import Literal, Required, TypedDict
 
-from .version_config_param import VersionConfigParam
+from ...._types import SequenceNotStr
 
-__all__ = ["CanaryDeployCreateParams"]
+__all__ = ["CanaryDeployCreateParams", "Rule", "RuleServe", "RuleServeRollout", "RuleMatch"]
 
 
 class CanaryDeployCreateParams(TypedDict, total=False):
-    versions: Required[Iterable[VersionConfigParam]]
-    """List of version configurations"""
+    rules: Iterable[Rule]
+
+
+class RuleServeRollout(TypedDict, total=False):
+    """One slot in a percentage rollout."""
+
+    version_id: Required[str]
+
+    weight: Required[float]
+
+
+class RuleServe(TypedDict, total=False):
+    """What a rule serves when matched.
+
+    Exactly one of:
+    - ``version_id`` — serve a specific version
+    - ``rollout`` — weighted random across versions; weights must sum to
+      less than 100, with the leftover routing to the main version
+    """
+
+    rollout: Iterable[RuleServeRollout]
+
+    version_id: str
+
+
+class RuleMatch(TypedDict, total=False):
+    """A single attribute/operator/values check.
+
+    A clause matches when the routing context's value for ``attribute``
+    satisfies ``operator`` against any of ``values``.
+    """
+
+    attribute: Required[str]
+    """Attribute name from the routing context"""
+
+    operator: Required[Literal["in", "not_in", "starts_with"]]
+    """Match operator"""
+
+    values: Required[SequenceNotStr[str]]
+
+
+class Rule(TypedDict, total=False):
+    """A targeting rule: ``match`` clauses (AND) gate ``serve``.
+
+    An empty ``match`` is a catch-all (always fires).
+    """
+
+    serve: Required[RuleServe]
+    """What a rule serves when matched.
+
+    Exactly one of:
+
+    - `version_id` — serve a specific version
+    - `rollout` — weighted random across versions; weights must sum to less than
+      100, with the leftover routing to the main version
+    """
+
+    match: Iterable[RuleMatch]

src/telnyx/types/ai/assistants/canary_deploy_response.py

@@ -1,21 +1,81 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List
+from typing import List, Optional
 from datetime import datetime
+from typing_extensions import Literal
 
 from ...._models import BaseModel
-from .version_config import VersionConfig
 
-__all__ = ["CanaryDeployResponse"]
+__all__ = ["CanaryDeployResponse", "Rule", "RuleServe", "RuleServeRollout", "RuleMatch"]
+
+
+class RuleServeRollout(BaseModel):
+    """One slot in a percentage rollout."""
+
+    version_id: str
+
+    weight: float
+
+
+class RuleServe(BaseModel):
+    """What a rule serves when matched.
+
+    Exactly one of:
+    - ``version_id`` — serve a specific version
+    - ``rollout`` — weighted random across versions; weights must sum to
+      less than 100, with the leftover routing to the main version
+    """
+
+    rollout: Optional[List[RuleServeRollout]] = None
+
+    version_id: Optional[str] = None
+
+
+class RuleMatch(BaseModel):
+    """A single attribute/operator/values check.
+
+    A clause matches when the routing context's value for ``attribute``
+    satisfies ``operator`` against any of ``values``.
+    """
+
+    attribute: str
+    """Attribute name from the routing context"""
+
+    operator: Literal["in", "not_in", "starts_with"]
+    """Match operator"""
+
+    values: List[str]
+
+
+class Rule(BaseModel):
+    """A targeting rule: ``match`` clauses (AND) gate ``serve``.
+
+    An empty ``match`` is a catch-all (always fires).
+    """
+
+    serve: RuleServe
+    """What a rule serves when matched.
+
+    Exactly one of:
+
+    - `version_id` — serve a specific version
+    - `rollout` — weighted random across versions; weights must sum to less than
+      100, with the leftover routing to the main version
+    """
+
+    match: Optional[List[RuleMatch]] = None
 
 
 class CanaryDeployResponse(BaseModel):
-    """Response model for canary deploy operations."""
+    """Response shape.
+
+    Always carries ``rules`` (canonical).
+    """
 
     assistant_id: str
 
     created_at: datetime
 
-    updated_at: datetime
+    rules: List[Rule]
 
-    versions: List[VersionConfig]
+    updated_at: datetime

src/telnyx/types/ai/assistants/canary_deploy_update_params.py

@@ -3,13 +3,69 @@
 from __future__ import annotations
 
 from typing import Iterable
-from typing_extensions import Required, TypedDict
+from typing_extensions import Literal, Required, TypedDict
 
-from .version_config_param import VersionConfigParam
+from ...._types import SequenceNotStr
 
-__all__ = ["CanaryDeployUpdateParams"]
+__all__ = ["CanaryDeployUpdateParams", "Rule", "RuleServe", "RuleServeRollout", "RuleMatch"]
 
 
 class CanaryDeployUpdateParams(TypedDict, total=False):
-    versions: Required[Iterable[VersionConfigParam]]
-    """List of version configurations"""
+    rules: Iterable[Rule]
+
+
+class RuleServeRollout(TypedDict, total=False):
+    """One slot in a percentage rollout."""
+
+    version_id: Required[str]
+
+    weight: Required[float]
+
+
+class RuleServe(TypedDict, total=False):
+    """What a rule serves when matched.
+
+    Exactly one of:
+    - ``version_id`` — serve a specific version
+    - ``rollout`` — weighted random across versions; weights must sum to
+      less than 100, with the leftover routing to the main version
+    """
+
+    rollout: Iterable[RuleServeRollout]
+
+    version_id: str
+
+
+class RuleMatch(TypedDict, total=False):
+    """A single attribute/operator/values check.
+
+    A clause matches when the routing context's value for ``attribute``
+    satisfies ``operator`` against any of ``values``.
+    """
+
+    attribute: Required[str]
+    """Attribute name from the routing context"""
+
+    operator: Required[Literal["in", "not_in", "starts_with"]]
+    """Match operator"""
+
+    values: Required[SequenceNotStr[str]]
+
+
+class Rule(TypedDict, total=False):
+    """A targeting rule: ``match`` clauses (AND) gate ``serve``.
+
+    An empty ``match`` is a catch-all (always fires).
+    """
+
+    serve: Required[RuleServe]
+    """What a rule serves when matched.
+
+    Exactly one of:
+
+    - `version_id` — serve a specific version
+    - `rollout` — weighted random across versions; weights must sum to less than
+      100, with the leftover routing to the main version
+    """
+
+    match: Iterable[RuleMatch]