You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit d2a794f
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .speakeasy/out.openapi.yaml
+22-1Lines changed: 22 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -6207,6 +6207,10 @@ components:
6207
6207
index: 0
6208
6208
object: 'embedding'
6209
6209
properties:
6210
+
document_index:
6211
+
description: 'Index of the source document when `input` was a list of documents (contextual embeddings). Absent otherwise.'
6212
+
example: 0
6213
+
type: 'integer'
6210
6214
embedding:
6211
6215
anyOf:
6212
6216
- items:
@@ -44088,6 +44092,19 @@ paths:
44088
44092
minLength: 1
44089
44093
type: 'string'
44090
44094
type: 'array'
44095
+
- description: 'Documents to embed with document-level context: each item is an ordered list of chunk strings. One embedding is returned per chunk, in document order, with `document_index` set on each. Only models that support contextual embeddings accept this shape.'
44096
+
example:
44097
+
- - 'Paris is the capital of France.'
44098
+
- 'It sits on the Seine.'
44099
+
- - 'Berlin is the capital of Germany.'
44100
+
items:
44101
+
items:
44102
+
minLength: 1
44103
+
type: 'string'
44104
+
minItems: 1
44105
+
type: 'array'
44106
+
minItems: 1
44107
+
type: 'array'
44091
44108
- items:
44092
44109
type: 'number'
44093
44110
type: 'array'
@@ -44141,7 +44158,7 @@ paths:
44141
44158
description: 'Text, token, or multimodal input(s) to embed'
44142
44159
example: 'The quick brown fox jumps over the lazy dog'
44143
44160
input_type:
44144
-
description: 'The type of input (e.g. search_query, search_document)'
44161
+
description: 'The type of input (e.g. search_query, search_document). Document-chunk input (`string[][]`) is only valid with a document input type.'
44145
44162
example: 'search_query'
44146
44163
type: 'string'
44147
44164
model:
@@ -44207,6 +44224,10 @@ paths:
44207
44224
index: 0
44208
44225
object: 'embedding'
44209
44226
properties:
44227
+
document_index:
44228
+
description: 'Index of the source document when `input` was a list of documents (contextual embeddings). Absent otherwise.'
|`embedding`|[components.Embedding](../components/embedding.mdx)| βοΈ | Embedding vector as an array of floats or a base64 string |[<br/>0.0023064255,<br/>-0.009327292,<br/>0.015797347<br/>]|
13
-
|`index`|*Optional[int]*| β | Index of the embedding in the input list | 0 |
|`document_index`|*Optional[int]*| β | Index of the source document when `input` was a list of documents (contextual embeddings). Absent otherwise. | 0 |
13
+
|`embedding`|[components.Embedding](../components/embedding.mdx)| βοΈ | Embedding vector as an array of floats or a base64 string |[<br/>0.0023064255,<br/>-0.009327292,<br/>0.015797347<br/>]|
14
+
|`index`|*Optional[int]*| β | Index of the embedding in the input list | 0 |
0 commit comments