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

isaacus/types/extractions/qa_create_params.py

@@ -0,0 +1,64 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Optional
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["QaCreateParams", "ChunkingOptions"]
+
+
+class QaCreateParams(TypedDict, total=False):
+    model: Required[Literal["kanon-answer-extractor", "kanon-answer-extractor-mini"]]
+    """
+    The ID of the [model](https://docs.isaacus.com/models#extractive-qa) to use for
+    extractive question answering.
+    """
+
+    query: Required[str]
+    """The query to extract the answer to.
+
+    The query must contain at least one non-whitespace character.
+
+    Unlike the texts from which the answer will be extracted, the query cannot be so
+    long that it exceeds the maximum input length of the model.
+    """
+
+    texts: Required[List[str]]
+    """The texts to search for the answer in and extract the answer from.
+
+    There must be at least one text.
+
+    Each text must contain at least one non-whitespace character.
+    """
+
+    chunking_options: Optional[ChunkingOptions]
+    """Options for how to split text into smaller chunks."""
+
+    ignore_inextractability: bool
+    """
+    Whether to, if the model's score of the likelihood that an answer can not be
+    extracted from a text is greater than the highest score of all possible answers,
+    still return the highest scoring answers for that text.
+
+    If you have already determined that the texts answer the query, for example, by
+    using one of our classification or reranker models, then you should set this to
+    `true`.
+    """
+
+    top_k: int
+    """The number of highest scoring answers to return.
+
+    If `null`, which is the default, all answers will be returned.
+    """
+
+
+class ChunkingOptions(TypedDict, total=False):
+    overlap_ratio: Optional[float]
+    """A number greater than or equal to 0 and less than 1."""
+
+    overlap_tokens: Optional[int]
+    """A whole number greater than -1."""
+
+    size: Optional[int]
+    """A whole number greater than or equal to 1."""

isaacus/types/reranking_create_params.py

@@ -29,7 +29,7 @@ class RerankingCreateParams(TypedDict, total=False):
 
     There must be at least one text.
 
-    The texts must contain at least one non-whitespace character.
+    Each text must contain at least one non-whitespace character.
     """
 
     chunking_options: Optional[ChunkingOptions]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: isaacus
-Version: 0.5.0
+Version: 0.6.1
 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
@@ -131,7 +131,7 @@ universal_classification = client.classifications.universal.create(
         "size": 512,
     },
 )
-print(universal_classification.chunking_options)
+print(universal_classification.classifications)
 ```
 
 ## Handling errors

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

@@ -1,40 +1,47 @@
-isaacus/__init__.py,sha256=Wgs-qjblN9tJvI22iWwi5CfiVvyn1drBPnTYhVj7cWk,2426
-isaacus/_base_client.py,sha256=f8PpKwJ8YPyCeeBMSa71foqa9INVBTKqwRAwYRGIEq8,65455
-isaacus/_client.py,sha256=aqn4G8onxd-CBS_Tgnr9QA41g6ltcIScHsuUo9U1JeU,15874
+isaacus/__init__.py,sha256=wr6ddQI6xaQxDY-GoGzbBSqxrHcTB0JXRu35iJSo4f8,2537
+isaacus/_base_client.py,sha256=ppcrw3sdH8GjKCCOzQq8IFBYxDeZUc7b7ABov3VPbYI,64055
+isaacus/_client.py,sha256=-2sN8vyAm_qN2P6JuLxKel6BfvA6mragbo4TPOwLs3Y,16544
 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=q-l1tes71l6z-D5ffu9-G4UigTVVeJwiwIzA_gO4RFo,29045
+isaacus/_models.py,sha256=mB2r2VWQq49jG-F0RIXDrBxPp3v-Eg12wMOtVTNxtv4,29057
 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/_response.py,sha256=aXLF5ia58bjjQXTxY574lh7JfKXiGL2tDTX09klm8lw,28794
 isaacus/_streaming.py,sha256=tMBfwrfEFWm0v7vWFgjn_lizsoD70lPkYigIBuADaCM,10104
 isaacus/_types.py,sha256=WCRAb8jikEJoOi8nza8l5NnOTKgZlpmN5fkiHoKoY08,6144
-isaacus/_version.py,sha256=sKzfejNUQSpNw34xaEeyTyEFijKAL_S_FtI3io-aV1c,159
+isaacus/_version.py,sha256=mXn9Voi9RjCSKBeTeNhHxaqwo8_2Zcwq04UnPfptUUc,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
-isaacus/_utils/_proxy.py,sha256=z3zsateHtb0EARTWKk8QZNHfPkqJbqwd1lM993LBwGE,1902
+isaacus/_utils/_proxy.py,sha256=aglnj2yBTDyGX9Akk2crZHrl10oqRmceUy2Zp008XEs,1975
 isaacus/_utils/_reflection.py,sha256=ZmGkIgT_PuwedyNBrrKGbxoWtkpytJNU1uU4QHnmEMU,1364
+isaacus/_utils/_resources_proxy.py,sha256=vW2q6wobLs4JH9DnlVsdaotKEzn5bWqqe8WhNTAOv_k,594
 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=D0DbbNu8GnYQTSICnTSHDGsYXj8TcAKyhejb0XcnjtY,4602
-isaacus/_utils/_utils.py,sha256=8UmbPOy_AAr2uUjjFui-VZSrVBHRj6bfNEKRp5YZP2A,12004
+isaacus/_utils/_utils.py,sha256=ts4CiiuNpFiGB6YMdkQRh2SZvYvsl7mAF-JWHCcLDf4,12312
 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/__init__.py,sha256=BFfbYDoVs497KDWA4AOZbtK2Wv8zx9pip4GZQphfGSI,1686
+isaacus/resources/rerankings.py,sha256=V_6f8HIdW4N5GzA41U_fFxoD2pua8cndFg8et23rWsI,11174
 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=KEBH6BXeD3BvIWY_IlcC7373Qzl7yN8dJxbsnYcyvKA,10690
+isaacus/resources/classifications/universal.py,sha256=AyG0_P3Af0rQQAfDv9oTHLGzjsvyIH5c7eWgg2UWxT8,10677
+isaacus/resources/extractions/__init__.py,sha256=24ccXv3kRlfXwnZJ4572kWNjJKiJ0Cd5vWeRkKCuMyY,1015
+isaacus/resources/extractions/extractions.py,sha256=RaUnv1OG4i5J3JhpBNfpnxELpSHvmkqZmS2_DVL9Wvw,3671
+isaacus/resources/extractions/qa.py,sha256=nPddCTtSxAyNVu4OCSjObeaGNWopm8_-eZuu345cCRo,9932
 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/reranking_create_params.py,sha256=eoZcGr0_o8o-NBZ9W7yqW4cZH5dhxMmfIM9jFtIiUu0,2481
 isaacus/types/classifications/__init__.py,sha256=GX6WFRzjx9qcuJhdRZjFLJRYMM4d5J8F5N-BUq4ZgP0,296
 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,,
+isaacus/types/classifications/universal_create_params.py,sha256=0RYreNEY9j5BqxJLMoDxIvibYZnCZcNTFN0zERz7kpg,2277
+isaacus/types/extractions/__init__.py,sha256=9FahSE48xCUSAdkb1DaqRBBznuQ805lmRdlY22iLtQw,254
+isaacus/types/extractions/answer_extraction.py,sha256=KIqfIsdlYAAjDDwzM8XuFOW_1u5zv34RWbIa3WchBxc,2152
+isaacus/types/extractions/qa_create_params.py,sha256=iaGIDnuJ8Kek5jW6QMQdbAQJYYiihcjZ1k_iSDbt1Mk,2065
+isaacus-0.6.1.dist-info/METADATA,sha256=DKStXBPJ7xD0C_Sbod0sChzemCCr63-EWjyMckbpH4E,14346
+isaacus-0.6.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+isaacus-0.6.1.dist-info/licenses/LICENSE,sha256=lUen4LYVFVGEVXBsntBAPsQsOWgMkno1e9WfgWkpZ-k,11337
+isaacus-0.6.1.dist-info/RECORD,,