isaacus 0.3.3__py3-none-any.whl → 0.5.0__py3-none-any.whl

isaacus/_base_client.py

@@ -98,7 +98,11 @@ _StreamT = TypeVar("_StreamT", bound=Stream[Any])
 _AsyncStreamT = TypeVar("_AsyncStreamT", bound=AsyncStream[Any])
 
 if TYPE_CHECKING:
-    from httpx._config import DEFAULT_TIMEOUT_CONFIG as HTTPX_DEFAULT_TIMEOUT
+    from httpx._config import (
+        DEFAULT_TIMEOUT_CONFIG,  # pyright: ignore[reportPrivateImportUsage]
+    )
+
+    HTTPX_DEFAULT_TIMEOUT = DEFAULT_TIMEOUT_CONFIG
 else:
     try:
         from httpx._config import DEFAULT_TIMEOUT_CONFIG as HTTPX_DEFAULT_TIMEOUT

isaacus/_models.py

@@ -19,7 +19,6 @@ from typing_extensions import (
 )
 
 import pydantic
-import pydantic.generics
 from pydantic.fields import FieldInfo
 
 from ._types import (

isaacus/_utils/_typing.py

@@ -110,7 +110,7 @@ def extract_type_var_from_base(
     ```
     """
     cls = cast(object, get_origin(typ) or typ)
-    if cls in generic_bases:
+    if cls in generic_bases:  # pyright: ignore[reportUnnecessaryContains]
         # we're given the class directly
         return extract_type_arg(typ, index)
 

isaacus/_version.py

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

isaacus/resources/classifications/universal.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Optional
+from typing import List, Optional
 from typing_extensions import Literal
 
 import httpx
@@ -52,7 +52,7 @@ class UniversalResource(SyncAPIResource):
         *,
         model: Literal["kanon-universal-classifier", "kanon-universal-classifier-mini"],
         query: str,
-        text: 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,
@@ -64,7 +64,7 @@ class UniversalResource(SyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> UniversalClassification:
         """
-        Classify the relevance of a legal document to a query with an Isaacus universal
+        Classify the relevance of legal documents to a query with an Isaacus universal
         legal AI classifier.
 
         Args:
@@ -72,16 +72,16 @@ class UniversalResource(SyncAPIResource):
               to use for universal classification.
 
           query: The [Isaacus Query Language (IQL)](https://docs.isaacus.com/iql) query or, if
-              IQL is disabled, the statement, to evaluate the text against.
+              IQL is disabled, the statement, to evaluate the texts against.
 
               The query must contain at least one non-whitespace character.
 
-              Unlike the text being classified, the query cannot be so long that it exceeds
+              Unlike the texts being classified, the query cannot be so long that it exceeds
               the maximum input length of the universal classifier.
 
-          text: The text to classify.
+          texts: The texts to classify.
 
-              The text must contain at least one non-whitespace character.
+              The texts must contain at least one non-whitespace character.
 
           chunking_options: Options for how to split text into smaller chunks.
 
@@ -92,13 +92,13 @@ class UniversalResource(SyncAPIResource):
 
               `auto` is the default scoring method and is recommended for most use cases.
               Currently, it is equivalent to `chunk_max`. In the future, it will automatically
-              select the best method based on the model and input.
+              select the best method based on the model and inputs.
 
-              `chunk_max` uses the highest confidence score of all of the text's chunks.
+              `chunk_max` uses the highest confidence score of all of the texts' chunks.
 
-              `chunk_avg` averages the confidence scores of all of the text's chunks.
+              `chunk_avg` averages the confidence scores of all of the texts' chunks.
 
-              `chunk_min` uses the lowest confidence score of all of the text's chunks.
+              `chunk_min` uses the lowest confidence score of all of the texts' chunks.
 
           extra_headers: Send extra headers
 
@@ -114,7 +114,7 @@ class UniversalResource(SyncAPIResource):
                 {
                     "model": model,
                     "query": query,
-                    "text": text,
+                    "texts": texts,
                     "chunking_options": chunking_options,
                     "is_iql": is_iql,
                     "scoring_method": scoring_method,
@@ -153,7 +153,7 @@ class AsyncUniversalResource(AsyncAPIResource):
         *,
         model: Literal["kanon-universal-classifier", "kanon-universal-classifier-mini"],
         query: str,
-        text: 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,
@@ -165,7 +165,7 @@ class AsyncUniversalResource(AsyncAPIResource):
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> UniversalClassification:
         """
-        Classify the relevance of a legal document to a query with an Isaacus universal
+        Classify the relevance of legal documents to a query with an Isaacus universal
         legal AI classifier.
 
         Args:
@@ -173,16 +173,16 @@ class AsyncUniversalResource(AsyncAPIResource):
               to use for universal classification.
 
           query: The [Isaacus Query Language (IQL)](https://docs.isaacus.com/iql) query or, if
-              IQL is disabled, the statement, to evaluate the text against.
+              IQL is disabled, the statement, to evaluate the texts against.
 
               The query must contain at least one non-whitespace character.
 
-              Unlike the text being classified, the query cannot be so long that it exceeds
+              Unlike the texts being classified, the query cannot be so long that it exceeds
               the maximum input length of the universal classifier.
 
-          text: The text to classify.
+          texts: The texts to classify.
 
-              The text must contain at least one non-whitespace character.
+              The texts must contain at least one non-whitespace character.
 
           chunking_options: Options for how to split text into smaller chunks.
 
@@ -193,13 +193,13 @@ class AsyncUniversalResource(AsyncAPIResource):
 
               `auto` is the default scoring method and is recommended for most use cases.
               Currently, it is equivalent to `chunk_max`. In the future, it will automatically
-              select the best method based on the model and input.
+              select the best method based on the model and inputs.
 
-              `chunk_max` uses the highest confidence score of all of the text's chunks.
+              `chunk_max` uses the highest confidence score of all of the texts' chunks.
 
-              `chunk_avg` averages the confidence scores of all of the text's chunks.
+              `chunk_avg` averages the confidence scores of all of the texts' chunks.
 
-              `chunk_min` uses the lowest confidence score of all of the text's chunks.
+              `chunk_min` uses the lowest confidence score of all of the texts' chunks.
 
           extra_headers: Send extra headers
 
@@ -215,7 +215,7 @@ class AsyncUniversalResource(AsyncAPIResource):
                 {
                     "model": model,
                     "query": query,
-                    "text": text,
+                    "texts": texts,
                     "chunking_options": chunking_options,
                     "is_iql": is_iql,
                     "scoring_method": scoring_method,

isaacus/types/classifications/universal_classification.py

@@ -4,15 +4,23 @@ from typing import List, Optional
 
 from ..._models import BaseModel
 
-__all__ = ["UniversalClassification", "Chunk", "Usage"]
+__all__ = ["UniversalClassification", "Classification", "ClassificationChunk", "Usage"]
 
 
-class Chunk(BaseModel):
+class ClassificationChunk(BaseModel):
     end: int
-    """The end index of the chunk in the original text."""
+    """
+    The index of the character immediately after the last character of the chunk in
+    the original text, beginning from `0` (such that, in Python, the chunk is
+    equivalent to `text[start:end]`).
+    """
 
     index: int
-    """The index of the chunk in the list of chunks."""
+    """
+    The original position of the chunk in the outputted list of chunks before
+    sorting, starting from `0` (and, therefore, ending at the number of chunks minus
+    `1`).
+    """
 
     score: float
     """
@@ -24,19 +32,17 @@ class Chunk(BaseModel):
     """
 
     start: int
-    """The start index of the chunk in the original text."""
+    """
+    The index of the character in the original text where the chunk starts,
+    beginning from `0`.
+    """
 
     text: str
     """The text of the chunk."""
 
 
-class Usage(BaseModel):
-    input_tokens: int
-    """The number of tokens inputted to the model."""
-
-
-class UniversalClassification(BaseModel):
-    chunks: Optional[List[Chunk]] = None
+class Classification(BaseModel):
+    chunks: Optional[List[ClassificationChunk]] = None
     """
     The text as broken into chunks by
     [semchunk](https://github.com/isaacus-dev/semchunk), each chunk with its own
@@ -45,6 +51,12 @@ class UniversalClassification(BaseModel):
     If no chunking occurred, this will be `null`.
     """
 
+    index: int
+    """
+    The index of the text in the input array of texts, starting from `0` (and,
+    therefore, ending at the number of texts minus `1`).
+    """
+
     score: float
     """
     A score of the likelihood that the query expressed about the text is supported
@@ -54,5 +66,18 @@ class UniversalClassification(BaseModel):
     score less than `0.5` indicates that the text does not support the query.
     """
 
+
+class Usage(BaseModel):
+    input_tokens: int
+    """The number of tokens inputted to the model."""
+
+
+class UniversalClassification(BaseModel):
+    classifications: List[Classification]
+    """
+    The classifications of the texts, by relevance to the query, in order from
+    highest to lowest relevance score.
+    """
+
     usage: Usage
     """Statistics about the usage of resources in the process of classifying the text."""

isaacus/types/classifications/universal_create_params.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Optional
+from typing import List, Optional
 from typing_extensions import Literal, Required, TypedDict
 
 __all__ = ["UniversalCreateParams", "ChunkingOptions"]
@@ -18,18 +18,18 @@ class UniversalCreateParams(TypedDict, total=False):
     query: Required[str]
     """
     The [Isaacus Query Language (IQL)](https://docs.isaacus.com/iql) query or, if
-    IQL is disabled, the statement, to evaluate the text against.
+    IQL is disabled, the statement, to evaluate the texts against.
 
     The query must contain at least one non-whitespace character.
 
-    Unlike the text being classified, the query cannot be so long that it exceeds
+    Unlike the texts being classified, the query cannot be so long that it exceeds
     the maximum input length of the universal classifier.
     """
 
-    text: Required[str]
-    """The text to classify.
+    texts: Required[List[str]]
+    """The texts to classify.
 
-    The text must contain at least one non-whitespace character.
+    The texts must contain at least one non-whitespace character.
     """
 
     chunking_options: Optional[ChunkingOptions]
@@ -46,13 +46,13 @@ class UniversalCreateParams(TypedDict, total=False):
 
     `auto` is the default scoring method and is recommended for most use cases.
     Currently, it is equivalent to `chunk_max`. In the future, it will automatically
-    select the best method based on the model and input.
+    select the best method based on the model and inputs.
 
-    `chunk_max` uses the highest confidence score of all of the text's chunks.
+    `chunk_max` uses the highest confidence score of all of the texts' chunks.
 
-    `chunk_avg` averages the confidence scores of all of the text's chunks.
+    `chunk_avg` averages the confidence scores of all of the texts' chunks.
 
-    `chunk_min` uses the lowest confidence score of all of the text's chunks.
+    `chunk_min` uses the lowest confidence score of all of the texts' chunks.
     """
 
 

{isaacus-0.3.3.dist-info → isaacus-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: isaacus
-Version: 0.3.3
+Version: 0.5.0
 Summary: The official Python library for the isaacus API
 Project-URL: Homepage, https://github.com/isaacus-dev/isaacus-python
 Project-URL: Repository, https://github.com/isaacus-dev/isaacus-python
@@ -65,9 +65,9 @@ client = Isaacus(
 universal_classification = client.classifications.universal.create(
     model="kanon-universal-classifier",
     query="This is a confidentiality clause.",
-    text="I agree not to tell anyone about the document.",
+    texts=["I agree not to tell anyone about the document."],
 )
-print(universal_classification.chunks)
+print(universal_classification.classifications)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -93,9 +93,9 @@ async def main() -> None:
     universal_classification = await client.classifications.universal.create(
         model="kanon-universal-classifier",
         query="This is a confidentiality clause.",
-        text="I agree not to tell anyone about the document.",
+        texts=["I agree not to tell anyone about the document."],
     )
-    print(universal_classification.chunks)
+    print(universal_classification.classifications)
 
 
 asyncio.run(main())
@@ -124,7 +124,7 @@ client = Isaacus()
 universal_classification = client.classifications.universal.create(
     model="kanon-universal-classifier",
     query="This is a confidentiality clause.",
-    text="I agree not to tell anyone about the document.",
+    texts=["I agree not to tell anyone about the document."],
     chunking_options={
         "overlap_ratio": 0.1,
         "overlap_tokens": None,
@@ -153,7 +153,7 @@ try:
     client.classifications.universal.create(
         model="kanon-universal-classifier",
         query="This is a confidentiality clause.",
-        text="I agree not to tell anyone about the document.",
+        texts=["I agree not to tell anyone about the document."],
     )
 except isaacus.APIConnectionError as e:
     print("The server could not be reached")
@@ -200,7 +200,7 @@ client = Isaacus(
 client.with_options(max_retries=5).classifications.universal.create(
     model="kanon-universal-classifier",
     query="This is a confidentiality clause.",
-    text="I agree not to tell anyone about the document.",
+    texts=["I agree not to tell anyone about the document."],
 )
 ```
 
@@ -227,7 +227,7 @@ client = Isaacus(
 client.with_options(timeout=5.0).classifications.universal.create(
     model="kanon-universal-classifier",
     query="This is a confidentiality clause.",
-    text="I agree not to tell anyone about the document.",
+    texts=["I agree not to tell anyone about the document."],
 )
 ```
 
@@ -272,12 +272,12 @@ client = Isaacus()
 response = client.classifications.universal.with_raw_response.create(
     model="kanon-universal-classifier",
     query="This is a confidentiality clause.",
-    text="I agree not to tell anyone about the document.",
+    texts=["I agree not to tell anyone about the document."],
 )
 print(response.headers.get('X-My-Header'))
 
 universal = response.parse()  # get the object that `classifications.universal.create()` would have returned
-print(universal.chunks)
+print(universal.classifications)
 ```
 
 These methods return an [`APIResponse`](https://github.com/isaacus-dev/isaacus-python/tree/main/src/isaacus/_response.py) object.
@@ -294,7 +294,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 with client.classifications.universal.with_streaming_response.create(
     model="kanon-universal-classifier",
     query="This is a confidentiality clause.",
-    text="I agree not to tell anyone about the document.",
+    texts=["I agree not to tell anyone about the document."],
 ) as response:
     print(response.headers.get("X-My-Header"))
 

{isaacus-0.3.3.dist-info → isaacus-0.5.0.dist-info}/RECORD

@@ -1,17 +1,17 @@
 isaacus/__init__.py,sha256=Wgs-qjblN9tJvI22iWwi5CfiVvyn1drBPnTYhVj7cWk,2426
-isaacus/_base_client.py,sha256=-vFveHvk1CTWaJzq66vjAg5bPOqSuZsMyYgrnZMrsh0,65366
+isaacus/_base_client.py,sha256=f8PpKwJ8YPyCeeBMSa71foqa9INVBTKqwRAwYRGIEq8,65455
 isaacus/_client.py,sha256=aqn4G8onxd-CBS_Tgnr9QA41g6ltcIScHsuUo9U1JeU,15874
 isaacus/_compat.py,sha256=VWemUKbj6DDkQ-O4baSpHVLJafotzeXmCQGJugfVTIw,6580
 isaacus/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
 isaacus/_exceptions.py,sha256=L82uluhizzc94VydHIaJkNxkcG-2DAe74tNhrE2eN2A,3222
 isaacus/_files.py,sha256=mf4dOgL4b0ryyZlbqLhggD3GVgDf6XxdGFAgce01ugE,3549
-isaacus/_models.py,sha256=Bg-k8-T1kDWURAYXrbDF5FSAyLEy7k90Jrvne-dF4Wc,29070
+isaacus/_models.py,sha256=q-l1tes71l6z-D5ffu9-G4UigTVVeJwiwIzA_gO4RFo,29045
 isaacus/_qs.py,sha256=AOkSz4rHtK4YI3ZU_kzea-zpwBUgEY8WniGmTPyEimc,4846
 isaacus/_resource.py,sha256=iP_oYhz5enCI58mK7hlwLoPMPh4Q5s8-KBv-jGfv2aM,1106
 isaacus/_response.py,sha256=5v-mAgiP6X9EBGBvTYVdwuDjikiha-dc1dYmadIraCU,28795
 isaacus/_streaming.py,sha256=tMBfwrfEFWm0v7vWFgjn_lizsoD70lPkYigIBuADaCM,10104
 isaacus/_types.py,sha256=WCRAb8jikEJoOi8nza8l5NnOTKgZlpmN5fkiHoKoY08,6144
-isaacus/_version.py,sha256=e-M1q910IdIbw8sz6m5Ry2saoH5ROSo7HtHKq4fW4JI,159
+isaacus/_version.py,sha256=sKzfejNUQSpNw34xaEeyTyEFijKAL_S_FtI3io-aV1c,159
 isaacus/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 isaacus/_utils/__init__.py,sha256=PNZ_QJuzZEgyYXqkO1HVhGkj5IU9bglVUcw7H-Knjzw,2062
 isaacus/_utils/_logs.py,sha256=rwa1Yzjbs2JaFn9KQ06rH5c_GSNa--BVwWnWhvvT1tY,777
@@ -20,21 +20,21 @@ isaacus/_utils/_reflection.py,sha256=ZmGkIgT_PuwedyNBrrKGbxoWtkpytJNU1uU4QHnmEMU
 isaacus/_utils/_streams.py,sha256=SMC90diFFecpEg_zgDRVbdR3hSEIgVVij4taD-noMLM,289
 isaacus/_utils/_sync.py,sha256=TpGLrrhRNWTJtODNE6Fup3_k7zrWm1j2RlirzBwre-0,2862
 isaacus/_utils/_transform.py,sha256=n7kskEWz6o__aoNvhFoGVyDoalNe6mJwp-g7BWkdj88,15617
-isaacus/_utils/_typing.py,sha256=nOFiIH5faG-h5Ha-Ky2aZxw5kmR6iX8KzNtsn3JEWoA,4556
+isaacus/_utils/_typing.py,sha256=D0DbbNu8GnYQTSICnTSHDGsYXj8TcAKyhejb0XcnjtY,4602
 isaacus/_utils/_utils.py,sha256=8UmbPOy_AAr2uUjjFui-VZSrVBHRj6bfNEKRp5YZP2A,12004
 isaacus/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
 isaacus/resources/__init__.py,sha256=N582fDHPnidiDhuxYlHKV_Io6WDNMI3HE8Yze3l8wqU,1171
 isaacus/resources/rerankings.py,sha256=rNVu33jDe-KxaXKS9ReyPrvSYUIbTfxVRMm8MoZc9uI,11187
 isaacus/resources/classifications/__init__.py,sha256=tYSnDm-o0CVuTC95VoNJzOqHsb8jTzYmW8hdwW14K60,1158
 isaacus/resources/classifications/classifications.py,sha256=Td5Gscg1PNJJeobxow_hJq_RicpFe3ibEYN0Gh3Kpsg,4018
-isaacus/resources/classifications/universal.py,sha256=bA577ocisYb_xS4OA53pM8ZITFprgbL7Wl6ruBqkccE,10656
+isaacus/resources/classifications/universal.py,sha256=KEBH6BXeD3BvIWY_IlcC7373Qzl7yN8dJxbsnYcyvKA,10690
 isaacus/types/__init__.py,sha256=PswomxWpSak5TApm_28hneqI_l_g0-4NF5W6kdedI0Y,253
 isaacus/types/reranking.py,sha256=MQRUoH2UB185Q369H01jnvaT9pz4D9z0oOoz8oLMqjc,911
 isaacus/types/reranking_create_params.py,sha256=qJlXHbt4CxlBmdDpmqLC_VJ9ldTHBy4kxr1IwXxq4Es,2481
 isaacus/types/classifications/__init__.py,sha256=GX6WFRzjx9qcuJhdRZjFLJRYMM4d5J8F5N-BUq4ZgP0,296
-isaacus/types/classifications/universal_classification.py,sha256=Dmh03lcEzb5atmmdhNs99kPX9HQ1B_BaNKUojxu2nlA,1654
-isaacus/types/classifications/universal_create_params.py,sha256=fFhx7SfLPA36lwCYPEzrW2jr7hFlSFyVPqBzNcHXQ2w,2259
-isaacus-0.3.3.dist-info/METADATA,sha256=XJxWwrEkfc7Ig22POMnX2qrpb-_57WLPNsPMfxjN9gg,14296
-isaacus-0.3.3.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-isaacus-0.3.3.dist-info/licenses/LICENSE,sha256=lUen4LYVFVGEVXBsntBAPsQsOWgMkno1e9WfgWkpZ-k,11337
-isaacus-0.3.3.dist-info/RECORD,,
+isaacus/types/classifications/universal_classification.py,sha256=qeAaPg26wXDq1R_93SZIDzTp9AkfLRMucpd6Tie7NNU,2438
+isaacus/types/classifications/universal_create_params.py,sha256=yacdNfTCgkQhXtdd_fim1YqNCRMEoRL5aKCtbJCQhTk,2277
+isaacus-0.5.0.dist-info/METADATA,sha256=X7-4dd325DbmpBqy3h487IW4hdaBA0zH0yN5n3p3OvU,14347
+isaacus-0.5.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+isaacus-0.5.0.dist-info/licenses/LICENSE,sha256=lUen4LYVFVGEVXBsntBAPsQsOWgMkno1e9WfgWkpZ-k,11337
+isaacus-0.5.0.dist-info/RECORD,,