Skip to content

Commit d3924ec

Browse files
docs(api): reworded descriptions
1 parent 6502b7b commit d3924ec

7 files changed

Lines changed: 21 additions & 17 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 5
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-0768ad934de95835e9f317b06cbe79b8958d9acc9b4b06f3c7743a2b9fcc0f44.yml
3-
openapi_spec_hash: e00200876d755684db6ee666119bc719
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/isaacus%2Fisaacus-a307f2351504c7d4d18a52c3cc7a120f2b1347bb5cfd8f89f8a95591bcc22eac.yml
3+
openapi_spec_hash: 5057bbce3b8a5c9561253624702d893d
44
config_hash: 9040e7359f066240ad536041fb2c5185

src/client.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -724,15 +724,18 @@ export class Isaacus {
724724
static toFile = Uploads.toFile;
725725

726726
/**
727-
* Embed legal texts with Isaacus legal AI embedders.
727+
* Vectorize content with an Isaacus embedding model.
728728
*/
729729
embeddings: API.Embeddings = new API.Embeddings(this);
730730
classifications: API.Classifications = new API.Classifications(this);
731731
/**
732-
* Rerank legal documents by their relevance to queries with Isaacus legal AI rerankers.
732+
* Score and rank documents by their relevance to queries with an Isaacus reranker.
733733
*/
734734
rerankings: API.Rerankings = new API.Rerankings(this);
735735
extractions: API.Extractions = new API.Extractions(this);
736+
/**
737+
* Enrich documents with an Isaacus enrichment model.
738+
*/
736739
enrichments: API.Enrichments = new API.Enrichments(this);
737740
ilgs: API.ILGS = new API.ILGS(this);
738741
}

src/resources/classifications/universal/universal.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@ import { APIPromise } from '../../../core/api-promise';
55
import { RequestOptions } from '../../../internal/request-options';
66

77
/**
8-
* Classify legal documents with Isaacus legal AI classifiers.
8+
* Classify documents with an Isaacus classification model.
99
*/
1010
export class Universal extends APIResource {
1111
/**
12-
* Classify the relevance of legal documents to a query with an Isaacus universal
13-
* legal AI classifier.
12+
* Classify documents with an Isaacus universal classification model.
1413
*
1514
* @example
1615
* ```ts
@@ -32,7 +31,7 @@ export class Universal extends APIResource {
3231
export interface UniversalClassificationResponse {
3332
/**
3433
* The classifications of the texts, by relevance to the query, in order from
35-
* highest to lowest relevance score.
34+
* highest to lowest confidence score.
3635
*/
3736
classifications: Array<UniversalClassificationResponse.Classification>;
3837

src/resources/embeddings.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ import { APIPromise } from '../core/api-promise';
55
import { RequestOptions } from '../internal/request-options';
66

77
/**
8-
* Embed legal texts with Isaacus legal AI embedders.
8+
* Vectorize content with an Isaacus embedding model.
99
*/
1010
export class Embeddings extends APIResource {
1111
/**
12-
* Embed legal texts with an Isaacus legal AI embedder.
12+
* Vectorize content with an Isaacus embedding model.
1313
*
1414
* @example
1515
* ```ts

src/resources/enrichments.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ import * as v1API from './ilgs/v1/v1';
55
import { APIPromise } from '../core/api-promise';
66
import { RequestOptions } from '../internal/request-options';
77

8+
/**
9+
* Enrich documents with an Isaacus enrichment model.
10+
*/
811
export class Enrichments extends APIResource {
912
/**
10-
* Enrich documents with an Isaacus enricher model.
13+
* Enrich documents with an Isaacus enrichment model.
1114
*
1215
* @example
1316
* ```ts

src/resources/extractions/qa/qa.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import { APIPromise } from '../../../core/api-promise';
55
import { RequestOptions } from '../../../internal/request-options';
66

77
/**
8-
* Extract information from legal documents with Isaacus legal AI extractors.
8+
* Extract information from documents with an Isaacus extraction model.
99
*/
1010
export class QA extends APIResource {
1111
/**
12-
* Extract answers to questions from legal documents with an Isaacus legal AI
13-
* answer extractor.
12+
* Extract information from documents with an Isaacus extractive question answering
13+
* model.
1414
*
1515
* @example
1616
* ```ts

src/resources/rerankings.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@ import { APIPromise } from '../core/api-promise';
55
import { RequestOptions } from '../internal/request-options';
66

77
/**
8-
* Rerank legal documents by their relevance to queries with Isaacus legal AI rerankers.
8+
* Score and rank documents by their relevance to queries with an Isaacus reranker.
99
*/
1010
export class Rerankings extends APIResource {
1111
/**
12-
* Rank legal documents by their relevance to a query with an Isaacus legal AI
13-
* reranker.
12+
* Score and rank documents by their relevance to queries with an Isaacus reranker.
1413
*
1514
* @example
1615
* ```ts

0 commit comments

Comments
 (0)