feat(types): replace List[str] with SequenceNotStr in params

Author: stainless-app[bot]

src/contextual/_utils/_transform.py

@@ -16,6 +16,7 @@
     lru_cache,
     is_mapping,
     is_iterable,
+    is_sequence,
 )
 from .._files import is_base64_file_input
 from ._typing import (
@@ -24,6 +25,7 @@
     extract_type_arg,
     is_iterable_type,
     is_required_type,
+    is_sequence_type,
     is_annotated_type,
     strip_annotated_type,
 )
@@ -184,6 +186,8 @@ def _transform_recursive(
         (is_list_type(stripped_type) and is_list(data))
         # Iterable[T]
         or (is_iterable_type(stripped_type) and is_iterable(data) and not isinstance(data, str))
+        # Sequence[T]
+        or (is_sequence_type(stripped_type) and is_sequence(data) and not isinstance(data, str))
     ):
         # dicts are technically iterable, but it is an iterable on the keys of the dict and is not usually
         # intended as an iterable, so we don't transform it.
@@ -346,6 +350,8 @@ async def _async_transform_recursive(
         (is_list_type(stripped_type) and is_list(data))
         # Iterable[T]
         or (is_iterable_type(stripped_type) and is_iterable(data) and not isinstance(data, str))
+        # Sequence[T]
+        or (is_sequence_type(stripped_type) and is_sequence(data) and not isinstance(data, str))
     ):
         # dicts are technically iterable, but it is an iterable on the keys of the dict and is not usually
         # intended as an iterable, so we don't transform it.

src/contextual/resources/agents/agents.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Any, List, cast
+from typing import Any, cast
 
 import httpx
 
@@ -15,7 +15,7 @@
     AsyncQueryResourceWithStreamingResponse,
 )
 from ...types import agent_list_params, agent_create_params, agent_update_params
-from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven, SequenceNotStr
 from ..._utils import maybe_transform, async_maybe_transform
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -64,12 +64,12 @@ def create(
         *,
         name: str,
         agent_configs: AgentConfigsParam | NotGiven = NOT_GIVEN,
-        datastore_ids: List[str] | NotGiven = NOT_GIVEN,
+        datastore_ids: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         description: str | NotGiven = NOT_GIVEN,
         filter_prompt: str | NotGiven = NOT_GIVEN,
         multiturn_system_prompt: str | NotGiven = NOT_GIVEN,
         no_retrieval_system_prompt: str | NotGiven = NOT_GIVEN,
-        suggested_queries: List[str] | NotGiven = NOT_GIVEN,
+        suggested_queries: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         system_prompt: str | NotGiven = NOT_GIVEN,
         # 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.
@@ -156,12 +156,12 @@ def update(
         agent_id: str,
         *,
         agent_configs: AgentConfigsParam | NotGiven = NOT_GIVEN,
-        datastore_ids: List[str] | NotGiven = NOT_GIVEN,
+        datastore_ids: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         filter_prompt: str | NotGiven = NOT_GIVEN,
         llm_model_id: str | NotGiven = NOT_GIVEN,
         multiturn_system_prompt: str | NotGiven = NOT_GIVEN,
         no_retrieval_system_prompt: str | NotGiven = NOT_GIVEN,
-        suggested_queries: List[str] | NotGiven = NOT_GIVEN,
+        suggested_queries: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         system_prompt: str | NotGiven = NOT_GIVEN,
         # 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.
@@ -462,12 +462,12 @@ async def create(
         *,
         name: str,
         agent_configs: AgentConfigsParam | NotGiven = NOT_GIVEN,
-        datastore_ids: List[str] | NotGiven = NOT_GIVEN,
+        datastore_ids: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         description: str | NotGiven = NOT_GIVEN,
         filter_prompt: str | NotGiven = NOT_GIVEN,
         multiturn_system_prompt: str | NotGiven = NOT_GIVEN,
         no_retrieval_system_prompt: str | NotGiven = NOT_GIVEN,
-        suggested_queries: List[str] | NotGiven = NOT_GIVEN,
+        suggested_queries: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         system_prompt: str | NotGiven = NOT_GIVEN,
         # 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.
@@ -554,12 +554,12 @@ async def update(
         agent_id: str,
         *,
         agent_configs: AgentConfigsParam | NotGiven = NOT_GIVEN,
-        datastore_ids: List[str] | NotGiven = NOT_GIVEN,
+        datastore_ids: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         filter_prompt: str | NotGiven = NOT_GIVEN,
         llm_model_id: str | NotGiven = NOT_GIVEN,
         multiturn_system_prompt: str | NotGiven = NOT_GIVEN,
         no_retrieval_system_prompt: str | NotGiven = NOT_GIVEN,
-        suggested_queries: List[str] | NotGiven = NOT_GIVEN,
+        suggested_queries: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         system_prompt: str | NotGiven = NOT_GIVEN,
         # 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.

src/contextual/resources/agents/query.py

@@ -2,13 +2,13 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Iterable
+from typing import Union, Iterable
 from datetime import datetime
 from typing_extensions import Literal
 
 import httpx
 
-from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven, SequenceNotStr
 from ..._utils import maybe_transform, async_maybe_transform
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -253,12 +253,12 @@ def metrics(
         self,
         agent_id: str,
         *,
-        conversation_ids: List[str] | NotGiven = NOT_GIVEN,
+        conversation_ids: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
         created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         offset: int | NotGiven = NOT_GIVEN,
-        user_emails: List[str] | NotGiven = NOT_GIVEN,
+        user_emails: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         # 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,
@@ -323,7 +323,7 @@ def retrieval_info(
         message_id: str,
         *,
         agent_id: str,
-        content_ids: List[str],
+        content_ids: SequenceNotStr[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,
@@ -590,12 +590,12 @@ async def metrics(
         self,
         agent_id: str,
         *,
-        conversation_ids: List[str] | NotGiven = NOT_GIVEN,
+        conversation_ids: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         created_after: Union[str, datetime] | NotGiven = NOT_GIVEN,
         created_before: Union[str, datetime] | NotGiven = NOT_GIVEN,
         limit: int | NotGiven = NOT_GIVEN,
         offset: int | NotGiven = NOT_GIVEN,
-        user_emails: List[str] | NotGiven = NOT_GIVEN,
+        user_emails: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         # 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,
@@ -660,7 +660,7 @@ async def retrieval_info(
         message_id: str,
         *,
         agent_id: str,
-        content_ids: List[str],
+        content_ids: SequenceNotStr[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,

src/contextual/resources/generate.py

@@ -2,12 +2,12 @@
 
 from __future__ import annotations
 
-from typing import List, Iterable
+from typing import Iterable
 
 import httpx
 
 from ..types import generate_create_params
-from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven, SequenceNotStr
 from .._utils import maybe_transform, async_maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
@@ -46,7 +46,7 @@ def with_streaming_response(self) -> GenerateResourceWithStreamingResponse:
     def create(
         self,
         *,
-        knowledge: List[str],
+        knowledge: SequenceNotStr[str],
         messages: Iterable[generate_create_params.Message],
         model: str,
         avoid_commentary: bool | NotGiven = NOT_GIVEN,
@@ -154,7 +154,7 @@ def with_streaming_response(self) -> AsyncGenerateResourceWithStreamingResponse:
     async def create(
         self,
         *,
-        knowledge: List[str],
+        knowledge: SequenceNotStr[str],
         messages: Iterable[generate_create_params.Message],
         model: str,
         avoid_commentary: bool | NotGiven = NOT_GIVEN,

src/contextual/resources/rerank.py

@@ -2,12 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
-
 import httpx
 
 from ..types import rerank_create_params
-from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven, SequenceNotStr
 from .._utils import maybe_transform, async_maybe_transform
 from .._compat import cached_property
 from .._resource import SyncAPIResource, AsyncAPIResource
@@ -46,11 +44,11 @@ def with_streaming_response(self) -> RerankResourceWithStreamingResponse:
     def create(
         self,
         *,
-        documents: List[str],
+        documents: SequenceNotStr[str],
         model: str,
         query: str,
         instruction: str | NotGiven = NOT_GIVEN,
-        metadata: List[str] | NotGiven = NOT_GIVEN,
+        metadata: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         top_n: int | NotGiven = NOT_GIVEN,
         # 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.
@@ -152,11 +150,11 @@ def with_streaming_response(self) -> AsyncRerankResourceWithStreamingResponse:
     async def create(
         self,
         *,
-        documents: List[str],
+        documents: SequenceNotStr[str],
         model: str,
         query: str,
         instruction: str | NotGiven = NOT_GIVEN,
-        metadata: List[str] | NotGiven = NOT_GIVEN,
+        metadata: SequenceNotStr[str] | NotGiven = NOT_GIVEN,
         top_n: int | NotGiven = NOT_GIVEN,
         # 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.

src/contextual/types/agent_create_params.py

@@ -2,9 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["AgentCreateParams"]
 
 
@@ -15,7 +16,7 @@ class AgentCreateParams(TypedDict, total=False):
     agent_configs: "AgentConfigsParam"
     """The following advanced parameters are experimental and subject to change."""
 
-    datastore_ids: List[str]
+    datastore_ids: SequenceNotStr[str]
     """The IDs of the datastore to associate with this agent."""
 
     description: str
@@ -36,7 +37,7 @@ class AgentCreateParams(TypedDict, total=False):
     retrievals that can be used to answer a query.
     """
 
-    suggested_queries: List[str]
+    suggested_queries: SequenceNotStr[str]
     """
     These queries will show up as suggestions in the Contextual UI when users load
     the agent. We recommend including common queries that users will ask, as well as

src/contextual/types/agent_update_params.py

@@ -2,17 +2,18 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["AgentUpdateParams"]
 
 
 class AgentUpdateParams(TypedDict, total=False):
     agent_configs: "AgentConfigsParam"
     """The following advanced parameters are experimental and subject to change."""
 
-    datastore_ids: List[str]
+    datastore_ids: SequenceNotStr[str]
     """IDs of the datastore to associate with the agent."""
 
     filter_prompt: str
@@ -38,7 +39,7 @@ class AgentUpdateParams(TypedDict, total=False):
     retrievals that can be used to answer a query.
     """
 
-    suggested_queries: List[str]
+    suggested_queries: SequenceNotStr[str]
     """
     These queries will show up as suggestions in the Contextual UI when users load
     the agent. We recommend including common queries that users will ask, as well as

src/contextual/types/agents/query_metrics_params.py

@@ -2,17 +2,18 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import Union
 from datetime import datetime
 from typing_extensions import Annotated, TypedDict
 
+from ..._types import SequenceNotStr
 from ..._utils import PropertyInfo
 
 __all__ = ["QueryMetricsParams"]
 
 
 class QueryMetricsParams(TypedDict, total=False):
-    conversation_ids: List[str]
+    conversation_ids: SequenceNotStr[str]
     """Filter messages by conversation ids."""
 
     created_after: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
@@ -27,5 +28,5 @@ class QueryMetricsParams(TypedDict, total=False):
     offset: int
     """Offset for pagination."""
 
-    user_emails: List[str]
+    user_emails: SequenceNotStr[str]
     """Filter messages by users."""

src/contextual/types/agents/query_retrieval_info_params.py

@@ -2,15 +2,16 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["QueryRetrievalInfoParams"]
 
 
 class QueryRetrievalInfoParams(TypedDict, total=False):
     agent_id: Required[str]
     """ID of the agent which sent the provided message."""
 
-    content_ids: Required[List[str]]
+    content_ids: Required[SequenceNotStr[str]]
     """List of content ids for which to get the metadata."""

src/contextual/types/datastores/base_metadata_filter_param.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
-from typing import List, Union
+from typing import Union
 from typing_extensions import Literal, Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["BaseMetadataFilterParam"]
 
 
@@ -29,7 +31,7 @@ class BaseMetadataFilterParam(TypedDict, total=False):
     ]
     """Operator to be used for the filter."""
 
-    value: Union[str, float, bool, List[Union[str, float, bool]], None]
+    value: Union[str, float, bool, SequenceNotStr[Union[str, float, bool]], None]
     """The value to be searched for in the field.
 
     In case of exists operator, it is not needed.