@mixedbread/sdk 0.61.0 → 0.63.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +48 -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 +33 -0
- package/client.js.map +1 -1
- package/client.mjs +33 -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 +155 -740
- package/resources/stores/files.d.mts.map +1 -1
- package/resources/stores/files.d.ts +155 -740
- 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 +294 -532
- package/resources/stores/stores.d.mts.map +1 -1
- package/resources/stores/stores.d.ts +294 -532
- 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 +72 -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 +332 -1243
- package/src/resources/stores/index.ts +22 -4
- package/src/resources/stores/stores.ts +433 -851
- 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.js";
|
|
|
2
2
|
import * as Shared from "../shared.js";
|
|
3
3
|
import * as ContentAPI from "../extractions/content.js";
|
|
4
4
|
import * as FilesAPI from "./files.js";
|
|
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.js";
|
|
6
6
|
import { APIPromise } from "../../core/api-promise.js";
|
|
7
7
|
import { Cursor, type CursorParams, PagePromise } from "../../core/pagination.js";
|
|
8
8
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
@@ -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
|
*/
|
|
@@ -150,114 +367,12 @@ export interface ScoredAudioURLInputChunk {
|
|
|
150
367
|
/**
|
|
151
368
|
* Model for audio URL validation.
|
|
152
369
|
*/
|
|
153
|
-
audio_url?:
|
|
370
|
+
audio_url?: AudioURL | null;
|
|
154
371
|
/**
|
|
155
372
|
* The sampling rate of the audio.
|
|
156
373
|
*/
|
|
157
374
|
sampling_rate: number;
|
|
158
375
|
}
|
|
159
|
-
export declare namespace ScoredAudioURLInputChunk {
|
|
160
|
-
interface MarkdownChunkGeneratedMetadata {
|
|
161
|
-
type?: 'markdown';
|
|
162
|
-
file_type?: 'text/markdown';
|
|
163
|
-
language?: string | null;
|
|
164
|
-
word_count?: number | null;
|
|
165
|
-
file_size?: number | null;
|
|
166
|
-
chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
|
|
167
|
-
heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
|
|
168
|
-
start_line?: number;
|
|
169
|
-
num_lines?: number;
|
|
170
|
-
file_extension?: string | null;
|
|
171
|
-
frontmatter?: {
|
|
172
|
-
[key: string]: unknown;
|
|
173
|
-
};
|
|
174
|
-
[k: string]: unknown;
|
|
175
|
-
}
|
|
176
|
-
namespace MarkdownChunkGeneratedMetadata {
|
|
177
|
-
interface ChunkHeading {
|
|
178
|
-
level: number;
|
|
179
|
-
text: string;
|
|
180
|
-
}
|
|
181
|
-
interface HeadingContext {
|
|
182
|
-
level: number;
|
|
183
|
-
text: string;
|
|
184
|
-
}
|
|
185
|
-
}
|
|
186
|
-
interface TextChunkGeneratedMetadata {
|
|
187
|
-
type?: 'text';
|
|
188
|
-
file_type?: 'text/plain';
|
|
189
|
-
language?: string | null;
|
|
190
|
-
word_count?: number | null;
|
|
191
|
-
file_size?: number | null;
|
|
192
|
-
start_line?: number;
|
|
193
|
-
num_lines?: number;
|
|
194
|
-
file_extension?: string | null;
|
|
195
|
-
[k: string]: unknown;
|
|
196
|
-
}
|
|
197
|
-
interface PdfChunkGeneratedMetadata {
|
|
198
|
-
type?: 'pdf';
|
|
199
|
-
file_type?: 'application/pdf';
|
|
200
|
-
total_pages?: number | null;
|
|
201
|
-
total_size?: number | null;
|
|
202
|
-
file_extension?: string | null;
|
|
203
|
-
[k: string]: unknown;
|
|
204
|
-
}
|
|
205
|
-
interface CodeChunkGeneratedMetadata {
|
|
206
|
-
type?: 'code';
|
|
207
|
-
file_type: string;
|
|
208
|
-
language?: string | null;
|
|
209
|
-
word_count?: number | null;
|
|
210
|
-
file_size?: number | null;
|
|
211
|
-
start_line?: number;
|
|
212
|
-
num_lines?: number;
|
|
213
|
-
file_extension?: string | null;
|
|
214
|
-
[k: string]: unknown;
|
|
215
|
-
}
|
|
216
|
-
interface AudioChunkGeneratedMetadata {
|
|
217
|
-
type?: 'audio';
|
|
218
|
-
file_type?: string;
|
|
219
|
-
file_size?: number | null;
|
|
220
|
-
total_duration_seconds?: number | null;
|
|
221
|
-
sample_rate?: number | null;
|
|
222
|
-
channels?: number | null;
|
|
223
|
-
audio_format?: number | null;
|
|
224
|
-
bpm?: number | null;
|
|
225
|
-
file_extension?: string | null;
|
|
226
|
-
[k: string]: unknown;
|
|
227
|
-
}
|
|
228
|
-
interface VideoChunkGeneratedMetadata {
|
|
229
|
-
type?: 'video';
|
|
230
|
-
file_type?: string;
|
|
231
|
-
file_size?: number | null;
|
|
232
|
-
total_duration_seconds?: number | null;
|
|
233
|
-
fps?: number | null;
|
|
234
|
-
width?: number | null;
|
|
235
|
-
height?: number | null;
|
|
236
|
-
frame_count?: number | null;
|
|
237
|
-
has_audio_stream?: boolean;
|
|
238
|
-
bpm?: number | null;
|
|
239
|
-
file_extension?: string | null;
|
|
240
|
-
[k: string]: unknown;
|
|
241
|
-
}
|
|
242
|
-
interface ImageChunkGeneratedMetadata {
|
|
243
|
-
type?: 'image';
|
|
244
|
-
file_type?: string;
|
|
245
|
-
file_size?: number | null;
|
|
246
|
-
width?: number | null;
|
|
247
|
-
height?: number | null;
|
|
248
|
-
file_extension?: string | null;
|
|
249
|
-
[k: string]: unknown;
|
|
250
|
-
}
|
|
251
|
-
/**
|
|
252
|
-
* Model for audio URL validation.
|
|
253
|
-
*/
|
|
254
|
-
interface AudioURL {
|
|
255
|
-
/**
|
|
256
|
-
* The audio URL. Can be either a URL or a Data URI.
|
|
257
|
-
*/
|
|
258
|
-
url: string;
|
|
259
|
-
}
|
|
260
|
-
}
|
|
261
376
|
export interface ScoredImageURLInputChunk {
|
|
262
377
|
/**
|
|
263
378
|
* position of the chunk in a file
|
|
@@ -270,7 +385,7 @@ export interface ScoredImageURLInputChunk {
|
|
|
270
385
|
/**
|
|
271
386
|
* metadata of the chunk
|
|
272
387
|
*/
|
|
273
|
-
generated_metadata?:
|
|
388
|
+
generated_metadata?: MarkdownChunkGeneratedMetadata | TextChunkGeneratedMetadata | PdfChunkGeneratedMetadata | CodeChunkGeneratedMetadata | AudioChunkGeneratedMetadata | VideoChunkGeneratedMetadata | ImageChunkGeneratedMetadata | null;
|
|
274
389
|
/**
|
|
275
390
|
* model used for this chunk
|
|
276
391
|
*/
|
|
@@ -314,113 +429,7 @@ export interface ScoredImageURLInputChunk {
|
|
|
314
429
|
/**
|
|
315
430
|
* Model for image URL validation.
|
|
316
431
|
*/
|
|
317
|
-
image_url?:
|
|
318
|
-
}
|
|
319
|
-
export declare namespace ScoredImageURLInputChunk {
|
|
320
|
-
interface MarkdownChunkGeneratedMetadata {
|
|
321
|
-
type?: 'markdown';
|
|
322
|
-
file_type?: 'text/markdown';
|
|
323
|
-
language?: string | null;
|
|
324
|
-
word_count?: number | null;
|
|
325
|
-
file_size?: number | null;
|
|
326
|
-
chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
|
|
327
|
-
heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
|
|
328
|
-
start_line?: number;
|
|
329
|
-
num_lines?: number;
|
|
330
|
-
file_extension?: string | null;
|
|
331
|
-
frontmatter?: {
|
|
332
|
-
[key: string]: unknown;
|
|
333
|
-
};
|
|
334
|
-
[k: string]: unknown;
|
|
335
|
-
}
|
|
336
|
-
namespace MarkdownChunkGeneratedMetadata {
|
|
337
|
-
interface ChunkHeading {
|
|
338
|
-
level: number;
|
|
339
|
-
text: string;
|
|
340
|
-
}
|
|
341
|
-
interface HeadingContext {
|
|
342
|
-
level: number;
|
|
343
|
-
text: string;
|
|
344
|
-
}
|
|
345
|
-
}
|
|
346
|
-
interface TextChunkGeneratedMetadata {
|
|
347
|
-
type?: 'text';
|
|
348
|
-
file_type?: 'text/plain';
|
|
349
|
-
language?: string | null;
|
|
350
|
-
word_count?: number | null;
|
|
351
|
-
file_size?: number | null;
|
|
352
|
-
start_line?: number;
|
|
353
|
-
num_lines?: number;
|
|
354
|
-
file_extension?: string | null;
|
|
355
|
-
[k: string]: unknown;
|
|
356
|
-
}
|
|
357
|
-
interface PdfChunkGeneratedMetadata {
|
|
358
|
-
type?: 'pdf';
|
|
359
|
-
file_type?: 'application/pdf';
|
|
360
|
-
total_pages?: number | null;
|
|
361
|
-
total_size?: number | null;
|
|
362
|
-
file_extension?: string | null;
|
|
363
|
-
[k: string]: unknown;
|
|
364
|
-
}
|
|
365
|
-
interface CodeChunkGeneratedMetadata {
|
|
366
|
-
type?: 'code';
|
|
367
|
-
file_type: string;
|
|
368
|
-
language?: string | null;
|
|
369
|
-
word_count?: number | null;
|
|
370
|
-
file_size?: number | null;
|
|
371
|
-
start_line?: number;
|
|
372
|
-
num_lines?: number;
|
|
373
|
-
file_extension?: string | null;
|
|
374
|
-
[k: string]: unknown;
|
|
375
|
-
}
|
|
376
|
-
interface AudioChunkGeneratedMetadata {
|
|
377
|
-
type?: 'audio';
|
|
378
|
-
file_type?: string;
|
|
379
|
-
file_size?: number | null;
|
|
380
|
-
total_duration_seconds?: number | null;
|
|
381
|
-
sample_rate?: number | null;
|
|
382
|
-
channels?: number | null;
|
|
383
|
-
audio_format?: number | null;
|
|
384
|
-
bpm?: number | null;
|
|
385
|
-
file_extension?: string | null;
|
|
386
|
-
[k: string]: unknown;
|
|
387
|
-
}
|
|
388
|
-
interface VideoChunkGeneratedMetadata {
|
|
389
|
-
type?: 'video';
|
|
390
|
-
file_type?: string;
|
|
391
|
-
file_size?: number | null;
|
|
392
|
-
total_duration_seconds?: number | null;
|
|
393
|
-
fps?: number | null;
|
|
394
|
-
width?: number | null;
|
|
395
|
-
height?: number | null;
|
|
396
|
-
frame_count?: number | null;
|
|
397
|
-
has_audio_stream?: boolean;
|
|
398
|
-
bpm?: number | null;
|
|
399
|
-
file_extension?: string | null;
|
|
400
|
-
[k: string]: unknown;
|
|
401
|
-
}
|
|
402
|
-
interface ImageChunkGeneratedMetadata {
|
|
403
|
-
type?: 'image';
|
|
404
|
-
file_type?: string;
|
|
405
|
-
file_size?: number | null;
|
|
406
|
-
width?: number | null;
|
|
407
|
-
height?: number | null;
|
|
408
|
-
file_extension?: string | null;
|
|
409
|
-
[k: string]: unknown;
|
|
410
|
-
}
|
|
411
|
-
/**
|
|
412
|
-
* Model for image URL validation.
|
|
413
|
-
*/
|
|
414
|
-
interface ImageURL {
|
|
415
|
-
/**
|
|
416
|
-
* The image URL. Can be either a URL or a Data URI.
|
|
417
|
-
*/
|
|
418
|
-
url: string;
|
|
419
|
-
/**
|
|
420
|
-
* The image format/mimetype
|
|
421
|
-
*/
|
|
422
|
-
format?: string;
|
|
423
|
-
}
|
|
432
|
+
image_url?: ImageURLOutput | null;
|
|
424
433
|
}
|
|
425
434
|
export interface ScoredTextInputChunk {
|
|
426
435
|
/**
|
|
@@ -434,7 +443,7 @@ export interface ScoredTextInputChunk {
|
|
|
434
443
|
/**
|
|
435
444
|
* metadata of the chunk
|
|
436
445
|
*/
|
|
437
|
-
generated_metadata?:
|
|
446
|
+
generated_metadata?: MarkdownChunkGeneratedMetadata | TextChunkGeneratedMetadata | PdfChunkGeneratedMetadata | CodeChunkGeneratedMetadata | AudioChunkGeneratedMetadata | VideoChunkGeneratedMetadata | ImageChunkGeneratedMetadata | null;
|
|
438
447
|
/**
|
|
439
448
|
* model used for this chunk
|
|
440
449
|
*/
|
|
@@ -475,99 +484,10 @@ export interface ScoredTextInputChunk {
|
|
|
475
484
|
* Text content
|
|
476
485
|
*/
|
|
477
486
|
text?: string | null;
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
file_type?: 'text/markdown';
|
|
483
|
-
language?: string | null;
|
|
484
|
-
word_count?: number | null;
|
|
485
|
-
file_size?: number | null;
|
|
486
|
-
chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
|
|
487
|
-
heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
|
|
488
|
-
start_line?: number;
|
|
489
|
-
num_lines?: number;
|
|
490
|
-
file_extension?: string | null;
|
|
491
|
-
frontmatter?: {
|
|
492
|
-
[key: string]: unknown;
|
|
493
|
-
};
|
|
494
|
-
[k: string]: unknown;
|
|
495
|
-
}
|
|
496
|
-
namespace MarkdownChunkGeneratedMetadata {
|
|
497
|
-
interface ChunkHeading {
|
|
498
|
-
level: number;
|
|
499
|
-
text: string;
|
|
500
|
-
}
|
|
501
|
-
interface HeadingContext {
|
|
502
|
-
level: number;
|
|
503
|
-
text: string;
|
|
504
|
-
}
|
|
505
|
-
}
|
|
506
|
-
interface TextChunkGeneratedMetadata {
|
|
507
|
-
type?: 'text';
|
|
508
|
-
file_type?: 'text/plain';
|
|
509
|
-
language?: string | null;
|
|
510
|
-
word_count?: number | null;
|
|
511
|
-
file_size?: number | null;
|
|
512
|
-
start_line?: number;
|
|
513
|
-
num_lines?: number;
|
|
514
|
-
file_extension?: string | null;
|
|
515
|
-
[k: string]: unknown;
|
|
516
|
-
}
|
|
517
|
-
interface PdfChunkGeneratedMetadata {
|
|
518
|
-
type?: 'pdf';
|
|
519
|
-
file_type?: 'application/pdf';
|
|
520
|
-
total_pages?: number | null;
|
|
521
|
-
total_size?: number | null;
|
|
522
|
-
file_extension?: string | null;
|
|
523
|
-
[k: string]: unknown;
|
|
524
|
-
}
|
|
525
|
-
interface CodeChunkGeneratedMetadata {
|
|
526
|
-
type?: 'code';
|
|
527
|
-
file_type: string;
|
|
528
|
-
language?: string | null;
|
|
529
|
-
word_count?: number | null;
|
|
530
|
-
file_size?: number | null;
|
|
531
|
-
start_line?: number;
|
|
532
|
-
num_lines?: number;
|
|
533
|
-
file_extension?: string | null;
|
|
534
|
-
[k: string]: unknown;
|
|
535
|
-
}
|
|
536
|
-
interface AudioChunkGeneratedMetadata {
|
|
537
|
-
type?: 'audio';
|
|
538
|
-
file_type?: string;
|
|
539
|
-
file_size?: number | null;
|
|
540
|
-
total_duration_seconds?: number | null;
|
|
541
|
-
sample_rate?: number | null;
|
|
542
|
-
channels?: number | null;
|
|
543
|
-
audio_format?: number | null;
|
|
544
|
-
bpm?: number | null;
|
|
545
|
-
file_extension?: string | null;
|
|
546
|
-
[k: string]: unknown;
|
|
547
|
-
}
|
|
548
|
-
interface VideoChunkGeneratedMetadata {
|
|
549
|
-
type?: 'video';
|
|
550
|
-
file_type?: string;
|
|
551
|
-
file_size?: number | null;
|
|
552
|
-
total_duration_seconds?: number | null;
|
|
553
|
-
fps?: number | null;
|
|
554
|
-
width?: number | null;
|
|
555
|
-
height?: number | null;
|
|
556
|
-
frame_count?: number | null;
|
|
557
|
-
has_audio_stream?: boolean;
|
|
558
|
-
bpm?: number | null;
|
|
559
|
-
file_extension?: string | null;
|
|
560
|
-
[k: string]: unknown;
|
|
561
|
-
}
|
|
562
|
-
interface ImageChunkGeneratedMetadata {
|
|
563
|
-
type?: 'image';
|
|
564
|
-
file_type?: string;
|
|
565
|
-
file_size?: number | null;
|
|
566
|
-
width?: number | null;
|
|
567
|
-
height?: number | null;
|
|
568
|
-
file_extension?: string | null;
|
|
569
|
-
[k: string]: unknown;
|
|
570
|
-
}
|
|
487
|
+
/**
|
|
488
|
+
* LLM-generated context that situates this chunk within its source document
|
|
489
|
+
*/
|
|
490
|
+
context?: string | null;
|
|
571
491
|
}
|
|
572
492
|
export interface ScoredVideoURLInputChunk {
|
|
573
493
|
/**
|
|
@@ -581,7 +501,7 @@ export interface ScoredVideoURLInputChunk {
|
|
|
581
501
|
/**
|
|
582
502
|
* metadata of the chunk
|
|
583
503
|
*/
|
|
584
|
-
generated_metadata?:
|
|
504
|
+
generated_metadata?: MarkdownChunkGeneratedMetadata | TextChunkGeneratedMetadata | PdfChunkGeneratedMetadata | CodeChunkGeneratedMetadata | AudioChunkGeneratedMetadata | VideoChunkGeneratedMetadata | ImageChunkGeneratedMetadata | null;
|
|
585
505
|
/**
|
|
586
506
|
* model used for this chunk
|
|
587
507
|
*/
|
|
@@ -619,111 +539,13 @@ export interface ScoredVideoURLInputChunk {
|
|
|
619
539
|
*/
|
|
620
540
|
transcription?: string | null;
|
|
621
541
|
/**
|
|
622
|
-
*
|
|
542
|
+
* summary of the video
|
|
623
543
|
*/
|
|
624
|
-
|
|
625
|
-
}
|
|
626
|
-
export declare namespace ScoredVideoURLInputChunk {
|
|
627
|
-
interface MarkdownChunkGeneratedMetadata {
|
|
628
|
-
type?: 'markdown';
|
|
629
|
-
file_type?: 'text/markdown';
|
|
630
|
-
language?: string | null;
|
|
631
|
-
word_count?: number | null;
|
|
632
|
-
file_size?: number | null;
|
|
633
|
-
chunk_headings?: Array<MarkdownChunkGeneratedMetadata.ChunkHeading>;
|
|
634
|
-
heading_context?: Array<MarkdownChunkGeneratedMetadata.HeadingContext>;
|
|
635
|
-
start_line?: number;
|
|
636
|
-
num_lines?: number;
|
|
637
|
-
file_extension?: string | null;
|
|
638
|
-
frontmatter?: {
|
|
639
|
-
[key: string]: unknown;
|
|
640
|
-
};
|
|
641
|
-
[k: string]: unknown;
|
|
642
|
-
}
|
|
643
|
-
namespace MarkdownChunkGeneratedMetadata {
|
|
644
|
-
interface ChunkHeading {
|
|
645
|
-
level: number;
|
|
646
|
-
text: string;
|
|
647
|
-
}
|
|
648
|
-
interface HeadingContext {
|
|
649
|
-
level: number;
|
|
650
|
-
text: string;
|
|
651
|
-
}
|
|
652
|
-
}
|
|
653
|
-
interface TextChunkGeneratedMetadata {
|
|
654
|
-
type?: 'text';
|
|
655
|
-
file_type?: 'text/plain';
|
|
656
|
-
language?: string | null;
|
|
657
|
-
word_count?: number | null;
|
|
658
|
-
file_size?: number | null;
|
|
659
|
-
start_line?: number;
|
|
660
|
-
num_lines?: number;
|
|
661
|
-
file_extension?: string | null;
|
|
662
|
-
[k: string]: unknown;
|
|
663
|
-
}
|
|
664
|
-
interface PdfChunkGeneratedMetadata {
|
|
665
|
-
type?: 'pdf';
|
|
666
|
-
file_type?: 'application/pdf';
|
|
667
|
-
total_pages?: number | null;
|
|
668
|
-
total_size?: number | null;
|
|
669
|
-
file_extension?: string | null;
|
|
670
|
-
[k: string]: unknown;
|
|
671
|
-
}
|
|
672
|
-
interface CodeChunkGeneratedMetadata {
|
|
673
|
-
type?: 'code';
|
|
674
|
-
file_type: string;
|
|
675
|
-
language?: string | null;
|
|
676
|
-
word_count?: number | null;
|
|
677
|
-
file_size?: number | null;
|
|
678
|
-
start_line?: number;
|
|
679
|
-
num_lines?: number;
|
|
680
|
-
file_extension?: string | null;
|
|
681
|
-
[k: string]: unknown;
|
|
682
|
-
}
|
|
683
|
-
interface AudioChunkGeneratedMetadata {
|
|
684
|
-
type?: 'audio';
|
|
685
|
-
file_type?: string;
|
|
686
|
-
file_size?: number | null;
|
|
687
|
-
total_duration_seconds?: number | null;
|
|
688
|
-
sample_rate?: number | null;
|
|
689
|
-
channels?: number | null;
|
|
690
|
-
audio_format?: number | null;
|
|
691
|
-
bpm?: number | null;
|
|
692
|
-
file_extension?: string | null;
|
|
693
|
-
[k: string]: unknown;
|
|
694
|
-
}
|
|
695
|
-
interface VideoChunkGeneratedMetadata {
|
|
696
|
-
type?: 'video';
|
|
697
|
-
file_type?: string;
|
|
698
|
-
file_size?: number | null;
|
|
699
|
-
total_duration_seconds?: number | null;
|
|
700
|
-
fps?: number | null;
|
|
701
|
-
width?: number | null;
|
|
702
|
-
height?: number | null;
|
|
703
|
-
frame_count?: number | null;
|
|
704
|
-
has_audio_stream?: boolean;
|
|
705
|
-
bpm?: number | null;
|
|
706
|
-
file_extension?: string | null;
|
|
707
|
-
[k: string]: unknown;
|
|
708
|
-
}
|
|
709
|
-
interface ImageChunkGeneratedMetadata {
|
|
710
|
-
type?: 'image';
|
|
711
|
-
file_type?: string;
|
|
712
|
-
file_size?: number | null;
|
|
713
|
-
width?: number | null;
|
|
714
|
-
height?: number | null;
|
|
715
|
-
file_extension?: string | null;
|
|
716
|
-
[k: string]: unknown;
|
|
717
|
-
}
|
|
544
|
+
summary?: string | null;
|
|
718
545
|
/**
|
|
719
546
|
* Model for video URL validation.
|
|
720
547
|
*/
|
|
721
|
-
|
|
722
|
-
/**
|
|
723
|
-
* The video URL. Can be either a URL or a Data URI.
|
|
724
|
-
*/
|
|
725
|
-
url: string;
|
|
726
|
-
}
|
|
548
|
+
video_url?: VideoURL | null;
|
|
727
549
|
}
|
|
728
550
|
/**
|
|
729
551
|
* Model representing a store with its metadata and timestamps.
|
|
@@ -745,6 +567,10 @@ export interface Store {
|
|
|
745
567
|
* Whether the store can be accessed by anyone with valid login credentials
|
|
746
568
|
*/
|
|
747
569
|
is_public?: boolean;
|
|
570
|
+
/**
|
|
571
|
+
* License for public stores
|
|
572
|
+
*/
|
|
573
|
+
license?: string | null;
|
|
748
574
|
/**
|
|
749
575
|
* Additional metadata associated with the store
|
|
750
576
|
*/
|
|
@@ -752,11 +578,11 @@ export interface Store {
|
|
|
752
578
|
/**
|
|
753
579
|
* Configuration for a store.
|
|
754
580
|
*/
|
|
755
|
-
config?:
|
|
581
|
+
config?: StoreConfig | null;
|
|
756
582
|
/**
|
|
757
583
|
* Counts of files in different states
|
|
758
584
|
*/
|
|
759
|
-
file_counts?:
|
|
585
|
+
file_counts?: FileCounts;
|
|
760
586
|
/**
|
|
761
587
|
* Represents an expiration policy for a store.
|
|
762
588
|
*/
|
|
@@ -794,62 +620,6 @@ export interface Store {
|
|
|
794
620
|
*/
|
|
795
621
|
object?: 'store';
|
|
796
622
|
}
|
|
797
|
-
export declare namespace Store {
|
|
798
|
-
/**
|
|
799
|
-
* Configuration for a store.
|
|
800
|
-
*/
|
|
801
|
-
interface Config {
|
|
802
|
-
/**
|
|
803
|
-
* Contextualize files with metadata
|
|
804
|
-
*/
|
|
805
|
-
contextualization?: boolean | Config.ContextualizationConfig;
|
|
806
|
-
/**
|
|
807
|
-
* Whether to save original content in the store. When False, only vectors are
|
|
808
|
-
* indexed without the original content (index-only mode). This is useful for data
|
|
809
|
-
* privacy. Note: Reranking is not supported when content is not saved.
|
|
810
|
-
*/
|
|
811
|
-
save_content?: boolean;
|
|
812
|
-
}
|
|
813
|
-
namespace Config {
|
|
814
|
-
interface ContextualizationConfig {
|
|
815
|
-
/**
|
|
816
|
-
* Include all metadata or specific fields in the contextualization. Supports dot
|
|
817
|
-
* notation for nested fields (e.g., 'author.name'). When True, all metadata is
|
|
818
|
-
* included (flattened). When a list, only specified fields are included.
|
|
819
|
-
*/
|
|
820
|
-
with_metadata?: boolean | Array<string>;
|
|
821
|
-
}
|
|
822
|
-
}
|
|
823
|
-
/**
|
|
824
|
-
* Counts of files in different states
|
|
825
|
-
*/
|
|
826
|
-
interface FileCounts {
|
|
827
|
-
/**
|
|
828
|
-
* Number of files waiting to be processed
|
|
829
|
-
*/
|
|
830
|
-
pending?: number;
|
|
831
|
-
/**
|
|
832
|
-
* Number of files currently being processed
|
|
833
|
-
*/
|
|
834
|
-
in_progress?: number;
|
|
835
|
-
/**
|
|
836
|
-
* Number of files whose processing was cancelled
|
|
837
|
-
*/
|
|
838
|
-
cancelled?: number;
|
|
839
|
-
/**
|
|
840
|
-
* Number of successfully processed files
|
|
841
|
-
*/
|
|
842
|
-
completed?: number;
|
|
843
|
-
/**
|
|
844
|
-
* Number of files that failed processing
|
|
845
|
-
*/
|
|
846
|
-
failed?: number;
|
|
847
|
-
/**
|
|
848
|
-
* Total number of files
|
|
849
|
-
*/
|
|
850
|
-
total?: number;
|
|
851
|
-
}
|
|
852
|
-
}
|
|
853
623
|
/**
|
|
854
624
|
* Options for configuring store chunk searches.
|
|
855
625
|
*/
|
|
@@ -867,12 +637,12 @@ export interface StoreChunkSearchOptions {
|
|
|
867
637
|
* Whether to rerank results and optional reranking configuration. Ignored when
|
|
868
638
|
* agentic is enabled (the agent handles ranking).
|
|
869
639
|
*/
|
|
870
|
-
rerank?: boolean |
|
|
640
|
+
rerank?: boolean | RerankConfig | null;
|
|
871
641
|
/**
|
|
872
642
|
* Whether to use agentic multi-query search with automatic query decomposition and
|
|
873
643
|
* ranking. When enabled, rewrite_query and rerank options are ignored.
|
|
874
644
|
*/
|
|
875
|
-
agentic?: boolean |
|
|
645
|
+
agentic?: boolean | AgenticSearchConfig | null;
|
|
876
646
|
/**
|
|
877
647
|
* Whether to return file metadata
|
|
878
648
|
*/
|
|
@@ -882,43 +652,54 @@ export interface StoreChunkSearchOptions {
|
|
|
882
652
|
*/
|
|
883
653
|
apply_search_rules?: boolean;
|
|
884
654
|
}
|
|
885
|
-
|
|
655
|
+
/**
|
|
656
|
+
* Configuration for a store.
|
|
657
|
+
*/
|
|
658
|
+
export interface StoreConfig {
|
|
886
659
|
/**
|
|
887
|
-
*
|
|
660
|
+
* Contextualize files with metadata
|
|
888
661
|
*/
|
|
889
|
-
|
|
890
|
-
/**
|
|
891
|
-
* The name of the reranking model
|
|
892
|
-
*/
|
|
893
|
-
model?: string;
|
|
894
|
-
/**
|
|
895
|
-
* Whether to include metadata in the reranked results
|
|
896
|
-
*/
|
|
897
|
-
with_metadata?: boolean | Array<string>;
|
|
898
|
-
/**
|
|
899
|
-
* Maximum number of results to return after reranking. If None, returns all
|
|
900
|
-
* reranked results.
|
|
901
|
-
*/
|
|
902
|
-
top_k?: number | null;
|
|
903
|
-
}
|
|
662
|
+
contextualization?: boolean | ContextualizationConfig;
|
|
904
663
|
/**
|
|
905
|
-
*
|
|
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.
|
|
906
667
|
*/
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
|
|
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;
|
|
922
703
|
}
|
|
923
704
|
/**
|
|
924
705
|
* Response model for store deletion.
|
|
@@ -987,6 +768,10 @@ export interface StoreCreateParams {
|
|
|
987
768
|
* Whether the store can be accessed by anyone with valid login credentials
|
|
988
769
|
*/
|
|
989
770
|
is_public?: boolean;
|
|
771
|
+
/**
|
|
772
|
+
* License for public stores
|
|
773
|
+
*/
|
|
774
|
+
license?: string | null;
|
|
990
775
|
/**
|
|
991
776
|
* Represents an expiration policy for a store.
|
|
992
777
|
*/
|
|
@@ -998,39 +783,12 @@ export interface StoreCreateParams {
|
|
|
998
783
|
/**
|
|
999
784
|
* Configuration for a store.
|
|
1000
785
|
*/
|
|
1001
|
-
config?:
|
|
786
|
+
config?: StoreConfig | null;
|
|
1002
787
|
/**
|
|
1003
788
|
* Optional list of file IDs
|
|
1004
789
|
*/
|
|
1005
790
|
file_ids?: Array<string> | null;
|
|
1006
791
|
}
|
|
1007
|
-
export declare namespace StoreCreateParams {
|
|
1008
|
-
/**
|
|
1009
|
-
* Configuration for a store.
|
|
1010
|
-
*/
|
|
1011
|
-
interface Config {
|
|
1012
|
-
/**
|
|
1013
|
-
* Contextualize files with metadata
|
|
1014
|
-
*/
|
|
1015
|
-
contextualization?: boolean | Config.ContextualizationConfig;
|
|
1016
|
-
/**
|
|
1017
|
-
* Whether to save original content in the store. When False, only vectors are
|
|
1018
|
-
* indexed without the original content (index-only mode). This is useful for data
|
|
1019
|
-
* privacy. Note: Reranking is not supported when content is not saved.
|
|
1020
|
-
*/
|
|
1021
|
-
save_content?: boolean;
|
|
1022
|
-
}
|
|
1023
|
-
namespace Config {
|
|
1024
|
-
interface ContextualizationConfig {
|
|
1025
|
-
/**
|
|
1026
|
-
* Include all metadata or specific fields in the contextualization. Supports dot
|
|
1027
|
-
* notation for nested fields (e.g., 'author.name'). When True, all metadata is
|
|
1028
|
-
* included (flattened). When a list, only specified fields are included.
|
|
1029
|
-
*/
|
|
1030
|
-
with_metadata?: boolean | Array<string>;
|
|
1031
|
-
}
|
|
1032
|
-
}
|
|
1033
|
-
}
|
|
1034
792
|
export interface StoreUpdateParams {
|
|
1035
793
|
/**
|
|
1036
794
|
* New name for the store. Can only contain lowercase letters, numbers, periods
|
|
@@ -1045,6 +803,10 @@ export interface StoreUpdateParams {
|
|
|
1045
803
|
* Whether the store can be accessed by anyone with valid login credentials
|
|
1046
804
|
*/
|
|
1047
805
|
is_public?: boolean | null;
|
|
806
|
+
/**
|
|
807
|
+
* License for public stores
|
|
808
|
+
*/
|
|
809
|
+
license?: string | null;
|
|
1048
810
|
/**
|
|
1049
811
|
* Represents an expiration policy for a store.
|
|
1050
812
|
*/
|
|
@@ -1172,7 +934,7 @@ export interface StoreSearchParams {
|
|
|
1172
934
|
search_options?: StoreChunkSearchOptions;
|
|
1173
935
|
}
|
|
1174
936
|
export declare namespace Stores {
|
|
1175
|
-
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, };
|
|
1176
|
-
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, };
|
|
1177
939
|
}
|
|
1178
940
|
//# sourceMappingURL=stores.d.ts.map
|