@mixedbread/sdk 0.31.0 → 0.31.1
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 +8 -0
- package/package.json +1 -1
- package/resources/stores/files.d.mts +46 -0
- package/resources/stores/files.d.mts.map +1 -1
- package/resources/stores/files.d.ts +46 -0
- package/resources/stores/files.d.ts.map +1 -1
- package/resources/stores/files.js +68 -0
- package/resources/stores/files.js.map +1 -1
- package/resources/stores/files.mjs +67 -0
- package/resources/stores/files.mjs.map +1 -1
- package/src/resources/stores/files.ts +104 -0
- 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
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.31.1 (2025-10-01)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.31.0...v0.31.1](https://github.com/mixedbread-ai/mixedbread-ts/compare/v0.31.0...v0.31.1)
|
|
6
|
+
|
|
7
|
+
### Chores
|
|
8
|
+
|
|
9
|
+
* allow the store to be pulled ([ff53f58](https://github.com/mixedbread-ai/mixedbread-ts/commit/ff53f58723326550249c4bcfe6b67bed88c0e0e6))
|
|
10
|
+
|
|
3
11
|
## 0.31.0 (2025-10-01)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v0.30.0...v0.31.0](https://github.com/mixedbread-ai/mixedbread-ts/compare/v0.30.0...v0.31.0)
|
package/package.json
CHANGED
|
@@ -4,6 +4,7 @@ import * as VectorStoresFilesAPI from "../vector-stores/files.mjs";
|
|
|
4
4
|
import * as VectorStoresAPI from "../vector-stores/vector-stores.mjs";
|
|
5
5
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
6
6
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
7
|
+
import { Uploadable } from "../../uploads.mjs";
|
|
7
8
|
export declare class Files extends APIResource {
|
|
8
9
|
/**
|
|
9
10
|
* Upload a file to a store.
|
|
@@ -51,6 +52,51 @@ export declare class Files extends APIResource {
|
|
|
51
52
|
* Returns: StoreFileSearchResponse: List of matching files with relevance scores
|
|
52
53
|
*/
|
|
53
54
|
search(body: FileSearchParams, options?: RequestOptions): APIPromise<FileSearchResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Poll for a file's processing status until it reaches a terminal state.
|
|
57
|
+
*
|
|
58
|
+
* @param storeIdentifier - The identifier of the store
|
|
59
|
+
* @param fileId - The ID of the file to poll
|
|
60
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
61
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
62
|
+
* @param options - Additional request options
|
|
63
|
+
* @returns The file object once it reaches a terminal state
|
|
64
|
+
*/
|
|
65
|
+
poll(storeIdentifier: string, fileId: string, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<StoreFile>;
|
|
66
|
+
/**
|
|
67
|
+
* Create a file in a vector store and wait for it to be processed.
|
|
68
|
+
*
|
|
69
|
+
* @param storeIdentifier - The identifier of the store to upload to
|
|
70
|
+
* @param body - The file creation parameters
|
|
71
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
72
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
73
|
+
* @param options - Additional request options
|
|
74
|
+
* @returns The file object once it reaches a terminal state
|
|
75
|
+
*/
|
|
76
|
+
createAndPoll(storeIdentifier: string, body: FileCreateParams, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<StoreFile>;
|
|
77
|
+
/**
|
|
78
|
+
* Upload a file to the files API and then create a file in a vector store.
|
|
79
|
+
* Note the file will be asynchronously processed.
|
|
80
|
+
*
|
|
81
|
+
* @param storeIdentifier - The identifier of the store to add the file to
|
|
82
|
+
* @param file - The file to upload
|
|
83
|
+
* @param body - Additional parameters for the vector store file
|
|
84
|
+
* @param options - Additional request options
|
|
85
|
+
* @returns The created vector store file
|
|
86
|
+
*/
|
|
87
|
+
upload(storeIdentifier: string, file: Uploadable, body?: Omit<FileCreateParams, 'file_id'>, options?: RequestOptions): Promise<StoreFile>;
|
|
88
|
+
/**
|
|
89
|
+
* Upload a file to files API, create a file in a vector store, and poll until processing is complete.
|
|
90
|
+
*
|
|
91
|
+
* @param storeIdentifier - The identifier of the store to add the file to
|
|
92
|
+
* @param file - The file to upload
|
|
93
|
+
* @param body - Additional parameters for the vector store file
|
|
94
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
95
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
96
|
+
* @param options - Additional request options
|
|
97
|
+
* @returns The vector store file object once it reaches a terminal state
|
|
98
|
+
*/
|
|
99
|
+
uploadAndPoll(storeIdentifier: string, file: Uploadable, body?: Omit<FileCreateParams, 'file_id'>, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<StoreFile>;
|
|
54
100
|
}
|
|
55
101
|
/**
|
|
56
102
|
* Represents a scored store file.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.d.mts","sourceRoot":"","sources":["../../src/resources/stores/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,oBAAoB;OACzB,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;
|
|
1
|
+
{"version":3,"file":"files.d.mts","sourceRoot":"","sources":["../../src/resources/stores/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,oBAAoB;OACzB,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;OAElB,EAAE,UAAU,EAAE;AAGrB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;OAOG;IACH,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIxG;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAKrG;;;;;;;OAOG;IACH,IAAI,CACF,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,cAAc,EACpB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAK1G;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAKxF;;;;;;;;;OASG;IACG,IAAI,CACR,eAAe,EAAE,MAAM,EACvB,MAAM,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;IAarB;;;;;;;;;OASG;IACG,aAAa,CACjB,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,gBAAgB,EACtB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;IAKrB;;;;;;;;;OASG;IACG,MAAM,CACV,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,UAAU,EAChB,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;IAarB;;;;;;;;;;OAUG;IACG,aAAa,CACjB,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,UAAU,EAChB,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,EACxC,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;CAItB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,eAAe,CAAC,oBAAoB,GACpC,eAAe,CAAC,wBAAwB,GACxC,eAAe,CAAC,wBAAwB,GACxC,eAAe,CAAC,wBAAwB,CAC3C,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CACV,SAAS,CAAC,cAAc,GACxB,SAAS,CAAC,kBAAkB,GAC5B,SAAS,CAAC,kBAAkB,GAC5B,SAAS,CAAC,kBAAkB,CAC/B,GAAG,IAAI,CAAC;CACV;AAED,yBAAiB,SAAS,CAAC;IACzB,UAAiB,cAAc;QAC7B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,kBAAkB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,kBAAkB;QACjC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,kBAAkB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC;QAEnB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,EAAE,kBAAkB,CAAC,QAAQ,CAAC;KACxC;IAED,UAAiB,kBAAkB,CAAC;QAClC;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB;KACF;IAED,UAAiB,kBAAkB;QACjC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,kBAAkB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC;QAEnB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,EAAE,kBAAkB,CAAC,QAAQ,CAAC;QAEvC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,kBAAkB,CAAC;QAClC;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;IAED,UAAiB,kBAAkB;QACjC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,kBAAkB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC;QAEnB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,EAAE,kBAAkB,CAAC,QAAQ,CAAC;KACxC;IAED,UAAiB,kBAAkB,CAAC;QAClC;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC,UAAU,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CACxB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;;WAIG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;;WAGG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAE7C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;QAE3C;;WAEG;QACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EACZ,MAAM,CAAC,YAAY,GACnB,MAAM,CAAC,qBAAqB,GAC5B,KAAK,CAAC,MAAM,CAAC,YAAY,GAAG,MAAM,CAAC,qBAAqB,CAAC,GACzD,IAAI,CAAC;CACV;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EACJ,MAAM,CAAC,YAAY,GACnB,MAAM,CAAC,qBAAqB,GAC5B,KAAK,CAAC,MAAM,CAAC,YAAY,GAAG,MAAM,CAAC,qBAAqB,CAAC,GACzD,IAAI,CAAC;IAET;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC;CACjD;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,GAAG,oBAAoB,CAAC,YAAY,GAAG,IAAI,CAAC;QAE5D;;WAEG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
|
@@ -4,6 +4,7 @@ import * as VectorStoresFilesAPI from "../vector-stores/files.js";
|
|
|
4
4
|
import * as VectorStoresAPI from "../vector-stores/vector-stores.js";
|
|
5
5
|
import { APIPromise } from "../../core/api-promise.js";
|
|
6
6
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
7
|
+
import { Uploadable } from "../../uploads.js";
|
|
7
8
|
export declare class Files extends APIResource {
|
|
8
9
|
/**
|
|
9
10
|
* Upload a file to a store.
|
|
@@ -51,6 +52,51 @@ export declare class Files extends APIResource {
|
|
|
51
52
|
* Returns: StoreFileSearchResponse: List of matching files with relevance scores
|
|
52
53
|
*/
|
|
53
54
|
search(body: FileSearchParams, options?: RequestOptions): APIPromise<FileSearchResponse>;
|
|
55
|
+
/**
|
|
56
|
+
* Poll for a file's processing status until it reaches a terminal state.
|
|
57
|
+
*
|
|
58
|
+
* @param storeIdentifier - The identifier of the store
|
|
59
|
+
* @param fileId - The ID of the file to poll
|
|
60
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
61
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
62
|
+
* @param options - Additional request options
|
|
63
|
+
* @returns The file object once it reaches a terminal state
|
|
64
|
+
*/
|
|
65
|
+
poll(storeIdentifier: string, fileId: string, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<StoreFile>;
|
|
66
|
+
/**
|
|
67
|
+
* Create a file in a vector store and wait for it to be processed.
|
|
68
|
+
*
|
|
69
|
+
* @param storeIdentifier - The identifier of the store to upload to
|
|
70
|
+
* @param body - The file creation parameters
|
|
71
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
72
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
73
|
+
* @param options - Additional request options
|
|
74
|
+
* @returns The file object once it reaches a terminal state
|
|
75
|
+
*/
|
|
76
|
+
createAndPoll(storeIdentifier: string, body: FileCreateParams, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<StoreFile>;
|
|
77
|
+
/**
|
|
78
|
+
* Upload a file to the files API and then create a file in a vector store.
|
|
79
|
+
* Note the file will be asynchronously processed.
|
|
80
|
+
*
|
|
81
|
+
* @param storeIdentifier - The identifier of the store to add the file to
|
|
82
|
+
* @param file - The file to upload
|
|
83
|
+
* @param body - Additional parameters for the vector store file
|
|
84
|
+
* @param options - Additional request options
|
|
85
|
+
* @returns The created vector store file
|
|
86
|
+
*/
|
|
87
|
+
upload(storeIdentifier: string, file: Uploadable, body?: Omit<FileCreateParams, 'file_id'>, options?: RequestOptions): Promise<StoreFile>;
|
|
88
|
+
/**
|
|
89
|
+
* Upload a file to files API, create a file in a vector store, and poll until processing is complete.
|
|
90
|
+
*
|
|
91
|
+
* @param storeIdentifier - The identifier of the store to add the file to
|
|
92
|
+
* @param file - The file to upload
|
|
93
|
+
* @param body - Additional parameters for the vector store file
|
|
94
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
95
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
96
|
+
* @param options - Additional request options
|
|
97
|
+
* @returns The vector store file object once it reaches a terminal state
|
|
98
|
+
*/
|
|
99
|
+
uploadAndPoll(storeIdentifier: string, file: Uploadable, body?: Omit<FileCreateParams, 'file_id'>, pollIntervalMs?: number, pollTimeoutMs?: number, options?: RequestOptions): Promise<StoreFile>;
|
|
54
100
|
}
|
|
55
101
|
/**
|
|
56
102
|
* Represents a scored store file.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../src/resources/stores/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,oBAAoB;OACzB,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;
|
|
1
|
+
{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../src/resources/stores/files.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,oBAAoB;OACzB,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;OAElB,EAAE,UAAU,EAAE;AAGrB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;OAOG;IACH,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAIxG;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IAKrG;;;;;;;OAOG;IACH,IAAI,CACF,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,cAAc,EACpB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAK1G;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAKxF;;;;;;;;;OASG;IACG,IAAI,CACR,eAAe,EAAE,MAAM,EACvB,MAAM,EAAE,MAAM,EACd,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;IAarB;;;;;;;;;OASG;IACG,aAAa,CACjB,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,gBAAgB,EACtB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;IAKrB;;;;;;;;;OASG;IACG,MAAM,CACV,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,UAAU,EAChB,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;IAarB;;;;;;;;;;OAUG;IACG,aAAa,CACjB,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,UAAU,EAChB,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,EACxC,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;CAItB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,KAAK,CACT,eAAe,CAAC,oBAAoB,GACpC,eAAe,CAAC,wBAAwB,GACxC,eAAe,CAAC,wBAAwB,GACxC,eAAe,CAAC,wBAAwB,CAC3C,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CACV,SAAS,CAAC,cAAc,GACxB,SAAS,CAAC,kBAAkB,GAC5B,SAAS,CAAC,kBAAkB,GAC5B,SAAS,CAAC,kBAAkB,CAC/B,GAAG,IAAI,CAAC;CACV;AAED,yBAAiB,SAAS,CAAC;IACzB,UAAiB,cAAc;QAC7B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,kBAAkB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,kBAAkB;QACjC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,kBAAkB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC;QAEnB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,EAAE,kBAAkB,CAAC,QAAQ,CAAC;KACxC;IAED,UAAiB,kBAAkB,CAAC;QAClC;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB;KACF;IAED,UAAiB,kBAAkB;QACjC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,kBAAkB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC;QAEnB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,EAAE,kBAAkB,CAAC,QAAQ,CAAC;QAEvC;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,kBAAkB,CAAC;QAClC;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;IAED,UAAiB,kBAAkB;QACjC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,kBAAkB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC;QAEnB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,EAAE,kBAAkB,CAAC,QAAQ,CAAC;KACxC;IAED,UAAiB,kBAAkB,CAAC;QAClC;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC,UAAU,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CACxB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,UAAU;QACzB;;;;WAIG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;;WAGG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC;IAE7C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;QAE3C;;WAEG;QACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EACZ,MAAM,CAAC,YAAY,GACnB,MAAM,CAAC,qBAAqB,GAC5B,KAAK,CAAC,MAAM,CAAC,YAAY,GAAG,MAAM,CAAC,qBAAqB,CAAC,GACzD,IAAI,CAAC;CACV;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EACJ,MAAM,CAAC,YAAY,GACnB,MAAM,CAAC,qBAAqB,GAC5B,KAAK,CAAC,MAAM,CAAC,YAAY,GAAG,MAAM,CAAC,qBAAqB,CAAC,GACzD,IAAI,CAAC;IAET;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEjD;;OAEG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC;CACjD;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,GAAG,oBAAoB,CAAC,YAAY,GAAG,IAAI,CAAC;QAE5D;;WAEG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.Files = void 0;
|
|
5
|
+
const tslib_1 = require("../../internal/tslib.js");
|
|
5
6
|
const resource_1 = require("../../core/resource.js");
|
|
7
|
+
const polling = tslib_1.__importStar(require("../../lib/polling.js"));
|
|
6
8
|
const path_1 = require("../../internal/utils/path.js");
|
|
7
9
|
class Files extends resource_1.APIResource {
|
|
8
10
|
/**
|
|
@@ -63,6 +65,72 @@ class Files extends resource_1.APIResource {
|
|
|
63
65
|
search(body, options) {
|
|
64
66
|
return this._client.post('/v1/stores/files/search', { body, ...options });
|
|
65
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* Poll for a file's processing status until it reaches a terminal state.
|
|
70
|
+
*
|
|
71
|
+
* @param storeIdentifier - The identifier of the store
|
|
72
|
+
* @param fileId - The ID of the file to poll
|
|
73
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
74
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
75
|
+
* @param options - Additional request options
|
|
76
|
+
* @returns The file object once it reaches a terminal state
|
|
77
|
+
*/
|
|
78
|
+
async poll(storeIdentifier, fileId, pollIntervalMs, pollTimeoutMs, options) {
|
|
79
|
+
const pollingIntervalMs = pollIntervalMs || 500;
|
|
80
|
+
const pollingTimeoutMs = pollTimeoutMs;
|
|
81
|
+
return polling.poll({
|
|
82
|
+
fn: () => this.retrieve(fileId, { store_identifier: storeIdentifier, ...options }),
|
|
83
|
+
condition: (result) => result.status === 'completed' || result.status === 'failed' || result.status === 'cancelled',
|
|
84
|
+
intervalSeconds: pollingIntervalMs / 1000,
|
|
85
|
+
...(pollingTimeoutMs && { timeoutSeconds: pollingTimeoutMs / 1000 }),
|
|
86
|
+
});
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Create a file in a vector store and wait for it to be processed.
|
|
90
|
+
*
|
|
91
|
+
* @param storeIdentifier - The identifier of the store to upload to
|
|
92
|
+
* @param body - The file creation parameters
|
|
93
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
94
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
95
|
+
* @param options - Additional request options
|
|
96
|
+
* @returns The file object once it reaches a terminal state
|
|
97
|
+
*/
|
|
98
|
+
async createAndPoll(storeIdentifier, body, pollIntervalMs, pollTimeoutMs, options) {
|
|
99
|
+
const file = await this.create(storeIdentifier, body, options);
|
|
100
|
+
return this.poll(storeIdentifier, file.id, pollIntervalMs, pollTimeoutMs, options);
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Upload a file to the files API and then create a file in a vector store.
|
|
104
|
+
* Note the file will be asynchronously processed.
|
|
105
|
+
*
|
|
106
|
+
* @param storeIdentifier - The identifier of the store to add the file to
|
|
107
|
+
* @param file - The file to upload
|
|
108
|
+
* @param body - Additional parameters for the vector store file
|
|
109
|
+
* @param options - Additional request options
|
|
110
|
+
* @returns The created vector store file
|
|
111
|
+
*/
|
|
112
|
+
async upload(storeIdentifier, file, body, options) {
|
|
113
|
+
const fileUploadResponse = await this._client.files.create({ file }, options);
|
|
114
|
+
return this.create(storeIdentifier, {
|
|
115
|
+
file_id: fileUploadResponse.id,
|
|
116
|
+
...body,
|
|
117
|
+
}, options);
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Upload a file to files API, create a file in a vector store, and poll until processing is complete.
|
|
121
|
+
*
|
|
122
|
+
* @param storeIdentifier - The identifier of the store to add the file to
|
|
123
|
+
* @param file - The file to upload
|
|
124
|
+
* @param body - Additional parameters for the vector store file
|
|
125
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
126
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
127
|
+
* @param options - Additional request options
|
|
128
|
+
* @returns The vector store file object once it reaches a terminal state
|
|
129
|
+
*/
|
|
130
|
+
async uploadAndPoll(storeIdentifier, file, body, pollIntervalMs, pollTimeoutMs, options) {
|
|
131
|
+
const vectorStoreFile = await this.upload(storeIdentifier, file, body, options);
|
|
132
|
+
return this.poll(storeIdentifier, vectorStoreFile.id, pollIntervalMs, pollTimeoutMs, options);
|
|
133
|
+
}
|
|
66
134
|
}
|
|
67
135
|
exports.Files = Files;
|
|
68
136
|
//# sourceMappingURL=files.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.js","sourceRoot":"","sources":["../../src/resources/stores/files.ts"],"names":[],"mappings":";AAAA,sFAAsF
|
|
1
|
+
{"version":3,"file":"files.js","sourceRoot":"","sources":["../../src/resources/stores/files.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAMlD,sEAA6C;AAE7C,uDAAiD;AAEjD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;OAOG;IACH,MAAM,CAAC,eAAuB,EAAE,IAAsB,EAAE,OAAwB;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,cAAc,eAAe,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAc,EAAE,MAA0B,EAAE,OAAwB;QAC3E,MAAM,EAAE,gBAAgB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,gBAAgB,UAAU,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,eAAuB,EACvB,IAAoB,EACpB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,cAAc,eAAe,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAc,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,cAAc,gBAAgB,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAGD;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,CACR,eAAuB,EACvB,MAAc,EACd,cAAuB,EACvB,aAAsB,EACtB,OAAwB;QAExB,MAAM,iBAAiB,GAAG,cAAc,IAAI,GAAG,CAAC;QAChD,MAAM,gBAAgB,GAAG,aAAa,CAAC;QAEvC,OAAO,OAAO,CAAC,IAAI,CAAC;YAClB,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,gBAAgB,EAAE,eAAe,EAAE,GAAG,OAAO,EAAE,CAAC;YAClF,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CACpB,MAAM,CAAC,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW;YAC9F,eAAe,EAAE,iBAAiB,GAAG,IAAI;YACzC,GAAG,CAAC,gBAAgB,IAAI,EAAE,cAAc,EAAE,gBAAgB,GAAG,IAAI,EAAE,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,eAAuB,EACvB,IAAsB,EACtB,cAAuB,EACvB,aAAsB,EACtB,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/D,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CACV,eAAuB,EACvB,IAAgB,EAChB,IAAwC,EACxC,OAAwB;QAExB,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAE9E,OAAO,IAAI,CAAC,MAAM,CAChB,eAAe,EACf;YACE,OAAO,EAAE,kBAAkB,CAAC,EAAE;YAC9B,GAAG,IAAI;SACR,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CACjB,eAAuB,EACvB,IAAgB,EAChB,IAAwC,EACxC,cAAuB,EACvB,aAAsB,EACtB,OAAwB;QAExB,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAChF,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,eAAe,CAAC,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF;AAzKD,sBAyKC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import * as polling from "../../lib/polling.mjs";
|
|
3
4
|
import { path } from "../../internal/utils/path.mjs";
|
|
4
5
|
export class Files extends APIResource {
|
|
5
6
|
/**
|
|
@@ -60,5 +61,71 @@ export class Files extends APIResource {
|
|
|
60
61
|
search(body, options) {
|
|
61
62
|
return this._client.post('/v1/stores/files/search', { body, ...options });
|
|
62
63
|
}
|
|
64
|
+
/**
|
|
65
|
+
* Poll for a file's processing status until it reaches a terminal state.
|
|
66
|
+
*
|
|
67
|
+
* @param storeIdentifier - The identifier of the store
|
|
68
|
+
* @param fileId - The ID of the file to poll
|
|
69
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
70
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
71
|
+
* @param options - Additional request options
|
|
72
|
+
* @returns The file object once it reaches a terminal state
|
|
73
|
+
*/
|
|
74
|
+
async poll(storeIdentifier, fileId, pollIntervalMs, pollTimeoutMs, options) {
|
|
75
|
+
const pollingIntervalMs = pollIntervalMs || 500;
|
|
76
|
+
const pollingTimeoutMs = pollTimeoutMs;
|
|
77
|
+
return polling.poll({
|
|
78
|
+
fn: () => this.retrieve(fileId, { store_identifier: storeIdentifier, ...options }),
|
|
79
|
+
condition: (result) => result.status === 'completed' || result.status === 'failed' || result.status === 'cancelled',
|
|
80
|
+
intervalSeconds: pollingIntervalMs / 1000,
|
|
81
|
+
...(pollingTimeoutMs && { timeoutSeconds: pollingTimeoutMs / 1000 }),
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
/**
|
|
85
|
+
* Create a file in a vector store and wait for it to be processed.
|
|
86
|
+
*
|
|
87
|
+
* @param storeIdentifier - The identifier of the store to upload to
|
|
88
|
+
* @param body - The file creation parameters
|
|
89
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
90
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
91
|
+
* @param options - Additional request options
|
|
92
|
+
* @returns The file object once it reaches a terminal state
|
|
93
|
+
*/
|
|
94
|
+
async createAndPoll(storeIdentifier, body, pollIntervalMs, pollTimeoutMs, options) {
|
|
95
|
+
const file = await this.create(storeIdentifier, body, options);
|
|
96
|
+
return this.poll(storeIdentifier, file.id, pollIntervalMs, pollTimeoutMs, options);
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Upload a file to the files API and then create a file in a vector store.
|
|
100
|
+
* Note the file will be asynchronously processed.
|
|
101
|
+
*
|
|
102
|
+
* @param storeIdentifier - The identifier of the store to add the file to
|
|
103
|
+
* @param file - The file to upload
|
|
104
|
+
* @param body - Additional parameters for the vector store file
|
|
105
|
+
* @param options - Additional request options
|
|
106
|
+
* @returns The created vector store file
|
|
107
|
+
*/
|
|
108
|
+
async upload(storeIdentifier, file, body, options) {
|
|
109
|
+
const fileUploadResponse = await this._client.files.create({ file }, options);
|
|
110
|
+
return this.create(storeIdentifier, {
|
|
111
|
+
file_id: fileUploadResponse.id,
|
|
112
|
+
...body,
|
|
113
|
+
}, options);
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* Upload a file to files API, create a file in a vector store, and poll until processing is complete.
|
|
117
|
+
*
|
|
118
|
+
* @param storeIdentifier - The identifier of the store to add the file to
|
|
119
|
+
* @param file - The file to upload
|
|
120
|
+
* @param body - Additional parameters for the vector store file
|
|
121
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
122
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
123
|
+
* @param options - Additional request options
|
|
124
|
+
* @returns The vector store file object once it reaches a terminal state
|
|
125
|
+
*/
|
|
126
|
+
async uploadAndPoll(storeIdentifier, file, body, pollIntervalMs, pollTimeoutMs, options) {
|
|
127
|
+
const vectorStoreFile = await this.upload(storeIdentifier, file, body, options);
|
|
128
|
+
return this.poll(storeIdentifier, vectorStoreFile.id, pollIntervalMs, pollTimeoutMs, options);
|
|
129
|
+
}
|
|
63
130
|
}
|
|
64
131
|
//# sourceMappingURL=files.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"files.mjs","sourceRoot":"","sources":["../../src/resources/stores/files.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAMf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;OAOG;IACH,MAAM,CAAC,eAAuB,EAAE,IAAsB,EAAE,OAAwB;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,cAAc,eAAe,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAc,EAAE,MAA0B,EAAE,OAAwB;QAC3E,MAAM,EAAE,gBAAgB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,gBAAgB,UAAU,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,eAAuB,EACvB,IAAoB,EACpB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,cAAc,eAAe,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAc,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,cAAc,gBAAgB,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF"}
|
|
1
|
+
{"version":3,"file":"files.mjs","sourceRoot":"","sources":["../../src/resources/stores/files.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAMf,KAAK,OAAO;OAEZ,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;OAOG;IACH,MAAM,CAAC,eAAuB,EAAE,IAAsB,EAAE,OAAwB;QAC9E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,cAAc,eAAe,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAc,EAAE,MAA0B,EAAE,OAAwB;QAC3E,MAAM,EAAE,gBAAgB,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,gBAAgB,UAAU,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,eAAuB,EACvB,IAAoB,EACpB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,cAAc,eAAe,aAAa,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjG,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAc,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,cAAc,gBAAgB,UAAU,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAGD;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,CACR,eAAuB,EACvB,MAAc,EACd,cAAuB,EACvB,aAAsB,EACtB,OAAwB;QAExB,MAAM,iBAAiB,GAAG,cAAc,IAAI,GAAG,CAAC;QAChD,MAAM,gBAAgB,GAAG,aAAa,CAAC;QAEvC,OAAO,OAAO,CAAC,IAAI,CAAC;YAClB,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,gBAAgB,EAAE,eAAe,EAAE,GAAG,OAAO,EAAE,CAAC;YAClF,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,CACpB,MAAM,CAAC,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW;YAC9F,eAAe,EAAE,iBAAiB,GAAG,IAAI;YACzC,GAAG,CAAC,gBAAgB,IAAI,EAAE,cAAc,EAAE,gBAAgB,GAAG,IAAI,EAAE,CAAC;SACrE,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa,CACjB,eAAuB,EACvB,IAAsB,EACtB,cAAuB,EACvB,aAAsB,EACtB,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC/D,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CACV,eAAuB,EACvB,IAAgB,EAChB,IAAwC,EACxC,OAAwB;QAExB,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QAE9E,OAAO,IAAI,CAAC,MAAM,CAChB,eAAe,EACf;YACE,OAAO,EAAE,kBAAkB,CAAC,EAAE;YAC9B,GAAG,IAAI;SACR,EACD,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa,CACjB,eAAuB,EACvB,IAAgB,EAChB,IAAwC,EACxC,cAAuB,EACvB,aAAsB,EACtB,OAAwB;QAExB,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAChF,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,eAAe,CAAC,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;CACF"}
|
|
@@ -6,6 +6,8 @@ import * as VectorStoresFilesAPI from '../vector-stores/files';
|
|
|
6
6
|
import * as VectorStoresAPI from '../vector-stores/vector-stores';
|
|
7
7
|
import { APIPromise } from '../../core/api-promise';
|
|
8
8
|
import { RequestOptions } from '../../internal/request-options';
|
|
9
|
+
import * as polling from '../../lib/polling';
|
|
10
|
+
import { Uploadable } from '../../uploads';
|
|
9
11
|
import { path } from '../../internal/utils/path';
|
|
10
12
|
|
|
11
13
|
export class Files extends APIResource {
|
|
@@ -75,6 +77,108 @@ export class Files extends APIResource {
|
|
|
75
77
|
search(body: FileSearchParams, options?: RequestOptions): APIPromise<FileSearchResponse> {
|
|
76
78
|
return this._client.post('/v1/stores/files/search', { body, ...options });
|
|
77
79
|
}
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Poll for a file's processing status until it reaches a terminal state.
|
|
84
|
+
*
|
|
85
|
+
* @param storeIdentifier - The identifier of the store
|
|
86
|
+
* @param fileId - The ID of the file to poll
|
|
87
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
88
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
89
|
+
* @param options - Additional request options
|
|
90
|
+
* @returns The file object once it reaches a terminal state
|
|
91
|
+
*/
|
|
92
|
+
async poll(
|
|
93
|
+
storeIdentifier: string,
|
|
94
|
+
fileId: string,
|
|
95
|
+
pollIntervalMs?: number,
|
|
96
|
+
pollTimeoutMs?: number,
|
|
97
|
+
options?: RequestOptions,
|
|
98
|
+
): Promise<StoreFile> {
|
|
99
|
+
const pollingIntervalMs = pollIntervalMs || 500;
|
|
100
|
+
const pollingTimeoutMs = pollTimeoutMs;
|
|
101
|
+
|
|
102
|
+
return polling.poll({
|
|
103
|
+
fn: () => this.retrieve(fileId, { store_identifier: storeIdentifier, ...options }),
|
|
104
|
+
condition: (result) =>
|
|
105
|
+
result.status === 'completed' || result.status === 'failed' || result.status === 'cancelled',
|
|
106
|
+
intervalSeconds: pollingIntervalMs / 1000,
|
|
107
|
+
...(pollingTimeoutMs && { timeoutSeconds: pollingTimeoutMs / 1000 }),
|
|
108
|
+
});
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* Create a file in a vector store and wait for it to be processed.
|
|
113
|
+
*
|
|
114
|
+
* @param storeIdentifier - The identifier of the store to upload to
|
|
115
|
+
* @param body - The file creation parameters
|
|
116
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
117
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
118
|
+
* @param options - Additional request options
|
|
119
|
+
* @returns The file object once it reaches a terminal state
|
|
120
|
+
*/
|
|
121
|
+
async createAndPoll(
|
|
122
|
+
storeIdentifier: string,
|
|
123
|
+
body: FileCreateParams,
|
|
124
|
+
pollIntervalMs?: number,
|
|
125
|
+
pollTimeoutMs?: number,
|
|
126
|
+
options?: RequestOptions,
|
|
127
|
+
): Promise<StoreFile> {
|
|
128
|
+
const file = await this.create(storeIdentifier, body, options);
|
|
129
|
+
return this.poll(storeIdentifier, file.id, pollIntervalMs, pollTimeoutMs, options);
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* Upload a file to the files API and then create a file in a vector store.
|
|
134
|
+
* Note the file will be asynchronously processed.
|
|
135
|
+
*
|
|
136
|
+
* @param storeIdentifier - The identifier of the store to add the file to
|
|
137
|
+
* @param file - The file to upload
|
|
138
|
+
* @param body - Additional parameters for the vector store file
|
|
139
|
+
* @param options - Additional request options
|
|
140
|
+
* @returns The created vector store file
|
|
141
|
+
*/
|
|
142
|
+
async upload(
|
|
143
|
+
storeIdentifier: string,
|
|
144
|
+
file: Uploadable,
|
|
145
|
+
body?: Omit<FileCreateParams, 'file_id'>,
|
|
146
|
+
options?: RequestOptions,
|
|
147
|
+
): Promise<StoreFile> {
|
|
148
|
+
const fileUploadResponse = await this._client.files.create({ file }, options);
|
|
149
|
+
|
|
150
|
+
return this.create(
|
|
151
|
+
storeIdentifier,
|
|
152
|
+
{
|
|
153
|
+
file_id: fileUploadResponse.id,
|
|
154
|
+
...body,
|
|
155
|
+
},
|
|
156
|
+
options,
|
|
157
|
+
);
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* Upload a file to files API, create a file in a vector store, and poll until processing is complete.
|
|
162
|
+
*
|
|
163
|
+
* @param storeIdentifier - The identifier of the store to add the file to
|
|
164
|
+
* @param file - The file to upload
|
|
165
|
+
* @param body - Additional parameters for the vector store file
|
|
166
|
+
* @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
|
|
167
|
+
* @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
|
|
168
|
+
* @param options - Additional request options
|
|
169
|
+
* @returns The vector store file object once it reaches a terminal state
|
|
170
|
+
*/
|
|
171
|
+
async uploadAndPoll(
|
|
172
|
+
storeIdentifier: string,
|
|
173
|
+
file: Uploadable,
|
|
174
|
+
body?: Omit<FileCreateParams, 'file_id'>,
|
|
175
|
+
pollIntervalMs?: number,
|
|
176
|
+
pollTimeoutMs?: number,
|
|
177
|
+
options?: RequestOptions,
|
|
178
|
+
): Promise<StoreFile> {
|
|
179
|
+
const vectorStoreFile = await this.upload(storeIdentifier, file, body, options);
|
|
180
|
+
return this.poll(storeIdentifier, vectorStoreFile.id, pollIntervalMs, pollTimeoutMs, options);
|
|
181
|
+
}
|
|
78
182
|
}
|
|
79
183
|
|
|
80
184
|
/**
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '0.31.
|
|
1
|
+
export const VERSION = '0.31.1'; // x-release-please-version
|
package/version.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.31.
|
|
1
|
+
export declare const VERSION = "0.31.1";
|
|
2
2
|
//# sourceMappingURL=version.d.mts.map
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "0.31.
|
|
1
|
+
export declare const VERSION = "0.31.1";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '0.31.
|
|
1
|
+
export const VERSION = '0.31.1'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|