@mixedbread/sdk 0.60.0 → 0.62.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 +56 -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 +22 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +22 -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 +159 -744
  90. package/resources/stores/files.d.mts.map +1 -1
  91. package/resources/stores/files.d.ts +159 -744
  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 +292 -538
  104. package/resources/stores/stores.d.mts.map +1 -1
  105. package/resources/stores/stores.d.ts +292 -538
  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 +60 -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 +343 -1254
  125. package/src/resources/stores/index.ts +22 -4
  126. package/src/resources/stores/stores.ts +429 -857
  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,276 +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
 
180
- /**
181
- * model used for this chunk
182
- */
183
- model?: string | null;
225
+ file_size?: number | null;
226
+
227
+ total_duration_seconds?: number | null;
228
+
229
+ sample_rate?: number | null;
184
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 {
185
246
  /**
186
- * score of the chunk
247
+ * The audio URL. Can be either a URL or a Data URI.
187
248
  */
188
- score: number;
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;
189
262
 
263
+ start_line?: number;
264
+
265
+ num_lines?: number;
266
+
267
+ file_extension?: string | null;
268
+
269
+ [k: string]: unknown;
270
+ }
271
+
272
+ export interface ContextualizationConfig {
190
273
  /**
191
- * file id
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.
192
277
  */
193
- file_id: string;
278
+ with_metadata?: boolean | Array<string>;
194
279
 
195
280
  /**
196
- * filename
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.
197
284
  */
198
- filename: string;
285
+ with_file_context?: boolean;
286
+ }
199
287
 
288
+ /**
289
+ * Represents an expiration policy for a store.
290
+ */
291
+ export interface ExpiresAfter {
200
292
  /**
201
- * store id
293
+ * Anchor date for the expiration policy
202
294
  */
203
- store_id: string;
295
+ anchor?: 'last_active_at';
204
296
 
205
297
  /**
206
- * external identifier for this file
298
+ * Number of days after which the store expires
207
299
  */
208
- external_id?: string | null;
300
+ days?: number;
301
+ }
209
302
 
303
+ /**
304
+ * Tracks counts of files in different states within a store.
305
+ */
306
+ export interface FileCounts {
210
307
  /**
211
- * file metadata
308
+ * Number of files waiting to be processed
212
309
  */
213
- metadata?: unknown;
310
+ pending?: number;
214
311
 
215
312
  /**
216
- * Input type identifier
313
+ * Number of files currently being processed
217
314
  */
218
- type?: 'audio_url';
315
+ in_progress?: number;
219
316
 
220
317
  /**
221
- * speech recognition (sr) text of the audio
318
+ * Number of files whose processing was cancelled
222
319
  */
223
- transcription?: string | null;
320
+ cancelled?: number;
224
321
 
225
322
  /**
226
- * summary of the audio
323
+ * Number of successfully processed files
227
324
  */
228
- summary?: string | null;
325
+ completed?: number;
229
326
 
230
327
  /**
231
- * Model for audio URL validation.
328
+ * Number of files that failed processing
232
329
  */
233
- audio_url?: ScoredAudioURLInputChunk.AudioURL | null;
330
+ failed?: number;
234
331
 
235
332
  /**
236
- * The sampling rate of the audio.
333
+ * Total number of files
237
334
  */
238
- sampling_rate: number;
335
+ total?: number;
239
336
  }
240
337
 
241
- export namespace ScoredAudioURLInputChunk {
242
- export interface MarkdownChunkGeneratedMetadata {
243
- type?: 'markdown';
244
-
245
- file_type?: 'text/markdown';
246
-
247
- language?: string | null;
248
-
249
- word_count?: number | null;
250
-
251
- file_size?: number | null;
252
-
253
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
254
-
255
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
256
-
257
- start_line?: number;
258
-
259
- num_lines?: number;
260
-
261
- file_extension?: string | null;
262
-
263
- frontmatter?: { [key: string]: unknown };
264
-
265
- [k: string]: unknown;
266
- }
267
-
268
- export namespace MarkdownChunkGeneratedMetadata {
269
- export interface ChunkHeading {
270
- level: number;
271
-
272
- text: string;
273
- }
274
-
275
- export interface HeadingContext {
276
- level: number;
277
-
278
- text: string;
279
- }
280
- }
281
-
282
- export interface TextChunkGeneratedMetadata {
283
- type?: 'text';
284
-
285
- file_type?: 'text/plain';
286
-
287
- language?: string | null;
288
-
289
- word_count?: number | null;
290
-
291
- file_size?: number | null;
292
-
293
- start_line?: number;
294
-
295
- num_lines?: number;
296
-
297
- file_extension?: string | null;
298
-
299
- [k: string]: unknown;
300
- }
301
-
302
- export interface PdfChunkGeneratedMetadata {
303
- type?: 'pdf';
304
-
305
- file_type?: 'application/pdf';
306
-
307
- total_pages?: number | null;
308
-
309
- total_size?: number | null;
310
-
311
- file_extension?: string | null;
312
-
313
- [k: string]: unknown;
314
- }
315
-
316
- export interface CodeChunkGeneratedMetadata {
317
- type?: 'code';
318
-
319
- file_type: string;
338
+ export interface ImageChunkGeneratedMetadata {
339
+ type?: 'image';
320
340
 
321
- language?: string | null;
341
+ file_type?: string;
322
342
 
323
- word_count?: number | null;
343
+ file_size?: number | null;
324
344
 
325
- file_size?: number | null;
345
+ width?: number | null;
326
346
 
327
- start_line?: number;
347
+ height?: number | null;
328
348
 
329
- num_lines?: number;
349
+ file_extension?: string | null;
330
350
 
331
- file_extension?: string | null;
332
-
333
- [k: string]: unknown;
334
- }
335
-
336
- export interface AudioChunkGeneratedMetadata {
337
- type?: 'audio';
338
-
339
- file_type?: string;
340
-
341
- file_size?: number | null;
342
-
343
- total_duration_seconds?: number | null;
344
-
345
- sample_rate?: number | null;
351
+ [k: string]: unknown;
352
+ }
346
353
 
347
- 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;
348
362
 
349
- audio_format?: number | null;
363
+ /**
364
+ * The image format/mimetype
365
+ */
366
+ format?: string;
367
+ }
350
368
 
351
- bpm?: number | null;
369
+ export interface MarkdownChunkGeneratedMetadata {
370
+ type?: 'markdown';
352
371
 
353
- file_extension?: string | null;
372
+ file_type?: 'text/markdown';
354
373
 
355
- [k: string]: unknown;
356
- }
374
+ language?: string | null;
357
375
 
358
- export interface VideoChunkGeneratedMetadata {
359
- type?: 'video';
376
+ word_count?: number | null;
360
377
 
361
- file_type?: string;
378
+ file_size?: number | null;
362
379
 
363
- file_size?: number | null;
380
+ chunk_headings?: Array<MarkdownHeading>;
364
381
 
365
- total_duration_seconds?: number | null;
382
+ heading_context?: Array<MarkdownHeading>;
366
383
 
367
- fps?: number | null;
384
+ start_line?: number;
368
385
 
369
- width?: number | null;
386
+ num_lines?: number;
370
387
 
371
- height?: number | null;
388
+ file_extension?: string | null;
372
389
 
373
- frame_count?: number | null;
390
+ frontmatter?: { [key: string]: unknown };
374
391
 
375
- has_audio_stream?: boolean;
392
+ [k: string]: unknown;
393
+ }
376
394
 
377
- bpm?: number | null;
395
+ export interface MarkdownHeading {
396
+ level: number;
378
397
 
379
- file_extension?: string | null;
398
+ text: string;
399
+ }
380
400
 
381
- [k: string]: unknown;
382
- }
401
+ export interface PdfChunkGeneratedMetadata {
402
+ type?: 'pdf';
383
403
 
384
- export interface ImageChunkGeneratedMetadata {
385
- type?: 'image';
404
+ file_type?: 'application/pdf';
386
405
 
387
- file_type?: string;
406
+ total_pages?: number | null;
388
407
 
389
- file_size?: number | null;
408
+ total_size?: number | null;
390
409
 
391
- width?: number | null;
410
+ file_extension?: string | null;
392
411
 
393
- height?: number | null;
412
+ [k: string]: unknown;
413
+ }
394
414
 
395
- 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;
396
423
 
397
- [k: string]: unknown;
398
- }
424
+ /**
425
+ * Whether to include metadata in the reranked results
426
+ */
427
+ with_metadata?: boolean | Array<string>;
399
428
 
400
429
  /**
401
- * Model for audio URL validation.
430
+ * Maximum number of results to return after reranking. If None, returns all
431
+ * reranked results.
402
432
  */
403
- export interface AudioURL {
404
- /**
405
- * The audio URL. Can be either a URL or a Data URI.
406
- */
407
- url: string;
408
- }
433
+ top_k?: number | null;
409
434
  }
410
435
 
411
- export interface ScoredImageURLInputChunk {
436
+ export interface ScoredAudioURLInputChunk {
412
437
  /**
413
438
  * position of the chunk in a file
414
439
  */
@@ -423,13 +448,13 @@ export interface ScoredImageURLInputChunk {
423
448
  * metadata of the chunk
424
449
  */
425
450
  generated_metadata?:
426
- | ScoredImageURLInputChunk.MarkdownChunkGeneratedMetadata
427
- | ScoredImageURLInputChunk.TextChunkGeneratedMetadata
428
- | ScoredImageURLInputChunk.PdfChunkGeneratedMetadata
429
- | ScoredImageURLInputChunk.CodeChunkGeneratedMetadata
430
- | ScoredImageURLInputChunk.AudioChunkGeneratedMetadata
431
- | ScoredImageURLInputChunk.VideoChunkGeneratedMetadata
432
- | ScoredImageURLInputChunk.ImageChunkGeneratedMetadata
451
+ | MarkdownChunkGeneratedMetadata
452
+ | TextChunkGeneratedMetadata
453
+ | PdfChunkGeneratedMetadata
454
+ | CodeChunkGeneratedMetadata
455
+ | AudioChunkGeneratedMetadata
456
+ | VideoChunkGeneratedMetadata
457
+ | ImageChunkGeneratedMetadata
433
458
  | null;
434
459
 
435
460
  /**
@@ -470,200 +495,25 @@ export interface ScoredImageURLInputChunk {
470
495
  /**
471
496
  * Input type identifier
472
497
  */
473
- type?: 'image_url';
474
-
475
- /**
476
- * ocr text of the image
477
- */
478
- ocr_text?: string | null;
498
+ type?: 'audio_url';
479
499
 
480
500
  /**
481
- * summary of the image
501
+ * speech recognition (sr) text of the audio
482
502
  */
483
- summary?: string | null;
503
+ transcription?: string | null;
484
504
 
485
505
  /**
486
- * Model for image URL validation.
506
+ * Model for audio URL validation.
487
507
  */
488
- image_url?: ScoredImageURLInputChunk.ImageURL | null;
489
- }
490
-
491
- export namespace ScoredImageURLInputChunk {
492
- export interface MarkdownChunkGeneratedMetadata {
493
- type?: 'markdown';
494
-
495
- file_type?: 'text/markdown';
496
-
497
- language?: string | null;
498
-
499
- word_count?: number | null;
500
-
501
- file_size?: number | null;
502
-
503
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
504
-
505
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
506
-
507
- start_line?: number;
508
-
509
- num_lines?: number;
510
-
511
- file_extension?: string | null;
512
-
513
- frontmatter?: { [key: string]: unknown };
514
-
515
- [k: string]: unknown;
516
- }
517
-
518
- export namespace MarkdownChunkGeneratedMetadata {
519
- export interface ChunkHeading {
520
- level: number;
521
-
522
- text: string;
523
- }
524
-
525
- export interface HeadingContext {
526
- level: number;
527
-
528
- text: string;
529
- }
530
- }
531
-
532
- export interface TextChunkGeneratedMetadata {
533
- type?: 'text';
534
-
535
- file_type?: 'text/plain';
536
-
537
- language?: string | null;
538
-
539
- word_count?: number | null;
540
-
541
- file_size?: number | null;
542
-
543
- start_line?: number;
544
-
545
- num_lines?: number;
546
-
547
- file_extension?: string | null;
548
-
549
- [k: string]: unknown;
550
- }
551
-
552
- export interface PdfChunkGeneratedMetadata {
553
- type?: 'pdf';
554
-
555
- file_type?: 'application/pdf';
556
-
557
- total_pages?: number | null;
558
-
559
- total_size?: number | null;
560
-
561
- file_extension?: string | null;
562
-
563
- [k: string]: unknown;
564
- }
565
-
566
- export interface CodeChunkGeneratedMetadata {
567
- type?: 'code';
568
-
569
- file_type: string;
570
-
571
- language?: string | null;
572
-
573
- word_count?: number | null;
574
-
575
- file_size?: number | null;
576
-
577
- start_line?: number;
578
-
579
- num_lines?: number;
580
-
581
- file_extension?: string | null;
582
-
583
- [k: string]: unknown;
584
- }
585
-
586
- export interface AudioChunkGeneratedMetadata {
587
- type?: 'audio';
588
-
589
- file_type?: string;
590
-
591
- file_size?: number | null;
592
-
593
- total_duration_seconds?: number | null;
594
-
595
- sample_rate?: number | null;
596
-
597
- channels?: number | null;
598
-
599
- audio_format?: number | null;
600
-
601
- bpm?: number | null;
602
-
603
- file_extension?: string | null;
604
-
605
- [k: string]: unknown;
606
- }
607
-
608
- export interface VideoChunkGeneratedMetadata {
609
- type?: 'video';
610
-
611
- file_type?: string;
612
-
613
- file_size?: number | null;
614
-
615
- total_duration_seconds?: number | null;
616
-
617
- fps?: number | null;
618
-
619
- width?: number | null;
620
-
621
- height?: number | null;
622
-
623
- frame_count?: number | null;
624
-
625
- has_audio_stream?: boolean;
626
-
627
- bpm?: number | null;
628
-
629
- file_extension?: string | null;
630
-
631
- [k: string]: unknown;
632
- }
633
-
634
- export interface ImageChunkGeneratedMetadata {
635
- type?: 'image';
636
-
637
- file_type?: string;
638
-
639
- file_size?: number | null;
640
-
641
- width?: number | null;
642
-
643
- height?: number | null;
644
-
645
- file_extension?: string | null;
646
-
647
- [k: string]: unknown;
648
- }
508
+ audio_url?: AudioURL | null;
649
509
 
650
510
  /**
651
- * Model for image URL validation.
511
+ * The sampling rate of the audio.
652
512
  */
653
- export interface ImageURL {
654
- /**
655
- * The image URL. Can be either a URL or a Data URI.
656
- */
657
- url: string;
658
-
659
- /**
660
- * The image format/mimetype
661
- */
662
- format?: string;
663
- }
513
+ sampling_rate: number;
664
514
  }
665
515
 
666
- export interface ScoredTextInputChunk {
516
+ export interface ScoredImageURLInputChunk {
667
517
  /**
668
518
  * position of the chunk in a file
669
519
  */
@@ -678,13 +528,13 @@ export interface ScoredTextInputChunk {
678
528
  * metadata of the chunk
679
529
  */
680
530
  generated_metadata?:
681
- | ScoredTextInputChunk.MarkdownChunkGeneratedMetadata
682
- | ScoredTextInputChunk.TextChunkGeneratedMetadata
683
- | ScoredTextInputChunk.PdfChunkGeneratedMetadata
684
- | ScoredTextInputChunk.CodeChunkGeneratedMetadata
685
- | ScoredTextInputChunk.AudioChunkGeneratedMetadata
686
- | ScoredTextInputChunk.VideoChunkGeneratedMetadata
687
- | ScoredTextInputChunk.ImageChunkGeneratedMetadata
531
+ | MarkdownChunkGeneratedMetadata
532
+ | TextChunkGeneratedMetadata
533
+ | PdfChunkGeneratedMetadata
534
+ | CodeChunkGeneratedMetadata
535
+ | AudioChunkGeneratedMetadata
536
+ | VideoChunkGeneratedMetadata
537
+ | ImageChunkGeneratedMetadata
688
538
  | null;
689
539
 
690
540
  /**
@@ -725,177 +575,102 @@ export interface ScoredTextInputChunk {
725
575
  /**
726
576
  * Input type identifier
727
577
  */
728
- type?: 'text';
729
-
730
- /**
731
- * The offset of the text in the file relative to the start of the file.
732
- */
733
- offset?: number;
578
+ type?: 'image_url';
734
579
 
735
580
  /**
736
- * Text content
581
+ * ocr text of the image
737
582
  */
738
- text?: string | null;
739
- }
740
-
741
- export namespace ScoredTextInputChunk {
742
- export interface MarkdownChunkGeneratedMetadata {
743
- type?: 'markdown';
744
-
745
- file_type?: 'text/markdown';
746
-
747
- language?: string | null;
748
-
749
- word_count?: number | null;
750
-
751
- file_size?: number | null;
752
-
753
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
754
-
755
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
756
-
757
- start_line?: number;
758
-
759
- num_lines?: number;
760
-
761
- file_extension?: string | null;
762
-
763
- frontmatter?: { [key: string]: unknown };
764
-
765
- [k: string]: unknown;
766
- }
767
-
768
- export namespace MarkdownChunkGeneratedMetadata {
769
- export interface ChunkHeading {
770
- level: number;
771
-
772
- text: string;
773
- }
774
-
775
- export interface HeadingContext {
776
- level: number;
777
-
778
- text: string;
779
- }
780
- }
781
-
782
- export interface TextChunkGeneratedMetadata {
783
- type?: 'text';
784
-
785
- file_type?: 'text/plain';
786
-
787
- language?: string | null;
788
-
789
- word_count?: number | null;
790
-
791
- file_size?: number | null;
792
-
793
- start_line?: number;
794
-
795
- num_lines?: number;
796
-
797
- file_extension?: string | null;
798
-
799
- [k: string]: unknown;
800
- }
801
-
802
- export interface PdfChunkGeneratedMetadata {
803
- type?: 'pdf';
804
-
805
- file_type?: 'application/pdf';
806
-
807
- total_pages?: number | null;
808
-
809
- total_size?: number | null;
810
-
811
- file_extension?: string | null;
812
-
813
- [k: string]: unknown;
814
- }
815
-
816
- export interface CodeChunkGeneratedMetadata {
817
- type?: 'code';
818
-
819
- file_type: string;
820
-
821
- language?: string | null;
822
-
823
- word_count?: number | null;
824
-
825
- file_size?: number | null;
826
-
827
- start_line?: number;
828
-
829
- num_lines?: number;
830
-
831
- file_extension?: string | null;
832
-
833
- [k: string]: unknown;
834
- }
835
-
836
- export interface AudioChunkGeneratedMetadata {
837
- type?: 'audio';
838
-
839
- file_type?: string;
840
-
841
- file_size?: number | null;
842
-
843
- total_duration_seconds?: number | null;
844
-
845
- sample_rate?: number | null;
846
-
847
- channels?: number | null;
848
-
849
- audio_format?: number | null;
850
-
851
- bpm?: number | null;
852
-
853
- file_extension?: string | null;
854
-
855
- [k: string]: unknown;
856
- }
857
-
858
- export interface VideoChunkGeneratedMetadata {
859
- type?: 'video';
860
-
861
- file_type?: string;
862
-
863
- file_size?: number | null;
583
+ ocr_text?: string | null;
864
584
 
865
- total_duration_seconds?: number | null;
585
+ /**
586
+ * summary of the image
587
+ */
588
+ summary?: string | null;
866
589
 
867
- fps?: number | null;
590
+ /**
591
+ * Model for image URL validation.
592
+ */
593
+ image_url?: ImageURLOutput | null;
594
+ }
868
595
 
869
- width?: number | null;
596
+ export interface ScoredTextInputChunk {
597
+ /**
598
+ * position of the chunk in a file
599
+ */
600
+ chunk_index: number;
870
601
 
871
- height?: number | null;
602
+ /**
603
+ * mime type of the chunk
604
+ */
605
+ mime_type?: string;
872
606
 
873
- 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;
874
619
 
875
- has_audio_stream?: boolean;
620
+ /**
621
+ * model used for this chunk
622
+ */
623
+ model?: string | null;
876
624
 
877
- bpm?: number | null;
625
+ /**
626
+ * score of the chunk
627
+ */
628
+ score: number;
878
629
 
879
- file_extension?: string | null;
630
+ /**
631
+ * file id
632
+ */
633
+ file_id: string;
880
634
 
881
- [k: string]: unknown;
882
- }
635
+ /**
636
+ * filename
637
+ */
638
+ filename: string;
883
639
 
884
- export interface ImageChunkGeneratedMetadata {
885
- type?: 'image';
640
+ /**
641
+ * store id
642
+ */
643
+ store_id: string;
886
644
 
887
- file_type?: string;
645
+ /**
646
+ * external identifier for this file
647
+ */
648
+ external_id?: string | null;
888
649
 
889
- file_size?: number | null;
650
+ /**
651
+ * file metadata
652
+ */
653
+ metadata?: unknown;
890
654
 
891
- width?: number | null;
655
+ /**
656
+ * Input type identifier
657
+ */
658
+ type?: 'text';
892
659
 
893
- height?: number | null;
660
+ /**
661
+ * The offset of the text in the file relative to the start of the file.
662
+ */
663
+ offset?: number;
894
664
 
895
- file_extension?: string | null;
665
+ /**
666
+ * Text content
667
+ */
668
+ text?: string | null;
896
669
 
897
- [k: string]: unknown;
898
- }
670
+ /**
671
+ * LLM-generated context that situates this chunk within its source document
672
+ */
673
+ context?: string | null;
899
674
  }
900
675
 
901
676
  export interface ScoredVideoURLInputChunk {
@@ -913,13 +688,13 @@ export interface ScoredVideoURLInputChunk {
913
688
  * metadata of the chunk
914
689
  */
915
690
  generated_metadata?:
916
- | ScoredVideoURLInputChunk.MarkdownChunkGeneratedMetadata
917
- | ScoredVideoURLInputChunk.TextChunkGeneratedMetadata
918
- | ScoredVideoURLInputChunk.PdfChunkGeneratedMetadata
919
- | ScoredVideoURLInputChunk.CodeChunkGeneratedMetadata
920
- | ScoredVideoURLInputChunk.AudioChunkGeneratedMetadata
921
- | ScoredVideoURLInputChunk.VideoChunkGeneratedMetadata
922
- | ScoredVideoURLInputChunk.ImageChunkGeneratedMetadata
691
+ | MarkdownChunkGeneratedMetadata
692
+ | TextChunkGeneratedMetadata
693
+ | PdfChunkGeneratedMetadata
694
+ | CodeChunkGeneratedMetadata
695
+ | AudioChunkGeneratedMetadata
696
+ | VideoChunkGeneratedMetadata
697
+ | ImageChunkGeneratedMetadata
923
698
  | null;
924
699
 
925
700
  /**
@@ -975,177 +750,7 @@ export interface ScoredVideoURLInputChunk {
975
750
  /**
976
751
  * Model for video URL validation.
977
752
  */
978
- video_url?: ScoredVideoURLInputChunk.VideoURL | null;
979
- }
980
-
981
- export namespace ScoredVideoURLInputChunk {
982
- export interface MarkdownChunkGeneratedMetadata {
983
- type?: 'markdown';
984
-
985
- file_type?: 'text/markdown';
986
-
987
- language?: string | null;
988
-
989
- word_count?: number | null;
990
-
991
- file_size?: number | null;
992
-
993
- chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
994
-
995
- heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
996
-
997
- start_line?: number;
998
-
999
- num_lines?: number;
1000
-
1001
- file_extension?: string | null;
1002
-
1003
- frontmatter?: { [key: string]: unknown };
1004
-
1005
- [k: string]: unknown;
1006
- }
1007
-
1008
- export namespace MarkdownChunkGeneratedMetadata {
1009
- export interface ChunkHeading {
1010
- level: number;
1011
-
1012
- text: string;
1013
- }
1014
-
1015
- export interface HeadingContext {
1016
- level: number;
1017
-
1018
- text: string;
1019
- }
1020
- }
1021
-
1022
- export interface TextChunkGeneratedMetadata {
1023
- type?: 'text';
1024
-
1025
- file_type?: 'text/plain';
1026
-
1027
- language?: string | null;
1028
-
1029
- word_count?: number | null;
1030
-
1031
- file_size?: number | null;
1032
-
1033
- start_line?: number;
1034
-
1035
- num_lines?: number;
1036
-
1037
- file_extension?: string | null;
1038
-
1039
- [k: string]: unknown;
1040
- }
1041
-
1042
- export interface PdfChunkGeneratedMetadata {
1043
- type?: 'pdf';
1044
-
1045
- file_type?: 'application/pdf';
1046
-
1047
- total_pages?: number | null;
1048
-
1049
- total_size?: number | null;
1050
-
1051
- file_extension?: string | null;
1052
-
1053
- [k: string]: unknown;
1054
- }
1055
-
1056
- export interface CodeChunkGeneratedMetadata {
1057
- type?: 'code';
1058
-
1059
- file_type: string;
1060
-
1061
- language?: string | null;
1062
-
1063
- word_count?: number | null;
1064
-
1065
- file_size?: number | null;
1066
-
1067
- start_line?: number;
1068
-
1069
- num_lines?: number;
1070
-
1071
- file_extension?: string | null;
1072
-
1073
- [k: string]: unknown;
1074
- }
1075
-
1076
- export interface AudioChunkGeneratedMetadata {
1077
- type?: 'audio';
1078
-
1079
- file_type?: string;
1080
-
1081
- file_size?: number | null;
1082
-
1083
- total_duration_seconds?: number | null;
1084
-
1085
- sample_rate?: number | null;
1086
-
1087
- channels?: number | null;
1088
-
1089
- audio_format?: number | null;
1090
-
1091
- bpm?: number | null;
1092
-
1093
- file_extension?: string | null;
1094
-
1095
- [k: string]: unknown;
1096
- }
1097
-
1098
- export interface VideoChunkGeneratedMetadata {
1099
- type?: 'video';
1100
-
1101
- file_type?: string;
1102
-
1103
- file_size?: number | null;
1104
-
1105
- total_duration_seconds?: number | null;
1106
-
1107
- fps?: number | null;
1108
-
1109
- width?: number | null;
1110
-
1111
- height?: number | null;
1112
-
1113
- frame_count?: number | null;
1114
-
1115
- has_audio_stream?: boolean;
1116
-
1117
- bpm?: number | null;
1118
-
1119
- file_extension?: string | null;
1120
-
1121
- [k: string]: unknown;
1122
- }
1123
-
1124
- export interface ImageChunkGeneratedMetadata {
1125
- type?: 'image';
1126
-
1127
- file_type?: string;
1128
-
1129
- file_size?: number | null;
1130
-
1131
- width?: number | null;
1132
-
1133
- height?: number | null;
1134
-
1135
- file_extension?: string | null;
1136
-
1137
- [k: string]: unknown;
1138
- }
1139
-
1140
- /**
1141
- * Model for video URL validation.
1142
- */
1143
- export interface VideoURL {
1144
- /**
1145
- * The video URL. Can be either a URL or a Data URI.
1146
- */
1147
- url: string;
1148
- }
753
+ video_url?: VideoURL | null;
1149
754
  }
1150
755
 
1151
756
  /**
@@ -1172,6 +777,11 @@ export interface Store {
1172
777
  */
1173
778
  is_public?: boolean;
1174
779
 
780
+ /**
781
+ * License for public stores
782
+ */
783
+ license?: string | null;
784
+
1175
785
  /**
1176
786
  * Additional metadata associated with the store
1177
787
  */
@@ -1180,12 +790,12 @@ export interface Store {
1180
790
  /**
1181
791
  * Configuration for a store.
1182
792
  */
1183
- config?: Store.Config | null;
793
+ config?: StoreConfig | null;
1184
794
 
1185
795
  /**
1186
796
  * Counts of files in different states
1187
797
  */
1188
- file_counts?: Store.FileCounts;
798
+ file_counts?: FileCounts;
1189
799
 
1190
800
  /**
1191
801
  * Represents an expiration policy for a store.
@@ -1233,71 +843,6 @@ export interface Store {
1233
843
  object?: 'store';
1234
844
  }
1235
845
 
1236
- export namespace Store {
1237
- /**
1238
- * Configuration for a store.
1239
- */
1240
- export interface Config {
1241
- /**
1242
- * Contextualize files with metadata
1243
- */
1244
- contextualization?: boolean | Config.ContextualizationConfig;
1245
-
1246
- /**
1247
- * Whether to save original content in the store. When False, only vectors are
1248
- * indexed without the original content (index-only mode). This is useful for data
1249
- * privacy. Note: Reranking is not supported when content is not saved.
1250
- */
1251
- save_content?: boolean;
1252
- }
1253
-
1254
- export namespace Config {
1255
- export interface ContextualizationConfig {
1256
- /**
1257
- * Include all metadata or specific fields in the contextualization. Supports dot
1258
- * notation for nested fields (e.g., 'author.name'). When True, all metadata is
1259
- * included (flattened). When a list, only specified fields are included.
1260
- */
1261
- with_metadata?: boolean | Array<string>;
1262
- }
1263
- }
1264
-
1265
- /**
1266
- * Counts of files in different states
1267
- */
1268
- export interface FileCounts {
1269
- /**
1270
- * Number of files waiting to be processed
1271
- */
1272
- pending?: number;
1273
-
1274
- /**
1275
- * Number of files currently being processed
1276
- */
1277
- in_progress?: number;
1278
-
1279
- /**
1280
- * Number of files whose processing was cancelled
1281
- */
1282
- cancelled?: number;
1283
-
1284
- /**
1285
- * Number of successfully processed files
1286
- */
1287
- completed?: number;
1288
-
1289
- /**
1290
- * Number of files that failed processing
1291
- */
1292
- failed?: number;
1293
-
1294
- /**
1295
- * Total number of files
1296
- */
1297
- total?: number;
1298
- }
1299
- }
1300
-
1301
846
  /**
1302
847
  * Options for configuring store chunk searches.
1303
848
  */
@@ -1317,13 +862,13 @@ export interface StoreChunkSearchOptions {
1317
862
  * Whether to rerank results and optional reranking configuration. Ignored when
1318
863
  * agentic is enabled (the agent handles ranking).
1319
864
  */
1320
- rerank?: boolean | StoreChunkSearchOptions.RerankConfig | null;
865
+ rerank?: boolean | RerankConfig | null;
1321
866
 
1322
867
  /**
1323
868
  * Whether to use agentic multi-query search with automatic query decomposition and
1324
869
  * ranking. When enabled, rewrite_query and rerank options are ignored.
1325
870
  */
1326
- agentic?: boolean | StoreChunkSearchOptions.AgenticSearchConfig | null;
871
+ agentic?: boolean | AgenticSearchConfig | null;
1327
872
 
1328
873
  /**
1329
874
  * Whether to return file metadata
@@ -1336,48 +881,77 @@ export interface StoreChunkSearchOptions {
1336
881
  apply_search_rules?: boolean;
1337
882
  }
1338
883
 
1339
- export namespace StoreChunkSearchOptions {
884
+ /**
885
+ * Configuration for a store.
886
+ */
887
+ export interface StoreConfig {
1340
888
  /**
1341
- * Represents a reranking configuration.
889
+ * Contextualize files with metadata
1342
890
  */
1343
- export interface RerankConfig {
1344
- /**
1345
- * The name of the reranking model
1346
- */
1347
- model?: string;
1348
-
1349
- /**
1350
- * Whether to include metadata in the reranked results
1351
- */
1352
- with_metadata?: boolean | Array<string>;
1353
-
1354
- /**
1355
- * Maximum number of results to return after reranking. If None, returns all
1356
- * reranked results.
1357
- */
1358
- top_k?: number | null;
1359
- }
891
+ contextualization?: boolean | ContextualizationConfig;
1360
892
 
1361
893
  /**
1362
- * 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.
1363
897
  */
1364
- export interface AgenticSearchConfig {
1365
- /**
1366
- * Maximum number of search rounds
1367
- */
1368
- max_rounds?: number;
898
+ save_content?: boolean;
899
+ }
1369
900
 
1370
- /**
1371
- * Maximum queries per round
1372
- */
1373
- queries_per_round?: number;
901
+ export interface TextChunkGeneratedMetadata {
902
+ type?: 'text';
1374
903
 
1375
- /**
1376
- * Additional custom instructions (followed only when not in conflict with existing
1377
- * rules)
1378
- */
1379
- instructions?: string | null;
1380
- }
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;
1381
955
  }
1382
956
 
1383
957
  /**
@@ -1458,6 +1032,11 @@ export interface StoreCreateParams {
1458
1032
  */
1459
1033
  is_public?: boolean;
1460
1034
 
1035
+ /**
1036
+ * License for public stores
1037
+ */
1038
+ license?: string | null;
1039
+
1461
1040
  /**
1462
1041
  * Represents an expiration policy for a store.
1463
1042
  */
@@ -1471,7 +1050,7 @@ export interface StoreCreateParams {
1471
1050
  /**
1472
1051
  * Configuration for a store.
1473
1052
  */
1474
- config?: StoreCreateParams.Config | null;
1053
+ config?: StoreConfig | null;
1475
1054
 
1476
1055
  /**
1477
1056
  * Optional list of file IDs
@@ -1479,36 +1058,6 @@ export interface StoreCreateParams {
1479
1058
  file_ids?: Array<string> | null;
1480
1059
  }
1481
1060
 
1482
- export namespace StoreCreateParams {
1483
- /**
1484
- * Configuration for a store.
1485
- */
1486
- export interface Config {
1487
- /**
1488
- * Contextualize files with metadata
1489
- */
1490
- contextualization?: boolean | Config.ContextualizationConfig;
1491
-
1492
- /**
1493
- * Whether to save original content in the store. When False, only vectors are
1494
- * indexed without the original content (index-only mode). This is useful for data
1495
- * privacy. Note: Reranking is not supported when content is not saved.
1496
- */
1497
- save_content?: boolean;
1498
- }
1499
-
1500
- export namespace Config {
1501
- export interface ContextualizationConfig {
1502
- /**
1503
- * Include all metadata or specific fields in the contextualization. Supports dot
1504
- * notation for nested fields (e.g., 'author.name'). When True, all metadata is
1505
- * included (flattened). When a list, only specified fields are included.
1506
- */
1507
- with_metadata?: boolean | Array<string>;
1508
- }
1509
- }
1510
- }
1511
-
1512
1061
  export interface StoreUpdateParams {
1513
1062
  /**
1514
1063
  * New name for the store. Can only contain lowercase letters, numbers, periods
@@ -1526,6 +1075,11 @@ export interface StoreUpdateParams {
1526
1075
  */
1527
1076
  is_public?: boolean | null;
1528
1077
 
1078
+ /**
1079
+ * License for public stores
1080
+ */
1081
+ license?: string | null;
1082
+
1529
1083
  /**
1530
1084
  * Represents an expiration policy for a store.
1531
1085
  */
@@ -1695,13 +1249,29 @@ Stores.Files = Files;
1695
1249
 
1696
1250
  export declare namespace Stores {
1697
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,
1698
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,
1699
1265
  type ScoredAudioURLInputChunk as ScoredAudioURLInputChunk,
1700
1266
  type ScoredImageURLInputChunk as ScoredImageURLInputChunk,
1701
1267
  type ScoredTextInputChunk as ScoredTextInputChunk,
1702
1268
  type ScoredVideoURLInputChunk as ScoredVideoURLInputChunk,
1703
1269
  type Store as Store,
1704
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,
1705
1275
  type StoreDeleteResponse as StoreDeleteResponse,
1706
1276
  type StoreMetadataFacetsResponse as StoreMetadataFacetsResponse,
1707
1277
  type StoreQuestionAnsweringResponse as StoreQuestionAnsweringResponse,
@@ -1717,17 +1287,19 @@ export declare namespace Stores {
1717
1287
 
1718
1288
  export {
1719
1289
  Files as Files,
1720
- type ScoredStoreFile as ScoredStoreFile,
1721
- type StoreFileStatus as StoreFileStatus,
1290
+ type AudioURLInputChunk as AudioURLInputChunk,
1291
+ type ImageURLInputChunk as ImageURLInputChunk,
1722
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,
1723
1297
  type FileListResponse as FileListResponse,
1724
1298
  type FileDeleteResponse as FileDeleteResponse,
1725
- type FileSearchResponse as FileSearchResponse,
1726
1299
  type FileCreateParams as FileCreateParams,
1727
1300
  type FileRetrieveParams as FileRetrieveParams,
1728
1301
  type FileUpdateParams as FileUpdateParams,
1729
1302
  type FileListParams as FileListParams,
1730
1303
  type FileDeleteParams as FileDeleteParams,
1731
- type FileSearchParams as FileSearchParams,
1732
1304
  };
1733
1305
  }