feat(api): add kanon-2-reranker

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 5
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-baf5ebdd05d1b5192759a356c2701131c47cfb5b7239a49fcb94e68d4210648c.yml
-openapi_spec_hash: 6ea786d56726e18156adf57915fcbe5f
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-cc6e47db2f93647cdafaa2098b9dbe0fc58291998c8a86e2a2e2adc4184da071.yml
+openapi_spec_hash: 8062d4e1530c9017628f3860742c0639
 config_hash: 9040e7359f066240ad536041fb2c5185

src/isaacus/resources/rerankings.py

@@ -51,7 +51,7 @@ def with_streaming_response(self) -> RerankingsResourceWithStreamingResponse:
     def create(
         self,
         *,
-        model: Literal["kanon-universal-classifier", "kanon-universal-classifier-mini"],
+        model: Literal["kanon-2-reranker", "kanon-universal-classifier", "kanon-universal-classifier-mini"],
         query: str,
         texts: SequenceNotStr[str],
         top_n: Optional[int] | Omit = omit,
@@ -70,8 +70,9 @@ def create(
         reranker.
 
         Args:
-          model: The ID of the [model](https://docs.isaacus.com/models#reranking) to use for
-              reranking.
+          model: The ID of the model to use for reranking, being either a
+              [reranking model](https://docs.isaacus.com/models/introduction#reranking) or
+              [universal classification model](https://docs.isaacus.com/models/introduction#universal-classification).
 
           query: The query to evaluate the relevance of the texts to.
 
@@ -96,7 +97,9 @@ def create(
               before enabling IQL since queries can be crafted to consume an excessively large
               amount of tokens.
 
-          scoring_method: The method to use for producing an overall relevance score for a text.
+          scoring_method: The method to use for producing an overall relevance score for a text that
+              exceeds the model's local context window and has, therefore, been split into
+              multiple chunks.
 
               `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
@@ -166,7 +169,7 @@ def with_streaming_response(self) -> AsyncRerankingsResourceWithStreamingRespons
     async def create(
         self,
         *,
-        model: Literal["kanon-universal-classifier", "kanon-universal-classifier-mini"],
+        model: Literal["kanon-2-reranker", "kanon-universal-classifier", "kanon-universal-classifier-mini"],
         query: str,
         texts: SequenceNotStr[str],
         top_n: Optional[int] | Omit = omit,
@@ -185,8 +188,9 @@ async def create(
         reranker.
 
         Args:
-          model: The ID of the [model](https://docs.isaacus.com/models#reranking) to use for
-              reranking.
+          model: The ID of the model to use for reranking, being either a
+              [reranking model](https://docs.isaacus.com/models/introduction#reranking) or
+              [universal classification model](https://docs.isaacus.com/models/introduction#universal-classification).
 
           query: The query to evaluate the relevance of the texts to.
 
@@ -211,7 +215,9 @@ async def create(
               before enabling IQL since queries can be crafted to consume an excessively large
               amount of tokens.
 
-          scoring_method: The method to use for producing an overall relevance score for a text.
+          scoring_method: The method to use for producing an overall relevance score for a text that
+              exceeds the model's local context window and has, therefore, been split into
+              multiple chunks.
 
               `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

src/isaacus/types/reranking_create_params.py

@@ -11,10 +11,11 @@
 
 
 class RerankingCreateParams(TypedDict, total=False):
-    model: Required[Literal["kanon-universal-classifier", "kanon-universal-classifier-mini"]]
+    model: Required[Literal["kanon-2-reranker", "kanon-universal-classifier", "kanon-universal-classifier-mini"]]
     """
-    The ID of the [model](https://docs.isaacus.com/models#reranking) to use for
-    reranking.
+    The ID of the model to use for reranking, being either a
+    [reranking model](https://docs.isaacus.com/models/introduction#reranking) or
+    [universal classification model](https://docs.isaacus.com/models/introduction#universal-classification).
     """
 
     query: Required[str]
@@ -49,7 +50,10 @@ class RerankingCreateParams(TypedDict, total=False):
     """
 
     scoring_method: Literal["auto", "chunk_max", "chunk_avg", "chunk_min"]
-    """The method to use for producing an overall relevance score for a text.
+    """
+    The method to use for producing an overall relevance score for a text that
+    exceeds the model's local context window and has, therefore, been split into
+    multiple chunks.
 
     `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

src/isaacus/types/reranking_response.py

@@ -31,8 +31,8 @@ class Usage(BaseModel):
 class RerankingResponse(BaseModel):
     results: List[Result]
     """
-    The rerankings of the texts, by relevance to the query, in order from highest to
-    lowest relevance score.
+    The texts reranked by relevance to the query, in order from highest to lowest
+    relevance score.
     """
 
     usage: Usage

tests/api_resources/test_rerankings.py

@@ -21,7 +21,7 @@ class TestRerankings:
     @parametrize
     def test_method_create(self, client: Isaacus) -> None:
         reranking = client.rerankings.create(
-            model="kanon-universal-classifier",
+            model="kanon-2-reranker",
             query="What are the essential elements required to establish a negligence claim?",
             texts=[
                 "To form a contract, there must be an offer, acceptance, consideration, and mutual intent to be bound.",
@@ -37,7 +37,7 @@ def test_method_create(self, client: Isaacus) -> None:
     @parametrize
     def test_method_create_with_all_params(self, client: Isaacus) -> None:
         reranking = client.rerankings.create(
-            model="kanon-universal-classifier",
+            model="kanon-2-reranker",
             query="What are the essential elements required to establish a negligence claim?",
             texts=[
                 "To form a contract, there must be an offer, acceptance, consideration, and mutual intent to be bound.",
@@ -61,7 +61,7 @@ def test_method_create_with_all_params(self, client: Isaacus) -> None:
     @parametrize
     def test_raw_response_create(self, client: Isaacus) -> None:
         response = client.rerankings.with_raw_response.create(
-            model="kanon-universal-classifier",
+            model="kanon-2-reranker",
             query="What are the essential elements required to establish a negligence claim?",
             texts=[
                 "To form a contract, there must be an offer, acceptance, consideration, and mutual intent to be bound.",
@@ -81,7 +81,7 @@ def test_raw_response_create(self, client: Isaacus) -> None:
     @parametrize
     def test_streaming_response_create(self, client: Isaacus) -> None:
         with client.rerankings.with_streaming_response.create(
-            model="kanon-universal-classifier",
+            model="kanon-2-reranker",
             query="What are the essential elements required to establish a negligence claim?",
             texts=[
                 "To form a contract, there must be an offer, acceptance, consideration, and mutual intent to be bound.",
@@ -109,7 +109,7 @@ class TestAsyncRerankings:
     @parametrize
     async def test_method_create(self, async_client: AsyncIsaacus) -> None:
         reranking = await async_client.rerankings.create(
-            model="kanon-universal-classifier",
+            model="kanon-2-reranker",
             query="What are the essential elements required to establish a negligence claim?",
             texts=[
                 "To form a contract, there must be an offer, acceptance, consideration, and mutual intent to be bound.",
@@ -125,7 +125,7 @@ async def test_method_create(self, async_client: AsyncIsaacus) -> None:
     @parametrize
     async def test_method_create_with_all_params(self, async_client: AsyncIsaacus) -> None:
         reranking = await async_client.rerankings.create(
-            model="kanon-universal-classifier",
+            model="kanon-2-reranker",
             query="What are the essential elements required to establish a negligence claim?",
             texts=[
                 "To form a contract, there must be an offer, acceptance, consideration, and mutual intent to be bound.",
@@ -149,7 +149,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncIsaacus) -
     @parametrize
     async def test_raw_response_create(self, async_client: AsyncIsaacus) -> None:
         response = await async_client.rerankings.with_raw_response.create(
-            model="kanon-universal-classifier",
+            model="kanon-2-reranker",
             query="What are the essential elements required to establish a negligence claim?",
             texts=[
                 "To form a contract, there must be an offer, acceptance, consideration, and mutual intent to be bound.",
@@ -169,7 +169,7 @@ async def test_raw_response_create(self, async_client: AsyncIsaacus) -> None:
     @parametrize
     async def test_streaming_response_create(self, async_client: AsyncIsaacus) -> None:
         async with async_client.rerankings.with_streaming_response.create(
-            model="kanon-universal-classifier",
+            model="kanon-2-reranker",
             query="What are the essential elements required to establish a negligence claim?",
             texts=[
                 "To form a contract, there must be an offer, acceptance, consideration, and mutual intent to be bound.",