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/resources/rerankings.ts

@@ -15,7 +15,7 @@ export class Rerankings extends APIResource {
    * @example
    * ```ts
    * const rerankingResponse = await client.rerankings.create({
-   *   model: 'kanon-universal-classifier',
+   *   model: 'kanon-2-reranker',
    *   query:
    *     'What are the essential elements required to establish a negligence claim?',
    *   texts: [
@@ -35,8 +35,8 @@ export class Rerankings extends APIResource {
 
 export interface RerankingResponse {
   /**
-   * 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.
    */
   results: Array<RerankingResponse.Result>;
 
@@ -74,10 +74,11 @@ export namespace RerankingResponse {
 
 export interface RerankingCreateParams {
   /**
-   * 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).
    */
-  model: 'kanon-universal-classifier' | 'kanon-universal-classifier-mini';
+  model: 'kanon-2-reranker' | 'kanon-universal-classifier' | 'kanon-universal-classifier-mini';
 
   /**
    * The query to evaluate the relevance of the texts to.
@@ -115,7 +116,9 @@ export interface RerankingCreateParams {
   is_iql?: boolean;
 
   /**
-   * 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

tests/api-resources/rerankings.test.ts

@@ -11,7 +11,7 @@ describe('resource rerankings', () => {
   // Mock server tests are disabled
   test.skip('create: only required params', async () => {
     const responsePromise = 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.',
@@ -33,7 +33,7 @@ describe('resource rerankings', () => {
   // Mock server tests are disabled
   test.skip('create: required and optional params', async () => {
     const response = await 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.',