isaacus 0.8.0__py3-none-any.whl → 0.9.1__py3-none-any.whl

isaacus/_utils/_transform.py

@@ -16,18 +16,20 @@ from ._utils import (
     lru_cache,
     is_mapping,
     is_iterable,
+    is_sequence,
 )
 from .._files import is_base64_file_input
+from ._compat import get_origin, is_typeddict
 from ._typing import (
     is_list_type,
     is_union_type,
     extract_type_arg,
     is_iterable_type,
     is_required_type,
+    is_sequence_type,
     is_annotated_type,
     strip_annotated_type,
 )
-from .._compat import get_origin, model_dump, is_typeddict
 
 _T = TypeVar("_T")
 
@@ -167,6 +169,8 @@ def _transform_recursive(
 
             Defaults to the same value as the `annotation` argument.
     """
+    from .._compat import model_dump
+
     if inner_type is None:
         inner_type = annotation
 
@@ -184,6 +188,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.
@@ -262,7 +268,7 @@ def _transform_typeddict(
     annotations = get_type_hints(expected_type, include_extras=True)
     for key, value in data.items():
         if not is_given(value):
-            # we don't need to include `NotGiven` values here as they'll
+            # we don't need to include omitted values here as they'll
             # be stripped out before the request is sent anyway
             continue
 
@@ -329,6 +335,8 @@ async def _async_transform_recursive(
 
             Defaults to the same value as the `annotation` argument.
     """
+    from .._compat import model_dump
+
     if inner_type is None:
         inner_type = annotation
 
@@ -346,6 +354,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.
@@ -424,7 +434,7 @@ async def _async_transform_typeddict(
     annotations = get_type_hints(expected_type, include_extras=True)
     for key, value in data.items():
         if not is_given(value):
-            # we don't need to include `NotGiven` values here as they'll
+            # we don't need to include omitted values here as they'll
             # be stripped out before the request is sent anyway
             continue
 

isaacus/_utils/_typing.py

@@ -15,7 +15,7 @@ from typing_extensions import (
 
 from ._utils import lru_cache
 from .._types import InheritsGeneric
-from .._compat import is_union as _is_union
+from ._compat import is_union as _is_union
 
 
 def is_annotated_type(typ: type) -> bool:
@@ -26,6 +26,11 @@ def is_list_type(typ: type) -> bool:
     return (get_origin(typ) or typ) == list
 
 
+def is_sequence_type(typ: type) -> bool:
+    origin = get_origin(typ) or typ
+    return origin == typing_extensions.Sequence or origin == typing.Sequence or origin == _c_abc.Sequence
+
+
 def is_iterable_type(typ: type) -> bool:
     """If the given type is `typing.Iterable[T]`"""
     origin = get_origin(typ) or typ

isaacus/_utils/_utils.py

@@ -21,8 +21,7 @@ from typing_extensions import TypeGuard
 
 import sniffio
 
-from .._types import NotGiven, FileTypes, NotGivenOr, HeadersLike
-from .._compat import parse_date as parse_date, parse_datetime as parse_datetime
+from .._types import Omit, NotGiven, FileTypes, HeadersLike
 
 _T = TypeVar("_T")
 _TupleT = TypeVar("_TupleT", bound=Tuple[object, ...])
@@ -64,7 +63,7 @@ def _extract_items(
     try:
         key = path[index]
     except IndexError:
-        if isinstance(obj, NotGiven):
+        if not is_given(obj):
             # no value was provided - we can safely ignore
             return []
 
@@ -127,8 +126,8 @@ def _extract_items(
     return []
 
 
-def is_given(obj: NotGivenOr[_T]) -> TypeGuard[_T]:
-    return not isinstance(obj, NotGiven)
+def is_given(obj: _T | NotGiven | Omit) -> TypeGuard[_T]:
+    return not isinstance(obj, NotGiven) and not isinstance(obj, Omit)
 
 
 # Type safe methods for narrowing types with TypeVars.

isaacus/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "isaacus"
-__version__ = "0.8.0"  # x-release-please-version
+__version__ = "0.9.1"  # x-release-please-version

isaacus/resources/__init__.py

@@ -1,5 +1,13 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+from .embeddings import (
+    EmbeddingsResource,
+    AsyncEmbeddingsResource,
+    EmbeddingsResourceWithRawResponse,
+    AsyncEmbeddingsResourceWithRawResponse,
+    EmbeddingsResourceWithStreamingResponse,
+    AsyncEmbeddingsResourceWithStreamingResponse,
+)
 from .rerankings import (
     RerankingsResource,
     AsyncRerankingsResource,
@@ -26,6 +34,12 @@ from .classifications import (
 )
 
 __all__ = [
+    "EmbeddingsResource",
+    "AsyncEmbeddingsResource",
+    "EmbeddingsResourceWithRawResponse",
+    "AsyncEmbeddingsResourceWithRawResponse",
+    "EmbeddingsResourceWithStreamingResponse",
+    "AsyncEmbeddingsResourceWithStreamingResponse",
     "ClassificationsResource",
     "AsyncClassificationsResource",
     "ClassificationsResourceWithRawResponse",

isaacus/resources/classifications/universal.py

@@ -2,12 +2,12 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Literal
 
 import httpx
 
-from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
 from ..._utils import maybe_transform, async_maybe_transform
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -19,7 +19,7 @@ from ..._response import (
 )
 from ..._base_client import make_request_options
 from ...types.classifications import universal_create_params
-from ...types.classifications.universal_classification import UniversalClassification
+from ...types.classifications.universal_classification_response import UniversalClassificationResponse
 
 __all__ = ["UniversalResource", "AsyncUniversalResource"]
 
@@ -49,17 +49,17 @@ class UniversalResource(SyncAPIResource):
         *,
         model: Literal["kanon-universal-classifier", "kanon-universal-classifier-mini"],
         query: str,
-        texts: List[str],
-        chunking_options: Optional[universal_create_params.ChunkingOptions] | NotGiven = NOT_GIVEN,
-        is_iql: bool | NotGiven = NOT_GIVEN,
-        scoring_method: Literal["auto", "chunk_max", "chunk_avg", "chunk_min"] | NotGiven = NOT_GIVEN,
+        texts: SequenceNotStr[str],
+        chunking_options: Optional[universal_create_params.ChunkingOptions] | Omit = omit,
+        is_iql: bool | Omit = omit,
+        scoring_method: Literal["auto", "chunk_max", "chunk_avg", "chunk_min"] | 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,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> UniversalClassification:
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> UniversalClassificationResponse:
         """
         Classify the relevance of legal documents to a query with an Isaacus universal
         legal AI classifier.
@@ -121,7 +121,7 @@ class UniversalResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=UniversalClassification,
+            cast_to=UniversalClassificationResponse,
         )
 
 
@@ -150,17 +150,17 @@ class AsyncUniversalResource(AsyncAPIResource):
         *,
         model: Literal["kanon-universal-classifier", "kanon-universal-classifier-mini"],
         query: str,
-        texts: List[str],
-        chunking_options: Optional[universal_create_params.ChunkingOptions] | NotGiven = NOT_GIVEN,
-        is_iql: bool | NotGiven = NOT_GIVEN,
-        scoring_method: Literal["auto", "chunk_max", "chunk_avg", "chunk_min"] | NotGiven = NOT_GIVEN,
+        texts: SequenceNotStr[str],
+        chunking_options: Optional[universal_create_params.ChunkingOptions] | Omit = omit,
+        is_iql: bool | Omit = omit,
+        scoring_method: Literal["auto", "chunk_max", "chunk_avg", "chunk_min"] | 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,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> UniversalClassification:
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> UniversalClassificationResponse:
         """
         Classify the relevance of legal documents to a query with an Isaacus universal
         legal AI classifier.
@@ -222,7 +222,7 @@ class AsyncUniversalResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=UniversalClassification,
+            cast_to=UniversalClassificationResponse,
         )
 
 

isaacus/resources/embeddings.py

@@ -0,0 +1,246 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from typing_extensions import Literal
+
+import httpx
+
+from ..types import embedding_create_params
+from .._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
+from .._utils import maybe_transform, async_maybe_transform
+from .._compat import cached_property
+from .._resource import SyncAPIResource, AsyncAPIResource
+from .._response import (
+    to_raw_response_wrapper,
+    to_streamed_response_wrapper,
+    async_to_raw_response_wrapper,
+    async_to_streamed_response_wrapper,
+)
+from .._base_client import make_request_options
+from ..types.embedding_response import EmbeddingResponse
+
+__all__ = ["EmbeddingsResource", "AsyncEmbeddingsResource"]
+
+
+class EmbeddingsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> EmbeddingsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/isaacus-dev/isaacus-python#accessing-raw-response-data-eg-headers
+        """
+        return EmbeddingsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> EmbeddingsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/isaacus-dev/isaacus-python#with_streaming_response
+        """
+        return EmbeddingsResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        model: Literal["kanon-2-embedder"],
+        texts: Union[SequenceNotStr[str], str],
+        dimensions: Optional[int] | Omit = omit,
+        overflow_strategy: Optional[Literal["drop_end"]] | Omit = omit,
+        task: Optional[Literal["retrieval/query", "retrieval/document"]] | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> EmbeddingResponse:
+        """
+        Embed legal texts with an Isaacus legal AI embedder.
+
+        Args:
+          model: The ID of the [model](https://docs.isaacus.com/models#embedding) to use for
+              embedding.
+
+          texts: The text or array of texts to embed.
+
+              Each text must contain at least one non-whitespace character.
+
+              No more than 128 texts can be embedded in a single request.
+
+          dimensions: A whole number greater than or equal to 1.
+
+          overflow_strategy: The strategy to employ when content exceeds the model's maximum input length.
+
+              `drop_end`, which is the default setting, drops tokens from the end of the
+              content exceeding the limit.
+
+              If `null`, an error will be raised if any content exceeds the model's maximum
+              input length.
+
+          task: The task the embeddings will be used for.
+
+              `retrieval/query` is meant for queries and statements, and `retrieval/document`
+              is meant for anything to be retrieved using query embeddings.
+
+              If `null`, which is the default setting, embeddings will not be optimized for
+              any particular task.
+
+          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
+        """
+        return self._post(
+            "/embeddings",
+            body=maybe_transform(
+                {
+                    "model": model,
+                    "texts": texts,
+                    "dimensions": dimensions,
+                    "overflow_strategy": overflow_strategy,
+                    "task": task,
+                },
+                embedding_create_params.EmbeddingCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=EmbeddingResponse,
+        )
+
+
+class AsyncEmbeddingsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncEmbeddingsResourceWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/isaacus-dev/isaacus-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncEmbeddingsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncEmbeddingsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/isaacus-dev/isaacus-python#with_streaming_response
+        """
+        return AsyncEmbeddingsResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        model: Literal["kanon-2-embedder"],
+        texts: Union[SequenceNotStr[str], str],
+        dimensions: Optional[int] | Omit = omit,
+        overflow_strategy: Optional[Literal["drop_end"]] | Omit = omit,
+        task: Optional[Literal["retrieval/query", "retrieval/document"]] | 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,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> EmbeddingResponse:
+        """
+        Embed legal texts with an Isaacus legal AI embedder.
+
+        Args:
+          model: The ID of the [model](https://docs.isaacus.com/models#embedding) to use for
+              embedding.
+
+          texts: The text or array of texts to embed.
+
+              Each text must contain at least one non-whitespace character.
+
+              No more than 128 texts can be embedded in a single request.
+
+          dimensions: A whole number greater than or equal to 1.
+
+          overflow_strategy: The strategy to employ when content exceeds the model's maximum input length.
+
+              `drop_end`, which is the default setting, drops tokens from the end of the
+              content exceeding the limit.
+
+              If `null`, an error will be raised if any content exceeds the model's maximum
+              input length.
+
+          task: The task the embeddings will be used for.
+
+              `retrieval/query` is meant for queries and statements, and `retrieval/document`
+              is meant for anything to be retrieved using query embeddings.
+
+              If `null`, which is the default setting, embeddings will not be optimized for
+              any particular task.
+
+          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
+        """
+        return await self._post(
+            "/embeddings",
+            body=await async_maybe_transform(
+                {
+                    "model": model,
+                    "texts": texts,
+                    "dimensions": dimensions,
+                    "overflow_strategy": overflow_strategy,
+                    "task": task,
+                },
+                embedding_create_params.EmbeddingCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=EmbeddingResponse,
+        )
+
+
+class EmbeddingsResourceWithRawResponse:
+    def __init__(self, embeddings: EmbeddingsResource) -> None:
+        self._embeddings = embeddings
+
+        self.create = to_raw_response_wrapper(
+            embeddings.create,
+        )
+
+
+class AsyncEmbeddingsResourceWithRawResponse:
+    def __init__(self, embeddings: AsyncEmbeddingsResource) -> None:
+        self._embeddings = embeddings
+
+        self.create = async_to_raw_response_wrapper(
+            embeddings.create,
+        )
+
+
+class EmbeddingsResourceWithStreamingResponse:
+    def __init__(self, embeddings: EmbeddingsResource) -> None:
+        self._embeddings = embeddings
+
+        self.create = to_streamed_response_wrapper(
+            embeddings.create,
+        )
+
+
+class AsyncEmbeddingsResourceWithStreamingResponse:
+    def __init__(self, embeddings: AsyncEmbeddingsResource) -> None:
+        self._embeddings = embeddings
+
+        self.create = async_to_streamed_response_wrapper(
+            embeddings.create,
+        )

isaacus/resources/extractions/qa.py

@@ -2,12 +2,12 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Literal
 
 import httpx
 
-from ..._types import NOT_GIVEN, Body, Query, Headers, NotGiven
+from ..._types import Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
 from ..._utils import maybe_transform, async_maybe_transform
 from ..._compat import cached_property
 from ..._resource import SyncAPIResource, AsyncAPIResource
@@ -19,7 +19,7 @@ from ..._response import (
 )
 from ..._base_client import make_request_options
 from ...types.extractions import qa_create_params
-from ...types.extractions.answer_extraction import AnswerExtraction
+from ...types.extractions.answer_extraction_response import AnswerExtractionResponse
 
 __all__ = ["QaResource", "AsyncQaResource"]
 
@@ -49,24 +49,25 @@ class QaResource(SyncAPIResource):
         *,
         model: Literal["kanon-answer-extractor", "kanon-answer-extractor-mini"],
         query: str,
-        texts: List[str],
-        chunking_options: Optional[qa_create_params.ChunkingOptions] | NotGiven = NOT_GIVEN,
-        ignore_inextractability: bool | NotGiven = NOT_GIVEN,
-        top_k: int | NotGiven = NOT_GIVEN,
+        texts: SequenceNotStr[str],
+        chunking_options: Optional[qa_create_params.ChunkingOptions] | Omit = omit,
+        ignore_inextractability: bool | Omit = omit,
+        top_k: int | 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,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> AnswerExtraction:
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> AnswerExtractionResponse:
         """
         Extract answers to questions from legal documents with an Isaacus legal AI
         answer extractor.
 
         Args:
-          model: The ID of the [model](https://docs.isaacus.com/models#extractive-qa) to use for
-              extractive question answering.
+          model: The ID of the
+              [model](https://docs.isaacus.com/models#extractive-question-answering) to use
+              for extractive question answering.
 
           query: The query to extract the answer to.
 
@@ -119,7 +120,7 @@ class QaResource(SyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=AnswerExtraction,
+            cast_to=AnswerExtractionResponse,
         )
 
 
@@ -148,24 +149,25 @@ class AsyncQaResource(AsyncAPIResource):
         *,
         model: Literal["kanon-answer-extractor", "kanon-answer-extractor-mini"],
         query: str,
-        texts: List[str],
-        chunking_options: Optional[qa_create_params.ChunkingOptions] | NotGiven = NOT_GIVEN,
-        ignore_inextractability: bool | NotGiven = NOT_GIVEN,
-        top_k: int | NotGiven = NOT_GIVEN,
+        texts: SequenceNotStr[str],
+        chunking_options: Optional[qa_create_params.ChunkingOptions] | Omit = omit,
+        ignore_inextractability: bool | Omit = omit,
+        top_k: int | 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,
         extra_query: Query | None = None,
         extra_body: Body | None = None,
-        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> AnswerExtraction:
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> AnswerExtractionResponse:
         """
         Extract answers to questions from legal documents with an Isaacus legal AI
         answer extractor.
 
         Args:
-          model: The ID of the [model](https://docs.isaacus.com/models#extractive-qa) to use for
-              extractive question answering.
+          model: The ID of the
+              [model](https://docs.isaacus.com/models#extractive-question-answering) to use
+              for extractive question answering.
 
           query: The query to extract the answer to.
 
@@ -218,7 +220,7 @@ class AsyncQaResource(AsyncAPIResource):
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=AnswerExtraction,
+            cast_to=AnswerExtractionResponse,
         )