feat(api): added latest OpenAPI specification (#29)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 1
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-472ef5f1174bab055fd83756f45445b5c0f1f3f442c531dfc275ea895ec229a7.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-ec269bff43481aeb5c72d3074aa31815ef915d435e78bc62b0290437a7b2992a.yml

README.md

@@ -15,10 +15,13 @@ The REST API documentation can be found on [docs.isaacus.com](https://docs.isaac
 ## Installation
 
 ```sh
-# install from PyPI
-pip install isaacus
+# install from the production repo
+pip install git+ssh://git@github.com/isaacus-dev/isaacus-python.git
 ```
 
+> [!NOTE]
+> Once this package is [published to PyPI](https://app.stainless.com/docs/guides/publish), this will become: `pip install isaacus`
+
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).

src/isaacus/resources/classifications/universal.py

@@ -68,10 +68,11 @@ def create(
         legal AI classifier.
 
         Args:
-          model: The ID of the model to use for universal classification.
+          model: The ID of the [model](https://docs.isaacus.com/models#universal-classification)
+              to use for universal classification.
 
-          query: The Isaacus Query Language (IQL) query or, if IQL is disabled, the statement, to
-              evaluate the text against.
+          query: The [Isaacus Query Language (IQL)](https://docs.isaacus.com/iql) query or, if
+              IQL is disabled, the statement, to evaluate the text against.
 
               The query must contain at least one non-whitespace character.
 
@@ -84,8 +85,8 @@ def create(
 
           chunking_options: Options for how to split text into smaller chunks.
 
-          is_iql: Whether the query should be interpreted as an Isaacus Query Language (IQL) query
-              or else as a statement.
+          is_iql: Whether the query should be interpreted as an
+              [IQL](https://docs.isaacus.com/iql) query or else as a statement.
 
           scoring_method: The method to use for producing an overall confidence score.
 
@@ -168,10 +169,11 @@ async def create(
         legal AI classifier.
 
         Args:
-          model: The ID of the model to use for universal classification.
+          model: The ID of the [model](https://docs.isaacus.com/models#universal-classification)
+              to use for universal classification.
 
-          query: The Isaacus Query Language (IQL) query or, if IQL is disabled, the statement, to
-              evaluate the text against.
+          query: The [Isaacus Query Language (IQL)](https://docs.isaacus.com/iql) query or, if
+              IQL is disabled, the statement, to evaluate the text against.
 
               The query must contain at least one non-whitespace character.
 
@@ -184,8 +186,8 @@ async def create(
 
           chunking_options: Options for how to split text into smaller chunks.
 
-          is_iql: Whether the query should be interpreted as an Isaacus Query Language (IQL) query
-              or else as a statement.
+          is_iql: Whether the query should be interpreted as an
+              [IQL](https://docs.isaacus.com/iql) query or else as a statement.
 
           scoring_method: The method to use for producing an overall confidence score.
 

src/isaacus/types/classifications/universal_create_params.py

@@ -10,12 +10,15 @@
 
 class UniversalCreateParams(TypedDict, total=False):
     model: Required[Literal["kanon-universal-classifier", "kanon-universal-classifier-mini"]]
-    """The ID of the model to use for universal classification."""
+    """
+    The ID of the [model](https://docs.isaacus.com/models#universal-classification)
+    to use for universal classification.
+    """
 
     query: Required[str]
     """
-    The Isaacus Query Language (IQL) query or, if IQL is disabled, the statement, to
-    evaluate the text against.
+    The [Isaacus Query Language (IQL)](https://docs.isaacus.com/iql) query or, if
+    IQL is disabled, the statement, to evaluate the text against.
 
     The query must contain at least one non-whitespace character.
 
@@ -34,8 +37,8 @@ class UniversalCreateParams(TypedDict, total=False):
 
     is_iql: bool
     """
-    Whether the query should be interpreted as an Isaacus Query Language (IQL) query
-    or else as a statement.
+    Whether the query should be interpreted as an
+    [IQL](https://docs.isaacus.com/iql) query or else as a statement.
     """
 
     scoring_method: Literal["auto", "chunk_max", "chunk_avg", "chunk_min"]