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

Author: stainless-app[bot]

src/zeroentropy/_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/zeroentropy/resources/documents.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union, Optional
+from typing import Dict, Union, Optional
 from typing_extensions import Literal
 
 import httpx
@@ -15,7 +15,7 @@
     document_get_info_list_params,
     document_get_page_info_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
@@ -63,7 +63,7 @@ def update(
         collection_name: str,
         path: str,
         index_status: Optional[Literal["not_parsed", "not_indexed"]] | NotGiven = NOT_GIVEN,
-        metadata: Optional[Dict[str, Union[str, List[str]]]] | NotGiven = NOT_GIVEN,
+        metadata: Optional[Dict[str, Union[str, 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,
@@ -182,7 +182,7 @@ def add(
         collection_name: str,
         content: document_add_params.Content,
         path: str,
-        metadata: Dict[str, Union[str, List[str]]] | NotGiven = NOT_GIVEN,
+        metadata: Dict[str, Union[str, SequenceNotStr[str]]] | NotGiven = NOT_GIVEN,
         overwrite: bool | 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.
@@ -466,7 +466,7 @@ async def update(
         collection_name: str,
         path: str,
         index_status: Optional[Literal["not_parsed", "not_indexed"]] | NotGiven = NOT_GIVEN,
-        metadata: Optional[Dict[str, Union[str, List[str]]]] | NotGiven = NOT_GIVEN,
+        metadata: Optional[Dict[str, Union[str, 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,
@@ -585,7 +585,7 @@ async def add(
         collection_name: str,
         content: document_add_params.Content,
         path: str,
-        metadata: Dict[str, Union[str, List[str]]] | NotGiven = NOT_GIVEN,
+        metadata: Dict[str, Union[str, SequenceNotStr[str]]] | NotGiven = NOT_GIVEN,
         overwrite: bool | 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/zeroentropy/resources/models.py

@@ -2,12 +2,12 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 
 import httpx
 
 from ..types import model_rerank_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) -> ModelsResourceWithStreamingResponse:
     def rerank(
         self,
         *,
-        documents: List[str],
+        documents: SequenceNotStr[str],
         query: str,
         model: str | NotGiven = NOT_GIVEN,
         top_n: Optional[int] | NotGiven = NOT_GIVEN,
@@ -126,7 +126,7 @@ def with_streaming_response(self) -> AsyncModelsResourceWithStreamingResponse:
     async def rerank(
         self,
         *,
-        documents: List[str],
+        documents: SequenceNotStr[str],
         query: str,
         model: str | NotGiven = NOT_GIVEN,
         top_n: Optional[int] | NotGiven = NOT_GIVEN,

src/zeroentropy/types/document_add_params.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union
+from typing import Dict, Union
 from typing_extensions import Literal, Required, TypeAlias, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = [
     "DocumentAddParams",
     "Content",
@@ -37,7 +39,7 @@ class DocumentAddParams(TypedDict, total=False):
     unless `overwrite` is set to `true`.
     """
 
-    metadata: Dict[str, Union[str, List[str]]]
+    metadata: Dict[str, Union[str, SequenceNotStr[str]]]
     """
     This is a metadata JSON object that can be used to assign various metadata
     attributes to your document. The provided object must match the type
@@ -65,7 +67,7 @@ class ContentAPITextDocument(TypedDict, total=False):
 
 
 class ContentAPITextPagesDocument(TypedDict, total=False):
-    pages: Required[List[str]]
+    pages: Required[SequenceNotStr[str]]
     """The content of this document, as an array of strings.
 
     Each string will be the content of a full page, and can be retrieved using the

src/zeroentropy/types/document_update_params.py

@@ -2,9 +2,11 @@
 
 from __future__ import annotations
 
-from typing import Dict, List, Union, Optional
+from typing import Dict, Union, Optional
 from typing_extensions import Literal, Required, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["DocumentUpdateParams"]
 
 
@@ -27,7 +29,7 @@ class DocumentUpdateParams(TypedDict, total=False):
     failure.
     """
 
-    metadata: Optional[Dict[str, Union[str, List[str]]]]
+    metadata: Optional[Dict[str, Union[str, SequenceNotStr[str]]]]
     """
     If this field is provided, the given metadata json will replace the document's
     existing metadata json. In other words, if you want to add a new field, you will

src/zeroentropy/types/model_rerank_params.py

@@ -2,14 +2,16 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Required, TypedDict
 
+from .._types import SequenceNotStr
+
 __all__ = ["ModelRerankParams"]
 
 
 class ModelRerankParams(TypedDict, total=False):
-    documents: Required[List[str]]
+    documents: Required[SequenceNotStr[str]]
     """The list of documents to rerank. Each document is a string."""
 
     query: Required[str]