@studyfetch/sdk 1.41.0 → 1.43.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 +34 -0
- package/README.md +6 -6
- package/internal/to-file.d.mts +1 -1
- package/internal/to-file.d.ts +1 -1
- package/internal/to-file.js +1 -1
- package/internal/to-file.mjs +1 -1
- package/package.json +1 -1
- package/resources/v1/components.d.mts +28 -0
- package/resources/v1/components.d.mts.map +1 -1
- package/resources/v1/components.d.ts +28 -0
- package/resources/v1/components.d.ts.map +1 -1
- package/resources/v1/folders.d.mts +2 -77
- package/resources/v1/folders.d.mts.map +1 -1
- package/resources/v1/folders.d.ts +2 -77
- package/resources/v1/folders.d.ts.map +1 -1
- package/resources/v1/folders.js.map +1 -1
- package/resources/v1/folders.mjs.map +1 -1
- package/resources/v1/index.d.mts +2 -1
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +2 -1
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +3 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +1 -0
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/materials/index.d.mts +2 -2
- package/resources/v1/materials/index.d.mts.map +1 -1
- package/resources/v1/materials/index.d.ts +2 -2
- package/resources/v1/materials/index.d.ts.map +1 -1
- package/resources/v1/materials/index.js.map +1 -1
- package/resources/v1/materials/index.mjs.map +1 -1
- package/resources/v1/materials/materials.d.mts +241 -805
- package/resources/v1/materials/materials.d.mts.map +1 -1
- package/resources/v1/materials/materials.d.ts +241 -805
- package/resources/v1/materials/materials.d.ts.map +1 -1
- package/resources/v1/materials/materials.js +54 -22
- package/resources/v1/materials/materials.js.map +1 -1
- package/resources/v1/materials/materials.mjs +54 -22
- package/resources/v1/materials/materials.mjs.map +1 -1
- package/resources/v1/materials/upload.d.mts +14 -407
- package/resources/v1/materials/upload.d.mts.map +1 -1
- package/resources/v1/materials/upload.d.ts +14 -407
- package/resources/v1/materials/upload.d.ts.map +1 -1
- package/resources/v1/materials/upload.js +5 -5
- package/resources/v1/materials/upload.js.map +1 -1
- package/resources/v1/materials/upload.mjs +5 -5
- package/resources/v1/materials/upload.mjs.map +1 -1
- package/resources/v1/pdf-generator/get.d.mts +61 -0
- package/resources/v1/pdf-generator/get.d.mts.map +1 -0
- package/resources/v1/pdf-generator/get.d.ts +61 -0
- package/resources/v1/pdf-generator/get.d.ts.map +1 -0
- package/resources/v1/pdf-generator/get.js +9 -0
- package/resources/v1/pdf-generator/get.js.map +1 -0
- package/resources/v1/pdf-generator/get.mjs +5 -0
- package/resources/v1/pdf-generator/get.mjs.map +1 -0
- package/resources/v1/pdf-generator/index.d.mts +3 -0
- package/resources/v1/pdf-generator/index.d.mts.map +1 -0
- package/resources/v1/pdf-generator/index.d.ts +3 -0
- package/resources/v1/pdf-generator/index.d.ts.map +1 -0
- package/resources/v1/pdf-generator/index.js +9 -0
- package/resources/v1/pdf-generator/index.js.map +1 -0
- package/resources/v1/pdf-generator/index.mjs +4 -0
- package/resources/v1/pdf-generator/index.mjs.map +1 -0
- package/resources/v1/pdf-generator/pdf-generator.d.mts +80 -0
- package/resources/v1/pdf-generator/pdf-generator.d.mts.map +1 -0
- package/resources/v1/pdf-generator/pdf-generator.d.ts +80 -0
- package/resources/v1/pdf-generator/pdf-generator.d.ts.map +1 -0
- package/resources/v1/pdf-generator/pdf-generator.js +70 -0
- package/resources/v1/pdf-generator/pdf-generator.js.map +1 -0
- package/resources/v1/pdf-generator/pdf-generator.mjs +65 -0
- package/resources/v1/pdf-generator/pdf-generator.mjs.map +1 -0
- package/resources/v1/pdf-generator.d.mts +2 -0
- package/resources/v1/pdf-generator.d.mts.map +1 -0
- package/resources/v1/pdf-generator.d.ts +2 -0
- package/resources/v1/pdf-generator.d.ts.map +1 -0
- package/resources/v1/pdf-generator.js +6 -0
- package/resources/v1/pdf-generator.js.map +1 -0
- package/resources/v1/pdf-generator.mjs +3 -0
- package/resources/v1/pdf-generator.mjs.map +1 -0
- package/resources/v1/v1.d.mts +6 -2
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +6 -2
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +4 -0
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +4 -0
- package/resources/v1/v1.mjs.map +1 -1
- package/src/internal/to-file.ts +1 -1
- package/src/resources/v1/components.ts +35 -0
- package/src/resources/v1/folders.ts +2 -98
- package/src/resources/v1/index.ts +14 -9
- package/src/resources/v1/materials/index.ts +7 -14
- package/src/resources/v1/materials/materials.ts +252 -988
- package/src/resources/v1/materials/upload.ts +16 -520
- package/src/resources/v1/pdf-generator/get.ts +75 -0
- package/src/resources/v1/pdf-generator/index.ts +10 -0
- package/src/resources/v1/pdf-generator/pdf-generator.ts +112 -0
- package/src/resources/v1/pdf-generator.ts +3 -0
- package/src/resources/v1/v1.ts +32 -18
- 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 BulkAPI from "./bulk.mjs";
|
|
3
3
|
import { Bulk, BulkMoveParams, BulkMoveResponse } from "./bulk.mjs";
|
|
4
4
|
import * as UploadAPI from "./upload.mjs";
|
|
5
|
-
import { Upload, UploadCompleteUploadParams,
|
|
5
|
+
import { Upload, UploadCompleteUploadParams, UploadGetPresignedURLParams, UploadGetPresignedURLResponse, UploadUploadFileAndProcessParams, UploadUploadFileParams, UploadUploadFromURLAndProcessParams, UploadUploadFromURLParams } from "./upload.mjs";
|
|
6
6
|
import { APIPromise } from "../../../core/api-promise.mjs";
|
|
7
7
|
import { RequestOptions } from "../../../internal/request-options.mjs";
|
|
8
8
|
export declare class Materials extends APIResource {
|
|
@@ -13,31 +13,35 @@ export declare class Materials extends APIResource {
|
|
|
13
13
|
*
|
|
14
14
|
* @example
|
|
15
15
|
* ```ts
|
|
16
|
-
* const
|
|
16
|
+
* const materialResponse = await client.v1.materials.create({
|
|
17
17
|
* content: { type: 'text' },
|
|
18
18
|
* name: 'Chapter 1 - Introduction',
|
|
19
19
|
* });
|
|
20
20
|
* ```
|
|
21
21
|
*/
|
|
22
|
-
create(body: MaterialCreateParams, options?: RequestOptions): APIPromise<
|
|
22
|
+
create(body: MaterialCreateParams, options?: RequestOptions): APIPromise<MaterialResponse>;
|
|
23
23
|
/**
|
|
24
24
|
* Get material by ID
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
27
|
* ```ts
|
|
28
|
-
* const
|
|
28
|
+
* const materialResponse = await client.v1.materials.retrieve(
|
|
29
|
+
* 'id',
|
|
30
|
+
* );
|
|
29
31
|
* ```
|
|
30
32
|
*/
|
|
31
|
-
retrieve(id: string, options?: RequestOptions): APIPromise<
|
|
33
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<MaterialResponse>;
|
|
32
34
|
/**
|
|
33
35
|
* Update a material
|
|
34
36
|
*
|
|
35
37
|
* @example
|
|
36
38
|
* ```ts
|
|
37
|
-
* const
|
|
39
|
+
* const materialResponse = await client.v1.materials.update(
|
|
40
|
+
* 'id',
|
|
41
|
+
* );
|
|
38
42
|
* ```
|
|
39
43
|
*/
|
|
40
|
-
update(id: string, options?: RequestOptions): APIPromise<
|
|
44
|
+
update(id: string, body: MaterialUpdateParams, options?: RequestOptions): APIPromise<MaterialResponse>;
|
|
41
45
|
/**
|
|
42
46
|
* Get all materials for organization
|
|
43
47
|
*
|
|
@@ -56,21 +60,29 @@ export declare class Materials extends APIResource {
|
|
|
56
60
|
* ```
|
|
57
61
|
*/
|
|
58
62
|
delete(id: string, options?: RequestOptions): APIPromise<void>;
|
|
63
|
+
/**
|
|
64
|
+
* Attempts to cancel a currently running PDF processing job
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* ```ts
|
|
68
|
+
* const response = await client.v1.materials.cancelJob('id');
|
|
69
|
+
* ```
|
|
70
|
+
*/
|
|
71
|
+
cancelJob(id: string, options?: RequestOptions): APIPromise<MaterialCancelJobResponse>;
|
|
59
72
|
/**
|
|
60
73
|
* Creates a material and waits for processing to finish before returning. Useful
|
|
61
74
|
* for synchronous API usage.
|
|
62
75
|
*
|
|
63
76
|
* @example
|
|
64
77
|
* ```ts
|
|
65
|
-
* const
|
|
66
|
-
* {
|
|
78
|
+
* const materialResponse =
|
|
79
|
+
* await client.v1.materials.createAndProcess({
|
|
67
80
|
* content: { type: 'text' },
|
|
68
81
|
* name: 'Chapter 1 - Introduction',
|
|
69
|
-
* }
|
|
70
|
-
* );
|
|
82
|
+
* });
|
|
71
83
|
* ```
|
|
72
84
|
*/
|
|
73
|
-
createAndProcess(body: MaterialCreateAndProcessParams, options?: RequestOptions): APIPromise<
|
|
85
|
+
createAndProcess(body: MaterialCreateAndProcessParams, options?: RequestOptions): APIPromise<MaterialResponse>;
|
|
74
86
|
/**
|
|
75
87
|
* Create batch upload URLs for multiple materials
|
|
76
88
|
*
|
|
@@ -95,21 +107,22 @@ export declare class Materials extends APIResource {
|
|
|
95
107
|
*
|
|
96
108
|
* @example
|
|
97
109
|
* ```ts
|
|
98
|
-
* const
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
110
|
+
* const generatedMaterialResponse =
|
|
111
|
+
* await client.v1.materials.generate({
|
|
112
|
+
* name: 'Photosynthesis Study Plan',
|
|
113
|
+
* topic: 'Photosynthesis in plants',
|
|
114
|
+
* type: 'notes',
|
|
115
|
+
* });
|
|
103
116
|
* ```
|
|
104
117
|
*/
|
|
105
|
-
generate(body: MaterialGenerateParams, options?: RequestOptions): APIPromise<
|
|
118
|
+
generate(body: MaterialGenerateParams, options?: RequestOptions): APIPromise<GeneratedMaterialResponse>;
|
|
106
119
|
/**
|
|
107
120
|
* Uses AI to generate study materials like outlines, notes, summaries, etc. from a
|
|
108
121
|
* given topic and waits for processing to complete
|
|
109
122
|
*
|
|
110
123
|
* @example
|
|
111
124
|
* ```ts
|
|
112
|
-
* const
|
|
125
|
+
* const generatedMaterialResponse =
|
|
113
126
|
* await client.v1.materials.generateAndProcess({
|
|
114
127
|
* name: 'Photosynthesis Study Plan',
|
|
115
128
|
* topic: 'Photosynthesis in plants',
|
|
@@ -117,7 +130,7 @@ export declare class Materials extends APIResource {
|
|
|
117
130
|
* });
|
|
118
131
|
* ```
|
|
119
132
|
*/
|
|
120
|
-
generateAndProcess(body: MaterialGenerateAndProcessParams, options?: RequestOptions): APIPromise<
|
|
133
|
+
generateAndProcess(body: MaterialGenerateAndProcessParams, options?: RequestOptions): APIPromise<GeneratedMaterialResponse>;
|
|
121
134
|
/**
|
|
122
135
|
* Get debug information for a material including extracted content
|
|
123
136
|
*
|
|
@@ -131,663 +144,92 @@ export declare class Materials extends APIResource {
|
|
|
131
144
|
getDebugInfo(id: string, options?: RequestOptions): APIPromise<MaterialGetDebugInfoResponse>;
|
|
132
145
|
/**
|
|
133
146
|
* Get temporary download URL for material
|
|
134
|
-
*
|
|
135
|
-
* @example
|
|
136
|
-
* ```ts
|
|
137
|
-
* const response = await client.v1.materials.getDownloadURL(
|
|
138
|
-
* 'id',
|
|
139
|
-
* );
|
|
140
|
-
* ```
|
|
141
|
-
*/
|
|
142
|
-
getDownloadURL(id: string, query?: MaterialGetDownloadURLParams | null | undefined, options?: RequestOptions): APIPromise<MaterialGetDownloadURLResponse>;
|
|
143
|
-
/**
|
|
144
|
-
* Move material to a different folder
|
|
145
|
-
*
|
|
146
|
-
* @example
|
|
147
|
-
* ```ts
|
|
148
|
-
* const response = await client.v1.materials.move('id', {
|
|
149
|
-
* folderId: 'folderId',
|
|
150
|
-
* });
|
|
151
|
-
* ```
|
|
152
|
-
*/
|
|
153
|
-
move(id: string, body: MaterialMoveParams, options?: RequestOptions): APIPromise<MaterialMoveResponse>;
|
|
154
|
-
/**
|
|
155
|
-
* Rename a material
|
|
156
|
-
*
|
|
157
|
-
* @example
|
|
158
|
-
* ```ts
|
|
159
|
-
* const response = await client.v1.materials.rename('id', {
|
|
160
|
-
* name: 'New Material Name',
|
|
161
|
-
* });
|
|
162
|
-
* ```
|
|
163
|
-
*/
|
|
164
|
-
rename(id: string, body: MaterialRenameParams, options?: RequestOptions): APIPromise<MaterialRenameResponse>;
|
|
165
|
-
/**
|
|
166
|
-
* Reprocess material to regenerate embeddings and extract content
|
|
167
|
-
*
|
|
168
|
-
* @example
|
|
169
|
-
* ```ts
|
|
170
|
-
* const response = await client.v1.materials.reprocess('id');
|
|
171
|
-
* ```
|
|
172
|
-
*/
|
|
173
|
-
reprocess(id: string, options?: RequestOptions): APIPromise<MaterialReprocessResponse>;
|
|
174
|
-
/**
|
|
175
|
-
* Search materials using RAG (Retrieval-Augmented Generation)
|
|
176
|
-
*
|
|
177
|
-
* @example
|
|
178
|
-
* ```ts
|
|
179
|
-
* const response = await client.v1.materials.search({
|
|
180
|
-
* query: 'What is photosynthesis?',
|
|
181
|
-
* });
|
|
182
|
-
* ```
|
|
183
|
-
*/
|
|
184
|
-
search(body: MaterialSearchParams, options?: RequestOptions): APIPromise<MaterialSearchResponse>;
|
|
185
|
-
}
|
|
186
|
-
export interface MaterialCreateResponse {
|
|
187
|
-
/**
|
|
188
|
-
* Material ID
|
|
189
|
-
*/
|
|
190
|
-
_id: string;
|
|
191
|
-
/**
|
|
192
|
-
* Material content
|
|
193
|
-
*/
|
|
194
|
-
content: MaterialCreateResponse.Content;
|
|
195
|
-
/**
|
|
196
|
-
* Content type
|
|
197
|
-
*/
|
|
198
|
-
contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
|
|
199
|
-
/**
|
|
200
|
-
* Creation timestamp
|
|
201
|
-
*/
|
|
202
|
-
createdAt: string;
|
|
203
|
-
/**
|
|
204
|
-
* Folder ID
|
|
205
|
-
*/
|
|
206
|
-
folderId: string | null;
|
|
207
|
-
/**
|
|
208
|
-
* Material name
|
|
209
|
-
*/
|
|
210
|
-
name: string;
|
|
211
|
-
/**
|
|
212
|
-
* Organization ID
|
|
213
|
-
*/
|
|
214
|
-
organizationId: string;
|
|
215
|
-
/**
|
|
216
|
-
* Material status
|
|
217
|
-
*/
|
|
218
|
-
status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
|
|
219
|
-
/**
|
|
220
|
-
* Last update timestamp
|
|
221
|
-
*/
|
|
222
|
-
updatedAt: string;
|
|
223
|
-
/**
|
|
224
|
-
* Material metadata
|
|
225
|
-
*/
|
|
226
|
-
metadata?: unknown;
|
|
227
|
-
/**
|
|
228
|
-
* References that this material cites
|
|
229
|
-
*/
|
|
230
|
-
references?: Array<MaterialCreateResponse.Reference>;
|
|
231
|
-
/**
|
|
232
|
-
* Usage information
|
|
233
|
-
*/
|
|
234
|
-
usage?: unknown;
|
|
235
|
-
}
|
|
236
|
-
export declare namespace MaterialCreateResponse {
|
|
237
|
-
/**
|
|
238
|
-
* Material content
|
|
239
|
-
*/
|
|
240
|
-
interface Content {
|
|
241
|
-
filename?: string;
|
|
242
|
-
fileSize?: number;
|
|
243
|
-
mimeType?: string;
|
|
244
|
-
s3Key?: string;
|
|
245
|
-
s3Url?: string;
|
|
246
|
-
text?: string;
|
|
247
|
-
url?: string;
|
|
248
|
-
}
|
|
249
|
-
interface Reference {
|
|
250
|
-
/**
|
|
251
|
-
* Reference title
|
|
252
|
-
*/
|
|
253
|
-
title: string;
|
|
254
|
-
/**
|
|
255
|
-
* Reference URL
|
|
256
|
-
*/
|
|
257
|
-
url?: string;
|
|
258
|
-
}
|
|
259
|
-
}
|
|
260
|
-
export interface MaterialRetrieveResponse {
|
|
261
|
-
/**
|
|
262
|
-
* Material ID
|
|
263
|
-
*/
|
|
264
|
-
_id: string;
|
|
265
|
-
/**
|
|
266
|
-
* Material content
|
|
267
|
-
*/
|
|
268
|
-
content: MaterialRetrieveResponse.Content;
|
|
269
|
-
/**
|
|
270
|
-
* Content type
|
|
271
|
-
*/
|
|
272
|
-
contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
|
|
273
|
-
/**
|
|
274
|
-
* Creation timestamp
|
|
275
|
-
*/
|
|
276
|
-
createdAt: string;
|
|
277
|
-
/**
|
|
278
|
-
* Folder ID
|
|
279
|
-
*/
|
|
280
|
-
folderId: string | null;
|
|
281
|
-
/**
|
|
282
|
-
* Material name
|
|
283
|
-
*/
|
|
284
|
-
name: string;
|
|
285
|
-
/**
|
|
286
|
-
* Organization ID
|
|
287
|
-
*/
|
|
288
|
-
organizationId: string;
|
|
289
|
-
/**
|
|
290
|
-
* Material status
|
|
291
|
-
*/
|
|
292
|
-
status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
|
|
293
|
-
/**
|
|
294
|
-
* Last update timestamp
|
|
295
|
-
*/
|
|
296
|
-
updatedAt: string;
|
|
297
|
-
/**
|
|
298
|
-
* Material metadata
|
|
299
|
-
*/
|
|
300
|
-
metadata?: unknown;
|
|
301
|
-
/**
|
|
302
|
-
* References that this material cites
|
|
303
|
-
*/
|
|
304
|
-
references?: Array<MaterialRetrieveResponse.Reference>;
|
|
305
|
-
/**
|
|
306
|
-
* Usage information
|
|
307
|
-
*/
|
|
308
|
-
usage?: unknown;
|
|
309
|
-
}
|
|
310
|
-
export declare namespace MaterialRetrieveResponse {
|
|
311
|
-
/**
|
|
312
|
-
* Material content
|
|
313
|
-
*/
|
|
314
|
-
interface Content {
|
|
315
|
-
filename?: string;
|
|
316
|
-
fileSize?: number;
|
|
317
|
-
mimeType?: string;
|
|
318
|
-
s3Key?: string;
|
|
319
|
-
s3Url?: string;
|
|
320
|
-
text?: string;
|
|
321
|
-
url?: string;
|
|
322
|
-
}
|
|
323
|
-
interface Reference {
|
|
324
|
-
/**
|
|
325
|
-
* Reference title
|
|
326
|
-
*/
|
|
327
|
-
title: string;
|
|
328
|
-
/**
|
|
329
|
-
* Reference URL
|
|
330
|
-
*/
|
|
331
|
-
url?: string;
|
|
332
|
-
}
|
|
333
|
-
}
|
|
334
|
-
export interface MaterialUpdateResponse {
|
|
335
|
-
/**
|
|
336
|
-
* Material ID
|
|
337
|
-
*/
|
|
338
|
-
_id: string;
|
|
339
|
-
/**
|
|
340
|
-
* Material content
|
|
341
|
-
*/
|
|
342
|
-
content: MaterialUpdateResponse.Content;
|
|
343
|
-
/**
|
|
344
|
-
* Content type
|
|
345
|
-
*/
|
|
346
|
-
contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
|
|
347
|
-
/**
|
|
348
|
-
* Creation timestamp
|
|
349
|
-
*/
|
|
350
|
-
createdAt: string;
|
|
351
|
-
/**
|
|
352
|
-
* Folder ID
|
|
353
|
-
*/
|
|
354
|
-
folderId: string | null;
|
|
355
|
-
/**
|
|
356
|
-
* Material name
|
|
357
|
-
*/
|
|
358
|
-
name: string;
|
|
359
|
-
/**
|
|
360
|
-
* Organization ID
|
|
361
|
-
*/
|
|
362
|
-
organizationId: string;
|
|
363
|
-
/**
|
|
364
|
-
* Material status
|
|
365
|
-
*/
|
|
366
|
-
status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
|
|
367
|
-
/**
|
|
368
|
-
* Last update timestamp
|
|
369
|
-
*/
|
|
370
|
-
updatedAt: string;
|
|
371
|
-
/**
|
|
372
|
-
* Material metadata
|
|
373
|
-
*/
|
|
374
|
-
metadata?: unknown;
|
|
375
|
-
/**
|
|
376
|
-
* References that this material cites
|
|
377
|
-
*/
|
|
378
|
-
references?: Array<MaterialUpdateResponse.Reference>;
|
|
379
|
-
/**
|
|
380
|
-
* Usage information
|
|
381
|
-
*/
|
|
382
|
-
usage?: unknown;
|
|
383
|
-
}
|
|
384
|
-
export declare namespace MaterialUpdateResponse {
|
|
385
|
-
/**
|
|
386
|
-
* Material content
|
|
387
|
-
*/
|
|
388
|
-
interface Content {
|
|
389
|
-
filename?: string;
|
|
390
|
-
fileSize?: number;
|
|
391
|
-
mimeType?: string;
|
|
392
|
-
s3Key?: string;
|
|
393
|
-
s3Url?: string;
|
|
394
|
-
text?: string;
|
|
395
|
-
url?: string;
|
|
396
|
-
}
|
|
397
|
-
interface Reference {
|
|
398
|
-
/**
|
|
399
|
-
* Reference title
|
|
400
|
-
*/
|
|
401
|
-
title: string;
|
|
402
|
-
/**
|
|
403
|
-
* Reference URL
|
|
404
|
-
*/
|
|
405
|
-
url?: string;
|
|
406
|
-
}
|
|
407
|
-
}
|
|
408
|
-
export interface MaterialListResponse {
|
|
409
|
-
materials?: Array<MaterialListResponse.Material>;
|
|
410
|
-
page?: number;
|
|
411
|
-
totalCount?: number;
|
|
412
|
-
totalPages?: number;
|
|
413
|
-
}
|
|
414
|
-
export declare namespace MaterialListResponse {
|
|
415
|
-
interface Material {
|
|
416
|
-
/**
|
|
417
|
-
* Material ID
|
|
418
|
-
*/
|
|
419
|
-
_id: string;
|
|
420
|
-
/**
|
|
421
|
-
* Material content
|
|
422
|
-
*/
|
|
423
|
-
content: Material.Content;
|
|
424
|
-
/**
|
|
425
|
-
* Content type
|
|
426
|
-
*/
|
|
427
|
-
contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
|
|
428
|
-
/**
|
|
429
|
-
* Creation timestamp
|
|
430
|
-
*/
|
|
431
|
-
createdAt: string;
|
|
432
|
-
/**
|
|
433
|
-
* Folder ID
|
|
434
|
-
*/
|
|
435
|
-
folderId: string | null;
|
|
436
|
-
/**
|
|
437
|
-
* Material name
|
|
438
|
-
*/
|
|
439
|
-
name: string;
|
|
440
|
-
/**
|
|
441
|
-
* Organization ID
|
|
442
|
-
*/
|
|
443
|
-
organizationId: string;
|
|
444
|
-
/**
|
|
445
|
-
* Material status
|
|
446
|
-
*/
|
|
447
|
-
status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
|
|
448
|
-
/**
|
|
449
|
-
* Last update timestamp
|
|
450
|
-
*/
|
|
451
|
-
updatedAt: string;
|
|
452
|
-
/**
|
|
453
|
-
* Material metadata
|
|
454
|
-
*/
|
|
455
|
-
metadata?: unknown;
|
|
456
|
-
/**
|
|
457
|
-
* References that this material cites
|
|
458
|
-
*/
|
|
459
|
-
references?: Array<Material.Reference>;
|
|
460
|
-
/**
|
|
461
|
-
* Usage information
|
|
462
|
-
*/
|
|
463
|
-
usage?: unknown;
|
|
464
|
-
}
|
|
465
|
-
namespace Material {
|
|
466
|
-
/**
|
|
467
|
-
* Material content
|
|
468
|
-
*/
|
|
469
|
-
interface Content {
|
|
470
|
-
filename?: string;
|
|
471
|
-
fileSize?: number;
|
|
472
|
-
mimeType?: string;
|
|
473
|
-
s3Key?: string;
|
|
474
|
-
s3Url?: string;
|
|
475
|
-
text?: string;
|
|
476
|
-
url?: string;
|
|
477
|
-
}
|
|
478
|
-
interface Reference {
|
|
479
|
-
/**
|
|
480
|
-
* Reference title
|
|
481
|
-
*/
|
|
482
|
-
title: string;
|
|
483
|
-
/**
|
|
484
|
-
* Reference URL
|
|
485
|
-
*/
|
|
486
|
-
url?: string;
|
|
487
|
-
}
|
|
488
|
-
}
|
|
489
|
-
}
|
|
490
|
-
export interface MaterialCreateAndProcessResponse {
|
|
491
|
-
/**
|
|
492
|
-
* Material ID
|
|
493
|
-
*/
|
|
494
|
-
_id: string;
|
|
495
|
-
/**
|
|
496
|
-
* Material content
|
|
497
|
-
*/
|
|
498
|
-
content: MaterialCreateAndProcessResponse.Content;
|
|
499
|
-
/**
|
|
500
|
-
* Content type
|
|
501
|
-
*/
|
|
502
|
-
contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
|
|
503
|
-
/**
|
|
504
|
-
* Creation timestamp
|
|
505
|
-
*/
|
|
506
|
-
createdAt: string;
|
|
507
|
-
/**
|
|
508
|
-
* Folder ID
|
|
509
|
-
*/
|
|
510
|
-
folderId: string | null;
|
|
511
|
-
/**
|
|
512
|
-
* Material name
|
|
513
|
-
*/
|
|
514
|
-
name: string;
|
|
515
|
-
/**
|
|
516
|
-
* Organization ID
|
|
517
|
-
*/
|
|
518
|
-
organizationId: string;
|
|
519
|
-
/**
|
|
520
|
-
* Material status
|
|
521
|
-
*/
|
|
522
|
-
status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
|
|
523
|
-
/**
|
|
524
|
-
* Last update timestamp
|
|
525
|
-
*/
|
|
526
|
-
updatedAt: string;
|
|
527
|
-
/**
|
|
528
|
-
* Material metadata
|
|
529
|
-
*/
|
|
530
|
-
metadata?: unknown;
|
|
531
|
-
/**
|
|
532
|
-
* References that this material cites
|
|
533
|
-
*/
|
|
534
|
-
references?: Array<MaterialCreateAndProcessResponse.Reference>;
|
|
535
|
-
/**
|
|
536
|
-
* Usage information
|
|
537
|
-
*/
|
|
538
|
-
usage?: unknown;
|
|
539
|
-
}
|
|
540
|
-
export declare namespace MaterialCreateAndProcessResponse {
|
|
541
|
-
/**
|
|
542
|
-
* Material content
|
|
543
|
-
*/
|
|
544
|
-
interface Content {
|
|
545
|
-
filename?: string;
|
|
546
|
-
fileSize?: number;
|
|
547
|
-
mimeType?: string;
|
|
548
|
-
s3Key?: string;
|
|
549
|
-
s3Url?: string;
|
|
550
|
-
text?: string;
|
|
551
|
-
url?: string;
|
|
552
|
-
}
|
|
553
|
-
interface Reference {
|
|
554
|
-
/**
|
|
555
|
-
* Reference title
|
|
556
|
-
*/
|
|
557
|
-
title: string;
|
|
558
|
-
/**
|
|
559
|
-
* Reference URL
|
|
560
|
-
*/
|
|
561
|
-
url?: string;
|
|
562
|
-
}
|
|
563
|
-
}
|
|
564
|
-
export type MaterialCreateBatchUploadURLsResponse = Array<MaterialCreateBatchUploadURLsResponse.MaterialCreateBatchUploadURLsResponseItem>;
|
|
565
|
-
export declare namespace MaterialCreateBatchUploadURLsResponse {
|
|
566
|
-
interface MaterialCreateBatchUploadURLsResponseItem {
|
|
567
|
-
/**
|
|
568
|
-
* Material ID
|
|
569
|
-
*/
|
|
570
|
-
materialId: string;
|
|
571
|
-
/**
|
|
572
|
-
* Material name
|
|
573
|
-
*/
|
|
574
|
-
name: string;
|
|
575
|
-
/**
|
|
576
|
-
* S3 key
|
|
577
|
-
*/
|
|
578
|
-
s3Key: string;
|
|
579
|
-
/**
|
|
580
|
-
* Presigned upload URL
|
|
581
|
-
*/
|
|
582
|
-
uploadUrl: string;
|
|
583
|
-
}
|
|
584
|
-
}
|
|
585
|
-
export interface MaterialGenerateResponse {
|
|
586
|
-
/**
|
|
587
|
-
* Material ID
|
|
588
|
-
*/
|
|
589
|
-
_id: string;
|
|
590
|
-
/**
|
|
591
|
-
* Material content
|
|
592
|
-
*/
|
|
593
|
-
content: MaterialGenerateResponse.Content;
|
|
594
|
-
/**
|
|
595
|
-
* Content type
|
|
596
|
-
*/
|
|
597
|
-
contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
|
|
598
|
-
/**
|
|
599
|
-
* Creation timestamp
|
|
600
|
-
*/
|
|
601
|
-
createdAt: string;
|
|
602
|
-
/**
|
|
603
|
-
* Folder ID
|
|
604
|
-
*/
|
|
605
|
-
folderId: string | null;
|
|
606
|
-
/**
|
|
607
|
-
* Material name
|
|
608
|
-
*/
|
|
609
|
-
name: string;
|
|
610
|
-
/**
|
|
611
|
-
* Organization ID
|
|
612
|
-
*/
|
|
613
|
-
organizationId: string;
|
|
614
|
-
/**
|
|
615
|
-
* Material status
|
|
616
|
-
*/
|
|
617
|
-
status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
|
|
618
|
-
/**
|
|
619
|
-
* Last update timestamp
|
|
620
|
-
*/
|
|
621
|
-
updatedAt: string;
|
|
622
|
-
/**
|
|
623
|
-
* Generation metadata
|
|
624
|
-
*/
|
|
625
|
-
generationMetadata?: unknown;
|
|
626
|
-
/**
|
|
627
|
-
* Material metadata
|
|
628
|
-
*/
|
|
629
|
-
metadata?: unknown;
|
|
630
|
-
/**
|
|
631
|
-
* References that this material cites
|
|
632
|
-
*/
|
|
633
|
-
references?: Array<MaterialGenerateResponse.Reference>;
|
|
634
|
-
/**
|
|
635
|
-
* Usage information
|
|
636
|
-
*/
|
|
637
|
-
usage?: unknown;
|
|
638
|
-
}
|
|
639
|
-
export declare namespace MaterialGenerateResponse {
|
|
640
|
-
/**
|
|
641
|
-
* Material content
|
|
642
|
-
*/
|
|
643
|
-
interface Content {
|
|
644
|
-
filename?: string;
|
|
645
|
-
fileSize?: number;
|
|
646
|
-
mimeType?: string;
|
|
647
|
-
s3Key?: string;
|
|
648
|
-
s3Url?: string;
|
|
649
|
-
text?: string;
|
|
650
|
-
url?: string;
|
|
651
|
-
}
|
|
652
|
-
interface Reference {
|
|
653
|
-
/**
|
|
654
|
-
* Reference title
|
|
655
|
-
*/
|
|
656
|
-
title: string;
|
|
657
|
-
/**
|
|
658
|
-
* Reference URL
|
|
659
|
-
*/
|
|
660
|
-
url?: string;
|
|
661
|
-
}
|
|
662
|
-
}
|
|
663
|
-
export interface MaterialGenerateAndProcessResponse {
|
|
664
|
-
/**
|
|
665
|
-
* Material ID
|
|
666
|
-
*/
|
|
667
|
-
_id: string;
|
|
668
|
-
/**
|
|
669
|
-
* Material content
|
|
670
|
-
*/
|
|
671
|
-
content: MaterialGenerateAndProcessResponse.Content;
|
|
672
|
-
/**
|
|
673
|
-
* Content type
|
|
674
|
-
*/
|
|
675
|
-
contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
|
|
676
|
-
/**
|
|
677
|
-
* Creation timestamp
|
|
678
|
-
*/
|
|
679
|
-
createdAt: string;
|
|
680
|
-
/**
|
|
681
|
-
* Folder ID
|
|
682
|
-
*/
|
|
683
|
-
folderId: string | null;
|
|
684
|
-
/**
|
|
685
|
-
* Material name
|
|
686
|
-
*/
|
|
687
|
-
name: string;
|
|
688
|
-
/**
|
|
689
|
-
* Organization ID
|
|
690
|
-
*/
|
|
691
|
-
organizationId: string;
|
|
692
|
-
/**
|
|
693
|
-
* Material status
|
|
694
|
-
*/
|
|
695
|
-
status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
|
|
696
|
-
/**
|
|
697
|
-
* Last update timestamp
|
|
698
|
-
*/
|
|
699
|
-
updatedAt: string;
|
|
700
|
-
/**
|
|
701
|
-
* Generation metadata
|
|
702
|
-
*/
|
|
703
|
-
generationMetadata?: unknown;
|
|
704
|
-
/**
|
|
705
|
-
* Material metadata
|
|
706
|
-
*/
|
|
707
|
-
metadata?: unknown;
|
|
708
|
-
/**
|
|
709
|
-
* References that this material cites
|
|
710
|
-
*/
|
|
711
|
-
references?: Array<MaterialGenerateAndProcessResponse.Reference>;
|
|
712
|
-
/**
|
|
713
|
-
* Usage information
|
|
714
|
-
*/
|
|
715
|
-
usage?: unknown;
|
|
716
|
-
}
|
|
717
|
-
export declare namespace MaterialGenerateAndProcessResponse {
|
|
718
|
-
/**
|
|
719
|
-
* Material content
|
|
720
|
-
*/
|
|
721
|
-
interface Content {
|
|
722
|
-
filename?: string;
|
|
723
|
-
fileSize?: number;
|
|
724
|
-
mimeType?: string;
|
|
725
|
-
s3Key?: string;
|
|
726
|
-
s3Url?: string;
|
|
727
|
-
text?: string;
|
|
728
|
-
url?: string;
|
|
729
|
-
}
|
|
730
|
-
interface Reference {
|
|
731
|
-
/**
|
|
732
|
-
* Reference title
|
|
733
|
-
*/
|
|
734
|
-
title: string;
|
|
735
|
-
/**
|
|
736
|
-
* Reference URL
|
|
737
|
-
*/
|
|
738
|
-
url?: string;
|
|
739
|
-
}
|
|
740
|
-
}
|
|
741
|
-
export interface MaterialGetDebugInfoResponse {
|
|
147
|
+
*
|
|
148
|
+
* @example
|
|
149
|
+
* ```ts
|
|
150
|
+
* const response = await client.v1.materials.getDownloadURL(
|
|
151
|
+
* 'id',
|
|
152
|
+
* );
|
|
153
|
+
* ```
|
|
154
|
+
*/
|
|
155
|
+
getDownloadURL(id: string, query?: MaterialGetDownloadURLParams | null | undefined, options?: RequestOptions): APIPromise<MaterialGetDownloadURLResponse>;
|
|
742
156
|
/**
|
|
743
|
-
*
|
|
157
|
+
* Returns the current status of a PDF processing job including progress
|
|
158
|
+
* information
|
|
159
|
+
*
|
|
160
|
+
* @example
|
|
161
|
+
* ```ts
|
|
162
|
+
* const response = await client.v1.materials.getJobStatus(
|
|
163
|
+
* 'id',
|
|
164
|
+
* );
|
|
165
|
+
* ```
|
|
744
166
|
*/
|
|
745
|
-
|
|
167
|
+
getJobStatus(id: string, options?: RequestOptions): APIPromise<MaterialGetJobStatusResponse>;
|
|
746
168
|
/**
|
|
747
|
-
*
|
|
169
|
+
* Move material to a different folder
|
|
170
|
+
*
|
|
171
|
+
* @example
|
|
172
|
+
* ```ts
|
|
173
|
+
* const materialResponse = await client.v1.materials.move(
|
|
174
|
+
* 'id',
|
|
175
|
+
* { folderId: 'folderId' },
|
|
176
|
+
* );
|
|
177
|
+
* ```
|
|
748
178
|
*/
|
|
749
|
-
|
|
179
|
+
move(id: string, body: MaterialMoveParams, options?: RequestOptions): APIPromise<MaterialResponse>;
|
|
750
180
|
/**
|
|
751
|
-
*
|
|
181
|
+
* Rename a material
|
|
182
|
+
*
|
|
183
|
+
* @example
|
|
184
|
+
* ```ts
|
|
185
|
+
* const materialResponse = await client.v1.materials.rename(
|
|
186
|
+
* 'id',
|
|
187
|
+
* { name: 'New Material Name' },
|
|
188
|
+
* );
|
|
189
|
+
* ```
|
|
752
190
|
*/
|
|
753
|
-
|
|
191
|
+
rename(id: string, body: MaterialRenameParams, options?: RequestOptions): APIPromise<MaterialResponse>;
|
|
754
192
|
/**
|
|
755
|
-
*
|
|
193
|
+
* Reprocess material to regenerate embeddings and extract content
|
|
194
|
+
*
|
|
195
|
+
* @example
|
|
196
|
+
* ```ts
|
|
197
|
+
* const materialResponse =
|
|
198
|
+
* await client.v1.materials.reprocess('id');
|
|
199
|
+
* ```
|
|
756
200
|
*/
|
|
757
|
-
|
|
201
|
+
reprocess(id: string, options?: RequestOptions): APIPromise<MaterialResponse>;
|
|
758
202
|
/**
|
|
759
|
-
*
|
|
203
|
+
* Search materials using RAG (Retrieval-Augmented Generation)
|
|
204
|
+
*
|
|
205
|
+
* @example
|
|
206
|
+
* ```ts
|
|
207
|
+
* const response = await client.v1.materials.search({
|
|
208
|
+
* query: 'What is photosynthesis?',
|
|
209
|
+
* });
|
|
210
|
+
* ```
|
|
760
211
|
*/
|
|
761
|
-
|
|
212
|
+
search(body: MaterialSearchParams, options?: RequestOptions): APIPromise<MaterialSearchResponse>;
|
|
213
|
+
}
|
|
214
|
+
export interface Content {
|
|
762
215
|
/**
|
|
763
|
-
*
|
|
216
|
+
* Type of content
|
|
764
217
|
*/
|
|
765
|
-
|
|
218
|
+
type: 'text' | 'pdf' | 'video' | 'audio' | 'url';
|
|
766
219
|
/**
|
|
767
|
-
*
|
|
220
|
+
* URL to fetch content from
|
|
768
221
|
*/
|
|
769
|
-
|
|
222
|
+
sourceUrl?: string;
|
|
770
223
|
/**
|
|
771
|
-
*
|
|
224
|
+
* Text content (for text type)
|
|
772
225
|
*/
|
|
773
|
-
|
|
774
|
-
}
|
|
775
|
-
export declare namespace MaterialGetDebugInfoResponse {
|
|
776
|
-
interface Image {
|
|
777
|
-
id?: string;
|
|
778
|
-
description?: string;
|
|
779
|
-
pageIndex?: number;
|
|
780
|
-
s3Key?: string;
|
|
781
|
-
s3Url?: string;
|
|
782
|
-
}
|
|
783
|
-
}
|
|
784
|
-
export interface MaterialGetDownloadURLResponse {
|
|
226
|
+
text?: string;
|
|
785
227
|
/**
|
|
786
|
-
*
|
|
228
|
+
* URL to the content (for url type)
|
|
787
229
|
*/
|
|
788
|
-
|
|
230
|
+
url?: string;
|
|
789
231
|
}
|
|
790
|
-
export interface
|
|
232
|
+
export interface GeneratedMaterialResponse {
|
|
791
233
|
/**
|
|
792
234
|
* Material ID
|
|
793
235
|
*/
|
|
@@ -795,7 +237,7 @@ export interface MaterialMoveResponse {
|
|
|
795
237
|
/**
|
|
796
238
|
* Material content
|
|
797
239
|
*/
|
|
798
|
-
content:
|
|
240
|
+
content: GeneratedMaterialResponse.Content;
|
|
799
241
|
/**
|
|
800
242
|
* Content type
|
|
801
243
|
*/
|
|
@@ -824,6 +266,10 @@ export interface MaterialMoveResponse {
|
|
|
824
266
|
* Last update timestamp
|
|
825
267
|
*/
|
|
826
268
|
updatedAt: string;
|
|
269
|
+
/**
|
|
270
|
+
* Generation metadata
|
|
271
|
+
*/
|
|
272
|
+
generationMetadata?: unknown;
|
|
827
273
|
/**
|
|
828
274
|
* Material metadata
|
|
829
275
|
*/
|
|
@@ -831,13 +277,13 @@ export interface MaterialMoveResponse {
|
|
|
831
277
|
/**
|
|
832
278
|
* References that this material cites
|
|
833
279
|
*/
|
|
834
|
-
references?: Array<
|
|
280
|
+
references?: Array<Reference>;
|
|
835
281
|
/**
|
|
836
282
|
* Usage information
|
|
837
283
|
*/
|
|
838
284
|
usage?: unknown;
|
|
839
285
|
}
|
|
840
|
-
export declare namespace
|
|
286
|
+
export declare namespace GeneratedMaterialResponse {
|
|
841
287
|
/**
|
|
842
288
|
* Material content
|
|
843
289
|
*/
|
|
@@ -850,18 +296,8 @@ export declare namespace MaterialMoveResponse {
|
|
|
850
296
|
text?: string;
|
|
851
297
|
url?: string;
|
|
852
298
|
}
|
|
853
|
-
interface Reference {
|
|
854
|
-
/**
|
|
855
|
-
* Reference title
|
|
856
|
-
*/
|
|
857
|
-
title: string;
|
|
858
|
-
/**
|
|
859
|
-
* Reference URL
|
|
860
|
-
*/
|
|
861
|
-
url?: string;
|
|
862
|
-
}
|
|
863
299
|
}
|
|
864
|
-
export interface
|
|
300
|
+
export interface MaterialResponse {
|
|
865
301
|
/**
|
|
866
302
|
* Material ID
|
|
867
303
|
*/
|
|
@@ -869,7 +305,7 @@ export interface MaterialRenameResponse {
|
|
|
869
305
|
/**
|
|
870
306
|
* Material content
|
|
871
307
|
*/
|
|
872
|
-
content:
|
|
308
|
+
content: MaterialResponse.Content;
|
|
873
309
|
/**
|
|
874
310
|
* Content type
|
|
875
311
|
*/
|
|
@@ -905,13 +341,13 @@ export interface MaterialRenameResponse {
|
|
|
905
341
|
/**
|
|
906
342
|
* References that this material cites
|
|
907
343
|
*/
|
|
908
|
-
references?: Array<
|
|
344
|
+
references?: Array<Reference>;
|
|
909
345
|
/**
|
|
910
346
|
* Usage information
|
|
911
347
|
*/
|
|
912
348
|
usage?: unknown;
|
|
913
349
|
}
|
|
914
|
-
export declare namespace
|
|
350
|
+
export declare namespace MaterialResponse {
|
|
915
351
|
/**
|
|
916
352
|
* Material content
|
|
917
353
|
*/
|
|
@@ -924,89 +360,161 @@ export declare namespace MaterialRenameResponse {
|
|
|
924
360
|
text?: string;
|
|
925
361
|
url?: string;
|
|
926
362
|
}
|
|
927
|
-
|
|
363
|
+
}
|
|
364
|
+
export interface Reference {
|
|
365
|
+
/**
|
|
366
|
+
* Reference title
|
|
367
|
+
*/
|
|
368
|
+
title: string;
|
|
369
|
+
/**
|
|
370
|
+
* Reference URL
|
|
371
|
+
*/
|
|
372
|
+
url?: string;
|
|
373
|
+
}
|
|
374
|
+
export interface MaterialListResponse {
|
|
375
|
+
materials?: Array<MaterialResponse>;
|
|
376
|
+
page?: number;
|
|
377
|
+
totalCount?: number;
|
|
378
|
+
totalPages?: number;
|
|
379
|
+
}
|
|
380
|
+
export interface MaterialCancelJobResponse {
|
|
381
|
+
message?: string;
|
|
382
|
+
success?: boolean;
|
|
383
|
+
}
|
|
384
|
+
export type MaterialCreateBatchUploadURLsResponse = Array<MaterialCreateBatchUploadURLsResponse.MaterialCreateBatchUploadURLsResponseItem>;
|
|
385
|
+
export declare namespace MaterialCreateBatchUploadURLsResponse {
|
|
386
|
+
interface MaterialCreateBatchUploadURLsResponseItem {
|
|
928
387
|
/**
|
|
929
|
-
*
|
|
388
|
+
* Material ID
|
|
930
389
|
*/
|
|
931
|
-
|
|
390
|
+
materialId: string;
|
|
932
391
|
/**
|
|
933
|
-
*
|
|
392
|
+
* Material name
|
|
934
393
|
*/
|
|
935
|
-
|
|
394
|
+
name: string;
|
|
395
|
+
/**
|
|
396
|
+
* S3 key
|
|
397
|
+
*/
|
|
398
|
+
s3Key: string;
|
|
399
|
+
/**
|
|
400
|
+
* Presigned upload URL
|
|
401
|
+
*/
|
|
402
|
+
uploadUrl: string;
|
|
936
403
|
}
|
|
937
404
|
}
|
|
938
|
-
export interface
|
|
405
|
+
export interface MaterialGetDebugInfoResponse {
|
|
939
406
|
/**
|
|
940
|
-
*
|
|
407
|
+
* Content details
|
|
941
408
|
*/
|
|
942
|
-
|
|
409
|
+
content: unknown;
|
|
943
410
|
/**
|
|
944
|
-
*
|
|
411
|
+
* Content type
|
|
945
412
|
*/
|
|
946
|
-
|
|
413
|
+
contentType: string;
|
|
947
414
|
/**
|
|
948
|
-
*
|
|
415
|
+
* Processed images
|
|
949
416
|
*/
|
|
950
|
-
|
|
417
|
+
images: Array<MaterialGetDebugInfoResponse.Image>;
|
|
951
418
|
/**
|
|
952
|
-
*
|
|
419
|
+
* Material ID
|
|
953
420
|
*/
|
|
954
|
-
|
|
421
|
+
materialId: string;
|
|
955
422
|
/**
|
|
956
|
-
*
|
|
423
|
+
* Material metadata
|
|
957
424
|
*/
|
|
958
|
-
|
|
425
|
+
metadata: unknown;
|
|
959
426
|
/**
|
|
960
427
|
* Material name
|
|
961
428
|
*/
|
|
962
429
|
name: string;
|
|
963
430
|
/**
|
|
964
|
-
*
|
|
431
|
+
* Processing status
|
|
965
432
|
*/
|
|
966
|
-
|
|
433
|
+
status: string;
|
|
967
434
|
/**
|
|
968
|
-
*
|
|
435
|
+
* Transcript structure for videos
|
|
969
436
|
*/
|
|
970
|
-
|
|
437
|
+
transcriptStructure: unknown | null;
|
|
438
|
+
}
|
|
439
|
+
export declare namespace MaterialGetDebugInfoResponse {
|
|
440
|
+
interface Image {
|
|
441
|
+
id?: string;
|
|
442
|
+
description?: string;
|
|
443
|
+
pageIndex?: number;
|
|
444
|
+
s3Key?: string;
|
|
445
|
+
s3Url?: string;
|
|
446
|
+
}
|
|
447
|
+
}
|
|
448
|
+
export interface MaterialGetDownloadURLResponse {
|
|
971
449
|
/**
|
|
972
|
-
*
|
|
450
|
+
* Temporary download URL
|
|
973
451
|
*/
|
|
974
|
-
|
|
452
|
+
downloadUrl: string;
|
|
453
|
+
}
|
|
454
|
+
export interface MaterialGetJobStatusResponse {
|
|
975
455
|
/**
|
|
976
|
-
*
|
|
456
|
+
* Job completion time
|
|
977
457
|
*/
|
|
978
|
-
|
|
458
|
+
completedAt?: string;
|
|
979
459
|
/**
|
|
980
|
-
*
|
|
460
|
+
* Error message if job failed
|
|
981
461
|
*/
|
|
982
|
-
|
|
462
|
+
error?: string;
|
|
983
463
|
/**
|
|
984
|
-
*
|
|
464
|
+
* Unique job identifier
|
|
985
465
|
*/
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
466
|
+
jobId?: string;
|
|
467
|
+
progress?: MaterialGetJobStatusResponse.Progress;
|
|
468
|
+
resultSummary?: MaterialGetJobStatusResponse.ResultSummary;
|
|
989
469
|
/**
|
|
990
|
-
*
|
|
470
|
+
* Job start time
|
|
991
471
|
*/
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
472
|
+
startedAt?: string;
|
|
473
|
+
/**
|
|
474
|
+
* Current job status
|
|
475
|
+
*/
|
|
476
|
+
status?: 'pending' | 'running' | 'completed' | 'failed' | 'cancelled';
|
|
477
|
+
}
|
|
478
|
+
export declare namespace MaterialGetJobStatusResponse {
|
|
479
|
+
interface Progress {
|
|
480
|
+
/**
|
|
481
|
+
* Current batch being processed
|
|
482
|
+
*/
|
|
483
|
+
currentBatch?: number;
|
|
484
|
+
/**
|
|
485
|
+
* Completion percentage (0-100)
|
|
486
|
+
*/
|
|
487
|
+
percentage?: number;
|
|
488
|
+
/**
|
|
489
|
+
* Images processed so far
|
|
490
|
+
*/
|
|
491
|
+
processedImages?: number;
|
|
492
|
+
/**
|
|
493
|
+
* Total number of batches
|
|
494
|
+
*/
|
|
495
|
+
totalBatches?: number;
|
|
496
|
+
/**
|
|
497
|
+
* Total images to process
|
|
498
|
+
*/
|
|
499
|
+
totalImages?: number;
|
|
1000
500
|
}
|
|
1001
|
-
interface
|
|
501
|
+
interface ResultSummary {
|
|
1002
502
|
/**
|
|
1003
|
-
*
|
|
503
|
+
* Number of images processed
|
|
1004
504
|
*/
|
|
1005
|
-
|
|
505
|
+
imagesProcessed?: number;
|
|
1006
506
|
/**
|
|
1007
|
-
*
|
|
507
|
+
* Total processing time in milliseconds
|
|
1008
508
|
*/
|
|
1009
|
-
|
|
509
|
+
processingTimeMs?: number;
|
|
510
|
+
/**
|
|
511
|
+
* Whether text was extracted
|
|
512
|
+
*/
|
|
513
|
+
textExtracted?: boolean;
|
|
514
|
+
/**
|
|
515
|
+
* Length of extracted text
|
|
516
|
+
*/
|
|
517
|
+
textLength?: number;
|
|
1010
518
|
}
|
|
1011
519
|
}
|
|
1012
520
|
export interface MaterialSearchResponse {
|
|
@@ -1072,7 +580,7 @@ export interface MaterialCreateParams {
|
|
|
1072
580
|
/**
|
|
1073
581
|
* Content details
|
|
1074
582
|
*/
|
|
1075
|
-
content:
|
|
583
|
+
content: Content;
|
|
1076
584
|
/**
|
|
1077
585
|
* Name of the material
|
|
1078
586
|
*/
|
|
@@ -1084,37 +592,22 @@ export interface MaterialCreateParams {
|
|
|
1084
592
|
/**
|
|
1085
593
|
* References that this material cites
|
|
1086
594
|
*/
|
|
1087
|
-
references?: Array<
|
|
595
|
+
references?: Array<Reference>;
|
|
1088
596
|
}
|
|
1089
|
-
export
|
|
597
|
+
export interface MaterialUpdateParams {
|
|
1090
598
|
/**
|
|
1091
|
-
*
|
|
599
|
+
* Array of references to update (optional)
|
|
1092
600
|
*/
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
*/
|
|
1097
|
-
type: 'text' | 'pdf' | 'video' | 'audio' | 'url';
|
|
1098
|
-
/**
|
|
1099
|
-
* URL to fetch content from
|
|
1100
|
-
*/
|
|
1101
|
-
sourceUrl?: string;
|
|
1102
|
-
/**
|
|
1103
|
-
* Text content (for text type)
|
|
1104
|
-
*/
|
|
1105
|
-
text?: string;
|
|
1106
|
-
/**
|
|
1107
|
-
* URL to the content (for url type)
|
|
1108
|
-
*/
|
|
1109
|
-
url?: string;
|
|
1110
|
-
}
|
|
601
|
+
references?: Array<MaterialUpdateParams.Reference>;
|
|
602
|
+
}
|
|
603
|
+
export declare namespace MaterialUpdateParams {
|
|
1111
604
|
interface Reference {
|
|
1112
605
|
/**
|
|
1113
606
|
* Reference title
|
|
1114
607
|
*/
|
|
1115
608
|
title: string;
|
|
1116
609
|
/**
|
|
1117
|
-
* Reference URL
|
|
610
|
+
* Reference URL (optional)
|
|
1118
611
|
*/
|
|
1119
612
|
url?: string;
|
|
1120
613
|
}
|
|
@@ -1141,7 +634,7 @@ export interface MaterialCreateAndProcessParams {
|
|
|
1141
634
|
/**
|
|
1142
635
|
* Content details
|
|
1143
636
|
*/
|
|
1144
|
-
content:
|
|
637
|
+
content: Content;
|
|
1145
638
|
/**
|
|
1146
639
|
* Name of the material
|
|
1147
640
|
*/
|
|
@@ -1157,45 +650,12 @@ export interface MaterialCreateAndProcessParams {
|
|
|
1157
650
|
/**
|
|
1158
651
|
* References that this material cites
|
|
1159
652
|
*/
|
|
1160
|
-
references?: Array<
|
|
653
|
+
references?: Array<Reference>;
|
|
1161
654
|
/**
|
|
1162
655
|
* Maximum time to wait for processing in milliseconds (default: 5 minutes)
|
|
1163
656
|
*/
|
|
1164
657
|
timeoutMs?: number;
|
|
1165
658
|
}
|
|
1166
|
-
export declare namespace MaterialCreateAndProcessParams {
|
|
1167
|
-
/**
|
|
1168
|
-
* Content details
|
|
1169
|
-
*/
|
|
1170
|
-
interface Content {
|
|
1171
|
-
/**
|
|
1172
|
-
* Type of content
|
|
1173
|
-
*/
|
|
1174
|
-
type: 'text' | 'pdf' | 'video' | 'audio' | 'url';
|
|
1175
|
-
/**
|
|
1176
|
-
* URL to fetch content from
|
|
1177
|
-
*/
|
|
1178
|
-
sourceUrl?: string;
|
|
1179
|
-
/**
|
|
1180
|
-
* Text content (for text type)
|
|
1181
|
-
*/
|
|
1182
|
-
text?: string;
|
|
1183
|
-
/**
|
|
1184
|
-
* URL to the content (for url type)
|
|
1185
|
-
*/
|
|
1186
|
-
url?: string;
|
|
1187
|
-
}
|
|
1188
|
-
interface Reference {
|
|
1189
|
-
/**
|
|
1190
|
-
* Reference title
|
|
1191
|
-
*/
|
|
1192
|
-
title: string;
|
|
1193
|
-
/**
|
|
1194
|
-
* Reference URL
|
|
1195
|
-
*/
|
|
1196
|
-
url?: string;
|
|
1197
|
-
}
|
|
1198
|
-
}
|
|
1199
659
|
export interface MaterialCreateBatchUploadURLsParams {
|
|
1200
660
|
/**
|
|
1201
661
|
* Array of materials to create
|
|
@@ -1254,19 +714,7 @@ export interface MaterialGenerateParams {
|
|
|
1254
714
|
/**
|
|
1255
715
|
* References that this material cites
|
|
1256
716
|
*/
|
|
1257
|
-
references?: Array<
|
|
1258
|
-
}
|
|
1259
|
-
export declare namespace MaterialGenerateParams {
|
|
1260
|
-
interface Reference {
|
|
1261
|
-
/**
|
|
1262
|
-
* Reference title
|
|
1263
|
-
*/
|
|
1264
|
-
title: string;
|
|
1265
|
-
/**
|
|
1266
|
-
* Reference URL
|
|
1267
|
-
*/
|
|
1268
|
-
url?: string;
|
|
1269
|
-
}
|
|
717
|
+
references?: Array<Reference>;
|
|
1270
718
|
}
|
|
1271
719
|
export interface MaterialGenerateAndProcessParams {
|
|
1272
720
|
/**
|
|
@@ -1304,24 +752,12 @@ export interface MaterialGenerateAndProcessParams {
|
|
|
1304
752
|
/**
|
|
1305
753
|
* References that this material cites
|
|
1306
754
|
*/
|
|
1307
|
-
references?: Array<
|
|
755
|
+
references?: Array<Reference>;
|
|
1308
756
|
/**
|
|
1309
757
|
* Maximum time to wait for processing in milliseconds (default: 5 minutes)
|
|
1310
758
|
*/
|
|
1311
759
|
timeoutMs?: number;
|
|
1312
760
|
}
|
|
1313
|
-
export declare namespace MaterialGenerateAndProcessParams {
|
|
1314
|
-
interface Reference {
|
|
1315
|
-
/**
|
|
1316
|
-
* Reference title
|
|
1317
|
-
*/
|
|
1318
|
-
title: string;
|
|
1319
|
-
/**
|
|
1320
|
-
* Reference URL
|
|
1321
|
-
*/
|
|
1322
|
-
url?: string;
|
|
1323
|
-
}
|
|
1324
|
-
}
|
|
1325
761
|
export interface MaterialGetDownloadURLParams {
|
|
1326
762
|
/**
|
|
1327
763
|
* URL expiration time in seconds (default: 3600)
|
|
@@ -1359,8 +795,8 @@ export interface MaterialSearchParams {
|
|
|
1359
795
|
topK?: number;
|
|
1360
796
|
}
|
|
1361
797
|
export declare namespace Materials {
|
|
1362
|
-
export { type
|
|
1363
|
-
export { Upload as Upload, type
|
|
798
|
+
export { type Content as Content, type GeneratedMaterialResponse as GeneratedMaterialResponse, type MaterialResponse as MaterialResponse, type Reference as Reference, type MaterialListResponse as MaterialListResponse, type MaterialCancelJobResponse as MaterialCancelJobResponse, type MaterialCreateBatchUploadURLsResponse as MaterialCreateBatchUploadURLsResponse, type MaterialGetDebugInfoResponse as MaterialGetDebugInfoResponse, type MaterialGetDownloadURLResponse as MaterialGetDownloadURLResponse, type MaterialGetJobStatusResponse as MaterialGetJobStatusResponse, type MaterialSearchResponse as MaterialSearchResponse, type MaterialCreateParams as MaterialCreateParams, type MaterialUpdateParams as MaterialUpdateParams, type MaterialListParams as MaterialListParams, type MaterialCreateAndProcessParams as MaterialCreateAndProcessParams, type MaterialCreateBatchUploadURLsParams as MaterialCreateBatchUploadURLsParams, type MaterialGenerateParams as MaterialGenerateParams, type MaterialGenerateAndProcessParams as MaterialGenerateAndProcessParams, type MaterialGetDownloadURLParams as MaterialGetDownloadURLParams, type MaterialMoveParams as MaterialMoveParams, type MaterialRenameParams as MaterialRenameParams, type MaterialSearchParams as MaterialSearchParams, };
|
|
799
|
+
export { Upload as Upload, type UploadGetPresignedURLResponse as UploadGetPresignedURLResponse, type UploadCompleteUploadParams as UploadCompleteUploadParams, type UploadGetPresignedURLParams as UploadGetPresignedURLParams, type UploadUploadFileParams as UploadUploadFileParams, type UploadUploadFileAndProcessParams as UploadUploadFileAndProcessParams, type UploadUploadFromURLParams as UploadUploadFromURLParams, type UploadUploadFromURLAndProcessParams as UploadUploadFromURLAndProcessParams, };
|
|
1364
800
|
export { Bulk as Bulk, type BulkMoveResponse as BulkMoveResponse, type BulkMoveParams as BulkMoveParams };
|
|
1365
801
|
}
|
|
1366
802
|
//# sourceMappingURL=materials.d.mts.map
|