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

isaacus/types/extractions/answer_extraction_response.py

@@ -8,6 +8,8 @@ __all__ = ["AnswerExtractionResponse", "Extraction", "ExtractionAnswer", "Usage"
 
 
 class ExtractionAnswer(BaseModel):
+    """An answer extracted from a text."""
+
     end: int
     """
     The index of the character immediately after the last character of the answer in
@@ -31,6 +33,8 @@ class ExtractionAnswer(BaseModel):
 
 
 class Extraction(BaseModel):
+    """The result of extracting answers from a text."""
+
     answers: List[ExtractionAnswer]
     """Answers extracted from the text, ordered from highest to lowest score."""
 
@@ -53,6 +57,10 @@ class Extraction(BaseModel):
 
 
 class Usage(BaseModel):
+    """
+    Statistics about the usage of resources in the process of extracting answers from the texts.
+    """
+
     input_tokens: int
     """The number of tokens inputted to the model."""
 

isaacus/types/extractions/qa_create_params.py

@@ -57,11 +57,13 @@ class QaCreateParams(TypedDict, total=False):
 
 
 class ChunkingOptions(TypedDict, total=False):
+    """Options for how to split text into smaller chunks."""
+
     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."""
+    """A whole number greater than or equal to 0."""
 
     size: Optional[int]
     """A whole number greater than or equal to 1."""

isaacus/types/reranking_create_params.py

@@ -67,11 +67,13 @@ class RerankingCreateParams(TypedDict, total=False):
 
 
 class ChunkingOptions(TypedDict, total=False):
+    """Options for how to split text into smaller chunks."""
+
     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."""
+    """A whole number greater than or equal to 0."""
 
     size: Optional[int]
     """A whole number greater than or equal to 1."""

isaacus/types/reranking_response.py

@@ -22,6 +22,8 @@ class Result(BaseModel):
 
 
 class Usage(BaseModel):
+    """Statistics about the usage of resources in the process of reranking the texts."""
+
     input_tokens: int
     """The number of tokens inputted to the model."""
 

{isaacus-0.9.1.dist-info → isaacus-0.10.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: isaacus
-Version: 0.9.1
+Version: 0.10.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
@@ -13,15 +13,15 @@ Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: OS Independent
 Classifier: Operating System :: POSIX
 Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Requires-Dist: anyio<5,>=3.5.0
 Requires-Dist: distro<2,>=1.7.0
 Requires-Dist: httpx<1,>=0.23.0
@@ -38,12 +38,21 @@ Description-Content-Type: text/markdown
 <!-- prettier-ignore -->
 [![PyPI version](https://img.shields.io/pypi/v/isaacus.svg?label=pypi%20(stable))](https://pypi.org/project/isaacus/)
 
-The Isaacus Python library provides convenient access to the Isaacus REST API from any Python 3.8+
+The Isaacus Python library provides convenient access to the Isaacus REST API from any Python 3.9+
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
 It is generated with [Stainless](https://www.stainless.com/).
 
+## MCP Server
+
+Use the Isaacus MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
+
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=isaacus-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsImlzYWFjdXMtbWNwIl0sImVudiI6eyJJU0FBQ1VTX0FQSV9LRVkiOiJNeSBBUEkgS2V5In19)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22isaacus-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22isaacus-mcp%22%5D%2C%22env%22%3A%7B%22ISAACUS_API_KEY%22%3A%22My%20API%20Key%22%7D%7D)
+
+> Note: You may need to set environment variables in your MCP client.
+
 ## Documentation
 
 The REST API documentation can be found on [docs.isaacus.com](https://docs.isaacus.com). The full API of this library can be found in [api.md](https://github.com/isaacus-dev/isaacus-python/tree/main/api.md).
@@ -73,6 +82,7 @@ embedding_response = client.embeddings.create(
         "Are restraints of trade enforceable under English law?",
         "What is a non-compete clause?",
     ],
+    task="retrieval/query",
 )
 print(embedding_response.embeddings)
 ```
@@ -103,6 +113,7 @@ async def main() -> None:
             "Are restraints of trade enforceable under English law?",
             "What is a non-compete clause?",
         ],
+        task="retrieval/query",
     )
     print(embedding_response.embeddings)
 
@@ -126,6 +137,7 @@ pip install isaacus[aiohttp]
 Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
 
 ```python
+import os
 import asyncio
 from isaacus import DefaultAioHttpClient
 from isaacus import AsyncIsaacus
@@ -133,7 +145,7 @@ from isaacus import AsyncIsaacus
 
 async def main() -> None:
     async with AsyncIsaacus(
-        api_key="My API Key",
+        api_key=os.environ.get("ISAACUS_API_KEY"),  # This is the default and can be omitted
         http_client=DefaultAioHttpClient(),
     ) as client:
         embedding_response = await client.embeddings.create(
@@ -142,6 +154,7 @@ async def main() -> None:
                 "Are restraints of trade enforceable under English law?",
                 "What is a non-compete clause?",
             ],
+            task="retrieval/query",
         )
         print(embedding_response.embeddings)
 
@@ -202,6 +215,7 @@ try:
             "Are restraints of trade enforceable under English law?",
             "What is a non-compete clause?",
         ],
+        task="retrieval/query",
     )
 except isaacus.APIConnectionError as e:
     print("The server could not be reached")
@@ -251,6 +265,7 @@ client.with_options(max_retries=5).embeddings.create(
         "Are restraints of trade enforceable under English law?",
         "What is a non-compete clause?",
     ],
+    task="retrieval/query",
 )
 ```
 
@@ -280,6 +295,7 @@ client.with_options(timeout=5.0).embeddings.create(
         "Are restraints of trade enforceable under English law?",
         "What is a non-compete clause?",
     ],
+    task="retrieval/query",
 )
 ```
 
@@ -324,6 +340,7 @@ client = Isaacus()
 response = client.embeddings.with_raw_response.create(
     model="kanon-2-embedder",
     texts=["Are restraints of trade enforceable under English law?", "What is a non-compete clause?"],
+    task="retrieval/query",
 )
 print(response.headers.get('X-My-Header'))
 
@@ -348,6 +365,7 @@ with client.embeddings.with_streaming_response.create(
         "Are restraints of trade enforceable under English law?",
         "What is a non-compete clause?",
     ],
+    task="retrieval/query",
 ) as response:
     print(response.headers.get("X-My-Header"))
 
@@ -458,7 +476,7 @@ print(isaacus.__version__)
 
 ## Requirements
 
-Python 3.8 or higher.
+Python 3.9 or higher.
 
 ## Contributing
 

{isaacus-0.9.1.dist-info → isaacus-0.10.1.dist-info}/RECORD

@@ -1,52 +1,56 @@
 isaacus/__init__.py,sha256=wtI0vXNsVgND6Lmq0G6l2iQALnXyM7HqyL9C6gOiaFE,2633
-isaacus/_base_client.py,sha256=Az9XYe7zI4rpf8OKfALV4Yd1yFTPbx7jm_Fv-me8_w4,67048
-isaacus/_client.py,sha256=EOZacvJHWvcvEyvpjPGFiwr3egLvFQEwWDiVnJY_veA,17149
-isaacus/_compat.py,sha256=DQBVORjFb33zch24jzkhM14msvnzY7mmSmgDLaVFUM8,6562
+isaacus/_base_client.py,sha256=C9XldfwpcOoabQRZxP9Vio1ypL9NSp86JiaeSzRrrM8,73659
+isaacus/_client.py,sha256=VeyYx9N4VTFvZFNHKNrQdTT8WdU70SwyPSYL-74XBCU,22625
+isaacus/_compat.py,sha256=teO44AYozpv2wFRrUi7brcZfGPpFSERQZ4fcdX6zVvs,6627
 isaacus/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
 isaacus/_exceptions.py,sha256=L82uluhizzc94VydHIaJkNxkcG-2DAe74tNhrE2eN2A,3222
 isaacus/_files.py,sha256=KnEzGi_O756MvKyJ4fOCW_u3JhOeWPQ4RsmDvqihDQU,3545
-isaacus/_models.py,sha256=lKnskYPONAWDvWo8tmbbVk7HmG7UOsI0Nve0vSMmkRc,30452
+isaacus/_models.py,sha256=R3MpO2z4XhTAnD3ObEks32suRXleF1g7BEgQTOLIxTs,32112
 isaacus/_qs.py,sha256=craIKyvPktJ94cvf9zn8j8ekG9dWJzhWv0ob34lIOv4,4828
 isaacus/_resource.py,sha256=iP_oYhz5enCI58mK7hlwLoPMPh4Q5s8-KBv-jGfv2aM,1106
 isaacus/_response.py,sha256=aXLF5ia58bjjQXTxY574lh7JfKXiGL2tDTX09klm8lw,28794
-isaacus/_streaming.py,sha256=tMBfwrfEFWm0v7vWFgjn_lizsoD70lPkYigIBuADaCM,10104
-isaacus/_types.py,sha256=Bc2gbOMQA8Un1hMX-lkCISJ0_WFoL7iXMs9l9siVwEg,7237
-isaacus/_version.py,sha256=DWNJ1sode6KvzGPouiry6cMoyZDK-GUUN1L8UJr_6qg,159
+isaacus/_streaming.py,sha256=jcoIlOzPElsxFLKe54I-TavCZEuYIx_MYkZN3uSQFqk,10225
+isaacus/_types.py,sha256=hm4MJQF5-9CmsPcIufE6_KvsWtxKrRMnJAgZ7MBydsk,7595
+isaacus/_version.py,sha256=sh7F5nhnT1jJBe1Zberq8uJWRpL_fXN97Dm-a1GY4bo,160
 isaacus/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 isaacus/_utils/__init__.py,sha256=7fch0GT9zpNnErbciSpUNa-SjTxxjY6kxHxKMOM4AGs,2305
 isaacus/_utils/_compat.py,sha256=D8gtAvjJQrDWt9upS0XaG9Rr5l1QhiAx_I_1utT_tt0,1195
 isaacus/_utils/_datetime_parse.py,sha256=bABTs0Bc6rabdFvnIwXjEhWL15TcRgWZ_6XGTqN8xUk,4204
+isaacus/_utils/_json.py,sha256=bl95uuIWwgSfXX-gP1trK_lDAPwJujYfJ05Cxo2SEC4,962
 isaacus/_utils/_logs.py,sha256=rwa1Yzjbs2JaFn9KQ06rH5c_GSNa--BVwWnWhvvT1tY,777
 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/_sync.py,sha256=HBnZkkBnzxtwOZe0212C4EyoRvxhTVtTrLFDz2_xVCg,1589
 isaacus/_utils/_transform.py,sha256=NjCzmnfqYrsAikUHQig6N9QfuTVbKipuP3ur9mcNF-E,15951
 isaacus/_utils/_typing.py,sha256=N_5PPuFNsaygbtA_npZd98SVN1LQQvFTKL6bkWPBZGU,4786
-isaacus/_utils/_utils.py,sha256=0dDqauUbVZEXV0NVl7Bwu904Wwo5eyFCZpQThhFNhyA,12253
+isaacus/_utils/_utils.py,sha256=ugfUaneOK7I8h9b3656flwf5u_kthY0gvNuqvgOLoSU,12252
 isaacus/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
-isaacus/resources/__init__.py,sha256=hYuuyfGpHUmFIXOnO_qcjbgyyoaSm4yt6EhDL_NXUoU,2188
+isaacus/resources/__init__.py,sha256=lBkxBgx6-Cz4isNcKC15aHKJxXJN0xw3Dzj8iZlEz8o,2703
 isaacus/resources/embeddings.py,sha256=Ol-K756e376CnzdoEBuuRRIIdbNpYUOLD0bUN7o6ffA,9470
-isaacus/resources/rerankings.py,sha256=6mfn-T7BKBD0gJcjqOoPhUJsHr7nb2QW0ZYuRND5p8k,11193
+isaacus/resources/enrichments.py,sha256=x41-2i-Iu3iJPZBrrMOuDMoh62Ud7lKhMc3JLmbdAGg,8759
+isaacus/resources/rerankings.py,sha256=Zz3TofFzaexgxqmOsxFWIhb2MFJdEr2o1JzsSxeiIKE,11189
 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=TuTkM2d0bC5A3Eo_1km06IISu2nctEGpWzKHKHnW2IE,10714
 isaacus/resources/extractions/__init__.py,sha256=24ccXv3kRlfXwnZJ4572kWNjJKiJ0Cd5vWeRkKCuMyY,1015
 isaacus/resources/extractions/extractions.py,sha256=RaUnv1OG4i5J3JhpBNfpnxELpSHvmkqZmS2_DVL9Wvw,3671
 isaacus/resources/extractions/qa.py,sha256=5KgPXamGlkR4qTglw0LBsIiytxGwdALQ-RBV7hS5kGo,10029
-isaacus/types/__init__.py,sha256=rJe7gBVr0PgUiBlmSw0LoKhUsBVGsj2NoSSMieJGEpM,433
+isaacus/types/__init__.py,sha256=oEeUoff816LbolcipS92iRJDw6Zdgd4GqsDY67G_Bx0,594
 isaacus/types/embedding_create_params.py,sha256=Vcqa_CSnj_rXl8CWyGzBtjJKin18dRmy-q8N0eNFYQ8,1575
-isaacus/types/embedding_response.py,sha256=LMBDLmYDu8oMoFH-Ov1_N4LovyUPNOeDg8aOHmzjykw,846
-isaacus/types/reranking_create_params.py,sha256=T6N23D1N6zE8rC_wMh1xylj3XSOSqd1-truPNrxZwlE,2522
-isaacus/types/reranking_response.py,sha256=uZDUZrYYbgygj2GpyV2seUWaCiXAzCZBQxmLxV_hEoU,927
+isaacus/types/embedding_response.py,sha256=hDrsSna4GW8-ukNKtN7Svv-zskulPdymkgfv0RJGFoU,937
+isaacus/types/enrichment_create_params.py,sha256=7DmPWolHTrUNLBtS1qpUAK6XUjQ4QlIOwlO1rQP7kZ4,1347
+isaacus/types/enrichment_response.py,sha256=8ykz2OssM6YEHe-rjn-SNBLAmM-7IwyRRBM2CqM4xY4,57688
+isaacus/types/reranking_create_params.py,sha256=8JzCxxIqhsLyINUgzVjG8HadMSrAlqMYMZX-c84vsjk,2595
+isaacus/types/reranking_response.py,sha256=qyCeK30TC6YXO_zmzRzAskwQxnHuyehjqLM8QO5B8z0,1017
 isaacus/types/classifications/__init__.py,sha256=5wz2ChA8Ld8Yfx-7z7PShbfeyvE3wXRfpkctjS27t10,321
-isaacus/types/classifications/universal_classification_response.py,sha256=C-dPzlM4WAHO6ylPcUXZSY2rzjHkwnX77u4LQrHrbSY,2454
-isaacus/types/classifications/universal_create_params.py,sha256=ygK0Ge6PH92c_SyZB94zNGrvwxt9lskza8UTO_RFoDc,2319
+isaacus/types/classifications/universal_classification_response.py,sha256=DkqL-2oCDZStVTC0ErABe9PC7mo7r8QUj-yrpMNXzP4,2545
+isaacus/types/classifications/universal_create_params.py,sha256=o33anF7A87yvW7pBPffTY0Wbhdos5dSdqNGG3qDe20s,2392
 isaacus/types/extractions/__init__.py,sha256=em0yfSoMG1XqO_LfmqveKlKh03y5x6g7hbaUn7ck21c,279
-isaacus/types/extractions/answer_extraction_response.py,sha256=2-EHPss-y5s519W3-PpWyJzjLjUl4OkUfr9teWIN02o,2168
-isaacus/types/extractions/qa_create_params.py,sha256=2ethTpU4W2aOkDO6SZfd4TBkk4aVWeK38nrIzO3EXjg,2127
-isaacus-0.9.1.dist-info/METADATA,sha256=4VrWgR3zsqPXxHSxt8cNcf_WJuUyJarwD2kpbbNZDjs,15438
-isaacus-0.9.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-isaacus-0.9.1.dist-info/licenses/LICENSE,sha256=lUen4LYVFVGEVXBsntBAPsQsOWgMkno1e9WfgWkpZ-k,11337
-isaacus-0.9.1.dist-info/RECORD,,
+isaacus/types/extractions/answer_extraction_response.py,sha256=B-TKDFyte681wE-DttSGF85E5eLbmeVONNxxavSXjcY,2383
+isaacus/types/extractions/qa_create_params.py,sha256=qa6J5OrYA-nLCCuUG8PSb5N4VZAbKeco7lNCmTXQggA,2200
+isaacus-0.10.1.dist-info/METADATA,sha256=EZQDUAP_3DMmBrf8XJHtWiBFQkDTcVxesYEc9FBz0to,17499
+isaacus-0.10.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+isaacus-0.10.1.dist-info/licenses/LICENSE,sha256=a39aM3IX2G2L5Xs88KP8lWSk-UJ3Eaqo8HwnQs9c08U,11337
+isaacus-0.10.1.dist-info/RECORD,,

{isaacus-0.9.1.dist-info → isaacus-0.10.1.dist-info}/licenses/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2025 Isaacus
+   Copyright 2026 Isaacus
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.