Skip to content

Commit 026c4db

Browse files
committed
docs(api): reworded descriptions
1 parent e7c4d03 commit 026c4db

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

openapi.yaml

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
info:
22
title: Isaacus API
33
version: 0.8.2
4-
description: A RESTful API for using Isaacus legal AI models, data and other solutions.
4+
description: A RESTful API for using Isaacus legal models, data and other solutions.
55
termsOfService: https://isaacus.com/terms
66
contact:
77
name: Isaacus Support
@@ -19,7 +19,7 @@ paths:
1919
tags:
2020
- Embeddings
2121
summary: Embedding
22-
description: Embed legal texts with an Isaacus legal AI embedder.
22+
description: Vectorize content with an Isaacus embedding model.
2323
operationId: CreateEmbeddings
2424
requestBody:
2525
content:
@@ -29,7 +29,7 @@ paths:
2929
required: true
3030
responses:
3131
'200':
32-
description: Embeddings of legal texts produced by an Isaacus legal AI embedder.
32+
description: Embeddings of texts produced by an Isaacus embedding model.
3333
content:
3434
application/json:
3535
schema:
@@ -196,8 +196,8 @@ paths:
196196
tags:
197197
- Rerankings
198198
summary: Reranking
199-
description: Rank legal documents by their relevance to a query with an Isaacus
200-
legal AI reranker.
199+
description: Score and rank documents by their relevance to queries with an
200+
Isaacus reranker.
201201
operationId: CreateReranking
202202
requestBody:
203203
content:
@@ -361,8 +361,8 @@ paths:
361361
tags:
362362
- Extractions
363363
summary: Extractive question answering
364-
description: Extract answers to questions from legal documents with an Isaacus
365-
legal AI answer extractor.
364+
description: Extract information from documents with an Isaacus extractive question
365+
answering model.
366366
operationId: CreateAnswerExtractions
367367
requestBody:
368368
content:
@@ -530,8 +530,7 @@ paths:
530530
tags:
531531
- Classifications
532532
summary: Universal classification
533-
description: Classify the relevance of legal documents to a query with an Isaacus
534-
universal legal AI classifier.
533+
description: Classify documents with an Isaacus universal classification model.
535534
operationId: CreateUniversalClassifications
536535
requestBody:
537536
content:
@@ -541,8 +540,8 @@ paths:
541540
required: true
542541
responses:
543542
'200':
544-
description: Classifications of the relevance of legal documents to a query
545-
produced by an Isaacus universal legal AI classifier.
543+
description: Classifications of the relevance of documents to a query produced
544+
by an Isaacus universal classification model.
546545
content:
547546
application/json:
548547
schema:
@@ -709,7 +708,7 @@ paths:
709708
tags:
710709
- Enrichments
711710
summary: Enrichment
712-
description: Enrich documents with an Isaacus enricher model.
711+
description: Enrich documents with an Isaacus enrichment model.
713712
operationId: CreateEnrichments
714713
requestBody:
715714
content:
@@ -1319,8 +1318,8 @@ components:
13191318
- query
13201319
- texts
13211320
title: Answer extraction request
1322-
description: A request to extract answers from legal documents with an Isaacus
1323-
legal AI extractive question answering model.
1321+
description: A request to extract answers from documents with an Isaacus extractive
1322+
question answering model.
13241323
examples:
13251324
- model: kanon-answer-extractor
13261325
query: What is the punishment for murder in Victoria?
@@ -1567,7 +1566,7 @@ components:
15671566
- model
15681567
- texts
15691568
title: Embedding request
1570-
description: A request to embed legal texts with an Isaacus legal AI embedder.
1569+
description: A request to vectorize content with an Isaacus embedding model.
15711570
examples:
15721571
- model: kanon-2-embedder
15731572
texts:
@@ -4238,8 +4237,8 @@ components:
42384237
- query
42394238
- texts
42404239
title: Reranking request
4241-
description: A request to rerank legal documents by their relevance to a query
4242-
with an Isaacus legal AI reranker.
4240+
description: A request to rerank documents by their relevance to a query with
4241+
an Isaacus reranker.
42434242
examples:
42444243
- model: kanon-2-reranker
42454244
query: What are the essential elements required to establish a negligence
@@ -4629,8 +4628,8 @@ components:
46294628
- query
46304629
- texts
46314630
title: Universal classification request
4632-
description: A request to classify the relevance of legal documents to a query
4633-
with an Isaacus universal legal AI classifier.
4631+
description: A request to classify the relevance of documents to a query with
4632+
an Isaacus universal classification model.
46344633
examples:
46354634
- model: kanon-universal-classifier
46364635
query: This is a confidentiality clause.
@@ -4643,7 +4642,7 @@ components:
46434642
$ref: '#/components/schemas/UniversalClassification'
46444643
type: array
46454644
description: The classifications of the texts, by relevance to the query,
4646-
in order from highest to lowest relevance score.
4645+
in order from highest to lowest confidence score.
46474646
examples:
46484647
- - index: 0
46494648
score: 0.8825573934438159
@@ -4763,15 +4762,17 @@ components:
47634762
security:
47644763
- APIKeyBearerTokenAuth: []
47654764
tags:
4765+
- name: Enrichments
4766+
description: Enrich documents with an Isaacus enrichment model.
47664767
- name: Embeddings
4767-
description: Embed legal texts with Isaacus legal AI embedders.
4768+
description: Vectorize content with an Isaacus embedding model.
47684769
- name: Rerankings
4769-
description: Rerank legal documents by their relevance to queries with Isaacus legal
4770-
AI rerankers.
4770+
description: Score and rank documents by their relevance to queries with an Isaacus
4771+
reranker.
47714772
- name: Extractions
4772-
description: Extract information from legal documents with Isaacus legal AI extractors.
4773+
description: Extract information from documents with an Isaacus extraction model.
47734774
- name: Classifications
4774-
description: Classify legal documents with Isaacus legal AI classifiers.
4775+
description: Classify documents with an Isaacus classification model.
47754776
externalDocs:
47764777
url: https://docs.isaacus.com/api-reference
47774778
description: Reference documentation for the Isaacus API.

0 commit comments

Comments
 (0)