@mixedbread/sdk 0.29.0 → 0.31.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/README.md +18 -18
  3. package/bin/cli +4 -10
  4. package/bin/migration-config.json +70 -0
  5. package/client.d.mts +3 -0
  6. package/client.d.mts.map +1 -1
  7. package/client.d.ts +3 -0
  8. package/client.d.ts.map +1 -1
  9. package/client.js +3 -0
  10. package/client.js.map +1 -1
  11. package/client.mjs +3 -0
  12. package/client.mjs.map +1 -1
  13. package/package.json +1 -1
  14. package/resources/data-sources/connectors.d.mts +4 -4
  15. package/resources/data-sources/connectors.d.mts.map +1 -1
  16. package/resources/data-sources/connectors.d.ts +4 -4
  17. package/resources/data-sources/connectors.d.ts.map +1 -1
  18. package/resources/index.d.mts +1 -0
  19. package/resources/index.d.mts.map +1 -1
  20. package/resources/index.d.ts +1 -0
  21. package/resources/index.d.ts.map +1 -1
  22. package/resources/index.js +3 -1
  23. package/resources/index.js.map +1 -1
  24. package/resources/index.mjs +1 -0
  25. package/resources/index.mjs.map +1 -1
  26. package/resources/stores/files.d.mts +547 -0
  27. package/resources/stores/files.d.mts.map +1 -0
  28. package/resources/stores/files.d.ts +547 -0
  29. package/resources/stores/files.d.ts.map +1 -0
  30. package/resources/stores/files.js +68 -0
  31. package/resources/stores/files.js.map +1 -0
  32. package/resources/stores/files.mjs +64 -0
  33. package/resources/stores/files.mjs.map +1 -0
  34. package/resources/stores/index.d.mts +3 -0
  35. package/resources/stores/index.d.mts.map +1 -0
  36. package/resources/stores/index.d.ts +3 -0
  37. package/resources/stores/index.d.ts.map +1 -0
  38. package/resources/stores/index.js +9 -0
  39. package/resources/stores/index.js.map +1 -0
  40. package/resources/stores/index.mjs +4 -0
  41. package/resources/stores/index.mjs.map +1 -0
  42. package/resources/stores/stores.d.mts +372 -0
  43. package/resources/stores/stores.d.mts.map +1 -0
  44. package/resources/stores/stores.d.ts +372 -0
  45. package/resources/stores/stores.d.ts.map +1 -0
  46. package/resources/stores/stores.js +100 -0
  47. package/resources/stores/stores.js.map +1 -0
  48. package/resources/stores/stores.mjs +95 -0
  49. package/resources/stores/stores.mjs.map +1 -0
  50. package/resources/stores.d.mts +2 -0
  51. package/resources/stores.d.mts.map +1 -0
  52. package/resources/stores.d.ts +2 -0
  53. package/resources/stores.d.ts.map +1 -0
  54. package/resources/stores.js +6 -0
  55. package/resources/stores.js.map +1 -0
  56. package/resources/stores.mjs +3 -0
  57. package/resources/stores.mjs.map +1 -0
  58. package/resources/vector-stores/files.d.mts +316 -266
  59. package/resources/vector-stores/files.d.mts.map +1 -1
  60. package/resources/vector-stores/files.d.ts +316 -266
  61. package/resources/vector-stores/files.d.ts.map +1 -1
  62. package/resources/vector-stores/files.js +10 -35
  63. package/resources/vector-stores/files.js.map +1 -1
  64. package/resources/vector-stores/files.mjs +10 -35
  65. package/resources/vector-stores/files.mjs.map +1 -1
  66. package/resources/vector-stores/vector-stores.d.mts +593 -275
  67. package/resources/vector-stores/vector-stores.d.mts.map +1 -1
  68. package/resources/vector-stores/vector-stores.d.ts +593 -275
  69. package/resources/vector-stores/vector-stores.d.ts.map +1 -1
  70. package/resources/vector-stores/vector-stores.js +15 -41
  71. package/resources/vector-stores/vector-stores.js.map +1 -1
  72. package/resources/vector-stores/vector-stores.mjs +15 -41
  73. package/resources/vector-stores/vector-stores.mjs.map +1 -1
  74. package/src/client.ts +31 -0
  75. package/src/resources/data-sources/connectors.ts +4 -4
  76. package/src/resources/index.ts +14 -0
  77. package/src/resources/stores/files.ts +692 -0
  78. package/src/resources/stores/index.ts +30 -0
  79. package/src/resources/stores/stores.ts +523 -0
  80. package/src/resources/stores.ts +3 -0
  81. package/src/resources/vector-stores/files.ts +359 -441
  82. package/src/resources/vector-stores/vector-stores.ts +693 -453
  83. package/src/version.ts +1 -1
  84. package/version.d.mts +1 -1
  85. package/version.d.ts +1 -1
  86. package/version.js +1 -1
  87. package/version.mjs +1 -1
@@ -8,77 +8,51 @@ import { RequestOptions } from "../../internal/request-options.js";
8
8
  export declare class VectorStores extends APIResource {
9
9
  files: FilesAPI.Files;
10
10
  /**
11
- * Create a new vector store.
11
+ * DEPRECATED: Use POST /stores instead
12
12
  *
13
- * Args: vector_store_create: VectorStoreCreate object containing the name,
14
- * description, and metadata.
15
- *
16
- * Returns: VectorStore: The response containing the created vector store details.
13
+ * @deprecated Use stores instead
17
14
  */
18
15
  create(body: VectorStoreCreateParams, options?: RequestOptions): APIPromise<VectorStore>;
19
16
  /**
20
- * Get a vector store by ID or name.
21
- *
22
- * Args: vector_store_identifier: The ID or name of the vector store to retrieve.
17
+ * DEPRECATED: Use GET /stores/{store_identifier} instead
23
18
  *
24
- * Returns: VectorStore: The response containing the vector store details.
19
+ * @deprecated Use stores instead
25
20
  */
26
21
  retrieve(vectorStoreIdentifier: string, options?: RequestOptions): APIPromise<VectorStore>;
27
22
  /**
28
- * Update a vector store by ID or name.
29
- *
30
- * Args: vector_store_identifier: The ID or name of the vector store to update.
31
- * vector_store_update: VectorStoreCreate object containing the name, description,
32
- * and metadata.
23
+ * DEPRECATED: Use PUT /stores/{store_identifier} instead
33
24
  *
34
- * Returns: VectorStore: The response containing the updated vector store details.
25
+ * @deprecated Use stores instead
35
26
  */
36
27
  update(vectorStoreIdentifier: string, body: VectorStoreUpdateParams, options?: RequestOptions): APIPromise<VectorStore>;
37
28
  /**
38
- * List all vector stores with optional search.
29
+ * DEPRECATED: Use GET /stores instead
39
30
  *
40
- * Args: options: The pagination options including limit, cursor, and optional
41
- * search query (q)
42
- *
43
- * Returns: VectorStoreListResponse: The list of vector stores
31
+ * @deprecated Use stores instead
44
32
  */
45
33
  list(query?: VectorStoreListParams | null | undefined, options?: RequestOptions): PagePromise<VectorStoresCursor, VectorStore>;
46
34
  /**
47
- * Delete a vector store by ID or name.
48
- *
49
- * Args: vector_store_identifier: The ID or name of the vector store to delete.
35
+ * DEPRECATED: Use DELETE /stores/{store_identifier} instead
50
36
  *
51
- * Returns: VectorStore: The response containing the deleted vector store details.
37
+ * @deprecated Use stores instead
52
38
  */
53
39
  delete(vectorStoreIdentifier: string, options?: RequestOptions): APIPromise<VectorStoreDeleteResponse>;
54
40
  /**
55
- * Question answering
41
+ * DEPRECATED: Use POST /stores/question-answering instead
42
+ *
43
+ * @deprecated Use stores.question_answering instead
56
44
  */
57
45
  questionAnswering(body: VectorStoreQuestionAnsweringParams, options?: RequestOptions): APIPromise<VectorStoreQuestionAnsweringResponse>;
58
46
  /**
59
- * Perform semantic search across vector store chunks.
60
- *
61
- * This endpoint searches through vector store chunks using semantic similarity
62
- * matching. It supports complex search queries with filters and returns
63
- * relevance-scored results.
64
- *
65
- * Args: search_params: Search configuration including: - query text or
66
- * embeddings - vector_store_ids: List of vector stores to search - file_ids:
67
- * Optional list of file IDs to filter chunks by (or tuple of list and condition
68
- * operator) - metadata filters - pagination parameters - sorting preferences
69
- * \_state: API state dependency \_ctx: Service context dependency
47
+ * DEPRECATED: Use POST /stores/search instead
70
48
  *
71
- * Returns: VectorStoreSearchChunkResponse containing: - List of matched chunks
72
- * with relevance scores - Pagination details including total result count
73
- *
74
- * Raises: HTTPException (400): If search parameters are invalid HTTPException
75
- * (404): If no vector stores are found to search
49
+ * @deprecated Use stores.search instead
76
50
  */
77
51
  search(body: VectorStoreSearchParams, options?: RequestOptions): APIPromise<VectorStoreSearchResponse>;
78
52
  }
79
53
  export type VectorStoresCursor = Cursor<VectorStore>;
80
54
  /**
81
- * Represents an expiration policy for a vector store.
55
+ * Represents an expiration policy for a store.
82
56
  */
83
57
  export interface ExpiresAfter {
84
58
  /**
@@ -86,7 +60,7 @@ export interface ExpiresAfter {
86
60
  */
87
61
  anchor?: 'last_active_at';
88
62
  /**
89
- * Number of days after which the vector store expires
63
+ * Number of days after which the store expires
90
64
  */
91
65
  days?: number;
92
66
  }
@@ -102,7 +76,9 @@ export interface ScoredAudioURLInputChunk {
102
76
  /**
103
77
  * metadata of the chunk
104
78
  */
105
- generated_metadata?: ScoredAudioURLInputChunk.MarkdownChunkGeneratedMetadata | ScoredAudioURLInputChunk.TextChunkGeneratedMetadata | ScoredAudioURLInputChunk.PdfChunkGeneratedMetadata | ScoredAudioURLInputChunk.CodeChunkGeneratedMetadata | ScoredAudioURLInputChunk.AudioChunkGeneratedMetadata | null;
79
+ generated_metadata?: {
80
+ [key: string]: unknown;
81
+ } | null;
106
82
  /**
107
83
  * model used for this chunk
108
84
  */
@@ -120,9 +96,9 @@ export interface ScoredAudioURLInputChunk {
120
96
  */
121
97
  filename: string;
122
98
  /**
123
- * vector store id
99
+ * store id
124
100
  */
125
- vector_store_id: string;
101
+ store_id: string;
126
102
  /**
127
103
  * file metadata
128
104
  */
@@ -149,59 +125,6 @@ export interface ScoredAudioURLInputChunk {
149
125
  sampling_rate: number;
150
126
  }
151
127
  export declare namespace ScoredAudioURLInputChunk {
152
- interface MarkdownChunkGeneratedMetadata {
153
- type?: 'markdown';
154
- file_type?: 'text/markdown';
155
- language: string;
156
- word_count: number;
157
- file_size: number;
158
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
159
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
160
- [k: string]: unknown;
161
- }
162
- namespace MarkdownChunkGeneratedMetadata {
163
- interface ChunkHeading {
164
- level: number;
165
- text: string;
166
- }
167
- interface HeadingContext {
168
- level: number;
169
- text: string;
170
- }
171
- }
172
- interface TextChunkGeneratedMetadata {
173
- type?: 'text';
174
- file_type?: 'text/plain';
175
- language: string;
176
- word_count: number;
177
- file_size: number;
178
- [k: string]: unknown;
179
- }
180
- interface PdfChunkGeneratedMetadata {
181
- type?: 'pdf';
182
- file_type?: 'application/pdf';
183
- total_pages: number;
184
- total_size: number;
185
- [k: string]: unknown;
186
- }
187
- interface CodeChunkGeneratedMetadata {
188
- type?: 'code';
189
- file_type: string;
190
- language: string;
191
- word_count: number;
192
- file_size: number;
193
- [k: string]: unknown;
194
- }
195
- interface AudioChunkGeneratedMetadata {
196
- type?: 'audio';
197
- file_type: string;
198
- file_size: number;
199
- total_duration_seconds: number;
200
- sample_rate: number;
201
- channels: number;
202
- audio_format: number;
203
- [k: string]: unknown;
204
- }
205
128
  /**
206
129
  * The audio input specification.
207
130
  */
@@ -224,7 +147,9 @@ export interface ScoredImageURLInputChunk {
224
147
  /**
225
148
  * metadata of the chunk
226
149
  */
227
- generated_metadata?: ScoredImageURLInputChunk.MarkdownChunkGeneratedMetadata | ScoredImageURLInputChunk.TextChunkGeneratedMetadata | ScoredImageURLInputChunk.PdfChunkGeneratedMetadata | ScoredImageURLInputChunk.CodeChunkGeneratedMetadata | ScoredImageURLInputChunk.AudioChunkGeneratedMetadata | null;
150
+ generated_metadata?: {
151
+ [key: string]: unknown;
152
+ } | null;
228
153
  /**
229
154
  * model used for this chunk
230
155
  */
@@ -242,9 +167,9 @@ export interface ScoredImageURLInputChunk {
242
167
  */
243
168
  filename: string;
244
169
  /**
245
- * vector store id
170
+ * store id
246
171
  */
247
- vector_store_id: string;
172
+ store_id: string;
248
173
  /**
249
174
  * file metadata
250
175
  */
@@ -267,59 +192,6 @@ export interface ScoredImageURLInputChunk {
267
192
  image_url: ScoredImageURLInputChunk.ImageURL;
268
193
  }
269
194
  export declare namespace ScoredImageURLInputChunk {
270
- interface MarkdownChunkGeneratedMetadata {
271
- type?: 'markdown';
272
- file_type?: 'text/markdown';
273
- language: string;
274
- word_count: number;
275
- file_size: number;
276
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
277
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
278
- [k: string]: unknown;
279
- }
280
- namespace MarkdownChunkGeneratedMetadata {
281
- interface ChunkHeading {
282
- level: number;
283
- text: string;
284
- }
285
- interface HeadingContext {
286
- level: number;
287
- text: string;
288
- }
289
- }
290
- interface TextChunkGeneratedMetadata {
291
- type?: 'text';
292
- file_type?: 'text/plain';
293
- language: string;
294
- word_count: number;
295
- file_size: number;
296
- [k: string]: unknown;
297
- }
298
- interface PdfChunkGeneratedMetadata {
299
- type?: 'pdf';
300
- file_type?: 'application/pdf';
301
- total_pages: number;
302
- total_size: number;
303
- [k: string]: unknown;
304
- }
305
- interface CodeChunkGeneratedMetadata {
306
- type?: 'code';
307
- file_type: string;
308
- language: string;
309
- word_count: number;
310
- file_size: number;
311
- [k: string]: unknown;
312
- }
313
- interface AudioChunkGeneratedMetadata {
314
- type?: 'audio';
315
- file_type: string;
316
- file_size: number;
317
- total_duration_seconds: number;
318
- sample_rate: number;
319
- channels: number;
320
- audio_format: number;
321
- [k: string]: unknown;
322
- }
323
195
  /**
324
196
  * The image input specification.
325
197
  */
@@ -346,7 +218,9 @@ export interface ScoredTextInputChunk {
346
218
  /**
347
219
  * metadata of the chunk
348
220
  */
349
- generated_metadata?: ScoredTextInputChunk.MarkdownChunkGeneratedMetadata | ScoredTextInputChunk.TextChunkGeneratedMetadata | ScoredTextInputChunk.PdfChunkGeneratedMetadata | ScoredTextInputChunk.CodeChunkGeneratedMetadata | ScoredTextInputChunk.AudioChunkGeneratedMetadata | null;
221
+ generated_metadata?: {
222
+ [key: string]: unknown;
223
+ } | null;
350
224
  /**
351
225
  * model used for this chunk
352
226
  */
@@ -364,9 +238,9 @@ export interface ScoredTextInputChunk {
364
238
  */
365
239
  filename: string;
366
240
  /**
367
- * vector store id
241
+ * store id
368
242
  */
369
- vector_store_id: string;
243
+ store_id: string;
370
244
  /**
371
245
  * file metadata
372
246
  */
@@ -384,61 +258,6 @@ export interface ScoredTextInputChunk {
384
258
  */
385
259
  text: string;
386
260
  }
387
- export declare namespace ScoredTextInputChunk {
388
- interface MarkdownChunkGeneratedMetadata {
389
- type?: 'markdown';
390
- file_type?: 'text/markdown';
391
- language: string;
392
- word_count: number;
393
- file_size: number;
394
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
395
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
396
- [k: string]: unknown;
397
- }
398
- namespace MarkdownChunkGeneratedMetadata {
399
- interface ChunkHeading {
400
- level: number;
401
- text: string;
402
- }
403
- interface HeadingContext {
404
- level: number;
405
- text: string;
406
- }
407
- }
408
- interface TextChunkGeneratedMetadata {
409
- type?: 'text';
410
- file_type?: 'text/plain';
411
- language: string;
412
- word_count: number;
413
- file_size: number;
414
- [k: string]: unknown;
415
- }
416
- interface PdfChunkGeneratedMetadata {
417
- type?: 'pdf';
418
- file_type?: 'application/pdf';
419
- total_pages: number;
420
- total_size: number;
421
- [k: string]: unknown;
422
- }
423
- interface CodeChunkGeneratedMetadata {
424
- type?: 'code';
425
- file_type: string;
426
- language: string;
427
- word_count: number;
428
- file_size: number;
429
- [k: string]: unknown;
430
- }
431
- interface AudioChunkGeneratedMetadata {
432
- type?: 'audio';
433
- file_type: string;
434
- file_size: number;
435
- total_duration_seconds: number;
436
- sample_rate: number;
437
- channels: number;
438
- audio_format: number;
439
- [k: string]: unknown;
440
- }
441
- }
442
261
  export interface ScoredVideoURLInputChunk {
443
262
  /**
444
263
  * position of the chunk in a file
@@ -451,7 +270,9 @@ export interface ScoredVideoURLInputChunk {
451
270
  /**
452
271
  * metadata of the chunk
453
272
  */
454
- generated_metadata?: ScoredVideoURLInputChunk.MarkdownChunkGeneratedMetadata | ScoredVideoURLInputChunk.TextChunkGeneratedMetadata | ScoredVideoURLInputChunk.PdfChunkGeneratedMetadata | ScoredVideoURLInputChunk.CodeChunkGeneratedMetadata | ScoredVideoURLInputChunk.AudioChunkGeneratedMetadata | null;
273
+ generated_metadata?: {
274
+ [key: string]: unknown;
275
+ } | null;
455
276
  /**
456
277
  * model used for this chunk
457
278
  */
@@ -469,9 +290,9 @@ export interface ScoredVideoURLInputChunk {
469
290
  */
470
291
  filename: string;
471
292
  /**
472
- * vector store id
293
+ * store id
473
294
  */
474
- vector_store_id: string;
295
+ store_id: string;
475
296
  /**
476
297
  * file metadata
477
298
  */
@@ -494,59 +315,6 @@ export interface ScoredVideoURLInputChunk {
494
315
  video_url: ScoredVideoURLInputChunk.VideoURL;
495
316
  }
496
317
  export declare namespace ScoredVideoURLInputChunk {
497
- interface MarkdownChunkGeneratedMetadata {
498
- type?: 'markdown';
499
- file_type?: 'text/markdown';
500
- language: string;
501
- word_count: number;
502
- file_size: number;
503
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
504
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
505
- [k: string]: unknown;
506
- }
507
- namespace MarkdownChunkGeneratedMetadata {
508
- interface ChunkHeading {
509
- level: number;
510
- text: string;
511
- }
512
- interface HeadingContext {
513
- level: number;
514
- text: string;
515
- }
516
- }
517
- interface TextChunkGeneratedMetadata {
518
- type?: 'text';
519
- file_type?: 'text/plain';
520
- language: string;
521
- word_count: number;
522
- file_size: number;
523
- [k: string]: unknown;
524
- }
525
- interface PdfChunkGeneratedMetadata {
526
- type?: 'pdf';
527
- file_type?: 'application/pdf';
528
- total_pages: number;
529
- total_size: number;
530
- [k: string]: unknown;
531
- }
532
- interface CodeChunkGeneratedMetadata {
533
- type?: 'code';
534
- file_type: string;
535
- language: string;
536
- word_count: number;
537
- file_size: number;
538
- [k: string]: unknown;
539
- }
540
- interface AudioChunkGeneratedMetadata {
541
- type?: 'audio';
542
- file_type: string;
543
- file_size: number;
544
- total_duration_seconds: number;
545
- sample_rate: number;
546
- channels: number;
547
- audio_format: number;
548
- [k: string]: unknown;
549
- }
550
318
  /**
551
319
  * The video input specification.
552
320
  */
@@ -586,7 +354,7 @@ export interface VectorStore {
586
354
  */
587
355
  file_counts?: VectorStore.FileCounts;
588
356
  /**
589
- * Represents an expiration policy for a vector store.
357
+ * Represents an expiration policy for a store.
590
358
  */
591
359
  expires_after?: ExpiresAfter | null;
592
360
  /**
@@ -702,7 +470,282 @@ export interface VectorStoreQuestionAnsweringResponse {
702
470
  /**
703
471
  * Source documents used to generate the answer
704
472
  */
705
- sources?: Array<ScoredTextInputChunk | ScoredImageURLInputChunk | ScoredAudioURLInputChunk | ScoredVideoURLInputChunk>;
473
+ sources?: Array<VectorStoreQuestionAnsweringResponse.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredTextInputChunk | VectorStoreQuestionAnsweringResponse.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk | VectorStoreQuestionAnsweringResponse.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk | VectorStoreQuestionAnsweringResponse.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk>;
474
+ }
475
+ export declare namespace VectorStoreQuestionAnsweringResponse {
476
+ /**
477
+ * Scored text chunk for deprecated API.
478
+ */
479
+ interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredTextInputChunk {
480
+ /**
481
+ * position of the chunk in a file
482
+ */
483
+ chunk_index: number;
484
+ /**
485
+ * mime type of the chunk
486
+ */
487
+ mime_type?: string;
488
+ /**
489
+ * metadata of the chunk
490
+ */
491
+ generated_metadata?: {
492
+ [key: string]: unknown;
493
+ } | null;
494
+ /**
495
+ * model used for this chunk
496
+ */
497
+ model?: string | null;
498
+ /**
499
+ * score of the chunk
500
+ */
501
+ score: number;
502
+ /**
503
+ * file id
504
+ */
505
+ file_id: string;
506
+ /**
507
+ * filename
508
+ */
509
+ filename: string;
510
+ /**
511
+ * store id
512
+ */
513
+ vector_store_id: string;
514
+ /**
515
+ * file metadata
516
+ */
517
+ metadata?: unknown;
518
+ /**
519
+ * Input type identifier
520
+ */
521
+ type?: 'text';
522
+ /**
523
+ * The offset of the text in the file relative to the start of the file.
524
+ */
525
+ offset?: number;
526
+ /**
527
+ * Text content to process
528
+ */
529
+ text: string;
530
+ }
531
+ /**
532
+ * Scored image chunk for deprecated API.
533
+ */
534
+ interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk {
535
+ /**
536
+ * position of the chunk in a file
537
+ */
538
+ chunk_index: number;
539
+ /**
540
+ * mime type of the chunk
541
+ */
542
+ mime_type?: string;
543
+ /**
544
+ * metadata of the chunk
545
+ */
546
+ generated_metadata?: {
547
+ [key: string]: unknown;
548
+ } | null;
549
+ /**
550
+ * model used for this chunk
551
+ */
552
+ model?: string | null;
553
+ /**
554
+ * score of the chunk
555
+ */
556
+ score: number;
557
+ /**
558
+ * file id
559
+ */
560
+ file_id: string;
561
+ /**
562
+ * filename
563
+ */
564
+ filename: string;
565
+ /**
566
+ * store id
567
+ */
568
+ vector_store_id: string;
569
+ /**
570
+ * file metadata
571
+ */
572
+ metadata?: unknown;
573
+ /**
574
+ * Input type identifier
575
+ */
576
+ type?: 'image_url';
577
+ /**
578
+ * ocr text of the image
579
+ */
580
+ ocr_text?: string | null;
581
+ /**
582
+ * summary of the image
583
+ */
584
+ summary?: string | null;
585
+ /**
586
+ * The image input specification.
587
+ */
588
+ image_url: MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk.ImageURL;
589
+ }
590
+ namespace MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk {
591
+ /**
592
+ * The image input specification.
593
+ */
594
+ interface ImageURL {
595
+ /**
596
+ * The image URL. Can be either a URL or a Data URI.
597
+ */
598
+ url: string;
599
+ /**
600
+ * The image format/mimetype
601
+ */
602
+ format?: string;
603
+ }
604
+ }
605
+ /**
606
+ * Scored audio chunk for deprecated API.
607
+ */
608
+ interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk {
609
+ /**
610
+ * position of the chunk in a file
611
+ */
612
+ chunk_index: number;
613
+ /**
614
+ * mime type of the chunk
615
+ */
616
+ mime_type?: string;
617
+ /**
618
+ * metadata of the chunk
619
+ */
620
+ generated_metadata?: {
621
+ [key: string]: unknown;
622
+ } | null;
623
+ /**
624
+ * model used for this chunk
625
+ */
626
+ model?: string | null;
627
+ /**
628
+ * score of the chunk
629
+ */
630
+ score: number;
631
+ /**
632
+ * file id
633
+ */
634
+ file_id: string;
635
+ /**
636
+ * filename
637
+ */
638
+ filename: string;
639
+ /**
640
+ * store id
641
+ */
642
+ vector_store_id: string;
643
+ /**
644
+ * file metadata
645
+ */
646
+ metadata?: unknown;
647
+ /**
648
+ * Input type identifier
649
+ */
650
+ type?: 'audio_url';
651
+ /**
652
+ * speech recognition (sr) text of the audio
653
+ */
654
+ transcription?: string | null;
655
+ /**
656
+ * summary of the audio
657
+ */
658
+ summary?: string | null;
659
+ /**
660
+ * The audio input specification.
661
+ */
662
+ audio_url: MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk.AudioURL;
663
+ /**
664
+ * The sampling rate of the audio.
665
+ */
666
+ sampling_rate: number;
667
+ }
668
+ namespace MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk {
669
+ /**
670
+ * The audio input specification.
671
+ */
672
+ interface AudioURL {
673
+ /**
674
+ * The audio URL. Can be either a URL or a Data URI.
675
+ */
676
+ url: string;
677
+ }
678
+ }
679
+ /**
680
+ * Scored video chunk for deprecated API.
681
+ */
682
+ interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk {
683
+ /**
684
+ * position of the chunk in a file
685
+ */
686
+ chunk_index: number;
687
+ /**
688
+ * mime type of the chunk
689
+ */
690
+ mime_type?: string;
691
+ /**
692
+ * metadata of the chunk
693
+ */
694
+ generated_metadata?: {
695
+ [key: string]: unknown;
696
+ } | null;
697
+ /**
698
+ * model used for this chunk
699
+ */
700
+ model?: string | null;
701
+ /**
702
+ * score of the chunk
703
+ */
704
+ score: number;
705
+ /**
706
+ * file id
707
+ */
708
+ file_id: string;
709
+ /**
710
+ * filename
711
+ */
712
+ filename: string;
713
+ /**
714
+ * store id
715
+ */
716
+ vector_store_id: string;
717
+ /**
718
+ * file metadata
719
+ */
720
+ metadata?: unknown;
721
+ /**
722
+ * Input type identifier
723
+ */
724
+ type?: 'video_url';
725
+ /**
726
+ * speech recognition (sr) text of the video
727
+ */
728
+ transcription?: string | null;
729
+ /**
730
+ * summary of the video
731
+ */
732
+ summary?: string | null;
733
+ /**
734
+ * The video input specification.
735
+ */
736
+ video_url: MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk.VideoURL;
737
+ }
738
+ namespace MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk {
739
+ /**
740
+ * The video input specification.
741
+ */
742
+ interface VideoURL {
743
+ /**
744
+ * The video URL. Can be either a URL or a Data URI.
745
+ */
746
+ url: string;
747
+ }
748
+ }
706
749
  }
707
750
  export interface VectorStoreSearchResponse {
708
751
  /**
@@ -712,7 +755,282 @@ export interface VectorStoreSearchResponse {
712
755
  /**
713
756
  * The list of scored vector store file chunks
714
757
  */
715
- data: Array<ScoredTextInputChunk | ScoredImageURLInputChunk | ScoredAudioURLInputChunk | ScoredVideoURLInputChunk>;
758
+ data: Array<VectorStoreSearchResponse.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredTextInputChunk | VectorStoreSearchResponse.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk | VectorStoreSearchResponse.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk | VectorStoreSearchResponse.MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk>;
759
+ }
760
+ export declare namespace VectorStoreSearchResponse {
761
+ /**
762
+ * Scored text chunk for deprecated API.
763
+ */
764
+ interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredTextInputChunk {
765
+ /**
766
+ * position of the chunk in a file
767
+ */
768
+ chunk_index: number;
769
+ /**
770
+ * mime type of the chunk
771
+ */
772
+ mime_type?: string;
773
+ /**
774
+ * metadata of the chunk
775
+ */
776
+ generated_metadata?: {
777
+ [key: string]: unknown;
778
+ } | null;
779
+ /**
780
+ * model used for this chunk
781
+ */
782
+ model?: string | null;
783
+ /**
784
+ * score of the chunk
785
+ */
786
+ score: number;
787
+ /**
788
+ * file id
789
+ */
790
+ file_id: string;
791
+ /**
792
+ * filename
793
+ */
794
+ filename: string;
795
+ /**
796
+ * store id
797
+ */
798
+ vector_store_id: string;
799
+ /**
800
+ * file metadata
801
+ */
802
+ metadata?: unknown;
803
+ /**
804
+ * Input type identifier
805
+ */
806
+ type?: 'text';
807
+ /**
808
+ * The offset of the text in the file relative to the start of the file.
809
+ */
810
+ offset?: number;
811
+ /**
812
+ * Text content to process
813
+ */
814
+ text: string;
815
+ }
816
+ /**
817
+ * Scored image chunk for deprecated API.
818
+ */
819
+ interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk {
820
+ /**
821
+ * position of the chunk in a file
822
+ */
823
+ chunk_index: number;
824
+ /**
825
+ * mime type of the chunk
826
+ */
827
+ mime_type?: string;
828
+ /**
829
+ * metadata of the chunk
830
+ */
831
+ generated_metadata?: {
832
+ [key: string]: unknown;
833
+ } | null;
834
+ /**
835
+ * model used for this chunk
836
+ */
837
+ model?: string | null;
838
+ /**
839
+ * score of the chunk
840
+ */
841
+ score: number;
842
+ /**
843
+ * file id
844
+ */
845
+ file_id: string;
846
+ /**
847
+ * filename
848
+ */
849
+ filename: string;
850
+ /**
851
+ * store id
852
+ */
853
+ vector_store_id: string;
854
+ /**
855
+ * file metadata
856
+ */
857
+ metadata?: unknown;
858
+ /**
859
+ * Input type identifier
860
+ */
861
+ type?: 'image_url';
862
+ /**
863
+ * ocr text of the image
864
+ */
865
+ ocr_text?: string | null;
866
+ /**
867
+ * summary of the image
868
+ */
869
+ summary?: string | null;
870
+ /**
871
+ * The image input specification.
872
+ */
873
+ image_url: MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk.ImageURL;
874
+ }
875
+ namespace MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredImageURLInputChunk {
876
+ /**
877
+ * The image input specification.
878
+ */
879
+ interface ImageURL {
880
+ /**
881
+ * The image URL. Can be either a URL or a Data URI.
882
+ */
883
+ url: string;
884
+ /**
885
+ * The image format/mimetype
886
+ */
887
+ format?: string;
888
+ }
889
+ }
890
+ /**
891
+ * Scored audio chunk for deprecated API.
892
+ */
893
+ interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk {
894
+ /**
895
+ * position of the chunk in a file
896
+ */
897
+ chunk_index: number;
898
+ /**
899
+ * mime type of the chunk
900
+ */
901
+ mime_type?: string;
902
+ /**
903
+ * metadata of the chunk
904
+ */
905
+ generated_metadata?: {
906
+ [key: string]: unknown;
907
+ } | null;
908
+ /**
909
+ * model used for this chunk
910
+ */
911
+ model?: string | null;
912
+ /**
913
+ * score of the chunk
914
+ */
915
+ score: number;
916
+ /**
917
+ * file id
918
+ */
919
+ file_id: string;
920
+ /**
921
+ * filename
922
+ */
923
+ filename: string;
924
+ /**
925
+ * store id
926
+ */
927
+ vector_store_id: string;
928
+ /**
929
+ * file metadata
930
+ */
931
+ metadata?: unknown;
932
+ /**
933
+ * Input type identifier
934
+ */
935
+ type?: 'audio_url';
936
+ /**
937
+ * speech recognition (sr) text of the audio
938
+ */
939
+ transcription?: string | null;
940
+ /**
941
+ * summary of the audio
942
+ */
943
+ summary?: string | null;
944
+ /**
945
+ * The audio input specification.
946
+ */
947
+ audio_url: MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk.AudioURL;
948
+ /**
949
+ * The sampling rate of the audio.
950
+ */
951
+ sampling_rate: number;
952
+ }
953
+ namespace MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredAudioURLInputChunk {
954
+ /**
955
+ * The audio input specification.
956
+ */
957
+ interface AudioURL {
958
+ /**
959
+ * The audio URL. Can be either a URL or a Data URI.
960
+ */
961
+ url: string;
962
+ }
963
+ }
964
+ /**
965
+ * Scored video chunk for deprecated API.
966
+ */
967
+ interface MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk {
968
+ /**
969
+ * position of the chunk in a file
970
+ */
971
+ chunk_index: number;
972
+ /**
973
+ * mime type of the chunk
974
+ */
975
+ mime_type?: string;
976
+ /**
977
+ * metadata of the chunk
978
+ */
979
+ generated_metadata?: {
980
+ [key: string]: unknown;
981
+ } | null;
982
+ /**
983
+ * model used for this chunk
984
+ */
985
+ model?: string | null;
986
+ /**
987
+ * score of the chunk
988
+ */
989
+ score: number;
990
+ /**
991
+ * file id
992
+ */
993
+ file_id: string;
994
+ /**
995
+ * filename
996
+ */
997
+ filename: string;
998
+ /**
999
+ * store id
1000
+ */
1001
+ vector_store_id: string;
1002
+ /**
1003
+ * file metadata
1004
+ */
1005
+ metadata?: unknown;
1006
+ /**
1007
+ * Input type identifier
1008
+ */
1009
+ type?: 'video_url';
1010
+ /**
1011
+ * speech recognition (sr) text of the video
1012
+ */
1013
+ transcription?: string | null;
1014
+ /**
1015
+ * summary of the video
1016
+ */
1017
+ summary?: string | null;
1018
+ /**
1019
+ * The video input specification.
1020
+ */
1021
+ video_url: MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk.VideoURL;
1022
+ }
1023
+ namespace MxbaiOmniAPIRoutesV1DeprecatedVectorStoresModelsScoredVideoURLInputChunk {
1024
+ /**
1025
+ * The video input specification.
1026
+ */
1027
+ interface VideoURL {
1028
+ /**
1029
+ * The video URL. Can be either a URL or a Data URI.
1030
+ */
1031
+ url: string;
1032
+ }
1033
+ }
716
1034
  }
717
1035
  export interface VectorStoreCreateParams {
718
1036
  /**
@@ -728,7 +1046,7 @@ export interface VectorStoreCreateParams {
728
1046
  */
729
1047
  is_public?: boolean;
730
1048
  /**
731
- * Represents an expiration policy for a vector store.
1049
+ * Represents an expiration policy for a store.
732
1050
  */
733
1051
  expires_after?: ExpiresAfter | null;
734
1052
  /**
@@ -742,7 +1060,7 @@ export interface VectorStoreCreateParams {
742
1060
  }
743
1061
  export interface VectorStoreUpdateParams {
744
1062
  /**
745
- * New name for the vector store
1063
+ * New name for the store
746
1064
  */
747
1065
  name?: string | null;
748
1066
  /**
@@ -754,7 +1072,7 @@ export interface VectorStoreUpdateParams {
754
1072
  */
755
1073
  is_public?: boolean | null;
756
1074
  /**
757
- * Represents an expiration policy for a vector store.
1075
+ * Represents an expiration policy for a store.
758
1076
  */
759
1077
  expires_after?: ExpiresAfter | null;
760
1078
  /**