@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.
- package/CHANGELOG.md +56 -0
- package/client.d.mts +28 -6
- package/client.d.mts.map +1 -1
- package/client.d.ts +28 -6
- package/client.d.ts.map +1 -1
- package/client.js +22 -0
- package/client.js.map +1 -1
- package/client.mjs +22 -0
- package/client.mjs.map +1 -1
- package/internal/utils/env.js +2 -2
- package/internal/utils/env.js.map +1 -1
- package/internal/utils/env.mjs +2 -2
- package/internal/utils/env.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/api-keys.d.mts +8 -24
- package/resources/api-keys.d.mts.map +1 -1
- package/resources/api-keys.d.ts +8 -24
- package/resources/api-keys.d.ts.map +1 -1
- package/resources/data-sources/connectors.d.mts +55 -0
- package/resources/data-sources/connectors.d.mts.map +1 -1
- package/resources/data-sources/connectors.d.ts +55 -0
- package/resources/data-sources/connectors.d.ts.map +1 -1
- package/resources/data-sources/connectors.js +55 -0
- package/resources/data-sources/connectors.js.map +1 -1
- package/resources/data-sources/connectors.mjs +55 -0
- package/resources/data-sources/connectors.mjs.map +1 -1
- package/resources/data-sources/data-sources.d.mts +59 -50
- package/resources/data-sources/data-sources.d.mts.map +1 -1
- package/resources/data-sources/data-sources.d.ts +59 -50
- package/resources/data-sources/data-sources.d.ts.map +1 -1
- package/resources/data-sources/data-sources.js +37 -0
- package/resources/data-sources/data-sources.js.map +1 -1
- package/resources/data-sources/data-sources.mjs +37 -0
- package/resources/data-sources/data-sources.mjs.map +1 -1
- package/resources/data-sources/index.d.mts +1 -1
- package/resources/data-sources/index.d.mts.map +1 -1
- package/resources/data-sources/index.d.ts +1 -1
- package/resources/data-sources/index.d.ts.map +1 -1
- package/resources/data-sources/index.js.map +1 -1
- package/resources/data-sources/index.mjs.map +1 -1
- package/resources/embeddings.d.mts +9 -0
- package/resources/embeddings.d.mts.map +1 -1
- package/resources/embeddings.d.ts +9 -0
- package/resources/embeddings.d.ts.map +1 -1
- package/resources/embeddings.js +9 -0
- package/resources/embeddings.js.map +1 -1
- package/resources/embeddings.mjs +9 -0
- package/resources/embeddings.mjs.map +1 -1
- package/resources/files/files.d.mts +47 -0
- package/resources/files/files.d.mts.map +1 -1
- package/resources/files/files.d.ts +47 -0
- package/resources/files/files.d.ts.map +1 -1
- package/resources/files/files.js +47 -0
- package/resources/files/files.js.map +1 -1
- package/resources/files/files.mjs +47 -0
- package/resources/files/files.mjs.map +1 -1
- package/resources/files/uploads.d.mts +36 -0
- package/resources/files/uploads.d.mts.map +1 -1
- package/resources/files/uploads.d.ts +36 -0
- package/resources/files/uploads.d.ts.map +1 -1
- package/resources/files/uploads.js +36 -0
- package/resources/files/uploads.js.map +1 -1
- package/resources/files/uploads.mjs +36 -0
- package/resources/files/uploads.mjs.map +1 -1
- package/resources/index.d.mts +3 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/parsing/index.d.mts +1 -1
- package/resources/parsing/index.d.mts.map +1 -1
- package/resources/parsing/index.d.ts +1 -1
- package/resources/parsing/index.d.ts.map +1 -1
- package/resources/parsing/index.js.map +1 -1
- package/resources/parsing/index.mjs.map +1 -1
- package/resources/parsing/jobs.d.mts +78 -85
- package/resources/parsing/jobs.d.mts.map +1 -1
- package/resources/parsing/jobs.d.ts +78 -85
- package/resources/parsing/jobs.d.ts.map +1 -1
- package/resources/parsing/jobs.js.map +1 -1
- package/resources/parsing/jobs.mjs.map +1 -1
- package/resources/parsing/parsing.d.mts +2 -2
- package/resources/parsing/parsing.d.mts.map +1 -1
- package/resources/parsing/parsing.d.ts +2 -2
- package/resources/parsing/parsing.d.ts.map +1 -1
- package/resources/parsing/parsing.js.map +1 -1
- package/resources/parsing/parsing.mjs.map +1 -1
- package/resources/stores/files.d.mts +159 -744
- package/resources/stores/files.d.mts.map +1 -1
- package/resources/stores/files.d.ts +159 -744
- package/resources/stores/files.d.ts.map +1 -1
- package/resources/stores/files.js +39 -12
- package/resources/stores/files.js.map +1 -1
- package/resources/stores/files.mjs +39 -12
- package/resources/stores/files.mjs.map +1 -1
- package/resources/stores/index.d.mts +2 -2
- package/resources/stores/index.d.mts.map +1 -1
- package/resources/stores/index.d.ts +2 -2
- package/resources/stores/index.d.ts.map +1 -1
- package/resources/stores/index.js.map +1 -1
- package/resources/stores/index.mjs.map +1 -1
- package/resources/stores/stores.d.mts +292 -538
- package/resources/stores/stores.d.mts.map +1 -1
- package/resources/stores/stores.d.ts +292 -538
- package/resources/stores/stores.d.ts.map +1 -1
- package/resources/stores/stores.js +56 -0
- package/resources/stores/stores.js.map +1 -1
- package/resources/stores/stores.mjs +56 -0
- package/resources/stores/stores.mjs.map +1 -1
- package/src/client.ts +60 -0
- package/src/internal/utils/env.ts +2 -2
- package/src/resources/api-keys.ts +8 -29
- package/src/resources/data-sources/connectors.ts +55 -0
- package/src/resources/data-sources/data-sources.ts +63 -56
- package/src/resources/data-sources/index.ts +2 -0
- package/src/resources/embeddings.ts +9 -0
- package/src/resources/files/files.ts +47 -0
- package/src/resources/files/uploads.ts +36 -0
- package/src/resources/index.ts +19 -0
- package/src/resources/parsing/index.ts +4 -1
- package/src/resources/parsing/jobs.ts +96 -100
- package/src/resources/parsing/parsing.ts +7 -1
- package/src/resources/stores/files.ts +343 -1254
- package/src/resources/stores/index.ts +22 -4
- package/src/resources/stores/stores.ts +429 -857
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -2,7 +2,7 @@ import { APIResource } from "../../core/resource.mjs";
|
|
|
2
2
|
import * as Shared from "../shared.mjs";
|
|
3
3
|
import * as ContentAPI from "../extractions/content.mjs";
|
|
4
4
|
import * as FilesAPI from "./files.mjs";
|
|
5
|
-
import { FileCreateParams, FileDeleteParams, FileDeleteResponse, FileListParams, FileListResponse, FileRetrieveParams,
|
|
5
|
+
import { AudioURLInputChunk, FileCreateParams, FileDeleteParams, FileDeleteResponse, FileListParams, FileListResponse, FileRetrieveParams, FileUpdateParams, Files, ImageURLInputChunk, StoreFile, StoreFileConfig, StoreFileStatus, TextInputChunk, VideoURLInputChunk } from "./files.mjs";
|
|
6
6
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
7
7
|
import { Cursor, type CursorParams, PagePromise } from "../../core/pagination.mjs";
|
|
8
8
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
@@ -15,6 +15,11 @@ export declare class Stores extends APIResource {
|
|
|
15
15
|
* description, and metadata.
|
|
16
16
|
*
|
|
17
17
|
* Returns: VectorStore: The response containing the created vector store details.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* const store = await client.stores.create();
|
|
22
|
+
* ```
|
|
18
23
|
*/
|
|
19
24
|
create(body: StoreCreateParams, options?: RequestOptions): APIPromise<Store>;
|
|
20
25
|
/**
|
|
@@ -23,6 +28,13 @@ export declare class Stores extends APIResource {
|
|
|
23
28
|
* Args: store_identifier: The ID or name of the store to retrieve.
|
|
24
29
|
*
|
|
25
30
|
* Returns: Store: The response containing the store details.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* ```ts
|
|
34
|
+
* const store = await client.stores.retrieve(
|
|
35
|
+
* 'store_identifier',
|
|
36
|
+
* );
|
|
37
|
+
* ```
|
|
26
38
|
*/
|
|
27
39
|
retrieve(storeIdentifier: string, options?: RequestOptions): APIPromise<Store>;
|
|
28
40
|
/**
|
|
@@ -32,6 +44,13 @@ export declare class Stores extends APIResource {
|
|
|
32
44
|
* StoreCreate object containing the name, description, and metadata.
|
|
33
45
|
*
|
|
34
46
|
* Returns: Store: The response containing the updated store details.
|
|
47
|
+
*
|
|
48
|
+
* @example
|
|
49
|
+
* ```ts
|
|
50
|
+
* const store = await client.stores.update(
|
|
51
|
+
* 'store_identifier',
|
|
52
|
+
* );
|
|
53
|
+
* ```
|
|
35
54
|
*/
|
|
36
55
|
update(storeIdentifier: string, body: StoreUpdateParams, options?: RequestOptions): APIPromise<Store>;
|
|
37
56
|
/**
|
|
@@ -41,6 +60,14 @@ export declare class Stores extends APIResource {
|
|
|
41
60
|
* vector stores.
|
|
42
61
|
*
|
|
43
62
|
* Returns: StoreListResponse: The list of stores.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* // Automatically fetches more pages as needed.
|
|
67
|
+
* for await (const store of client.stores.list()) {
|
|
68
|
+
* // ...
|
|
69
|
+
* }
|
|
70
|
+
* ```
|
|
44
71
|
*/
|
|
45
72
|
list(query?: StoreListParams | null | undefined, options?: RequestOptions): PagePromise<StoresCursor, Store>;
|
|
46
73
|
/**
|
|
@@ -49,14 +76,35 @@ export declare class Stores extends APIResource {
|
|
|
49
76
|
* Args: store_identifier: The ID or name of the store to delete.
|
|
50
77
|
*
|
|
51
78
|
* Returns: Store: The response containing the deleted store details.
|
|
79
|
+
*
|
|
80
|
+
* @example
|
|
81
|
+
* ```ts
|
|
82
|
+
* const store = await client.stores.delete(
|
|
83
|
+
* 'store_identifier',
|
|
84
|
+
* );
|
|
85
|
+
* ```
|
|
52
86
|
*/
|
|
53
87
|
delete(storeIdentifier: string, options?: RequestOptions): APIPromise<StoreDeleteResponse>;
|
|
54
88
|
/**
|
|
55
89
|
* Get metadata facets
|
|
90
|
+
*
|
|
91
|
+
* @example
|
|
92
|
+
* ```ts
|
|
93
|
+
* const response = await client.stores.metadataFacets({
|
|
94
|
+
* store_identifiers: ['string'],
|
|
95
|
+
* });
|
|
96
|
+
* ```
|
|
56
97
|
*/
|
|
57
98
|
metadataFacets(body: StoreMetadataFacetsParams, options?: RequestOptions): APIPromise<StoreMetadataFacetsResponse>;
|
|
58
99
|
/**
|
|
59
100
|
* Question answering
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* ```ts
|
|
104
|
+
* const response = await client.stores.questionAnswering({
|
|
105
|
+
* store_identifiers: ['string'],
|
|
106
|
+
* });
|
|
107
|
+
* ```
|
|
60
108
|
*/
|
|
61
109
|
questionAnswering(body: StoreQuestionAnsweringParams, options?: RequestOptions): APIPromise<StoreQuestionAnsweringResponse>;
|
|
62
110
|
/**
|
|
@@ -81,10 +129,82 @@ export declare class Stores extends APIResource {
|
|
|
81
129
|
*
|
|
82
130
|
* Raises: HTTPException (400): If search parameters are invalid HTTPException
|
|
83
131
|
* (404): If no vector stores are found to search
|
|
132
|
+
*
|
|
133
|
+
* @example
|
|
134
|
+
* ```ts
|
|
135
|
+
* const response = await client.stores.search({
|
|
136
|
+
* query: 'how to configure SSL',
|
|
137
|
+
* store_identifiers: ['string'],
|
|
138
|
+
* });
|
|
139
|
+
* ```
|
|
84
140
|
*/
|
|
85
141
|
search(body: StoreSearchParams, options?: RequestOptions): APIPromise<StoreSearchResponse>;
|
|
86
142
|
}
|
|
87
143
|
export type StoresCursor = Cursor<Store>;
|
|
144
|
+
/**
|
|
145
|
+
* Configuration for agentic multi-query search.
|
|
146
|
+
*/
|
|
147
|
+
export interface AgenticSearchConfig {
|
|
148
|
+
/**
|
|
149
|
+
* Maximum number of search rounds
|
|
150
|
+
*/
|
|
151
|
+
max_rounds?: number;
|
|
152
|
+
/**
|
|
153
|
+
* Maximum queries per round
|
|
154
|
+
*/
|
|
155
|
+
queries_per_round?: number;
|
|
156
|
+
/**
|
|
157
|
+
* Additional custom instructions (followed only when not in conflict with existing
|
|
158
|
+
* rules)
|
|
159
|
+
*/
|
|
160
|
+
instructions?: string | null;
|
|
161
|
+
}
|
|
162
|
+
export interface AudioChunkGeneratedMetadata {
|
|
163
|
+
type?: 'audio';
|
|
164
|
+
file_type?: string;
|
|
165
|
+
file_size?: number | null;
|
|
166
|
+
total_duration_seconds?: number | null;
|
|
167
|
+
sample_rate?: number | null;
|
|
168
|
+
channels?: number | null;
|
|
169
|
+
audio_format?: number | null;
|
|
170
|
+
bpm?: number | null;
|
|
171
|
+
file_extension?: string | null;
|
|
172
|
+
[k: string]: unknown;
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Model for audio URL validation.
|
|
176
|
+
*/
|
|
177
|
+
export interface AudioURL {
|
|
178
|
+
/**
|
|
179
|
+
* The audio URL. Can be either a URL or a Data URI.
|
|
180
|
+
*/
|
|
181
|
+
url: string;
|
|
182
|
+
}
|
|
183
|
+
export interface CodeChunkGeneratedMetadata {
|
|
184
|
+
type?: 'code';
|
|
185
|
+
file_type: string;
|
|
186
|
+
language?: string | null;
|
|
187
|
+
word_count?: number | null;
|
|
188
|
+
file_size?: number | null;
|
|
189
|
+
start_line?: number;
|
|
190
|
+
num_lines?: number;
|
|
191
|
+
file_extension?: string | null;
|
|
192
|
+
[k: string]: unknown;
|
|
193
|
+
}
|
|
194
|
+
export interface ContextualizationConfig {
|
|
195
|
+
/**
|
|
196
|
+
* Include all metadata or specific fields in the contextualization. Supports dot
|
|
197
|
+
* notation for nested fields (e.g., 'author.name'). When True, all metadata is
|
|
198
|
+
* included (flattened). When a list, only specified fields are included.
|
|
199
|
+
*/
|
|
200
|
+
with_metadata?: boolean | Array<string>;
|
|
201
|
+
/**
|
|
202
|
+
* Use an LLM to generate a short context for each text chunk that situates it
|
|
203
|
+
* within the full document, improving retrieval accuracy. Only applies to text
|
|
204
|
+
* content during non-sliced ingestion.
|
|
205
|
+
*/
|
|
206
|
+
with_file_context?: boolean;
|
|
207
|
+
}
|
|
88
208
|
/**
|
|
89
209
|
* Represents an expiration policy for a store.
|
|
90
210
|
*/
|
|
@@ -98,6 +218,103 @@ export interface ExpiresAfter {
|
|
|
98
218
|
*/
|
|
99
219
|
days?: number;
|
|
100
220
|
}
|
|
221
|
+
/**
|
|
222
|
+
* Tracks counts of files in different states within a store.
|
|
223
|
+
*/
|
|
224
|
+
export interface FileCounts {
|
|
225
|
+
/**
|
|
226
|
+
* Number of files waiting to be processed
|
|
227
|
+
*/
|
|
228
|
+
pending?: number;
|
|
229
|
+
/**
|
|
230
|
+
* Number of files currently being processed
|
|
231
|
+
*/
|
|
232
|
+
in_progress?: number;
|
|
233
|
+
/**
|
|
234
|
+
* Number of files whose processing was cancelled
|
|
235
|
+
*/
|
|
236
|
+
cancelled?: number;
|
|
237
|
+
/**
|
|
238
|
+
* Number of successfully processed files
|
|
239
|
+
*/
|
|
240
|
+
completed?: number;
|
|
241
|
+
/**
|
|
242
|
+
* Number of files that failed processing
|
|
243
|
+
*/
|
|
244
|
+
failed?: number;
|
|
245
|
+
/**
|
|
246
|
+
* Total number of files
|
|
247
|
+
*/
|
|
248
|
+
total?: number;
|
|
249
|
+
}
|
|
250
|
+
export interface ImageChunkGeneratedMetadata {
|
|
251
|
+
type?: 'image';
|
|
252
|
+
file_type?: string;
|
|
253
|
+
file_size?: number | null;
|
|
254
|
+
width?: number | null;
|
|
255
|
+
height?: number | null;
|
|
256
|
+
file_extension?: string | null;
|
|
257
|
+
[k: string]: unknown;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Model for image URL validation.
|
|
261
|
+
*/
|
|
262
|
+
export interface ImageURLOutput {
|
|
263
|
+
/**
|
|
264
|
+
* The image URL. Can be either a URL or a Data URI.
|
|
265
|
+
*/
|
|
266
|
+
url: string;
|
|
267
|
+
/**
|
|
268
|
+
* The image format/mimetype
|
|
269
|
+
*/
|
|
270
|
+
format?: string;
|
|
271
|
+
}
|
|
272
|
+
export interface MarkdownChunkGeneratedMetadata {
|
|
273
|
+
type?: 'markdown';
|
|
274
|
+
file_type?: 'text/markdown';
|
|
275
|
+
language?: string | null;
|
|
276
|
+
word_count?: number | null;
|
|
277
|
+
file_size?: number | null;
|
|
278
|
+
chunk_headings?: Array<MarkdownHeading>;
|
|
279
|
+
heading_context?: Array<MarkdownHeading>;
|
|
280
|
+
start_line?: number;
|
|
281
|
+
num_lines?: number;
|
|
282
|
+
file_extension?: string | null;
|
|
283
|
+
frontmatter?: {
|
|
284
|
+
[key: string]: unknown;
|
|
285
|
+
};
|
|
286
|
+
[k: string]: unknown;
|
|
287
|
+
}
|
|
288
|
+
export interface MarkdownHeading {
|
|
289
|
+
level: number;
|
|
290
|
+
text: string;
|
|
291
|
+
}
|
|
292
|
+
export interface PdfChunkGeneratedMetadata {
|
|
293
|
+
type?: 'pdf';
|
|
294
|
+
file_type?: 'application/pdf';
|
|
295
|
+
total_pages?: number | null;
|
|
296
|
+
total_size?: number | null;
|
|
297
|
+
file_extension?: string | null;
|
|
298
|
+
[k: string]: unknown;
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* Represents a reranking configuration.
|
|
302
|
+
*/
|
|
303
|
+
export interface RerankConfig {
|
|
304
|
+
/**
|
|
305
|
+
* The name of the reranking model
|
|
306
|
+
*/
|
|
307
|
+
model?: string;
|
|
308
|
+
/**
|
|
309
|
+
* Whether to include metadata in the reranked results
|
|
310
|
+
*/
|
|
311
|
+
with_metadata?: boolean | Array<string>;
|
|
312
|
+
/**
|
|
313
|
+
* Maximum number of results to return after reranking. If None, returns all
|
|
314
|
+
* reranked results.
|
|
315
|
+
*/
|
|
316
|
+
top_k?: number | null;
|
|
317
|
+
}
|
|
101
318
|
export interface ScoredAudioURLInputChunk {
|
|
102
319
|
/**
|
|
103
320
|
* position of the chunk in a file
|
|
@@ -110,7 +327,7 @@ export interface ScoredAudioURLInputChunk {
|
|
|
110
327
|
/**
|
|
111
328
|
* metadata of the chunk
|
|
112
329
|
*/
|
|
113
|
-
generated_metadata?:
|
|
330
|
+
generated_metadata?: MarkdownChunkGeneratedMetadata | TextChunkGeneratedMetadata | PdfChunkGeneratedMetadata | CodeChunkGeneratedMetadata | AudioChunkGeneratedMetadata | VideoChunkGeneratedMetadata | ImageChunkGeneratedMetadata | null;
|
|
114
331
|
/**
|
|
115
332
|
* model used for this chunk
|
|
116
333
|
*/
|
|
@@ -147,121 +364,15 @@ export interface ScoredAudioURLInputChunk {
|
|
|
147
364
|
* speech recognition (sr) text of the audio
|
|
148
365
|
*/
|
|
149
366
|
transcription?: string | null;
|
|
150
|
-
/**
|
|
151
|
-
* summary of the audio
|
|
152
|
-
*/
|
|
153
|
-
summary?: string | null;
|
|
154
367
|
/**
|
|
155
368
|
* Model for audio URL validation.
|
|
156
369
|
*/
|
|
157
|
-
audio_url?:
|
|
370
|
+
audio_url?: AudioURL | null;
|
|
158
371
|
/**
|
|
159
372
|
* The sampling rate of the audio.
|
|
160
373
|
*/
|
|
161
374
|
sampling_rate: number;
|
|
162
375
|
}
|
|
163
|
-
export declare namespace ScoredAudioURLInputChunk {
|
|
164
|
-
interface MarkdownChunkGeneratedMetadata {
|
|
165
|
-
type?: 'markdown';
|
|
166
|
-
file_type?: 'text/markdown';
|
|
167
|
-
language?: string | null;
|
|
168
|
-
word_count?: number | null;
|
|
169
|
-
file_size?: number | null;
|
|
170
|
-
chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
|
|
171
|
-
heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
|
|
172
|
-
start_line?: number;
|
|
173
|
-
num_lines?: number;
|
|
174
|
-
file_extension?: string | null;
|
|
175
|
-
frontmatter?: {
|
|
176
|
-
[key: string]: unknown;
|
|
177
|
-
};
|
|
178
|
-
[k: string]: unknown;
|
|
179
|
-
}
|
|
180
|
-
namespace MarkdownChunkGeneratedMetadata {
|
|
181
|
-
interface ChunkHeading {
|
|
182
|
-
level: number;
|
|
183
|
-
text: string;
|
|
184
|
-
}
|
|
185
|
-
interface HeadingContext {
|
|
186
|
-
level: number;
|
|
187
|
-
text: string;
|
|
188
|
-
}
|
|
189
|
-
}
|
|
190
|
-
interface TextChunkGeneratedMetadata {
|
|
191
|
-
type?: 'text';
|
|
192
|
-
file_type?: 'text/plain';
|
|
193
|
-
language?: string | null;
|
|
194
|
-
word_count?: number | null;
|
|
195
|
-
file_size?: number | null;
|
|
196
|
-
start_line?: number;
|
|
197
|
-
num_lines?: number;
|
|
198
|
-
file_extension?: string | null;
|
|
199
|
-
[k: string]: unknown;
|
|
200
|
-
}
|
|
201
|
-
interface PdfChunkGeneratedMetadata {
|
|
202
|
-
type?: 'pdf';
|
|
203
|
-
file_type?: 'application/pdf';
|
|
204
|
-
total_pages?: number | null;
|
|
205
|
-
total_size?: number | null;
|
|
206
|
-
file_extension?: string | null;
|
|
207
|
-
[k: string]: unknown;
|
|
208
|
-
}
|
|
209
|
-
interface CodeChunkGeneratedMetadata {
|
|
210
|
-
type?: 'code';
|
|
211
|
-
file_type: string;
|
|
212
|
-
language?: string | null;
|
|
213
|
-
word_count?: number | null;
|
|
214
|
-
file_size?: number | null;
|
|
215
|
-
start_line?: number;
|
|
216
|
-
num_lines?: number;
|
|
217
|
-
file_extension?: string | null;
|
|
218
|
-
[k: string]: unknown;
|
|
219
|
-
}
|
|
220
|
-
interface AudioChunkGeneratedMetadata {
|
|
221
|
-
type?: 'audio';
|
|
222
|
-
file_type?: string;
|
|
223
|
-
file_size?: number | null;
|
|
224
|
-
total_duration_seconds?: number | null;
|
|
225
|
-
sample_rate?: number | null;
|
|
226
|
-
channels?: number | null;
|
|
227
|
-
audio_format?: number | null;
|
|
228
|
-
bpm?: number | null;
|
|
229
|
-
file_extension?: string | null;
|
|
230
|
-
[k: string]: unknown;
|
|
231
|
-
}
|
|
232
|
-
interface VideoChunkGeneratedMetadata {
|
|
233
|
-
type?: 'video';
|
|
234
|
-
file_type?: string;
|
|
235
|
-
file_size?: number | null;
|
|
236
|
-
total_duration_seconds?: number | null;
|
|
237
|
-
fps?: number | null;
|
|
238
|
-
width?: number | null;
|
|
239
|
-
height?: number | null;
|
|
240
|
-
frame_count?: number | null;
|
|
241
|
-
has_audio_stream?: boolean;
|
|
242
|
-
bpm?: number | null;
|
|
243
|
-
file_extension?: string | null;
|
|
244
|
-
[k: string]: unknown;
|
|
245
|
-
}
|
|
246
|
-
interface ImageChunkGeneratedMetadata {
|
|
247
|
-
type?: 'image';
|
|
248
|
-
file_type?: string;
|
|
249
|
-
file_size?: number | null;
|
|
250
|
-
width?: number | null;
|
|
251
|
-
height?: number | null;
|
|
252
|
-
file_extension?: string | null;
|
|
253
|
-
[k: string]: unknown;
|
|
254
|
-
}
|
|
255
|
-
/**
|
|
256
|
-
* Model for audio URL validation.
|
|
257
|
-
*/
|
|
258
|
-
interface AudioURL {
|
|
259
|
-
/**
|
|
260
|
-
* The audio URL. Can be either a URL or a Data URI.
|
|
261
|
-
*/
|
|
262
|
-
url: string;
|
|
263
|
-
}
|
|
264
|
-
}
|
|
265
376
|
export interface ScoredImageURLInputChunk {
|
|
266
377
|
/**
|
|
267
378
|
* position of the chunk in a file
|
|
@@ -274,7 +385,7 @@ export interface ScoredImageURLInputChunk {
|
|
|
274
385
|
/**
|
|
275
386
|
* metadata of the chunk
|
|
276
387
|
*/
|
|
277
|
-
generated_metadata?:
|
|
388
|
+
generated_metadata?: MarkdownChunkGeneratedMetadata | TextChunkGeneratedMetadata | PdfChunkGeneratedMetadata | CodeChunkGeneratedMetadata | AudioChunkGeneratedMetadata | VideoChunkGeneratedMetadata | ImageChunkGeneratedMetadata | null;
|
|
278
389
|
/**
|
|
279
390
|
* model used for this chunk
|
|
280
391
|
*/
|
|
@@ -318,113 +429,7 @@ export interface ScoredImageURLInputChunk {
|
|
|
318
429
|
/**
|
|
319
430
|
* Model for image URL validation.
|
|
320
431
|
*/
|
|
321
|
-
image_url?:
|
|
322
|
-
}
|
|
323
|
-
export declare namespace ScoredImageURLInputChunk {
|
|
324
|
-
interface MarkdownChunkGeneratedMetadata {
|
|
325
|
-
type?: 'markdown';
|
|
326
|
-
file_type?: 'text/markdown';
|
|
327
|
-
language?: string | null;
|
|
328
|
-
word_count?: number | null;
|
|
329
|
-
file_size?: number | null;
|
|
330
|
-
chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
|
|
331
|
-
heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
|
|
332
|
-
start_line?: number;
|
|
333
|
-
num_lines?: number;
|
|
334
|
-
file_extension?: string | null;
|
|
335
|
-
frontmatter?: {
|
|
336
|
-
[key: string]: unknown;
|
|
337
|
-
};
|
|
338
|
-
[k: string]: unknown;
|
|
339
|
-
}
|
|
340
|
-
namespace MarkdownChunkGeneratedMetadata {
|
|
341
|
-
interface ChunkHeading {
|
|
342
|
-
level: number;
|
|
343
|
-
text: string;
|
|
344
|
-
}
|
|
345
|
-
interface HeadingContext {
|
|
346
|
-
level: number;
|
|
347
|
-
text: string;
|
|
348
|
-
}
|
|
349
|
-
}
|
|
350
|
-
interface TextChunkGeneratedMetadata {
|
|
351
|
-
type?: 'text';
|
|
352
|
-
file_type?: 'text/plain';
|
|
353
|
-
language?: string | null;
|
|
354
|
-
word_count?: number | null;
|
|
355
|
-
file_size?: number | null;
|
|
356
|
-
start_line?: number;
|
|
357
|
-
num_lines?: number;
|
|
358
|
-
file_extension?: string | null;
|
|
359
|
-
[k: string]: unknown;
|
|
360
|
-
}
|
|
361
|
-
interface PdfChunkGeneratedMetadata {
|
|
362
|
-
type?: 'pdf';
|
|
363
|
-
file_type?: 'application/pdf';
|
|
364
|
-
total_pages?: number | null;
|
|
365
|
-
total_size?: number | null;
|
|
366
|
-
file_extension?: string | null;
|
|
367
|
-
[k: string]: unknown;
|
|
368
|
-
}
|
|
369
|
-
interface CodeChunkGeneratedMetadata {
|
|
370
|
-
type?: 'code';
|
|
371
|
-
file_type: string;
|
|
372
|
-
language?: string | null;
|
|
373
|
-
word_count?: number | null;
|
|
374
|
-
file_size?: number | null;
|
|
375
|
-
start_line?: number;
|
|
376
|
-
num_lines?: number;
|
|
377
|
-
file_extension?: string | null;
|
|
378
|
-
[k: string]: unknown;
|
|
379
|
-
}
|
|
380
|
-
interface AudioChunkGeneratedMetadata {
|
|
381
|
-
type?: 'audio';
|
|
382
|
-
file_type?: string;
|
|
383
|
-
file_size?: number | null;
|
|
384
|
-
total_duration_seconds?: number | null;
|
|
385
|
-
sample_rate?: number | null;
|
|
386
|
-
channels?: number | null;
|
|
387
|
-
audio_format?: number | null;
|
|
388
|
-
bpm?: number | null;
|
|
389
|
-
file_extension?: string | null;
|
|
390
|
-
[k: string]: unknown;
|
|
391
|
-
}
|
|
392
|
-
interface VideoChunkGeneratedMetadata {
|
|
393
|
-
type?: 'video';
|
|
394
|
-
file_type?: string;
|
|
395
|
-
file_size?: number | null;
|
|
396
|
-
total_duration_seconds?: number | null;
|
|
397
|
-
fps?: number | null;
|
|
398
|
-
width?: number | null;
|
|
399
|
-
height?: number | null;
|
|
400
|
-
frame_count?: number | null;
|
|
401
|
-
has_audio_stream?: boolean;
|
|
402
|
-
bpm?: number | null;
|
|
403
|
-
file_extension?: string | null;
|
|
404
|
-
[k: string]: unknown;
|
|
405
|
-
}
|
|
406
|
-
interface ImageChunkGeneratedMetadata {
|
|
407
|
-
type?: 'image';
|
|
408
|
-
file_type?: string;
|
|
409
|
-
file_size?: number | null;
|
|
410
|
-
width?: number | null;
|
|
411
|
-
height?: number | null;
|
|
412
|
-
file_extension?: string | null;
|
|
413
|
-
[k: string]: unknown;
|
|
414
|
-
}
|
|
415
|
-
/**
|
|
416
|
-
* Model for image URL validation.
|
|
417
|
-
*/
|
|
418
|
-
interface ImageURL {
|
|
419
|
-
/**
|
|
420
|
-
* The image URL. Can be either a URL or a Data URI.
|
|
421
|
-
*/
|
|
422
|
-
url: string;
|
|
423
|
-
/**
|
|
424
|
-
* The image format/mimetype
|
|
425
|
-
*/
|
|
426
|
-
format?: string;
|
|
427
|
-
}
|
|
432
|
+
image_url?: ImageURLOutput | null;
|
|
428
433
|
}
|
|
429
434
|
export interface ScoredTextInputChunk {
|
|
430
435
|
/**
|
|
@@ -438,7 +443,7 @@ export interface ScoredTextInputChunk {
|
|
|
438
443
|
/**
|
|
439
444
|
* metadata of the chunk
|
|
440
445
|
*/
|
|
441
|
-
generated_metadata?:
|
|
446
|
+
generated_metadata?: MarkdownChunkGeneratedMetadata | TextChunkGeneratedMetadata | PdfChunkGeneratedMetadata | CodeChunkGeneratedMetadata | AudioChunkGeneratedMetadata | VideoChunkGeneratedMetadata | ImageChunkGeneratedMetadata | null;
|
|
442
447
|
/**
|
|
443
448
|
* model used for this chunk
|
|
444
449
|
*/
|
|
@@ -479,99 +484,10 @@ export interface ScoredTextInputChunk {
|
|
|
479
484
|
* Text content
|
|
480
485
|
*/
|
|
481
486
|
text?: string | null;
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
file_type?: 'text/markdown';
|
|
487
|
-
language?: string | null;
|
|
488
|
-
word_count?: number | null;
|
|
489
|
-
file_size?: number | null;
|
|
490
|
-
chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
|
|
491
|
-
heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
|
|
492
|
-
start_line?: number;
|
|
493
|
-
num_lines?: number;
|
|
494
|
-
file_extension?: string | null;
|
|
495
|
-
frontmatter?: {
|
|
496
|
-
[key: string]: unknown;
|
|
497
|
-
};
|
|
498
|
-
[k: string]: unknown;
|
|
499
|
-
}
|
|
500
|
-
namespace MarkdownChunkGeneratedMetadata {
|
|
501
|
-
interface ChunkHeading {
|
|
502
|
-
level: number;
|
|
503
|
-
text: string;
|
|
504
|
-
}
|
|
505
|
-
interface HeadingContext {
|
|
506
|
-
level: number;
|
|
507
|
-
text: string;
|
|
508
|
-
}
|
|
509
|
-
}
|
|
510
|
-
interface TextChunkGeneratedMetadata {
|
|
511
|
-
type?: 'text';
|
|
512
|
-
file_type?: 'text/plain';
|
|
513
|
-
language?: string | null;
|
|
514
|
-
word_count?: number | null;
|
|
515
|
-
file_size?: number | null;
|
|
516
|
-
start_line?: number;
|
|
517
|
-
num_lines?: number;
|
|
518
|
-
file_extension?: string | null;
|
|
519
|
-
[k: string]: unknown;
|
|
520
|
-
}
|
|
521
|
-
interface PdfChunkGeneratedMetadata {
|
|
522
|
-
type?: 'pdf';
|
|
523
|
-
file_type?: 'application/pdf';
|
|
524
|
-
total_pages?: number | null;
|
|
525
|
-
total_size?: number | null;
|
|
526
|
-
file_extension?: string | null;
|
|
527
|
-
[k: string]: unknown;
|
|
528
|
-
}
|
|
529
|
-
interface CodeChunkGeneratedMetadata {
|
|
530
|
-
type?: 'code';
|
|
531
|
-
file_type: string;
|
|
532
|
-
language?: string | null;
|
|
533
|
-
word_count?: number | null;
|
|
534
|
-
file_size?: number | null;
|
|
535
|
-
start_line?: number;
|
|
536
|
-
num_lines?: number;
|
|
537
|
-
file_extension?: string | null;
|
|
538
|
-
[k: string]: unknown;
|
|
539
|
-
}
|
|
540
|
-
interface AudioChunkGeneratedMetadata {
|
|
541
|
-
type?: 'audio';
|
|
542
|
-
file_type?: string;
|
|
543
|
-
file_size?: number | null;
|
|
544
|
-
total_duration_seconds?: number | null;
|
|
545
|
-
sample_rate?: number | null;
|
|
546
|
-
channels?: number | null;
|
|
547
|
-
audio_format?: number | null;
|
|
548
|
-
bpm?: number | null;
|
|
549
|
-
file_extension?: string | null;
|
|
550
|
-
[k: string]: unknown;
|
|
551
|
-
}
|
|
552
|
-
interface VideoChunkGeneratedMetadata {
|
|
553
|
-
type?: 'video';
|
|
554
|
-
file_type?: string;
|
|
555
|
-
file_size?: number | null;
|
|
556
|
-
total_duration_seconds?: number | null;
|
|
557
|
-
fps?: number | null;
|
|
558
|
-
width?: number | null;
|
|
559
|
-
height?: number | null;
|
|
560
|
-
frame_count?: number | null;
|
|
561
|
-
has_audio_stream?: boolean;
|
|
562
|
-
bpm?: number | null;
|
|
563
|
-
file_extension?: string | null;
|
|
564
|
-
[k: string]: unknown;
|
|
565
|
-
}
|
|
566
|
-
interface ImageChunkGeneratedMetadata {
|
|
567
|
-
type?: 'image';
|
|
568
|
-
file_type?: string;
|
|
569
|
-
file_size?: number | null;
|
|
570
|
-
width?: number | null;
|
|
571
|
-
height?: number | null;
|
|
572
|
-
file_extension?: string | null;
|
|
573
|
-
[k: string]: unknown;
|
|
574
|
-
}
|
|
487
|
+
/**
|
|
488
|
+
* LLM-generated context that situates this chunk within its source document
|
|
489
|
+
*/
|
|
490
|
+
context?: string | null;
|
|
575
491
|
}
|
|
576
492
|
export interface ScoredVideoURLInputChunk {
|
|
577
493
|
/**
|
|
@@ -585,7 +501,7 @@ export interface ScoredVideoURLInputChunk {
|
|
|
585
501
|
/**
|
|
586
502
|
* metadata of the chunk
|
|
587
503
|
*/
|
|
588
|
-
generated_metadata?:
|
|
504
|
+
generated_metadata?: MarkdownChunkGeneratedMetadata | TextChunkGeneratedMetadata | PdfChunkGeneratedMetadata | CodeChunkGeneratedMetadata | AudioChunkGeneratedMetadata | VideoChunkGeneratedMetadata | ImageChunkGeneratedMetadata | null;
|
|
589
505
|
/**
|
|
590
506
|
* model used for this chunk
|
|
591
507
|
*/
|
|
@@ -629,109 +545,7 @@ export interface ScoredVideoURLInputChunk {
|
|
|
629
545
|
/**
|
|
630
546
|
* Model for video URL validation.
|
|
631
547
|
*/
|
|
632
|
-
video_url?:
|
|
633
|
-
}
|
|
634
|
-
export declare namespace ScoredVideoURLInputChunk {
|
|
635
|
-
interface MarkdownChunkGeneratedMetadata {
|
|
636
|
-
type?: 'markdown';
|
|
637
|
-
file_type?: 'text/markdown';
|
|
638
|
-
language?: string | null;
|
|
639
|
-
word_count?: number | null;
|
|
640
|
-
file_size?: number | null;
|
|
641
|
-
chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
|
|
642
|
-
heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
|
|
643
|
-
start_line?: number;
|
|
644
|
-
num_lines?: number;
|
|
645
|
-
file_extension?: string | null;
|
|
646
|
-
frontmatter?: {
|
|
647
|
-
[key: string]: unknown;
|
|
648
|
-
};
|
|
649
|
-
[k: string]: unknown;
|
|
650
|
-
}
|
|
651
|
-
namespace MarkdownChunkGeneratedMetadata {
|
|
652
|
-
interface ChunkHeading {
|
|
653
|
-
level: number;
|
|
654
|
-
text: string;
|
|
655
|
-
}
|
|
656
|
-
interface HeadingContext {
|
|
657
|
-
level: number;
|
|
658
|
-
text: string;
|
|
659
|
-
}
|
|
660
|
-
}
|
|
661
|
-
interface TextChunkGeneratedMetadata {
|
|
662
|
-
type?: 'text';
|
|
663
|
-
file_type?: 'text/plain';
|
|
664
|
-
language?: string | null;
|
|
665
|
-
word_count?: number | null;
|
|
666
|
-
file_size?: number | null;
|
|
667
|
-
start_line?: number;
|
|
668
|
-
num_lines?: number;
|
|
669
|
-
file_extension?: string | null;
|
|
670
|
-
[k: string]: unknown;
|
|
671
|
-
}
|
|
672
|
-
interface PdfChunkGeneratedMetadata {
|
|
673
|
-
type?: 'pdf';
|
|
674
|
-
file_type?: 'application/pdf';
|
|
675
|
-
total_pages?: number | null;
|
|
676
|
-
total_size?: number | null;
|
|
677
|
-
file_extension?: string | null;
|
|
678
|
-
[k: string]: unknown;
|
|
679
|
-
}
|
|
680
|
-
interface CodeChunkGeneratedMetadata {
|
|
681
|
-
type?: 'code';
|
|
682
|
-
file_type: string;
|
|
683
|
-
language?: string | null;
|
|
684
|
-
word_count?: number | null;
|
|
685
|
-
file_size?: number | null;
|
|
686
|
-
start_line?: number;
|
|
687
|
-
num_lines?: number;
|
|
688
|
-
file_extension?: string | null;
|
|
689
|
-
[k: string]: unknown;
|
|
690
|
-
}
|
|
691
|
-
interface AudioChunkGeneratedMetadata {
|
|
692
|
-
type?: 'audio';
|
|
693
|
-
file_type?: string;
|
|
694
|
-
file_size?: number | null;
|
|
695
|
-
total_duration_seconds?: number | null;
|
|
696
|
-
sample_rate?: number | null;
|
|
697
|
-
channels?: number | null;
|
|
698
|
-
audio_format?: number | null;
|
|
699
|
-
bpm?: number | null;
|
|
700
|
-
file_extension?: string | null;
|
|
701
|
-
[k: string]: unknown;
|
|
702
|
-
}
|
|
703
|
-
interface VideoChunkGeneratedMetadata {
|
|
704
|
-
type?: 'video';
|
|
705
|
-
file_type?: string;
|
|
706
|
-
file_size?: number | null;
|
|
707
|
-
total_duration_seconds?: number | null;
|
|
708
|
-
fps?: number | null;
|
|
709
|
-
width?: number | null;
|
|
710
|
-
height?: number | null;
|
|
711
|
-
frame_count?: number | null;
|
|
712
|
-
has_audio_stream?: boolean;
|
|
713
|
-
bpm?: number | null;
|
|
714
|
-
file_extension?: string | null;
|
|
715
|
-
[k: string]: unknown;
|
|
716
|
-
}
|
|
717
|
-
interface ImageChunkGeneratedMetadata {
|
|
718
|
-
type?: 'image';
|
|
719
|
-
file_type?: string;
|
|
720
|
-
file_size?: number | null;
|
|
721
|
-
width?: number | null;
|
|
722
|
-
height?: number | null;
|
|
723
|
-
file_extension?: string | null;
|
|
724
|
-
[k: string]: unknown;
|
|
725
|
-
}
|
|
726
|
-
/**
|
|
727
|
-
* Model for video URL validation.
|
|
728
|
-
*/
|
|
729
|
-
interface VideoURL {
|
|
730
|
-
/**
|
|
731
|
-
* The video URL. Can be either a URL or a Data URI.
|
|
732
|
-
*/
|
|
733
|
-
url: string;
|
|
734
|
-
}
|
|
548
|
+
video_url?: VideoURL | null;
|
|
735
549
|
}
|
|
736
550
|
/**
|
|
737
551
|
* Model representing a store with its metadata and timestamps.
|
|
@@ -753,6 +567,10 @@ export interface Store {
|
|
|
753
567
|
* Whether the store can be accessed by anyone with valid login credentials
|
|
754
568
|
*/
|
|
755
569
|
is_public?: boolean;
|
|
570
|
+
/**
|
|
571
|
+
* License for public stores
|
|
572
|
+
*/
|
|
573
|
+
license?: string | null;
|
|
756
574
|
/**
|
|
757
575
|
* Additional metadata associated with the store
|
|
758
576
|
*/
|
|
@@ -760,11 +578,11 @@ export interface Store {
|
|
|
760
578
|
/**
|
|
761
579
|
* Configuration for a store.
|
|
762
580
|
*/
|
|
763
|
-
config?:
|
|
581
|
+
config?: StoreConfig | null;
|
|
764
582
|
/**
|
|
765
583
|
* Counts of files in different states
|
|
766
584
|
*/
|
|
767
|
-
file_counts?:
|
|
585
|
+
file_counts?: FileCounts;
|
|
768
586
|
/**
|
|
769
587
|
* Represents an expiration policy for a store.
|
|
770
588
|
*/
|
|
@@ -802,62 +620,6 @@ export interface Store {
|
|
|
802
620
|
*/
|
|
803
621
|
object?: 'store';
|
|
804
622
|
}
|
|
805
|
-
export declare namespace Store {
|
|
806
|
-
/**
|
|
807
|
-
* Configuration for a store.
|
|
808
|
-
*/
|
|
809
|
-
interface Config {
|
|
810
|
-
/**
|
|
811
|
-
* Contextualize files with metadata
|
|
812
|
-
*/
|
|
813
|
-
contextualization?: boolean | Config.ContextualizationConfig;
|
|
814
|
-
/**
|
|
815
|
-
* Whether to save original content in the store. When False, only vectors are
|
|
816
|
-
* indexed without the original content (index-only mode). This is useful for data
|
|
817
|
-
* privacy. Note: Reranking is not supported when content is not saved.
|
|
818
|
-
*/
|
|
819
|
-
save_content?: boolean;
|
|
820
|
-
}
|
|
821
|
-
namespace Config {
|
|
822
|
-
interface ContextualizationConfig {
|
|
823
|
-
/**
|
|
824
|
-
* Include all metadata or specific fields in the contextualization. Supports dot
|
|
825
|
-
* notation for nested fields (e.g., 'author.name'). When True, all metadata is
|
|
826
|
-
* included (flattened). When a list, only specified fields are included.
|
|
827
|
-
*/
|
|
828
|
-
with_metadata?: boolean | Array<string>;
|
|
829
|
-
}
|
|
830
|
-
}
|
|
831
|
-
/**
|
|
832
|
-
* Counts of files in different states
|
|
833
|
-
*/
|
|
834
|
-
interface FileCounts {
|
|
835
|
-
/**
|
|
836
|
-
* Number of files waiting to be processed
|
|
837
|
-
*/
|
|
838
|
-
pending?: number;
|
|
839
|
-
/**
|
|
840
|
-
* Number of files currently being processed
|
|
841
|
-
*/
|
|
842
|
-
in_progress?: number;
|
|
843
|
-
/**
|
|
844
|
-
* Number of files whose processing was cancelled
|
|
845
|
-
*/
|
|
846
|
-
cancelled?: number;
|
|
847
|
-
/**
|
|
848
|
-
* Number of successfully processed files
|
|
849
|
-
*/
|
|
850
|
-
completed?: number;
|
|
851
|
-
/**
|
|
852
|
-
* Number of files that failed processing
|
|
853
|
-
*/
|
|
854
|
-
failed?: number;
|
|
855
|
-
/**
|
|
856
|
-
* Total number of files
|
|
857
|
-
*/
|
|
858
|
-
total?: number;
|
|
859
|
-
}
|
|
860
|
-
}
|
|
861
623
|
/**
|
|
862
624
|
* Options for configuring store chunk searches.
|
|
863
625
|
*/
|
|
@@ -875,12 +637,12 @@ export interface StoreChunkSearchOptions {
|
|
|
875
637
|
* Whether to rerank results and optional reranking configuration. Ignored when
|
|
876
638
|
* agentic is enabled (the agent handles ranking).
|
|
877
639
|
*/
|
|
878
|
-
rerank?: boolean |
|
|
640
|
+
rerank?: boolean | RerankConfig | null;
|
|
879
641
|
/**
|
|
880
642
|
* Whether to use agentic multi-query search with automatic query decomposition and
|
|
881
643
|
* ranking. When enabled, rewrite_query and rerank options are ignored.
|
|
882
644
|
*/
|
|
883
|
-
agentic?: boolean |
|
|
645
|
+
agentic?: boolean | AgenticSearchConfig | null;
|
|
884
646
|
/**
|
|
885
647
|
* Whether to return file metadata
|
|
886
648
|
*/
|
|
@@ -890,43 +652,54 @@ export interface StoreChunkSearchOptions {
|
|
|
890
652
|
*/
|
|
891
653
|
apply_search_rules?: boolean;
|
|
892
654
|
}
|
|
893
|
-
|
|
655
|
+
/**
|
|
656
|
+
* Configuration for a store.
|
|
657
|
+
*/
|
|
658
|
+
export interface StoreConfig {
|
|
894
659
|
/**
|
|
895
|
-
*
|
|
660
|
+
* Contextualize files with metadata
|
|
896
661
|
*/
|
|
897
|
-
|
|
898
|
-
/**
|
|
899
|
-
* The name of the reranking model
|
|
900
|
-
*/
|
|
901
|
-
model?: string;
|
|
902
|
-
/**
|
|
903
|
-
* Whether to include metadata in the reranked results
|
|
904
|
-
*/
|
|
905
|
-
with_metadata?: boolean | Array<string>;
|
|
906
|
-
/**
|
|
907
|
-
* Maximum number of results to return after reranking. If None, returns all
|
|
908
|
-
* reranked results.
|
|
909
|
-
*/
|
|
910
|
-
top_k?: number | null;
|
|
911
|
-
}
|
|
662
|
+
contextualization?: boolean | ContextualizationConfig;
|
|
912
663
|
/**
|
|
913
|
-
*
|
|
664
|
+
* Whether to save original content in the store. When False, only vectors are
|
|
665
|
+
* indexed without the original content (index-only mode). This is useful for data
|
|
666
|
+
* privacy. Note: Reranking is not supported when content is not saved.
|
|
914
667
|
*/
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
668
|
+
save_content?: boolean;
|
|
669
|
+
}
|
|
670
|
+
export interface TextChunkGeneratedMetadata {
|
|
671
|
+
type?: 'text';
|
|
672
|
+
file_type?: 'text/plain';
|
|
673
|
+
language?: string | null;
|
|
674
|
+
word_count?: number | null;
|
|
675
|
+
file_size?: number | null;
|
|
676
|
+
start_line?: number;
|
|
677
|
+
num_lines?: number;
|
|
678
|
+
file_extension?: string | null;
|
|
679
|
+
[k: string]: unknown;
|
|
680
|
+
}
|
|
681
|
+
export interface VideoChunkGeneratedMetadata {
|
|
682
|
+
type?: 'video';
|
|
683
|
+
file_type?: string;
|
|
684
|
+
file_size?: number | null;
|
|
685
|
+
total_duration_seconds?: number | null;
|
|
686
|
+
fps?: number | null;
|
|
687
|
+
width?: number | null;
|
|
688
|
+
height?: number | null;
|
|
689
|
+
frame_count?: number | null;
|
|
690
|
+
has_audio_stream?: boolean;
|
|
691
|
+
bpm?: number | null;
|
|
692
|
+
file_extension?: string | null;
|
|
693
|
+
[k: string]: unknown;
|
|
694
|
+
}
|
|
695
|
+
/**
|
|
696
|
+
* Model for video URL validation.
|
|
697
|
+
*/
|
|
698
|
+
export interface VideoURL {
|
|
699
|
+
/**
|
|
700
|
+
* The video URL. Can be either a URL or a Data URI.
|
|
701
|
+
*/
|
|
702
|
+
url: string;
|
|
930
703
|
}
|
|
931
704
|
/**
|
|
932
705
|
* Response model for store deletion.
|
|
@@ -995,6 +768,10 @@ export interface StoreCreateParams {
|
|
|
995
768
|
* Whether the store can be accessed by anyone with valid login credentials
|
|
996
769
|
*/
|
|
997
770
|
is_public?: boolean;
|
|
771
|
+
/**
|
|
772
|
+
* License for public stores
|
|
773
|
+
*/
|
|
774
|
+
license?: string | null;
|
|
998
775
|
/**
|
|
999
776
|
* Represents an expiration policy for a store.
|
|
1000
777
|
*/
|
|
@@ -1006,39 +783,12 @@ export interface StoreCreateParams {
|
|
|
1006
783
|
/**
|
|
1007
784
|
* Configuration for a store.
|
|
1008
785
|
*/
|
|
1009
|
-
config?:
|
|
786
|
+
config?: StoreConfig | null;
|
|
1010
787
|
/**
|
|
1011
788
|
* Optional list of file IDs
|
|
1012
789
|
*/
|
|
1013
790
|
file_ids?: Array<string> | null;
|
|
1014
791
|
}
|
|
1015
|
-
export declare namespace StoreCreateParams {
|
|
1016
|
-
/**
|
|
1017
|
-
* Configuration for a store.
|
|
1018
|
-
*/
|
|
1019
|
-
interface Config {
|
|
1020
|
-
/**
|
|
1021
|
-
* Contextualize files with metadata
|
|
1022
|
-
*/
|
|
1023
|
-
contextualization?: boolean | Config.ContextualizationConfig;
|
|
1024
|
-
/**
|
|
1025
|
-
* Whether to save original content in the store. When False, only vectors are
|
|
1026
|
-
* indexed without the original content (index-only mode). This is useful for data
|
|
1027
|
-
* privacy. Note: Reranking is not supported when content is not saved.
|
|
1028
|
-
*/
|
|
1029
|
-
save_content?: boolean;
|
|
1030
|
-
}
|
|
1031
|
-
namespace Config {
|
|
1032
|
-
interface ContextualizationConfig {
|
|
1033
|
-
/**
|
|
1034
|
-
* Include all metadata or specific fields in the contextualization. Supports dot
|
|
1035
|
-
* notation for nested fields (e.g., 'author.name'). When True, all metadata is
|
|
1036
|
-
* included (flattened). When a list, only specified fields are included.
|
|
1037
|
-
*/
|
|
1038
|
-
with_metadata?: boolean | Array<string>;
|
|
1039
|
-
}
|
|
1040
|
-
}
|
|
1041
|
-
}
|
|
1042
792
|
export interface StoreUpdateParams {
|
|
1043
793
|
/**
|
|
1044
794
|
* New name for the store. Can only contain lowercase letters, numbers, periods
|
|
@@ -1053,6 +803,10 @@ export interface StoreUpdateParams {
|
|
|
1053
803
|
* Whether the store can be accessed by anyone with valid login credentials
|
|
1054
804
|
*/
|
|
1055
805
|
is_public?: boolean | null;
|
|
806
|
+
/**
|
|
807
|
+
* License for public stores
|
|
808
|
+
*/
|
|
809
|
+
license?: string | null;
|
|
1056
810
|
/**
|
|
1057
811
|
* Represents an expiration policy for a store.
|
|
1058
812
|
*/
|
|
@@ -1180,7 +934,7 @@ export interface StoreSearchParams {
|
|
|
1180
934
|
search_options?: StoreChunkSearchOptions;
|
|
1181
935
|
}
|
|
1182
936
|
export declare namespace Stores {
|
|
1183
|
-
export { type ExpiresAfter as ExpiresAfter, type ScoredAudioURLInputChunk as ScoredAudioURLInputChunk, type ScoredImageURLInputChunk as ScoredImageURLInputChunk, type ScoredTextInputChunk as ScoredTextInputChunk, type ScoredVideoURLInputChunk as ScoredVideoURLInputChunk, type Store as Store, type StoreChunkSearchOptions as StoreChunkSearchOptions, type StoreDeleteResponse as StoreDeleteResponse, type StoreMetadataFacetsResponse as StoreMetadataFacetsResponse, type StoreQuestionAnsweringResponse as StoreQuestionAnsweringResponse, type StoreSearchResponse as StoreSearchResponse, type StoresCursor as StoresCursor, type StoreCreateParams as StoreCreateParams, type StoreUpdateParams as StoreUpdateParams, type StoreListParams as StoreListParams, type StoreMetadataFacetsParams as StoreMetadataFacetsParams, type StoreQuestionAnsweringParams as StoreQuestionAnsweringParams, type StoreSearchParams as StoreSearchParams, };
|
|
1184
|
-
export { Files as Files, type
|
|
937
|
+
export { type AgenticSearchConfig as AgenticSearchConfig, type AudioChunkGeneratedMetadata as AudioChunkGeneratedMetadata, type AudioURL as AudioURL, type CodeChunkGeneratedMetadata as CodeChunkGeneratedMetadata, type ContextualizationConfig as ContextualizationConfig, type ExpiresAfter as ExpiresAfter, type FileCounts as FileCounts, type ImageChunkGeneratedMetadata as ImageChunkGeneratedMetadata, type ImageURLOutput as ImageURLOutput, type MarkdownChunkGeneratedMetadata as MarkdownChunkGeneratedMetadata, type MarkdownHeading as MarkdownHeading, type PdfChunkGeneratedMetadata as PdfChunkGeneratedMetadata, type RerankConfig as RerankConfig, type ScoredAudioURLInputChunk as ScoredAudioURLInputChunk, type ScoredImageURLInputChunk as ScoredImageURLInputChunk, type ScoredTextInputChunk as ScoredTextInputChunk, type ScoredVideoURLInputChunk as ScoredVideoURLInputChunk, type Store as Store, type StoreChunkSearchOptions as StoreChunkSearchOptions, type StoreConfig as StoreConfig, type TextChunkGeneratedMetadata as TextChunkGeneratedMetadata, type VideoChunkGeneratedMetadata as VideoChunkGeneratedMetadata, type VideoURL as VideoURL, type StoreDeleteResponse as StoreDeleteResponse, type StoreMetadataFacetsResponse as StoreMetadataFacetsResponse, type StoreQuestionAnsweringResponse as StoreQuestionAnsweringResponse, type StoreSearchResponse as StoreSearchResponse, type StoresCursor as StoresCursor, type StoreCreateParams as StoreCreateParams, type StoreUpdateParams as StoreUpdateParams, type StoreListParams as StoreListParams, type StoreMetadataFacetsParams as StoreMetadataFacetsParams, type StoreQuestionAnsweringParams as StoreQuestionAnsweringParams, type StoreSearchParams as StoreSearchParams, };
|
|
938
|
+
export { Files as Files, type AudioURLInputChunk as AudioURLInputChunk, type ImageURLInputChunk as ImageURLInputChunk, type StoreFile as StoreFile, type StoreFileConfig as StoreFileConfig, type StoreFileStatus as StoreFileStatus, type TextInputChunk as TextInputChunk, type VideoURLInputChunk as VideoURLInputChunk, type FileListResponse as FileListResponse, type FileDeleteResponse as FileDeleteResponse, type FileCreateParams as FileCreateParams, type FileRetrieveParams as FileRetrieveParams, type FileUpdateParams as FileUpdateParams, type FileListParams as FileListParams, type FileDeleteParams as FileDeleteParams, };
|
|
1185
939
|
}
|
|
1186
940
|
//# sourceMappingURL=stores.d.mts.map
|