Skip to content

Commit 5308689

Browse files
committed
feat(api): rename embedding -> embeddings
1 parent 98c087d commit 5308689

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

openapi.yaml

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ paths:
1818
post:
1919
tags:
2020
- Embeddings
21-
summary: Embedding
21+
summary: Embeddings
2222
description: Embed legal texts with an Isaacus legal AI embedder.
2323
operationId: CreateEmbeddings
2424
requestBody:
2525
content:
2626
application/json:
2727
schema:
28-
$ref: '#/components/schemas/EmbeddingRequest'
28+
$ref: '#/components/schemas/EmbeddingsRequest'
2929
required: true
3030
responses:
3131
'200':
@@ -34,7 +34,7 @@ paths:
3434
content:
3535
application/json:
3636
schema:
37-
$ref: '#/components/schemas/EmbeddingResponse'
37+
$ref: '#/components/schemas/EmbeddingsResponse'
3838
'400':
3939
description: The request was invalid or could not be processed.
4040
content:
@@ -50,29 +50,29 @@ paths:
5050
status: 400
5151
detail: The request was invalid or could not be processed.
5252
instance: null
53-
Embedding input too large error:
54-
summary: Embedding input too large error
53+
Embeddings input too large error:
54+
summary: Embeddings input too large error
5555
value:
5656
type: https://docs.isaacus.com/api-reference/errors#400-validation-error
57-
title: Embedding input too large error
57+
title: Embeddings input too large error
5858
status: 400
5959
detail: The input to the embedding model exceeds the maximum allowed
6060
size.
6161
instance: null
62-
Unsupported embedding dimension error:
63-
summary: Unsupported embedding dimension error
62+
Unsupported embeddings dimension error:
63+
summary: Unsupported embeddings dimension error
6464
value:
6565
type: https://docs.isaacus.com/api-reference/errors#400-validation-error
66-
title: Unsupported embedding dimension error
66+
title: Unsupported embeddings dimension error
6767
status: 400
6868
detail: The provided embedding dimension is not supported by the
6969
model.
7070
instance: null
71-
Unsupported embedding task error:
72-
summary: Unsupported embedding task error
71+
Unsupported embeddings task error:
72+
summary: Unsupported embeddings task error
7373
value:
7474
type: https://docs.isaacus.com/api-reference/errors#400-validation-error
75-
title: Unsupported embedding task error
75+
title: Unsupported embeddings task error
7676
status: 400
7777
detail: The provided embedding task is not supported by the model.
7878
instance: null
@@ -1139,12 +1139,12 @@ components:
11391139
- -0.0258
11401140
- 0.02062
11411141
- -0.0114
1142-
EmbeddingRequest:
1142+
EmbeddingsRequest:
11431143
properties:
11441144
model:
11451145
type: string
11461146
const: kanon-2-embedder
1147-
description: The ID of the [model](https://docs.isaacus.com/models#embedding)
1147+
description: The ID of the [model](https://docs.isaacus.com/models#embeddings)
11481148
to use for embedding.
11491149
examples:
11501150
- kanon-2-embedder
@@ -1229,15 +1229,15 @@ components:
12291229
required:
12301230
- model
12311231
- texts
1232-
title: Embedding request
1232+
title: Embeddings request
12331233
description: A request to embed legal texts with an Isaacus legal AI embedder.
12341234
examples:
12351235
- model: kanon-2-embedder
12361236
texts:
12371237
- Are restraints of trade enforceable under English law?
12381238
- What is a non-compete clause?
12391239
task: retrieval/query
1240-
EmbeddingResponse:
1240+
EmbeddingsResponse:
12411241
properties:
12421242
embeddings:
12431243
items:
@@ -1256,12 +1256,12 @@ components:
12561256
- -0.0128
12571257
- 0.00251
12581258
usage:
1259-
$ref: '#/components/schemas/EmbeddingUsage'
1259+
$ref: '#/components/schemas/EmbeddingsUsage'
12601260
type: object
12611261
required:
12621262
- embeddings
12631263
- usage
1264-
title: Embedding response
1264+
title: Embeddings response
12651265
description: Embeddings of legal texts produced by an Isaacus legal AI embedder.
12661266
examples:
12671267
- embeddings:
@@ -1277,7 +1277,7 @@ components:
12771277
- 0.00251
12781278
usage:
12791279
input_tokens: 42
1280-
EmbeddingUsage:
1280+
EmbeddingsUsage:
12811281
properties:
12821282
input_tokens:
12831283
type: integer
@@ -1288,7 +1288,7 @@ components:
12881288
type: object
12891289
required:
12901290
- input_tokens
1291-
title: Embedding usage
1291+
title: Embeddings usage
12921292
description: Statistics about the usage of resources in the process of embedding
12931293
the inputs.
12941294
examples:

0 commit comments

Comments
 (0)