Skip to content

Commit 59ad7bf

Browse files
committed
feat(api): add kanon-2-reranker
1 parent bd31ee2 commit 59ad7bf

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

openapi.yaml

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4114,12 +4114,14 @@ components:
41144114
model:
41154115
type: string
41164116
enum:
4117+
- kanon-2-reranker
41174118
- kanon-universal-classifier
41184119
- kanon-universal-classifier-mini
4119-
description: The ID of the [model](https://docs.isaacus.com/models#reranking)
4120-
to use for reranking.
4120+
description: The ID of the model to use for reranking, being either a [reranking
4121+
model](https://docs.isaacus.com/models/introduction#reranking) or [universal
4122+
classification model](https://docs.isaacus.com/models/introduction#universal-classification).
41214123
examples:
4122-
- kanon-universal-classifier
4124+
- kanon-2-reranker
41234125
query:
41244126
type: string
41254127
maxLength: 5000
@@ -4193,7 +4195,8 @@ components:
41934195
- chunk_avg
41944196
- chunk_min
41954197
description: 'The method to use for producing an overall relevance score
4196-
for a text.
4198+
for a text that exceeds the model''s local context window and has, therefore,
4199+
been split into multiple chunks.
41974200
41984201
41994202
`auto` is the default scoring method and is recommended for most use cases.
@@ -4238,7 +4241,7 @@ components:
42384241
description: A request to rerank legal documents by their relevance to a query
42394242
with an Isaacus legal AI reranker.
42404243
examples:
4241-
- model: kanon-universal-classifier
4244+
- model: kanon-2-reranker
42424245
query: What are the essential elements required to establish a negligence
42434246
claim?
42444247
texts:
@@ -4252,14 +4255,21 @@ components:
42524255
owed to the plaintiff.
42534256
- The concept of negligence is central to tort law, with courts assessing
42544257
whether a breach of duty caused harm.
4258+
top_n: null
4259+
is_iql: false
4260+
scoring_method: auto
4261+
chunking_options:
4262+
size: null
4263+
overlap_ratio: null
4264+
overlap_tokens: null
42554265
RerankingResponse:
42564266
properties:
42574267
results:
42584268
items:
42594269
$ref: '#/components/schemas/RerankingResult'
42604270
type: array
4261-
description: The rerankings of the texts, by relevance to the query, in
4262-
order from highest to lowest relevance score.
4271+
description: The texts reranked by relevance to the query, in order from
4272+
highest to lowest relevance score.
42634273
examples:
42644274
- - index: 2
42654275
score: 0.7727372261985272

0 commit comments

Comments
 (0)