@mixedbread/sdk 0.61.0 → 0.63.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 (131) hide show
  1. package/CHANGELOG.md +48 -0
  2. package/client.d.mts +28 -6
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +28 -6
  5. package/client.d.ts.map +1 -1
  6. package/client.js +33 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +33 -0
  9. package/client.mjs.map +1 -1
  10. package/internal/utils/env.js +2 -2
  11. package/internal/utils/env.js.map +1 -1
  12. package/internal/utils/env.mjs +2 -2
  13. package/internal/utils/env.mjs.map +1 -1
  14. package/package.json +1 -1
  15. package/resources/api-keys.d.mts +8 -24
  16. package/resources/api-keys.d.mts.map +1 -1
  17. package/resources/api-keys.d.ts +8 -24
  18. package/resources/api-keys.d.ts.map +1 -1
  19. package/resources/data-sources/connectors.d.mts +55 -0
  20. package/resources/data-sources/connectors.d.mts.map +1 -1
  21. package/resources/data-sources/connectors.d.ts +55 -0
  22. package/resources/data-sources/connectors.d.ts.map +1 -1
  23. package/resources/data-sources/connectors.js +55 -0
  24. package/resources/data-sources/connectors.js.map +1 -1
  25. package/resources/data-sources/connectors.mjs +55 -0
  26. package/resources/data-sources/connectors.mjs.map +1 -1
  27. package/resources/data-sources/data-sources.d.mts +59 -50
  28. package/resources/data-sources/data-sources.d.mts.map +1 -1
  29. package/resources/data-sources/data-sources.d.ts +59 -50
  30. package/resources/data-sources/data-sources.d.ts.map +1 -1
  31. package/resources/data-sources/data-sources.js +37 -0
  32. package/resources/data-sources/data-sources.js.map +1 -1
  33. package/resources/data-sources/data-sources.mjs +37 -0
  34. package/resources/data-sources/data-sources.mjs.map +1 -1
  35. package/resources/data-sources/index.d.mts +1 -1
  36. package/resources/data-sources/index.d.mts.map +1 -1
  37. package/resources/data-sources/index.d.ts +1 -1
  38. package/resources/data-sources/index.d.ts.map +1 -1
  39. package/resources/data-sources/index.js.map +1 -1
  40. package/resources/data-sources/index.mjs.map +1 -1
  41. package/resources/embeddings.d.mts +9 -0
  42. package/resources/embeddings.d.mts.map +1 -1
  43. package/resources/embeddings.d.ts +9 -0
  44. package/resources/embeddings.d.ts.map +1 -1
  45. package/resources/embeddings.js +9 -0
  46. package/resources/embeddings.js.map +1 -1
  47. package/resources/embeddings.mjs +9 -0
  48. package/resources/embeddings.mjs.map +1 -1
  49. package/resources/files/files.d.mts +47 -0
  50. package/resources/files/files.d.mts.map +1 -1
  51. package/resources/files/files.d.ts +47 -0
  52. package/resources/files/files.d.ts.map +1 -1
  53. package/resources/files/files.js +47 -0
  54. package/resources/files/files.js.map +1 -1
  55. package/resources/files/files.mjs +47 -0
  56. package/resources/files/files.mjs.map +1 -1
  57. package/resources/files/uploads.d.mts +36 -0
  58. package/resources/files/uploads.d.mts.map +1 -1
  59. package/resources/files/uploads.d.ts +36 -0
  60. package/resources/files/uploads.d.ts.map +1 -1
  61. package/resources/files/uploads.js +36 -0
  62. package/resources/files/uploads.js.map +1 -1
  63. package/resources/files/uploads.mjs +36 -0
  64. package/resources/files/uploads.mjs.map +1 -1
  65. package/resources/index.d.mts +3 -3
  66. package/resources/index.d.mts.map +1 -1
  67. package/resources/index.d.ts +3 -3
  68. package/resources/index.d.ts.map +1 -1
  69. package/resources/index.js.map +1 -1
  70. package/resources/index.mjs.map +1 -1
  71. package/resources/parsing/index.d.mts +1 -1
  72. package/resources/parsing/index.d.mts.map +1 -1
  73. package/resources/parsing/index.d.ts +1 -1
  74. package/resources/parsing/index.d.ts.map +1 -1
  75. package/resources/parsing/index.js.map +1 -1
  76. package/resources/parsing/index.mjs.map +1 -1
  77. package/resources/parsing/jobs.d.mts +78 -85
  78. package/resources/parsing/jobs.d.mts.map +1 -1
  79. package/resources/parsing/jobs.d.ts +78 -85
  80. package/resources/parsing/jobs.d.ts.map +1 -1
  81. package/resources/parsing/jobs.js.map +1 -1
  82. package/resources/parsing/jobs.mjs.map +1 -1
  83. package/resources/parsing/parsing.d.mts +2 -2
  84. package/resources/parsing/parsing.d.mts.map +1 -1
  85. package/resources/parsing/parsing.d.ts +2 -2
  86. package/resources/parsing/parsing.d.ts.map +1 -1
  87. package/resources/parsing/parsing.js.map +1 -1
  88. package/resources/parsing/parsing.mjs.map +1 -1
  89. package/resources/stores/files.d.mts +155 -740
  90. package/resources/stores/files.d.mts.map +1 -1
  91. package/resources/stores/files.d.ts +155 -740
  92. package/resources/stores/files.d.ts.map +1 -1
  93. package/resources/stores/files.js +39 -12
  94. package/resources/stores/files.js.map +1 -1
  95. package/resources/stores/files.mjs +39 -12
  96. package/resources/stores/files.mjs.map +1 -1
  97. package/resources/stores/index.d.mts +2 -2
  98. package/resources/stores/index.d.mts.map +1 -1
  99. package/resources/stores/index.d.ts +2 -2
  100. package/resources/stores/index.d.ts.map +1 -1
  101. package/resources/stores/index.js.map +1 -1
  102. package/resources/stores/index.mjs.map +1 -1
  103. package/resources/stores/stores.d.mts +294 -532
  104. package/resources/stores/stores.d.mts.map +1 -1
  105. package/resources/stores/stores.d.ts +294 -532
  106. package/resources/stores/stores.d.ts.map +1 -1
  107. package/resources/stores/stores.js +56 -0
  108. package/resources/stores/stores.js.map +1 -1
  109. package/resources/stores/stores.mjs +56 -0
  110. package/resources/stores/stores.mjs.map +1 -1
  111. package/src/client.ts +72 -0
  112. package/src/internal/utils/env.ts +2 -2
  113. package/src/resources/api-keys.ts +8 -29
  114. package/src/resources/data-sources/connectors.ts +55 -0
  115. package/src/resources/data-sources/data-sources.ts +63 -56
  116. package/src/resources/data-sources/index.ts +2 -0
  117. package/src/resources/embeddings.ts +9 -0
  118. package/src/resources/files/files.ts +47 -0
  119. package/src/resources/files/uploads.ts +36 -0
  120. package/src/resources/index.ts +19 -0
  121. package/src/resources/parsing/index.ts +4 -1
  122. package/src/resources/parsing/jobs.ts +96 -100
  123. package/src/resources/parsing/parsing.ts +7 -1
  124. package/src/resources/stores/files.ts +332 -1243
  125. package/src/resources/stores/index.ts +22 -4
  126. package/src/resources/stores/stores.ts +433 -851
  127. package/src/version.ts +1 -1
  128. package/version.d.mts +1 -1
  129. package/version.d.ts +1 -1
  130. package/version.js +1 -1
  131. package/version.mjs +1 -1
@@ -5,19 +5,21 @@ import * as Shared from '../shared';
5
5
  import * as ContentAPI from '../extractions/content';
6
6
  import * as FilesAPI from './files';
7
7
  import {
8
+ AudioURLInputChunk,
8
9
  FileCreateParams,
9
10
  FileDeleteParams,
10
11
  FileDeleteResponse,
11
12
  FileListParams,
12
13
  FileListResponse,
13
14
  FileRetrieveParams,
14
- FileSearchParams,
15
- FileSearchResponse,
16
15
  FileUpdateParams,
17
16
  Files,
18
- ScoredStoreFile,
17
+ ImageURLInputChunk,
19
18
  StoreFile,
19
+ StoreFileConfig,
20
20
  StoreFileStatus,
21
+ TextInputChunk,
22
+ VideoURLInputChunk,
21
23
  } from './files';
22
24
  import { APIPromise } from '../../core/api-promise';
23
25
  import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
@@ -34,6 +36,11 @@ export class Stores extends APIResource {
34
36
  * description, and metadata.
35
37
  *
36
38
  * Returns: VectorStore: The response containing the created vector store details.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * const store = await client.stores.create();
43
+ * ```
37
44
  */
38
45
  create(body: StoreCreateParams, options?: RequestOptions): APIPromise<Store> {
39
46
  return this._client.post('/v1/stores', { body, ...options });
@@ -45,6 +52,13 @@ export class Stores extends APIResource {
45
52
  * Args: store_identifier: The ID or name of the store to retrieve.
46
53
  *
47
54
  * Returns: Store: The response containing the store details.
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * const store = await client.stores.retrieve(
59
+ * 'store_identifier',
60
+ * );
61
+ * ```
48
62
  */
49
63
  retrieve(storeIdentifier: string, options?: RequestOptions): APIPromise<Store> {
50
64
  return this._client.get(path`/v1/stores/${storeIdentifier}`, options);
@@ -57,6 +71,13 @@ export class Stores extends APIResource {
57
71
  * StoreCreate object containing the name, description, and metadata.
58
72
  *
59
73
  * Returns: Store: The response containing the updated store details.
74
+ *
75
+ * @example
76
+ * ```ts
77
+ * const store = await client.stores.update(
78
+ * 'store_identifier',
79
+ * );
80
+ * ```
60
81
  */
61
82
  update(storeIdentifier: string, body: StoreUpdateParams, options?: RequestOptions): APIPromise<Store> {
62
83
  return this._client.put(path`/v1/stores/${storeIdentifier}`, { body, ...options });
@@ -69,6 +90,14 @@ export class Stores extends APIResource {
69
90
  * vector stores.
70
91
  *
71
92
  * Returns: StoreListResponse: The list of stores.
93
+ *
94
+ * @example
95
+ * ```ts
96
+ * // Automatically fetches more pages as needed.
97
+ * for await (const store of client.stores.list()) {
98
+ * // ...
99
+ * }
100
+ * ```
72
101
  */
73
102
  list(
74
103
  query: StoreListParams | null | undefined = {},
@@ -83,6 +112,13 @@ export class Stores extends APIResource {
83
112
  * Args: store_identifier: The ID or name of the store to delete.
84
113
  *
85
114
  * Returns: Store: The response containing the deleted store details.
115
+ *
116
+ * @example
117
+ * ```ts
118
+ * const store = await client.stores.delete(
119
+ * 'store_identifier',
120
+ * );
121
+ * ```
86
122
  */
87
123
  delete(storeIdentifier: string, options?: RequestOptions): APIPromise<StoreDeleteResponse> {
88
124
  return this._client.delete(path`/v1/stores/${storeIdentifier}`, options);
@@ -90,6 +126,13 @@ export class Stores extends APIResource {
90
126
 
91
127
  /**
92
128
  * Get metadata facets
129
+ *
130
+ * @example
131
+ * ```ts
132
+ * const response = await client.stores.metadataFacets({
133
+ * store_identifiers: ['string'],
134
+ * });
135
+ * ```
93
136
  */
94
137
  metadataFacets(
95
138
  body: StoreMetadataFacetsParams,
@@ -100,6 +143,13 @@ export class Stores extends APIResource {
100
143
 
101
144
  /**
102
145
  * Question answering
146
+ *
147
+ * @example
148
+ * ```ts
149
+ * const response = await client.stores.questionAnswering({
150
+ * store_identifiers: ['string'],
151
+ * });
152
+ * ```
103
153
  */
104
154
  questionAnswering(
105
155
  body: StoreQuestionAnsweringParams,
@@ -130,6 +180,14 @@ export class Stores extends APIResource {
130
180
  *
131
181
  * Raises: HTTPException (400): If search parameters are invalid HTTPException
132
182
  * (404): If no vector stores are found to search
183
+ *
184
+ * @example
185
+ * ```ts
186
+ * const response = await client.stores.search({
187
+ * query: 'how to configure SSL',
188
+ * store_identifiers: ['string'],
189
+ * });
190
+ * ```
133
191
  */
134
192
  search(body: StoreSearchParams, options?: RequestOptions): APIPromise<StoreSearchResponse> {
135
193
  return this._client.post('/v1/stores/search', { body, ...options });
@@ -139,271 +197,243 @@ export class Stores extends APIResource {
139
197
  export type StoresCursor = Cursor<Store>;
140
198
 
141
199
  /**
142
- * Represents an expiration policy for a store.
200
+ * Configuration for agentic multi-query search.
143
201
  */
144
- export interface ExpiresAfter {
202
+ export interface AgenticSearchConfig {
145
203
  /**
146
- * Anchor date for the expiration policy
204
+ * Maximum number of search rounds
147
205
  */
148
- anchor?: 'last_active_at';
206
+ max_rounds?: number;
149
207
 
150
208
  /**
151
- * Number of days after which the store expires
209
+ * Maximum queries per round
152
210
  */
153
- days?: number;
154
- }
211
+ queries_per_round?: number;
155
212
 
156
- export interface ScoredAudioURLInputChunk {
157
213
  /**
158
- * position of the chunk in a file
214
+ * Additional custom instructions (followed only when not in conflict with existing
215
+ * rules)
159
216
  */
160
- chunk_index: number;
217
+ instructions?: string | null;
218
+ }
161
219
 
162
- /**
163
- * mime type of the chunk
164
- */
165
- mime_type?: string;
220
+ export interface AudioChunkGeneratedMetadata {
221
+ type?: 'audio';
166
222
 
167
- /**
168
- * metadata of the chunk
169
- */
170
- generated_metadata?:
171
- | ScoredAudioURLInputChunk.MarkdownChunkGeneratedMetadata
172
- | ScoredAudioURLInputChunk.TextChunkGeneratedMetadata
173
- | ScoredAudioURLInputChunk.PdfChunkGeneratedMetadata
174
- | ScoredAudioURLInputChunk.CodeChunkGeneratedMetadata
175
- | ScoredAudioURLInputChunk.AudioChunkGeneratedMetadata
176
- | ScoredAudioURLInputChunk.VideoChunkGeneratedMetadata
177
- | ScoredAudioURLInputChunk.ImageChunkGeneratedMetadata
178
- | null;
223
+ file_type?: string;
179
224
 
225
+ file_size?: number | null;
226
+
227
+ total_duration_seconds?: number | null;
228
+
229
+ sample_rate?: number | null;
230
+
231
+ channels?: number | null;
232
+
233
+ audio_format?: number | null;
234
+
235
+ bpm?: number | null;
236
+
237
+ file_extension?: string | null;
238
+
239
+ [k: string]: unknown;
240
+ }
241
+
242
+ /**
243
+ * Model for audio URL validation.
244
+ */
245
+ export interface AudioURL {
180
246
  /**
181
- * model used for this chunk
247
+ * The audio URL. Can be either a URL or a Data URI.
182
248
  */
183
- model?: string | null;
249
+ url: string;
250
+ }
251
+
252
+ export interface CodeChunkGeneratedMetadata {
253
+ type?: 'code';
254
+
255
+ file_type: string;
256
+
257
+ language?: string | null;
258
+
259
+ word_count?: number | null;
260
+
261
+ file_size?: number | null;
262
+
263
+ start_line?: number;
264
+
265
+ num_lines?: number;
184
266
 
267
+ file_extension?: string | null;
268
+
269
+ [k: string]: unknown;
270
+ }
271
+
272
+ export interface ContextualizationConfig {
185
273
  /**
186
- * score of the chunk
274
+ * Include all metadata or specific fields in the contextualization. Supports dot
275
+ * notation for nested fields (e.g., 'author.name'). When True, all metadata is
276
+ * included (flattened). When a list, only specified fields are included.
187
277
  */
188
- score: number;
278
+ with_metadata?: boolean | Array<string>;
189
279
 
190
280
  /**
191
- * file id
281
+ * Use an LLM to generate a short context for each text chunk that situates it
282
+ * within the full document, improving retrieval accuracy. Only applies to text
283
+ * content during non-sliced ingestion.
192
284
  */
193
- file_id: string;
285
+ with_file_context?: boolean;
286
+ }
194
287
 
288
+ /**
289
+ * Represents an expiration policy for a store.
290
+ */
291
+ export interface ExpiresAfter {
195
292
  /**
196
- * filename
293
+ * Anchor date for the expiration policy
197
294
  */
198
- filename: string;
295
+ anchor?: 'last_active_at';
199
296
 
200
297
  /**
201
- * store id
298
+ * Number of days after which the store expires
202
299
  */
203
- store_id: string;
300
+ days?: number;
301
+ }
204
302
 
303
+ /**
304
+ * Tracks counts of files in different states within a store.
305
+ */
306
+ export interface FileCounts {
205
307
  /**
206
- * external identifier for this file
308
+ * Number of files waiting to be processed
207
309
  */
208
- external_id?: string | null;
310
+ pending?: number;
209
311
 
210
312
  /**
211
- * file metadata
313
+ * Number of files currently being processed
212
314
  */
213
- metadata?: unknown;
315
+ in_progress?: number;
214
316
 
215
317
  /**
216
- * Input type identifier
318
+ * Number of files whose processing was cancelled
217
319
  */
218
- type?: 'audio_url';
320
+ cancelled?: number;
219
321
 
220
322
  /**
221
- * speech recognition (sr) text of the audio
323
+ * Number of successfully processed files
222
324
  */
223
- transcription?: string | null;
325
+ completed?: number;
224
326
 
225
327
  /**
226
- * Model for audio URL validation.
328
+ * Number of files that failed processing
227
329
  */
228
- audio_url?: ScoredAudioURLInputChunk.AudioURL | null;
330
+ failed?: number;
229
331
 
230
332
  /**
231
- * The sampling rate of the audio.
333
+ * Total number of files
232
334
  */
233
- sampling_rate: number;
335
+ total?: number;
234
336
  }
235
337
 
236
- export namespace ScoredAudioURLInputChunk {
237
- export interface MarkdownChunkGeneratedMetadata {
238
- type?: 'markdown';
239
-
240
- file_type?: 'text/markdown';
241
-
242
- language?: string | null;
243
-
244
- word_count?: number | null;
245
-
246
- file_size?: number | null;
247
-
248
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
249
-
250
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
251
-
252
- start_line?: number;
253
-
254
- num_lines?: number;
255
-
256
- file_extension?: string | null;
257
-
258
- frontmatter?: { [key: string]: unknown };
259
-
260
- [k: string]: unknown;
261
- }
262
-
263
- export namespace MarkdownChunkGeneratedMetadata {
264
- export interface ChunkHeading {
265
- level: number;
266
-
267
- text: string;
268
- }
269
-
270
- export interface HeadingContext {
271
- level: number;
272
-
273
- text: string;
274
- }
275
- }
276
-
277
- export interface TextChunkGeneratedMetadata {
278
- type?: 'text';
279
-
280
- file_type?: 'text/plain';
281
-
282
- language?: string | null;
283
-
284
- word_count?: number | null;
285
-
286
- file_size?: number | null;
287
-
288
- start_line?: number;
289
-
290
- num_lines?: number;
291
-
292
- file_extension?: string | null;
293
-
294
- [k: string]: unknown;
295
- }
296
-
297
- export interface PdfChunkGeneratedMetadata {
298
- type?: 'pdf';
299
-
300
- file_type?: 'application/pdf';
301
-
302
- total_pages?: number | null;
303
-
304
- total_size?: number | null;
305
-
306
- file_extension?: string | null;
307
-
308
- [k: string]: unknown;
309
- }
310
-
311
- export interface CodeChunkGeneratedMetadata {
312
- type?: 'code';
313
-
314
- file_type: string;
315
-
316
- language?: string | null;
338
+ export interface ImageChunkGeneratedMetadata {
339
+ type?: 'image';
317
340
 
318
- word_count?: number | null;
341
+ file_type?: string;
319
342
 
320
- file_size?: number | null;
343
+ file_size?: number | null;
321
344
 
322
- start_line?: number;
345
+ width?: number | null;
323
346
 
324
- num_lines?: number;
347
+ height?: number | null;
325
348
 
326
- file_extension?: string | null;
349
+ file_extension?: string | null;
327
350
 
328
- [k: string]: unknown;
329
- }
330
-
331
- export interface AudioChunkGeneratedMetadata {
332
- type?: 'audio';
333
-
334
- file_type?: string;
335
-
336
- file_size?: number | null;
337
-
338
- total_duration_seconds?: number | null;
339
-
340
- sample_rate?: number | null;
351
+ [k: string]: unknown;
352
+ }
341
353
 
342
- channels?: number | null;
354
+ /**
355
+ * Model for image URL validation.
356
+ */
357
+ export interface ImageURLOutput {
358
+ /**
359
+ * The image URL. Can be either a URL or a Data URI.
360
+ */
361
+ url: string;
343
362
 
344
- audio_format?: number | null;
363
+ /**
364
+ * The image format/mimetype
365
+ */
366
+ format?: string;
367
+ }
345
368
 
346
- bpm?: number | null;
369
+ export interface MarkdownChunkGeneratedMetadata {
370
+ type?: 'markdown';
347
371
 
348
- file_extension?: string | null;
372
+ file_type?: 'text/markdown';
349
373
 
350
- [k: string]: unknown;
351
- }
374
+ language?: string | null;
352
375
 
353
- export interface VideoChunkGeneratedMetadata {
354
- type?: 'video';
376
+ word_count?: number | null;
355
377
 
356
- file_type?: string;
378
+ file_size?: number | null;
357
379
 
358
- file_size?: number | null;
380
+ chunk_headings?: Array<MarkdownHeading>;
359
381
 
360
- total_duration_seconds?: number | null;
382
+ heading_context?: Array<MarkdownHeading>;
361
383
 
362
- fps?: number | null;
384
+ start_line?: number;
363
385
 
364
- width?: number | null;
386
+ num_lines?: number;
365
387
 
366
- height?: number | null;
388
+ file_extension?: string | null;
367
389
 
368
- frame_count?: number | null;
390
+ frontmatter?: { [key: string]: unknown };
369
391
 
370
- has_audio_stream?: boolean;
392
+ [k: string]: unknown;
393
+ }
371
394
 
372
- bpm?: number | null;
395
+ export interface MarkdownHeading {
396
+ level: number;
373
397
 
374
- file_extension?: string | null;
398
+ text: string;
399
+ }
375
400
 
376
- [k: string]: unknown;
377
- }
401
+ export interface PdfChunkGeneratedMetadata {
402
+ type?: 'pdf';
378
403
 
379
- export interface ImageChunkGeneratedMetadata {
380
- type?: 'image';
404
+ file_type?: 'application/pdf';
381
405
 
382
- file_type?: string;
406
+ total_pages?: number | null;
383
407
 
384
- file_size?: number | null;
408
+ total_size?: number | null;
385
409
 
386
- width?: number | null;
410
+ file_extension?: string | null;
387
411
 
388
- height?: number | null;
412
+ [k: string]: unknown;
413
+ }
389
414
 
390
- file_extension?: string | null;
415
+ /**
416
+ * Represents a reranking configuration.
417
+ */
418
+ export interface RerankConfig {
419
+ /**
420
+ * The name of the reranking model
421
+ */
422
+ model?: string;
391
423
 
392
- [k: string]: unknown;
393
- }
424
+ /**
425
+ * Whether to include metadata in the reranked results
426
+ */
427
+ with_metadata?: boolean | Array<string>;
394
428
 
395
429
  /**
396
- * Model for audio URL validation.
430
+ * Maximum number of results to return after reranking. If None, returns all
431
+ * reranked results.
397
432
  */
398
- export interface AudioURL {
399
- /**
400
- * The audio URL. Can be either a URL or a Data URI.
401
- */
402
- url: string;
403
- }
433
+ top_k?: number | null;
404
434
  }
405
435
 
406
- export interface ScoredImageURLInputChunk {
436
+ export interface ScoredAudioURLInputChunk {
407
437
  /**
408
438
  * position of the chunk in a file
409
439
  */
@@ -418,13 +448,13 @@ export interface ScoredImageURLInputChunk {
418
448
  * metadata of the chunk
419
449
  */
420
450
  generated_metadata?:
421
- | ScoredImageURLInputChunk.MarkdownChunkGeneratedMetadata
422
- | ScoredImageURLInputChunk.TextChunkGeneratedMetadata
423
- | ScoredImageURLInputChunk.PdfChunkGeneratedMetadata
424
- | ScoredImageURLInputChunk.CodeChunkGeneratedMetadata
425
- | ScoredImageURLInputChunk.AudioChunkGeneratedMetadata
426
- | ScoredImageURLInputChunk.VideoChunkGeneratedMetadata
427
- | ScoredImageURLInputChunk.ImageChunkGeneratedMetadata
451
+ | MarkdownChunkGeneratedMetadata
452
+ | TextChunkGeneratedMetadata
453
+ | PdfChunkGeneratedMetadata
454
+ | CodeChunkGeneratedMetadata
455
+ | AudioChunkGeneratedMetadata
456
+ | VideoChunkGeneratedMetadata
457
+ | ImageChunkGeneratedMetadata
428
458
  | null;
429
459
 
430
460
  /**
@@ -465,200 +495,25 @@ export interface ScoredImageURLInputChunk {
465
495
  /**
466
496
  * Input type identifier
467
497
  */
468
- type?: 'image_url';
469
-
470
- /**
471
- * ocr text of the image
472
- */
473
- ocr_text?: string | null;
498
+ type?: 'audio_url';
474
499
 
475
500
  /**
476
- * summary of the image
501
+ * speech recognition (sr) text of the audio
477
502
  */
478
- summary?: string | null;
503
+ transcription?: string | null;
479
504
 
480
505
  /**
481
- * Model for image URL validation.
506
+ * Model for audio URL validation.
482
507
  */
483
- image_url?: ScoredImageURLInputChunk.ImageURL | null;
484
- }
485
-
486
- export namespace ScoredImageURLInputChunk {
487
- export interface MarkdownChunkGeneratedMetadata {
488
- type?: 'markdown';
489
-
490
- file_type?: 'text/markdown';
491
-
492
- language?: string | null;
493
-
494
- word_count?: number | null;
495
-
496
- file_size?: number | null;
497
-
498
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
499
-
500
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
501
-
502
- start_line?: number;
503
-
504
- num_lines?: number;
505
-
506
- file_extension?: string | null;
507
-
508
- frontmatter?: { [key: string]: unknown };
509
-
510
- [k: string]: unknown;
511
- }
512
-
513
- export namespace MarkdownChunkGeneratedMetadata {
514
- export interface ChunkHeading {
515
- level: number;
516
-
517
- text: string;
518
- }
519
-
520
- export interface HeadingContext {
521
- level: number;
522
-
523
- text: string;
524
- }
525
- }
526
-
527
- export interface TextChunkGeneratedMetadata {
528
- type?: 'text';
529
-
530
- file_type?: 'text/plain';
531
-
532
- language?: string | null;
533
-
534
- word_count?: number | null;
535
-
536
- file_size?: number | null;
537
-
538
- start_line?: number;
539
-
540
- num_lines?: number;
541
-
542
- file_extension?: string | null;
543
-
544
- [k: string]: unknown;
545
- }
546
-
547
- export interface PdfChunkGeneratedMetadata {
548
- type?: 'pdf';
549
-
550
- file_type?: 'application/pdf';
551
-
552
- total_pages?: number | null;
553
-
554
- total_size?: number | null;
555
-
556
- file_extension?: string | null;
557
-
558
- [k: string]: unknown;
559
- }
560
-
561
- export interface CodeChunkGeneratedMetadata {
562
- type?: 'code';
563
-
564
- file_type: string;
565
-
566
- language?: string | null;
567
-
568
- word_count?: number | null;
569
-
570
- file_size?: number | null;
571
-
572
- start_line?: number;
573
-
574
- num_lines?: number;
575
-
576
- file_extension?: string | null;
577
-
578
- [k: string]: unknown;
579
- }
580
-
581
- export interface AudioChunkGeneratedMetadata {
582
- type?: 'audio';
583
-
584
- file_type?: string;
585
-
586
- file_size?: number | null;
587
-
588
- total_duration_seconds?: number | null;
589
-
590
- sample_rate?: number | null;
591
-
592
- channels?: number | null;
593
-
594
- audio_format?: number | null;
595
-
596
- bpm?: number | null;
597
-
598
- file_extension?: string | null;
599
-
600
- [k: string]: unknown;
601
- }
602
-
603
- export interface VideoChunkGeneratedMetadata {
604
- type?: 'video';
605
-
606
- file_type?: string;
607
-
608
- file_size?: number | null;
609
-
610
- total_duration_seconds?: number | null;
611
-
612
- fps?: number | null;
613
-
614
- width?: number | null;
615
-
616
- height?: number | null;
617
-
618
- frame_count?: number | null;
619
-
620
- has_audio_stream?: boolean;
621
-
622
- bpm?: number | null;
623
-
624
- file_extension?: string | null;
625
-
626
- [k: string]: unknown;
627
- }
628
-
629
- export interface ImageChunkGeneratedMetadata {
630
- type?: 'image';
631
-
632
- file_type?: string;
633
-
634
- file_size?: number | null;
635
-
636
- width?: number | null;
637
-
638
- height?: number | null;
639
-
640
- file_extension?: string | null;
641
-
642
- [k: string]: unknown;
643
- }
508
+ audio_url?: AudioURL | null;
644
509
 
645
510
  /**
646
- * Model for image URL validation.
511
+ * The sampling rate of the audio.
647
512
  */
648
- export interface ImageURL {
649
- /**
650
- * The image URL. Can be either a URL or a Data URI.
651
- */
652
- url: string;
653
-
654
- /**
655
- * The image format/mimetype
656
- */
657
- format?: string;
658
- }
513
+ sampling_rate: number;
659
514
  }
660
515
 
661
- export interface ScoredTextInputChunk {
516
+ export interface ScoredImageURLInputChunk {
662
517
  /**
663
518
  * position of the chunk in a file
664
519
  */
@@ -673,13 +528,13 @@ export interface ScoredTextInputChunk {
673
528
  * metadata of the chunk
674
529
  */
675
530
  generated_metadata?:
676
- | ScoredTextInputChunk.MarkdownChunkGeneratedMetadata
677
- | ScoredTextInputChunk.TextChunkGeneratedMetadata
678
- | ScoredTextInputChunk.PdfChunkGeneratedMetadata
679
- | ScoredTextInputChunk.CodeChunkGeneratedMetadata
680
- | ScoredTextInputChunk.AudioChunkGeneratedMetadata
681
- | ScoredTextInputChunk.VideoChunkGeneratedMetadata
682
- | ScoredTextInputChunk.ImageChunkGeneratedMetadata
531
+ | MarkdownChunkGeneratedMetadata
532
+ | TextChunkGeneratedMetadata
533
+ | PdfChunkGeneratedMetadata
534
+ | CodeChunkGeneratedMetadata
535
+ | AudioChunkGeneratedMetadata
536
+ | VideoChunkGeneratedMetadata
537
+ | ImageChunkGeneratedMetadata
683
538
  | null;
684
539
 
685
540
  /**
@@ -720,177 +575,102 @@ export interface ScoredTextInputChunk {
720
575
  /**
721
576
  * Input type identifier
722
577
  */
723
- type?: 'text';
724
-
725
- /**
726
- * The offset of the text in the file relative to the start of the file.
727
- */
728
- offset?: number;
578
+ type?: 'image_url';
729
579
 
730
580
  /**
731
- * Text content
732
- */
733
- text?: string | null;
734
- }
735
-
736
- export namespace ScoredTextInputChunk {
737
- export interface MarkdownChunkGeneratedMetadata {
738
- type?: 'markdown';
739
-
740
- file_type?: 'text/markdown';
741
-
742
- language?: string | null;
743
-
744
- word_count?: number | null;
745
-
746
- file_size?: number | null;
747
-
748
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
749
-
750
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
751
-
752
- start_line?: number;
753
-
754
- num_lines?: number;
755
-
756
- file_extension?: string | null;
757
-
758
- frontmatter?: { [key: string]: unknown };
759
-
760
- [k: string]: unknown;
761
- }
762
-
763
- export namespace MarkdownChunkGeneratedMetadata {
764
- export interface ChunkHeading {
765
- level: number;
766
-
767
- text: string;
768
- }
769
-
770
- export interface HeadingContext {
771
- level: number;
772
-
773
- text: string;
774
- }
775
- }
776
-
777
- export interface TextChunkGeneratedMetadata {
778
- type?: 'text';
779
-
780
- file_type?: 'text/plain';
781
-
782
- language?: string | null;
783
-
784
- word_count?: number | null;
785
-
786
- file_size?: number | null;
787
-
788
- start_line?: number;
789
-
790
- num_lines?: number;
791
-
792
- file_extension?: string | null;
793
-
794
- [k: string]: unknown;
795
- }
796
-
797
- export interface PdfChunkGeneratedMetadata {
798
- type?: 'pdf';
799
-
800
- file_type?: 'application/pdf';
801
-
802
- total_pages?: number | null;
803
-
804
- total_size?: number | null;
805
-
806
- file_extension?: string | null;
807
-
808
- [k: string]: unknown;
809
- }
810
-
811
- export interface CodeChunkGeneratedMetadata {
812
- type?: 'code';
813
-
814
- file_type: string;
815
-
816
- language?: string | null;
817
-
818
- word_count?: number | null;
819
-
820
- file_size?: number | null;
821
-
822
- start_line?: number;
823
-
824
- num_lines?: number;
825
-
826
- file_extension?: string | null;
827
-
828
- [k: string]: unknown;
829
- }
830
-
831
- export interface AudioChunkGeneratedMetadata {
832
- type?: 'audio';
833
-
834
- file_type?: string;
835
-
836
- file_size?: number | null;
837
-
838
- total_duration_seconds?: number | null;
839
-
840
- sample_rate?: number | null;
841
-
842
- channels?: number | null;
843
-
844
- audio_format?: number | null;
845
-
846
- bpm?: number | null;
847
-
848
- file_extension?: string | null;
849
-
850
- [k: string]: unknown;
851
- }
852
-
853
- export interface VideoChunkGeneratedMetadata {
854
- type?: 'video';
855
-
856
- file_type?: string;
857
-
858
- file_size?: number | null;
581
+ * ocr text of the image
582
+ */
583
+ ocr_text?: string | null;
859
584
 
860
- total_duration_seconds?: number | null;
585
+ /**
586
+ * summary of the image
587
+ */
588
+ summary?: string | null;
861
589
 
862
- fps?: number | null;
590
+ /**
591
+ * Model for image URL validation.
592
+ */
593
+ image_url?: ImageURLOutput | null;
594
+ }
863
595
 
864
- width?: number | null;
596
+ export interface ScoredTextInputChunk {
597
+ /**
598
+ * position of the chunk in a file
599
+ */
600
+ chunk_index: number;
865
601
 
866
- height?: number | null;
602
+ /**
603
+ * mime type of the chunk
604
+ */
605
+ mime_type?: string;
867
606
 
868
- frame_count?: number | null;
607
+ /**
608
+ * metadata of the chunk
609
+ */
610
+ generated_metadata?:
611
+ | MarkdownChunkGeneratedMetadata
612
+ | TextChunkGeneratedMetadata
613
+ | PdfChunkGeneratedMetadata
614
+ | CodeChunkGeneratedMetadata
615
+ | AudioChunkGeneratedMetadata
616
+ | VideoChunkGeneratedMetadata
617
+ | ImageChunkGeneratedMetadata
618
+ | null;
869
619
 
870
- has_audio_stream?: boolean;
620
+ /**
621
+ * model used for this chunk
622
+ */
623
+ model?: string | null;
871
624
 
872
- bpm?: number | null;
625
+ /**
626
+ * score of the chunk
627
+ */
628
+ score: number;
873
629
 
874
- file_extension?: string | null;
630
+ /**
631
+ * file id
632
+ */
633
+ file_id: string;
875
634
 
876
- [k: string]: unknown;
877
- }
635
+ /**
636
+ * filename
637
+ */
638
+ filename: string;
878
639
 
879
- export interface ImageChunkGeneratedMetadata {
880
- type?: 'image';
640
+ /**
641
+ * store id
642
+ */
643
+ store_id: string;
881
644
 
882
- file_type?: string;
645
+ /**
646
+ * external identifier for this file
647
+ */
648
+ external_id?: string | null;
883
649
 
884
- file_size?: number | null;
650
+ /**
651
+ * file metadata
652
+ */
653
+ metadata?: unknown;
885
654
 
886
- width?: number | null;
655
+ /**
656
+ * Input type identifier
657
+ */
658
+ type?: 'text';
887
659
 
888
- height?: number | null;
660
+ /**
661
+ * The offset of the text in the file relative to the start of the file.
662
+ */
663
+ offset?: number;
889
664
 
890
- file_extension?: string | null;
665
+ /**
666
+ * Text content
667
+ */
668
+ text?: string | null;
891
669
 
892
- [k: string]: unknown;
893
- }
670
+ /**
671
+ * LLM-generated context that situates this chunk within its source document
672
+ */
673
+ context?: string | null;
894
674
  }
895
675
 
896
676
  export interface ScoredVideoURLInputChunk {
@@ -908,13 +688,13 @@ export interface ScoredVideoURLInputChunk {
908
688
  * metadata of the chunk
909
689
  */
910
690
  generated_metadata?:
911
- | ScoredVideoURLInputChunk.MarkdownChunkGeneratedMetadata
912
- | ScoredVideoURLInputChunk.TextChunkGeneratedMetadata
913
- | ScoredVideoURLInputChunk.PdfChunkGeneratedMetadata
914
- | ScoredVideoURLInputChunk.CodeChunkGeneratedMetadata
915
- | ScoredVideoURLInputChunk.AudioChunkGeneratedMetadata
916
- | ScoredVideoURLInputChunk.VideoChunkGeneratedMetadata
917
- | ScoredVideoURLInputChunk.ImageChunkGeneratedMetadata
691
+ | MarkdownChunkGeneratedMetadata
692
+ | TextChunkGeneratedMetadata
693
+ | PdfChunkGeneratedMetadata
694
+ | CodeChunkGeneratedMetadata
695
+ | AudioChunkGeneratedMetadata
696
+ | VideoChunkGeneratedMetadata
697
+ | ImageChunkGeneratedMetadata
918
698
  | null;
919
699
 
920
700
  /**
@@ -963,179 +743,14 @@ export interface ScoredVideoURLInputChunk {
963
743
  transcription?: string | null;
964
744
 
965
745
  /**
966
- * Model for video URL validation.
746
+ * summary of the video
967
747
  */
968
- video_url?: ScoredVideoURLInputChunk.VideoURL | null;
969
- }
970
-
971
- export namespace ScoredVideoURLInputChunk {
972
- export interface MarkdownChunkGeneratedMetadata {
973
- type?: 'markdown';
974
-
975
- file_type?: 'text/markdown';
976
-
977
- language?: string | null;
978
-
979
- word_count?: number | null;
980
-
981
- file_size?: number | null;
982
-
983
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
984
-
985
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
986
-
987
- start_line?: number;
988
-
989
- num_lines?: number;
990
-
991
- file_extension?: string | null;
992
-
993
- frontmatter?: { [key: string]: unknown };
994
-
995
- [k: string]: unknown;
996
- }
997
-
998
- export namespace MarkdownChunkGeneratedMetadata {
999
- export interface ChunkHeading {
1000
- level: number;
1001
-
1002
- text: string;
1003
- }
1004
-
1005
- export interface HeadingContext {
1006
- level: number;
1007
-
1008
- text: string;
1009
- }
1010
- }
1011
-
1012
- export interface TextChunkGeneratedMetadata {
1013
- type?: 'text';
1014
-
1015
- file_type?: 'text/plain';
1016
-
1017
- language?: string | null;
1018
-
1019
- word_count?: number | null;
1020
-
1021
- file_size?: number | null;
1022
-
1023
- start_line?: number;
1024
-
1025
- num_lines?: number;
1026
-
1027
- file_extension?: string | null;
1028
-
1029
- [k: string]: unknown;
1030
- }
1031
-
1032
- export interface PdfChunkGeneratedMetadata {
1033
- type?: 'pdf';
1034
-
1035
- file_type?: 'application/pdf';
1036
-
1037
- total_pages?: number | null;
1038
-
1039
- total_size?: number | null;
1040
-
1041
- file_extension?: string | null;
1042
-
1043
- [k: string]: unknown;
1044
- }
1045
-
1046
- export interface CodeChunkGeneratedMetadata {
1047
- type?: 'code';
1048
-
1049
- file_type: string;
1050
-
1051
- language?: string | null;
1052
-
1053
- word_count?: number | null;
1054
-
1055
- file_size?: number | null;
1056
-
1057
- start_line?: number;
1058
-
1059
- num_lines?: number;
1060
-
1061
- file_extension?: string | null;
1062
-
1063
- [k: string]: unknown;
1064
- }
1065
-
1066
- export interface AudioChunkGeneratedMetadata {
1067
- type?: 'audio';
1068
-
1069
- file_type?: string;
1070
-
1071
- file_size?: number | null;
1072
-
1073
- total_duration_seconds?: number | null;
1074
-
1075
- sample_rate?: number | null;
1076
-
1077
- channels?: number | null;
1078
-
1079
- audio_format?: number | null;
1080
-
1081
- bpm?: number | null;
1082
-
1083
- file_extension?: string | null;
1084
-
1085
- [k: string]: unknown;
1086
- }
1087
-
1088
- export interface VideoChunkGeneratedMetadata {
1089
- type?: 'video';
1090
-
1091
- file_type?: string;
1092
-
1093
- file_size?: number | null;
1094
-
1095
- total_duration_seconds?: number | null;
1096
-
1097
- fps?: number | null;
1098
-
1099
- width?: number | null;
1100
-
1101
- height?: number | null;
1102
-
1103
- frame_count?: number | null;
1104
-
1105
- has_audio_stream?: boolean;
1106
-
1107
- bpm?: number | null;
1108
-
1109
- file_extension?: string | null;
1110
-
1111
- [k: string]: unknown;
1112
- }
1113
-
1114
- export interface ImageChunkGeneratedMetadata {
1115
- type?: 'image';
1116
-
1117
- file_type?: string;
1118
-
1119
- file_size?: number | null;
1120
-
1121
- width?: number | null;
1122
-
1123
- height?: number | null;
1124
-
1125
- file_extension?: string | null;
1126
-
1127
- [k: string]: unknown;
1128
- }
748
+ summary?: string | null;
1129
749
 
1130
750
  /**
1131
751
  * Model for video URL validation.
1132
752
  */
1133
- export interface VideoURL {
1134
- /**
1135
- * The video URL. Can be either a URL or a Data URI.
1136
- */
1137
- url: string;
1138
- }
753
+ video_url?: VideoURL | null;
1139
754
  }
1140
755
 
1141
756
  /**
@@ -1162,6 +777,11 @@ export interface Store {
1162
777
  */
1163
778
  is_public?: boolean;
1164
779
 
780
+ /**
781
+ * License for public stores
782
+ */
783
+ license?: string | null;
784
+
1165
785
  /**
1166
786
  * Additional metadata associated with the store
1167
787
  */
@@ -1170,12 +790,12 @@ export interface Store {
1170
790
  /**
1171
791
  * Configuration for a store.
1172
792
  */
1173
- config?: Store.Config | null;
793
+ config?: StoreConfig | null;
1174
794
 
1175
795
  /**
1176
796
  * Counts of files in different states
1177
797
  */
1178
- file_counts?: Store.FileCounts;
798
+ file_counts?: FileCounts;
1179
799
 
1180
800
  /**
1181
801
  * Represents an expiration policy for a store.
@@ -1223,71 +843,6 @@ export interface Store {
1223
843
  object?: 'store';
1224
844
  }
1225
845
 
1226
- export namespace Store {
1227
- /**
1228
- * Configuration for a store.
1229
- */
1230
- export interface Config {
1231
- /**
1232
- * Contextualize files with metadata
1233
- */
1234
- contextualization?: boolean | Config.ContextualizationConfig;
1235
-
1236
- /**
1237
- * Whether to save original content in the store. When False, only vectors are
1238
- * indexed without the original content (index-only mode). This is useful for data
1239
- * privacy. Note: Reranking is not supported when content is not saved.
1240
- */
1241
- save_content?: boolean;
1242
- }
1243
-
1244
- export namespace Config {
1245
- export interface ContextualizationConfig {
1246
- /**
1247
- * Include all metadata or specific fields in the contextualization. Supports dot
1248
- * notation for nested fields (e.g., 'author.name'). When True, all metadata is
1249
- * included (flattened). When a list, only specified fields are included.
1250
- */
1251
- with_metadata?: boolean | Array<string>;
1252
- }
1253
- }
1254
-
1255
- /**
1256
- * Counts of files in different states
1257
- */
1258
- export interface FileCounts {
1259
- /**
1260
- * Number of files waiting to be processed
1261
- */
1262
- pending?: number;
1263
-
1264
- /**
1265
- * Number of files currently being processed
1266
- */
1267
- in_progress?: number;
1268
-
1269
- /**
1270
- * Number of files whose processing was cancelled
1271
- */
1272
- cancelled?: number;
1273
-
1274
- /**
1275
- * Number of successfully processed files
1276
- */
1277
- completed?: number;
1278
-
1279
- /**
1280
- * Number of files that failed processing
1281
- */
1282
- failed?: number;
1283
-
1284
- /**
1285
- * Total number of files
1286
- */
1287
- total?: number;
1288
- }
1289
- }
1290
-
1291
846
  /**
1292
847
  * Options for configuring store chunk searches.
1293
848
  */
@@ -1307,13 +862,13 @@ export interface StoreChunkSearchOptions {
1307
862
  * Whether to rerank results and optional reranking configuration. Ignored when
1308
863
  * agentic is enabled (the agent handles ranking).
1309
864
  */
1310
- rerank?: boolean | StoreChunkSearchOptions.RerankConfig | null;
865
+ rerank?: boolean | RerankConfig | null;
1311
866
 
1312
867
  /**
1313
868
  * Whether to use agentic multi-query search with automatic query decomposition and
1314
869
  * ranking. When enabled, rewrite_query and rerank options are ignored.
1315
870
  */
1316
- agentic?: boolean | StoreChunkSearchOptions.AgenticSearchConfig | null;
871
+ agentic?: boolean | AgenticSearchConfig | null;
1317
872
 
1318
873
  /**
1319
874
  * Whether to return file metadata
@@ -1326,48 +881,77 @@ export interface StoreChunkSearchOptions {
1326
881
  apply_search_rules?: boolean;
1327
882
  }
1328
883
 
1329
- export namespace StoreChunkSearchOptions {
884
+ /**
885
+ * Configuration for a store.
886
+ */
887
+ export interface StoreConfig {
1330
888
  /**
1331
- * Represents a reranking configuration.
889
+ * Contextualize files with metadata
1332
890
  */
1333
- export interface RerankConfig {
1334
- /**
1335
- * The name of the reranking model
1336
- */
1337
- model?: string;
1338
-
1339
- /**
1340
- * Whether to include metadata in the reranked results
1341
- */
1342
- with_metadata?: boolean | Array<string>;
1343
-
1344
- /**
1345
- * Maximum number of results to return after reranking. If None, returns all
1346
- * reranked results.
1347
- */
1348
- top_k?: number | null;
1349
- }
891
+ contextualization?: boolean | ContextualizationConfig;
1350
892
 
1351
893
  /**
1352
- * Configuration for agentic multi-query search.
894
+ * Whether to save original content in the store. When False, only vectors are
895
+ * indexed without the original content (index-only mode). This is useful for data
896
+ * privacy. Note: Reranking is not supported when content is not saved.
1353
897
  */
1354
- export interface AgenticSearchConfig {
1355
- /**
1356
- * Maximum number of search rounds
1357
- */
1358
- max_rounds?: number;
898
+ save_content?: boolean;
899
+ }
1359
900
 
1360
- /**
1361
- * Maximum queries per round
1362
- */
1363
- queries_per_round?: number;
901
+ export interface TextChunkGeneratedMetadata {
902
+ type?: 'text';
1364
903
 
1365
- /**
1366
- * Additional custom instructions (followed only when not in conflict with existing
1367
- * rules)
1368
- */
1369
- instructions?: string | null;
1370
- }
904
+ file_type?: 'text/plain';
905
+
906
+ language?: string | null;
907
+
908
+ word_count?: number | null;
909
+
910
+ file_size?: number | null;
911
+
912
+ start_line?: number;
913
+
914
+ num_lines?: number;
915
+
916
+ file_extension?: string | null;
917
+
918
+ [k: string]: unknown;
919
+ }
920
+
921
+ export interface VideoChunkGeneratedMetadata {
922
+ type?: 'video';
923
+
924
+ file_type?: string;
925
+
926
+ file_size?: number | null;
927
+
928
+ total_duration_seconds?: number | null;
929
+
930
+ fps?: number | null;
931
+
932
+ width?: number | null;
933
+
934
+ height?: number | null;
935
+
936
+ frame_count?: number | null;
937
+
938
+ has_audio_stream?: boolean;
939
+
940
+ bpm?: number | null;
941
+
942
+ file_extension?: string | null;
943
+
944
+ [k: string]: unknown;
945
+ }
946
+
947
+ /**
948
+ * Model for video URL validation.
949
+ */
950
+ export interface VideoURL {
951
+ /**
952
+ * The video URL. Can be either a URL or a Data URI.
953
+ */
954
+ url: string;
1371
955
  }
1372
956
 
1373
957
  /**
@@ -1448,6 +1032,11 @@ export interface StoreCreateParams {
1448
1032
  */
1449
1033
  is_public?: boolean;
1450
1034
 
1035
+ /**
1036
+ * License for public stores
1037
+ */
1038
+ license?: string | null;
1039
+
1451
1040
  /**
1452
1041
  * Represents an expiration policy for a store.
1453
1042
  */
@@ -1461,7 +1050,7 @@ export interface StoreCreateParams {
1461
1050
  /**
1462
1051
  * Configuration for a store.
1463
1052
  */
1464
- config?: StoreCreateParams.Config | null;
1053
+ config?: StoreConfig | null;
1465
1054
 
1466
1055
  /**
1467
1056
  * Optional list of file IDs
@@ -1469,36 +1058,6 @@ export interface StoreCreateParams {
1469
1058
  file_ids?: Array<string> | null;
1470
1059
  }
1471
1060
 
1472
- export namespace StoreCreateParams {
1473
- /**
1474
- * Configuration for a store.
1475
- */
1476
- export interface Config {
1477
- /**
1478
- * Contextualize files with metadata
1479
- */
1480
- contextualization?: boolean | Config.ContextualizationConfig;
1481
-
1482
- /**
1483
- * Whether to save original content in the store. When False, only vectors are
1484
- * indexed without the original content (index-only mode). This is useful for data
1485
- * privacy. Note: Reranking is not supported when content is not saved.
1486
- */
1487
- save_content?: boolean;
1488
- }
1489
-
1490
- export namespace Config {
1491
- export interface ContextualizationConfig {
1492
- /**
1493
- * Include all metadata or specific fields in the contextualization. Supports dot
1494
- * notation for nested fields (e.g., 'author.name'). When True, all metadata is
1495
- * included (flattened). When a list, only specified fields are included.
1496
- */
1497
- with_metadata?: boolean | Array<string>;
1498
- }
1499
- }
1500
- }
1501
-
1502
1061
  export interface StoreUpdateParams {
1503
1062
  /**
1504
1063
  * New name for the store. Can only contain lowercase letters, numbers, periods
@@ -1516,6 +1075,11 @@ export interface StoreUpdateParams {
1516
1075
  */
1517
1076
  is_public?: boolean | null;
1518
1077
 
1078
+ /**
1079
+ * License for public stores
1080
+ */
1081
+ license?: string | null;
1082
+
1519
1083
  /**
1520
1084
  * Represents an expiration policy for a store.
1521
1085
  */
@@ -1685,13 +1249,29 @@ Stores.Files = Files;
1685
1249
 
1686
1250
  export declare namespace Stores {
1687
1251
  export {
1252
+ type AgenticSearchConfig as AgenticSearchConfig,
1253
+ type AudioChunkGeneratedMetadata as AudioChunkGeneratedMetadata,
1254
+ type AudioURL as AudioURL,
1255
+ type CodeChunkGeneratedMetadata as CodeChunkGeneratedMetadata,
1256
+ type ContextualizationConfig as ContextualizationConfig,
1688
1257
  type ExpiresAfter as ExpiresAfter,
1258
+ type FileCounts as FileCounts,
1259
+ type ImageChunkGeneratedMetadata as ImageChunkGeneratedMetadata,
1260
+ type ImageURLOutput as ImageURLOutput,
1261
+ type MarkdownChunkGeneratedMetadata as MarkdownChunkGeneratedMetadata,
1262
+ type MarkdownHeading as MarkdownHeading,
1263
+ type PdfChunkGeneratedMetadata as PdfChunkGeneratedMetadata,
1264
+ type RerankConfig as RerankConfig,
1689
1265
  type ScoredAudioURLInputChunk as ScoredAudioURLInputChunk,
1690
1266
  type ScoredImageURLInputChunk as ScoredImageURLInputChunk,
1691
1267
  type ScoredTextInputChunk as ScoredTextInputChunk,
1692
1268
  type ScoredVideoURLInputChunk as ScoredVideoURLInputChunk,
1693
1269
  type Store as Store,
1694
1270
  type StoreChunkSearchOptions as StoreChunkSearchOptions,
1271
+ type StoreConfig as StoreConfig,
1272
+ type TextChunkGeneratedMetadata as TextChunkGeneratedMetadata,
1273
+ type VideoChunkGeneratedMetadata as VideoChunkGeneratedMetadata,
1274
+ type VideoURL as VideoURL,
1695
1275
  type StoreDeleteResponse as StoreDeleteResponse,
1696
1276
  type StoreMetadataFacetsResponse as StoreMetadataFacetsResponse,
1697
1277
  type StoreQuestionAnsweringResponse as StoreQuestionAnsweringResponse,
@@ -1707,17 +1287,19 @@ export declare namespace Stores {
1707
1287
 
1708
1288
  export {
1709
1289
  Files as Files,
1710
- type ScoredStoreFile as ScoredStoreFile,
1711
- type StoreFileStatus as StoreFileStatus,
1290
+ type AudioURLInputChunk as AudioURLInputChunk,
1291
+ type ImageURLInputChunk as ImageURLInputChunk,
1712
1292
  type StoreFile as StoreFile,
1293
+ type StoreFileConfig as StoreFileConfig,
1294
+ type StoreFileStatus as StoreFileStatus,
1295
+ type TextInputChunk as TextInputChunk,
1296
+ type VideoURLInputChunk as VideoURLInputChunk,
1713
1297
  type FileListResponse as FileListResponse,
1714
1298
  type FileDeleteResponse as FileDeleteResponse,
1715
- type FileSearchResponse as FileSearchResponse,
1716
1299
  type FileCreateParams as FileCreateParams,
1717
1300
  type FileRetrieveParams as FileRetrieveParams,
1718
1301
  type FileUpdateParams as FileUpdateParams,
1719
1302
  type FileListParams as FileListParams,
1720
1303
  type FileDeleteParams as FileDeleteParams,
1721
- type FileSearchParams as FileSearchParams,
1722
1304
  };
1723
1305
  }