@scenario-labs/sdk 0.3.0 → 1.1.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 +30 -0
- package/README.md +40 -8
- package/client.d.mts +36 -16
- package/client.d.mts.map +1 -1
- package/client.d.ts +36 -16
- package/client.d.ts.map +1 -1
- package/client.js +10 -0
- package/client.js.map +1 -1
- package/client.mjs +10 -0
- package/client.mjs.map +1 -1
- package/core/pagination.d.mts +153 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +153 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +276 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +263 -0
- package/core/pagination.mjs.map +1 -0
- package/index.d.mts +5 -1
- package/index.d.mts.map +1 -1
- package/index.d.ts +5 -1
- package/index.d.ts.map +1 -1
- package/index.js +14 -1
- package/index.js.map +1 -1
- package/index.mjs +5 -1
- package/index.mjs.map +1 -1
- package/lib/asset.d.mts +55 -0
- package/lib/asset.d.mts.map +1 -0
- package/lib/asset.d.ts +55 -0
- package/lib/asset.d.ts.map +1 -0
- package/lib/asset.js +60 -0
- package/lib/asset.js.map +1 -0
- package/lib/asset.mjs +54 -0
- package/lib/asset.mjs.map +1 -0
- package/lib/job.d.mts +13 -1
- package/lib/job.d.mts.map +1 -1
- package/lib/job.d.ts +13 -1
- package/lib/job.d.ts.map +1 -1
- package/lib/job.js +18 -1
- package/lib/job.js.map +1 -1
- package/lib/job.mjs +16 -0
- package/lib/job.mjs.map +1 -1
- package/lib/models.d.mts +34 -2
- package/lib/models.d.mts.map +1 -1
- package/lib/models.d.ts +34 -2
- package/lib/models.d.ts.map +1 -1
- package/lib/models.js +39 -2
- package/lib/models.js.map +1 -1
- package/lib/models.mjs +37 -1
- package/lib/models.mjs.map +1 -1
- package/lib/scenario.d.mts +14 -0
- package/lib/scenario.d.mts.map +1 -1
- package/lib/scenario.d.ts +14 -0
- package/lib/scenario.d.ts.map +1 -1
- package/lib/scenario.js +14 -0
- package/lib/scenario.js.map +1 -1
- package/lib/scenario.mjs +14 -0
- package/lib/scenario.mjs.map +1 -1
- package/lib/upload.d.mts +143 -0
- package/lib/upload.d.mts.map +1 -0
- package/lib/upload.d.ts +143 -0
- package/lib/upload.d.ts.map +1 -0
- package/lib/upload.js +242 -0
- package/lib/upload.js.map +1 -0
- package/lib/upload.mjs +203 -0
- package/lib/upload.mjs.map +1 -0
- package/lib/workflow.d.mts +13 -2
- package/lib/workflow.d.mts.map +1 -1
- package/lib/workflow.d.ts +13 -2
- package/lib/workflow.d.ts.map +1 -1
- package/lib/workflow.js +17 -4
- package/lib/workflow.js.map +1 -1
- package/lib/workflow.mjs +17 -4
- package/lib/workflow.mjs.map +1 -1
- package/lib/workflow_import_validator.d.mts +40 -0
- package/lib/workflow_import_validator.d.mts.map +1 -0
- package/lib/workflow_import_validator.d.ts +40 -0
- package/lib/workflow_import_validator.d.ts.map +1 -0
- package/lib/workflow_import_validator.js +69 -0
- package/lib/workflow_import_validator.js.map +1 -0
- package/lib/workflow_import_validator.mjs +64 -0
- package/lib/workflow_import_validator.mjs.map +1 -0
- package/package.json +11 -1
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -0
- package/resources/assets/assets.d.mts +646 -669
- package/resources/assets/assets.d.mts.map +1 -1
- package/resources/assets/assets.d.ts +646 -669
- package/resources/assets/assets.d.ts.map +1 -1
- package/resources/assets/assets.js +3 -2
- package/resources/assets/assets.js.map +1 -1
- package/resources/assets/assets.mjs +3 -2
- package/resources/assets/assets.mjs.map +1 -1
- package/resources/assets/index.d.mts +1 -1
- package/resources/assets/index.d.mts.map +1 -1
- package/resources/assets/index.d.ts +1 -1
- package/resources/assets/index.d.ts.map +1 -1
- package/resources/assets/index.js.map +1 -1
- package/resources/assets/index.mjs.map +1 -1
- package/resources/assets/public.d.mts +12 -12
- package/resources/assets/public.d.mts.map +1 -1
- package/resources/assets/public.d.ts +12 -12
- package/resources/assets/public.d.ts.map +1 -1
- package/resources/collections/collections.d.mts +38 -49
- package/resources/collections/collections.d.mts.map +1 -1
- package/resources/collections/collections.d.ts +38 -49
- package/resources/collections/collections.d.ts.map +1 -1
- package/resources/collections/collections.js +5 -1
- package/resources/collections/collections.js.map +1 -1
- package/resources/collections/collections.mjs +5 -1
- package/resources/collections/collections.mjs.map +1 -1
- package/resources/collections/index.d.mts +1 -1
- package/resources/collections/index.d.mts.map +1 -1
- package/resources/collections/index.d.ts +1 -1
- package/resources/collections/index.d.ts.map +1 -1
- package/resources/collections/index.js.map +1 -1
- package/resources/collections/index.mjs.map +1 -1
- package/resources/generate.d.mts +1027 -242
- package/resources/generate.d.mts.map +1 -1
- package/resources/generate.d.ts +1027 -242
- package/resources/generate.d.ts.map +1 -1
- package/resources/generate.js +7 -0
- package/resources/generate.js.map +1 -1
- package/resources/generate.mjs +7 -0
- package/resources/generate.mjs.map +1 -1
- package/resources/index.d.mts +8 -8
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +8 -8
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/jobs.d.mts +369 -380
- package/resources/jobs.d.mts.map +1 -1
- package/resources/jobs.d.ts +369 -380
- package/resources/jobs.d.ts.map +1 -1
- package/resources/jobs.js +2 -1
- package/resources/jobs.js.map +1 -1
- package/resources/jobs.mjs +2 -1
- package/resources/jobs.mjs.map +1 -1
- package/resources/models/description.d.mts +2 -2
- package/resources/models/description.d.mts.map +1 -1
- package/resources/models/description.d.ts +2 -2
- package/resources/models/description.d.ts.map +1 -1
- package/resources/models/examples.d.mts +4 -4
- package/resources/models/examples.d.mts.map +1 -1
- package/resources/models/examples.d.ts +4 -4
- package/resources/models/examples.d.ts.map +1 -1
- package/resources/models/index.d.mts +1 -1
- package/resources/models/index.d.mts.map +1 -1
- package/resources/models/index.d.ts +1 -1
- package/resources/models/index.d.ts.map +1 -1
- package/resources/models/index.js.map +1 -1
- package/resources/models/index.mjs.map +1 -1
- package/resources/models/models.d.mts +845 -856
- package/resources/models/models.d.mts.map +1 -1
- package/resources/models/models.d.ts +845 -856
- package/resources/models/models.d.ts.map +1 -1
- package/resources/models/models.js +2 -1
- package/resources/models/models.js.map +1 -1
- package/resources/models/models.mjs +2 -1
- package/resources/models/models.mjs.map +1 -1
- package/resources/models/train.d.mts +2 -2
- package/resources/models/train.d.mts.map +1 -1
- package/resources/models/train.d.ts +2 -2
- package/resources/models/train.d.ts.map +1 -1
- package/resources/search.d.mts +215 -295
- package/resources/search.d.mts.map +1 -1
- package/resources/search.d.ts +215 -295
- package/resources/search.d.ts.map +1 -1
- package/resources/search.js +9 -2
- package/resources/search.js.map +1 -1
- package/resources/search.mjs +9 -2
- package/resources/search.mjs.map +1 -1
- package/resources/tags.d.mts +23 -35
- package/resources/tags.d.mts.map +1 -1
- package/resources/tags.d.ts +23 -35
- package/resources/tags.d.ts.map +1 -1
- package/resources/tags.js +2 -1
- package/resources/tags.js.map +1 -1
- package/resources/tags.mjs +2 -1
- package/resources/tags.mjs.map +1 -1
- package/resources/usages.d.mts +3 -3
- package/resources/usages.d.mts.map +1 -1
- package/resources/usages.d.ts +3 -3
- package/resources/usages.d.ts.map +1 -1
- package/resources/workflows.d.mts +688 -704
- package/resources/workflows.d.mts.map +1 -1
- package/resources/workflows.d.ts +688 -704
- package/resources/workflows.d.ts.map +1 -1
- package/resources/workflows.js +5 -1
- package/resources/workflows.js.map +1 -1
- package/resources/workflows.mjs +5 -1
- package/resources/workflows.mjs.map +1 -1
- package/src/client.ts +107 -2
- package/src/core/pagination.ts +497 -0
- package/src/index.ts +11 -1
- package/src/lib/asset.ts +85 -0
- package/src/lib/job.ts +28 -1
- package/src/lib/models.ts +62 -2
- package/src/lib/scenario.ts +14 -0
- package/src/lib/upload.ts +344 -0
- package/src/lib/workflow.ts +29 -4
- package/src/lib/workflow_import_validator.ts +104 -0
- package/src/pagination.ts +2 -0
- package/src/resources/assets/assets.ts +930 -909
- package/src/resources/assets/index.ts +2 -0
- package/src/resources/assets/public.ts +17 -7
- package/src/resources/collections/collections.ts +45 -54
- package/src/resources/collections/index.ts +1 -0
- package/src/resources/generate.ts +1227 -136
- package/src/resources/index.ts +11 -1
- package/src/resources/jobs.ts +613 -622
- package/src/resources/models/description.ts +4 -0
- package/src/resources/models/examples.ts +8 -0
- package/src/resources/models/index.ts +1 -0
- package/src/resources/models/models.ts +1066 -1064
- package/src/resources/models/train.ts +4 -0
- package/src/resources/search.ts +239 -327
- package/src/resources/tags.ts +32 -39
- package/src/resources/usages.ts +5 -0
- package/src/resources/workflows.ts +850 -864
- 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/index.mjs
CHANGED
|
@@ -3,10 +3,14 @@ export { Scenario as default } from "./lib/scenario.mjs";
|
|
|
3
3
|
export { toFile } from "./core/uploads.mjs";
|
|
4
4
|
export { APIPromise } from "./core/api-promise.mjs";
|
|
5
5
|
export { Scenario } from "./lib/scenario.mjs";
|
|
6
|
+
export { PagePromise } from "./core/pagination.mjs";
|
|
6
7
|
export { ScenarioError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./core/error.mjs";
|
|
7
|
-
export { Job } from "./lib/job.mjs";
|
|
8
|
+
export { EnhancedJobs, Job } from "./lib/job.mjs";
|
|
8
9
|
export { EnhancedWorkflows, WorkflowEntity } from "./lib/workflow.mjs";
|
|
9
10
|
export { validateWorkflowFlow } from "./lib/workflow_validator.mjs";
|
|
11
|
+
export { validateEditorInfo, WorkflowImportError, VALID_EDITOR_NODE_TYPES, } from "./lib/workflow_import_validator.mjs";
|
|
10
12
|
export { EnhancedGenerate } from "./lib/generate.mjs";
|
|
11
13
|
export { EnhancedModels, EnhancedTrain } from "./lib/models.mjs";
|
|
14
|
+
export { EnhancedUploads, Upload } from "./lib/upload.mjs";
|
|
15
|
+
export { EnhancedAssets, Asset } from "./lib/asset.mjs";
|
|
12
16
|
//# sourceMappingURL=index.mjs.map
|
package/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,QAAQ,IAAI,OAAO,EAAE;OAEvB,EAAmB,MAAM,EAAE;OAC3B,EAAE,UAAU,EAAE;OACd,EAAE,QAAQ,EAAE;OAEZ,EACL,aAAa,EACb,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB;OACM,EAAE,GAAG,EAAkC;
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,QAAQ,IAAI,OAAO,EAAE;OAEvB,EAAmB,MAAM,EAAE;OAC3B,EAAE,UAAU,EAAE;OACd,EAAE,QAAQ,EAAE;OAEZ,EAAE,WAAW,EAAE;OACf,EACL,aAAa,EACb,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB;OACM,EAAE,YAAY,EAAE,GAAG,EAAkC;OACrD,EAAE,iBAAiB,EAAE,cAAc,EAAE;OACrC,EAAE,oBAAoB,EAAE;OACxB,EACL,kBAAkB,EAClB,mBAAmB,EACnB,uBAAuB,GAGxB;OACM,EAAE,gBAAgB,EAAE;OACpB,EAAE,cAAc,EAAE,aAAa,EAAE;OACjC,EAAE,eAAe,EAAE,MAAM,EAA2C;OACpE,EAAE,cAAc,EAAE,KAAK,EAAkB"}
|
package/lib/asset.d.mts
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import type { APIPromise } from "../core/api-promise.mjs";
|
|
2
|
+
import type { RequestOptions } from "../internal/request-options.mjs";
|
|
3
|
+
import { Assets, type AssetRetrieveParams, type AssetRetrieveResponse, type AssetUpdateParams, type AssetUpdateResponse } from "../resources/assets/assets.mjs";
|
|
4
|
+
/** Asset methods added on top of the original asset fields. */
|
|
5
|
+
export declare class AssetMethods {
|
|
6
|
+
/**
|
|
7
|
+
* Fetch the asset's content as bytes, using the signed `url` field on the
|
|
8
|
+
* asset. Works in Node ≥18 and in browsers with no extra setup.
|
|
9
|
+
*
|
|
10
|
+
* This is a thin wrapper around `fetch(asset.url)` — use `asset.url`
|
|
11
|
+
* directly if you need streaming or a Response object.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const res = await client.assets.retrieve(assetId);
|
|
16
|
+
* const bytes = await res.asset.download();
|
|
17
|
+
* await fs.writeFile('out.png', bytes);
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
download(this: Asset): Promise<Uint8Array>;
|
|
21
|
+
/** @internal Create an Asset from raw asset data. */
|
|
22
|
+
static from(data: AssetRetrieveResponse['asset']): Asset;
|
|
23
|
+
}
|
|
24
|
+
/** An asset with all original fields plus `.download()`. */
|
|
25
|
+
export type Asset = AssetRetrieveResponse.Asset & AssetMethods;
|
|
26
|
+
export declare const Asset: typeof AssetMethods;
|
|
27
|
+
/**
|
|
28
|
+
* @internal Helper type: adds `.download()` to the `asset` field of a response.
|
|
29
|
+
* Uses intersection so the original response type is preserved — a `WithAsset<T>` is still assignable to `T`.
|
|
30
|
+
*/
|
|
31
|
+
export type WithAsset<T extends {
|
|
32
|
+
asset: unknown;
|
|
33
|
+
}> = T & {
|
|
34
|
+
asset: AssetMethods;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* @internal Wrap `_thenUnwrap` to replace `response.asset` with an enhanced Asset.
|
|
38
|
+
*/
|
|
39
|
+
export declare function enhanceAsset<T extends {
|
|
40
|
+
asset: {
|
|
41
|
+
id: string;
|
|
42
|
+
url: string;
|
|
43
|
+
};
|
|
44
|
+
}>(promise: APIPromise<T>): APIPromise<WithAsset<T>>;
|
|
45
|
+
/**
|
|
46
|
+
* Enhanced Assets resource.
|
|
47
|
+
* All original methods (and subresources like `download`, `public`) are
|
|
48
|
+
* inherited. `retrieve` and `update` responses' `asset` field gains a
|
|
49
|
+
* `.download()` helper for fetching the asset's bytes.
|
|
50
|
+
*/
|
|
51
|
+
export declare class EnhancedAssets extends Assets {
|
|
52
|
+
retrieve(assetID: string, query?: AssetRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<WithAsset<AssetRetrieveResponse>>;
|
|
53
|
+
update(assetID: string, params: AssetUpdateParams, options?: RequestOptions): APIPromise<WithAsset<AssetUpdateResponse>>;
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=asset.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"asset.d.mts","sourceRoot":"","sources":["../src/lib/asset.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,EACL,MAAM,EACN,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACzB;AAED,+DAA+D;AAC/D,qBAAa,YAAY;IACvB;;;;;;;;;;;;;OAaG;IACG,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;IAQhD,qDAAqD;IACrD,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,GAAG,KAAK;CAGzD;AAED,4DAA4D;AAC5D,MAAM,MAAM,KAAK,GAAG,qBAAqB,CAAC,KAAK,GAAG,YAAY,CAAC;AAC/D,eAAO,MAAM,KAAK,qBAAe,CAAC;AAElC;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS;IAAE,KAAK,EAAE,OAAO,CAAA;CAAE,IAAI,CAAC,GAAG;IAAE,KAAK,EAAE,YAAY,CAAA;CAAE,CAAC;AAElF;;GAEG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS;IAAE,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,EAC3E,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GACrB,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAK1B;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,MAAM;IAC/B,QAAQ,CACf,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAItC,MAAM,CACb,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;CAG9C"}
|
package/lib/asset.d.ts
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import type { APIPromise } from "../core/api-promise.js";
|
|
2
|
+
import type { RequestOptions } from "../internal/request-options.js";
|
|
3
|
+
import { Assets, type AssetRetrieveParams, type AssetRetrieveResponse, type AssetUpdateParams, type AssetUpdateResponse } from "../resources/assets/assets.js";
|
|
4
|
+
/** Asset methods added on top of the original asset fields. */
|
|
5
|
+
export declare class AssetMethods {
|
|
6
|
+
/**
|
|
7
|
+
* Fetch the asset's content as bytes, using the signed `url` field on the
|
|
8
|
+
* asset. Works in Node ≥18 and in browsers with no extra setup.
|
|
9
|
+
*
|
|
10
|
+
* This is a thin wrapper around `fetch(asset.url)` — use `asset.url`
|
|
11
|
+
* directly if you need streaming or a Response object.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const res = await client.assets.retrieve(assetId);
|
|
16
|
+
* const bytes = await res.asset.download();
|
|
17
|
+
* await fs.writeFile('out.png', bytes);
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
download(this: Asset): Promise<Uint8Array>;
|
|
21
|
+
/** @internal Create an Asset from raw asset data. */
|
|
22
|
+
static from(data: AssetRetrieveResponse['asset']): Asset;
|
|
23
|
+
}
|
|
24
|
+
/** An asset with all original fields plus `.download()`. */
|
|
25
|
+
export type Asset = AssetRetrieveResponse.Asset & AssetMethods;
|
|
26
|
+
export declare const Asset: typeof AssetMethods;
|
|
27
|
+
/**
|
|
28
|
+
* @internal Helper type: adds `.download()` to the `asset` field of a response.
|
|
29
|
+
* Uses intersection so the original response type is preserved — a `WithAsset<T>` is still assignable to `T`.
|
|
30
|
+
*/
|
|
31
|
+
export type WithAsset<T extends {
|
|
32
|
+
asset: unknown;
|
|
33
|
+
}> = T & {
|
|
34
|
+
asset: AssetMethods;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* @internal Wrap `_thenUnwrap` to replace `response.asset` with an enhanced Asset.
|
|
38
|
+
*/
|
|
39
|
+
export declare function enhanceAsset<T extends {
|
|
40
|
+
asset: {
|
|
41
|
+
id: string;
|
|
42
|
+
url: string;
|
|
43
|
+
};
|
|
44
|
+
}>(promise: APIPromise<T>): APIPromise<WithAsset<T>>;
|
|
45
|
+
/**
|
|
46
|
+
* Enhanced Assets resource.
|
|
47
|
+
* All original methods (and subresources like `download`, `public`) are
|
|
48
|
+
* inherited. `retrieve` and `update` responses' `asset` field gains a
|
|
49
|
+
* `.download()` helper for fetching the asset's bytes.
|
|
50
|
+
*/
|
|
51
|
+
export declare class EnhancedAssets extends Assets {
|
|
52
|
+
retrieve(assetID: string, query?: AssetRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<WithAsset<AssetRetrieveResponse>>;
|
|
53
|
+
update(assetID: string, params: AssetUpdateParams, options?: RequestOptions): APIPromise<WithAsset<AssetUpdateResponse>>;
|
|
54
|
+
}
|
|
55
|
+
//# sourceMappingURL=asset.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"asset.d.ts","sourceRoot":"","sources":["../src/lib/asset.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,EACL,MAAM,EACN,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACzB;AAED,+DAA+D;AAC/D,qBAAa,YAAY;IACvB;;;;;;;;;;;;;OAaG;IACG,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;IAQhD,qDAAqD;IACrD,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC,GAAG,KAAK;CAGzD;AAED,4DAA4D;AAC5D,MAAM,MAAM,KAAK,GAAG,qBAAqB,CAAC,KAAK,GAAG,YAAY,CAAC;AAC/D,eAAO,MAAM,KAAK,qBAAe,CAAC;AAElC;;;GAGG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS;IAAE,KAAK,EAAE,OAAO,CAAA;CAAE,IAAI,CAAC,GAAG;IAAE,KAAK,EAAE,YAAY,CAAA;CAAE,CAAC;AAElF;;GAEG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS;IAAE,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,EAC3E,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GACrB,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAK1B;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,MAAM;IAC/B,QAAQ,CACf,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAItC,MAAM,CACb,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,iBAAiB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;CAG9C"}
|
package/lib/asset.js
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.EnhancedAssets = exports.Asset = exports.AssetMethods = void 0;
|
|
4
|
+
exports.enhanceAsset = enhanceAsset;
|
|
5
|
+
const assets_1 = require("../resources/assets/assets.js");
|
|
6
|
+
/** Asset methods added on top of the original asset fields. */
|
|
7
|
+
class AssetMethods {
|
|
8
|
+
/**
|
|
9
|
+
* Fetch the asset's content as bytes, using the signed `url` field on the
|
|
10
|
+
* asset. Works in Node ≥18 and in browsers with no extra setup.
|
|
11
|
+
*
|
|
12
|
+
* This is a thin wrapper around `fetch(asset.url)` — use `asset.url`
|
|
13
|
+
* directly if you need streaming or a Response object.
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* const res = await client.assets.retrieve(assetId);
|
|
18
|
+
* const bytes = await res.asset.download();
|
|
19
|
+
* await fs.writeFile('out.png', bytes);
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
async download() {
|
|
23
|
+
const res = await fetch(this.url);
|
|
24
|
+
if (!res.ok) {
|
|
25
|
+
throw new Error(`Failed to download asset ${this.id}: ${res.status} ${res.statusText}`);
|
|
26
|
+
}
|
|
27
|
+
return new Uint8Array(await res.arrayBuffer());
|
|
28
|
+
}
|
|
29
|
+
/** @internal Create an Asset from raw asset data. */
|
|
30
|
+
static from(data) {
|
|
31
|
+
return Object.assign(Object.create(AssetMethods.prototype), data);
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
exports.AssetMethods = AssetMethods;
|
|
35
|
+
exports.Asset = AssetMethods;
|
|
36
|
+
/**
|
|
37
|
+
* @internal Wrap `_thenUnwrap` to replace `response.asset` with an enhanced Asset.
|
|
38
|
+
*/
|
|
39
|
+
function enhanceAsset(promise) {
|
|
40
|
+
return promise._thenUnwrap((data) => ({
|
|
41
|
+
...data,
|
|
42
|
+
asset: exports.Asset.from(data.asset),
|
|
43
|
+
}));
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Enhanced Assets resource.
|
|
47
|
+
* All original methods (and subresources like `download`, `public`) are
|
|
48
|
+
* inherited. `retrieve` and `update` responses' `asset` field gains a
|
|
49
|
+
* `.download()` helper for fetching the asset's bytes.
|
|
50
|
+
*/
|
|
51
|
+
class EnhancedAssets extends assets_1.Assets {
|
|
52
|
+
retrieve(assetID, query = {}, options) {
|
|
53
|
+
return enhanceAsset(super.retrieve(assetID, query, options));
|
|
54
|
+
}
|
|
55
|
+
update(assetID, params, options) {
|
|
56
|
+
return enhanceAsset(super.update(assetID, params, options));
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
exports.EnhancedAssets = EnhancedAssets;
|
|
60
|
+
//# sourceMappingURL=asset.js.map
|
package/lib/asset.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"asset.js","sourceRoot":"","sources":["../src/lib/asset.ts"],"names":[],"mappings":";;;AAqDA,oCAOC;AA1DD,0DAMoC;AAEpC,+DAA+D;AAC/D,MAAa,YAAY;IACvB;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,CAAC,EAAE,KAAK,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QAC1F,CAAC;QACD,OAAO,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,qDAAqD;IACrD,MAAM,CAAC,IAAI,CAAC,IAAoC;QAC9C,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,IAAI,CAAU,CAAC;IAC7E,CAAC;CACF;AA3BD,oCA2BC;AAIY,QAAA,KAAK,GAAG,YAAY,CAAC;AAQlC;;GAEG;AACH,SAAgB,YAAY,CAC1B,OAAsB;IAEtB,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpC,GAAG,IAAI;QACP,KAAK,EAAE,aAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAuC,CAAC;KAChE,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAa,cAAe,SAAQ,eAAM;IAC/B,QAAQ,CACf,OAAe,EACf,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IAC/D,CAAC;IAEQ,MAAM,CACb,OAAe,EACf,MAAyB,EACzB,OAAwB;QAExB,OAAO,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC9D,CAAC;CACF;AAhBD,wCAgBC"}
|
package/lib/asset.mjs
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { Assets, } from "../resources/assets/assets.mjs";
|
|
2
|
+
/** Asset methods added on top of the original asset fields. */
|
|
3
|
+
export class AssetMethods {
|
|
4
|
+
/**
|
|
5
|
+
* Fetch the asset's content as bytes, using the signed `url` field on the
|
|
6
|
+
* asset. Works in Node ≥18 and in browsers with no extra setup.
|
|
7
|
+
*
|
|
8
|
+
* This is a thin wrapper around `fetch(asset.url)` — use `asset.url`
|
|
9
|
+
* directly if you need streaming or a Response object.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const res = await client.assets.retrieve(assetId);
|
|
14
|
+
* const bytes = await res.asset.download();
|
|
15
|
+
* await fs.writeFile('out.png', bytes);
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
18
|
+
async download() {
|
|
19
|
+
const res = await fetch(this.url);
|
|
20
|
+
if (!res.ok) {
|
|
21
|
+
throw new Error(`Failed to download asset ${this.id}: ${res.status} ${res.statusText}`);
|
|
22
|
+
}
|
|
23
|
+
return new Uint8Array(await res.arrayBuffer());
|
|
24
|
+
}
|
|
25
|
+
/** @internal Create an Asset from raw asset data. */
|
|
26
|
+
static from(data) {
|
|
27
|
+
return Object.assign(Object.create(AssetMethods.prototype), data);
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
export const Asset = AssetMethods;
|
|
31
|
+
/**
|
|
32
|
+
* @internal Wrap `_thenUnwrap` to replace `response.asset` with an enhanced Asset.
|
|
33
|
+
*/
|
|
34
|
+
export function enhanceAsset(promise) {
|
|
35
|
+
return promise._thenUnwrap((data) => ({
|
|
36
|
+
...data,
|
|
37
|
+
asset: Asset.from(data.asset),
|
|
38
|
+
}));
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Enhanced Assets resource.
|
|
42
|
+
* All original methods (and subresources like `download`, `public`) are
|
|
43
|
+
* inherited. `retrieve` and `update` responses' `asset` field gains a
|
|
44
|
+
* `.download()` helper for fetching the asset's bytes.
|
|
45
|
+
*/
|
|
46
|
+
export class EnhancedAssets extends Assets {
|
|
47
|
+
retrieve(assetID, query = {}, options) {
|
|
48
|
+
return enhanceAsset(super.retrieve(assetID, query, options));
|
|
49
|
+
}
|
|
50
|
+
update(assetID, params, options) {
|
|
51
|
+
return enhanceAsset(super.update(assetID, params, options));
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
//# sourceMappingURL=asset.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"asset.mjs","sourceRoot":"","sources":["../src/lib/asset.ts"],"names":[],"mappings":"OAEO,EACL,MAAM,GAKP;AAED,+DAA+D;AAC/D,MAAM,OAAO,YAAY;IACvB;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,CAAC,EAAE,KAAK,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QAC1F,CAAC;QACD,OAAO,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,qDAAqD;IACrD,MAAM,CAAC,IAAI,CAAC,IAAoC;QAC9C,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,IAAI,CAAU,CAAC;IAC7E,CAAC;CACF;AAID,MAAM,CAAC,MAAM,KAAK,GAAG,YAAY,CAAC;AAQlC;;GAEG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAsB;IAEtB,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpC,GAAG,IAAI;QACP,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAuC,CAAC;KAChE,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,cAAe,SAAQ,MAAM;IAC/B,QAAQ,CACf,OAAe,EACf,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IAC/D,CAAC;IAEQ,MAAM,CACb,OAAe,EACf,MAAyB,EACzB,OAAwB;QAExB,OAAO,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC9D,CAAC;CACF"}
|
package/lib/job.d.mts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { Scenario } from "../client.mjs";
|
|
2
2
|
import type { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
-
import type {
|
|
3
|
+
import type { RequestOptions } from "../internal/request-options.mjs";
|
|
4
|
+
import { Jobs, type JobRetrieveResponse, type JobTriggerActionParams, type JobTriggerActionResponse } from "../resources/jobs.mjs";
|
|
4
5
|
export interface WaitOptions {
|
|
5
6
|
/** Polling interval in milliseconds. Default: 3000 */
|
|
6
7
|
intervalMs?: number;
|
|
@@ -45,4 +46,15 @@ export declare function enhanceJob<T extends {
|
|
|
45
46
|
status: string;
|
|
46
47
|
};
|
|
47
48
|
}>(client: Scenario, promise: APIPromise<T>): APIPromise<WithJob<T>>;
|
|
49
|
+
/**
|
|
50
|
+
* Enhanced Jobs resource. `retrieve` and `triggerAction` responses' `job`
|
|
51
|
+
* field gains a `.wait()` helper — previously only job-creating endpoints
|
|
52
|
+
* (workflow.run, models.trigger, generate.*) had it. `list` is not enhanced:
|
|
53
|
+
* its items use a different (but structurally similar) type, and users
|
|
54
|
+
* typically fetch individual jobs via `retrieve` before acting on them.
|
|
55
|
+
*/
|
|
56
|
+
export declare class EnhancedJobs extends Jobs {
|
|
57
|
+
retrieve(jobID: string, options?: RequestOptions): APIPromise<WithJob<JobRetrieveResponse>>;
|
|
58
|
+
triggerAction(jobID: string, params: JobTriggerActionParams, options?: RequestOptions): APIPromise<WithJob<JobTriggerActionResponse>>;
|
|
59
|
+
}
|
|
48
60
|
//# sourceMappingURL=job.d.mts.map
|
package/lib/job.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"job.d.mts","sourceRoot":"","sources":["../src/lib/job.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,QAAQ,EAAE;OACjB,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"job.d.mts","sourceRoot":"","sources":["../src/lib/job.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,QAAQ,EAAE;OACjB,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,EACL,IAAI,EACJ,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC9B;AAED,MAAM,WAAW,WAAW;IAC1B,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD,2DAA2D;AAC3D,qBAAa,UAAU;IACrB,gBAAgB,CAAC,SAAiB,OAAO,EAAE,QAAQ,CAAC;IAEpD;;;;;;;;;OASG;IACG,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB1D,gDAAgD;IAChD,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,mBAAmB,CAAC,KAAK,CAAC,GAAG,GAAG;CAKrE;AAED,qDAAqD;AACrD,MAAM,MAAM,GAAG,GAAG,mBAAmB,CAAC,GAAG,GAAG,UAAU,CAAC;AACvD,eAAO,MAAM,GAAG,mBAAa,CAAC;AAE9B;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS;IAAE,GAAG,EAAE,OAAO,CAAA;CAAE,IAAI,CAAC,GAAG;IAAE,GAAG,EAAE,UAAU,CAAA;CAAE,CAAC;AAE1E;;GAEG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS;IAAE,GAAG,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,EAC7E,MAAM,EAAE,QAAQ,EAChB,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GACrB,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAKxB;AAED;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,IAAI;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAI3F,aAAa,CACpB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;CAGjD"}
|
package/lib/job.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { Scenario } from "../client.js";
|
|
2
2
|
import type { APIPromise } from "../core/api-promise.js";
|
|
3
|
-
import type {
|
|
3
|
+
import type { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
import { Jobs, type JobRetrieveResponse, type JobTriggerActionParams, type JobTriggerActionResponse } from "../resources/jobs.js";
|
|
4
5
|
export interface WaitOptions {
|
|
5
6
|
/** Polling interval in milliseconds. Default: 3000 */
|
|
6
7
|
intervalMs?: number;
|
|
@@ -45,4 +46,15 @@ export declare function enhanceJob<T extends {
|
|
|
45
46
|
status: string;
|
|
46
47
|
};
|
|
47
48
|
}>(client: Scenario, promise: APIPromise<T>): APIPromise<WithJob<T>>;
|
|
49
|
+
/**
|
|
50
|
+
* Enhanced Jobs resource. `retrieve` and `triggerAction` responses' `job`
|
|
51
|
+
* field gains a `.wait()` helper — previously only job-creating endpoints
|
|
52
|
+
* (workflow.run, models.trigger, generate.*) had it. `list` is not enhanced:
|
|
53
|
+
* its items use a different (but structurally similar) type, and users
|
|
54
|
+
* typically fetch individual jobs via `retrieve` before acting on them.
|
|
55
|
+
*/
|
|
56
|
+
export declare class EnhancedJobs extends Jobs {
|
|
57
|
+
retrieve(jobID: string, options?: RequestOptions): APIPromise<WithJob<JobRetrieveResponse>>;
|
|
58
|
+
triggerAction(jobID: string, params: JobTriggerActionParams, options?: RequestOptions): APIPromise<WithJob<JobTriggerActionResponse>>;
|
|
59
|
+
}
|
|
48
60
|
//# sourceMappingURL=job.d.ts.map
|
package/lib/job.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"job.d.ts","sourceRoot":"","sources":["../src/lib/job.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,QAAQ,EAAE;OACjB,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"job.d.ts","sourceRoot":"","sources":["../src/lib/job.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,QAAQ,EAAE;OACjB,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,EACL,IAAI,EACJ,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC9B;AAED,MAAM,WAAW,WAAW;IAC1B,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD,2DAA2D;AAC3D,qBAAa,UAAU;IACrB,gBAAgB,CAAC,SAAiB,OAAO,EAAE,QAAQ,CAAC;IAEpD;;;;;;;;;OASG;IACG,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAmB1D,gDAAgD;IAChD,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,mBAAmB,CAAC,KAAK,CAAC,GAAG,GAAG;CAKrE;AAED,qDAAqD;AACrD,MAAM,MAAM,GAAG,GAAG,mBAAmB,CAAC,GAAG,GAAG,UAAU,CAAC;AACvD,eAAO,MAAM,GAAG,mBAAa,CAAC;AAE9B;;;GAGG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS;IAAE,GAAG,EAAE,OAAO,CAAA;CAAE,IAAI,CAAC,GAAG;IAAE,GAAG,EAAE,UAAU,CAAA;CAAE,CAAC;AAE1E;;GAEG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS;IAAE,GAAG,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,EAC7E,MAAM,EAAE,QAAQ,EAChB,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GACrB,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAKxB;AAED;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,IAAI;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAI3F,aAAa,CACpB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;CAGjD"}
|
package/lib/job.js
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.Job = exports.JobMethods = void 0;
|
|
3
|
+
exports.EnhancedJobs = exports.Job = exports.JobMethods = void 0;
|
|
4
4
|
exports.enhanceJob = enhanceJob;
|
|
5
|
+
const jobs_1 = require("../resources/jobs.js");
|
|
5
6
|
const TERMINAL_STATUSES = new Set(['success', 'failure', 'canceled']);
|
|
6
7
|
/** Job methods added on top of the original job fields. */
|
|
7
8
|
class JobMethods {
|
|
@@ -47,4 +48,20 @@ function enhanceJob(client, promise) {
|
|
|
47
48
|
job: exports.Job.from(client, data.job),
|
|
48
49
|
}));
|
|
49
50
|
}
|
|
51
|
+
/**
|
|
52
|
+
* Enhanced Jobs resource. `retrieve` and `triggerAction` responses' `job`
|
|
53
|
+
* field gains a `.wait()` helper — previously only job-creating endpoints
|
|
54
|
+
* (workflow.run, models.trigger, generate.*) had it. `list` is not enhanced:
|
|
55
|
+
* its items use a different (but structurally similar) type, and users
|
|
56
|
+
* typically fetch individual jobs via `retrieve` before acting on them.
|
|
57
|
+
*/
|
|
58
|
+
class EnhancedJobs extends jobs_1.Jobs {
|
|
59
|
+
retrieve(jobID, options) {
|
|
60
|
+
return enhanceJob(this._client, super.retrieve(jobID, options));
|
|
61
|
+
}
|
|
62
|
+
triggerAction(jobID, params, options) {
|
|
63
|
+
return enhanceJob(this._client, super.triggerAction(jobID, params, options));
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
exports.EnhancedJobs = EnhancedJobs;
|
|
50
67
|
//# sourceMappingURL=job.js.map
|
package/lib/job.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"job.js","sourceRoot":"","sources":["../src/lib/job.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"job.js","sourceRoot":"","sources":["../src/lib/job.ts"],"names":[],"mappings":";;;AA2EA,gCAQC;AAhFD,+CAK2B;AAW3B,MAAM,iBAAiB,GAAmB,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;AAEtF,2DAA2D;AAC3D,MAAa,UAAU;IAGrB;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,CAAY,OAAqB;QACzC,MAAM,UAAU,GAAG,OAAO,EAAE,UAAU,IAAI,IAAK,CAAC;QAChD,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,MAAO,CAAC;QAChD,IAAI,OAAO,GAAG,CAAC,CAAC;QAEhB,OAAO,OAAO,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAE9D,IAAI,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC/C,OAAO,WAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC9C,CAAC;YAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;YAChE,OAAO,IAAI,UAAU,CAAC;QACxB,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,4BAA4B,SAAS,GAAG,IAAK,GAAG,CAAC,CAAC;IACrF,CAAC;IAED,gDAAgD;IAChD,MAAM,CAAC,IAAI,CAAC,MAAgB,EAAE,IAAgC;QAC5D,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,IAAI,CAAQ,CAAC;QAC5E,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5E,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAtCD,gCAsCC;AAIY,QAAA,GAAG,GAAG,UAAU,CAAC;AAQ9B;;GAEG;AACH,SAAgB,UAAU,CACxB,MAAgB,EAChB,OAAsB;IAEtB,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpC,GAAG,IAAI;QACP,GAAG,EAAE,WAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAiC,CAAC;KAC9D,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACH,MAAa,YAAa,SAAQ,WAAI;IAC3B,QAAQ,CAAC,KAAa,EAAE,OAAwB;QACvD,OAAO,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IAClE,CAAC;IAEQ,aAAa,CACpB,KAAa,EACb,MAA8B,EAC9B,OAAwB;QAExB,OAAO,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC/E,CAAC;CACF;AAZD,oCAYC"}
|
package/lib/job.mjs
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { Jobs, } from "../resources/jobs.mjs";
|
|
1
2
|
const TERMINAL_STATUSES = new Set(['success', 'failure', 'canceled']);
|
|
2
3
|
/** Job methods added on top of the original job fields. */
|
|
3
4
|
export class JobMethods {
|
|
@@ -42,4 +43,19 @@ export function enhanceJob(client, promise) {
|
|
|
42
43
|
job: Job.from(client, data.job),
|
|
43
44
|
}));
|
|
44
45
|
}
|
|
46
|
+
/**
|
|
47
|
+
* Enhanced Jobs resource. `retrieve` and `triggerAction` responses' `job`
|
|
48
|
+
* field gains a `.wait()` helper — previously only job-creating endpoints
|
|
49
|
+
* (workflow.run, models.trigger, generate.*) had it. `list` is not enhanced:
|
|
50
|
+
* its items use a different (but structurally similar) type, and users
|
|
51
|
+
* typically fetch individual jobs via `retrieve` before acting on them.
|
|
52
|
+
*/
|
|
53
|
+
export class EnhancedJobs extends Jobs {
|
|
54
|
+
retrieve(jobID, options) {
|
|
55
|
+
return enhanceJob(this._client, super.retrieve(jobID, options));
|
|
56
|
+
}
|
|
57
|
+
triggerAction(jobID, params, options) {
|
|
58
|
+
return enhanceJob(this._client, super.triggerAction(jobID, params, options));
|
|
59
|
+
}
|
|
60
|
+
}
|
|
45
61
|
//# sourceMappingURL=job.mjs.map
|
package/lib/job.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"job.mjs","sourceRoot":"","sources":["../src/lib/job.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"job.mjs","sourceRoot":"","sources":["../src/lib/job.ts"],"names":[],"mappings":"OAGO,EACL,IAAI,GAIL;AAWD,MAAM,iBAAiB,GAAmB,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;AAEtF,2DAA2D;AAC3D,MAAM,OAAO,UAAU;IAGrB;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,CAAY,OAAqB;QACzC,MAAM,UAAU,GAAG,OAAO,EAAE,UAAU,IAAI,IAAK,CAAC;QAChD,MAAM,SAAS,GAAG,OAAO,EAAE,SAAS,IAAI,MAAO,CAAC;QAChD,IAAI,OAAO,GAAG,CAAC,CAAC;QAEhB,OAAO,OAAO,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAE9D,IAAI,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC/C,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC9C,CAAC;YAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;YAChE,OAAO,IAAI,UAAU,CAAC;QACxB,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,4BAA4B,SAAS,GAAG,IAAK,GAAG,CAAC,CAAC;IACrF,CAAC;IAED,gDAAgD;IAChD,MAAM,CAAC,IAAI,CAAC,MAAgB,EAAE,IAAgC;QAC5D,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,IAAI,CAAQ,CAAC;QAC5E,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5E,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAID,MAAM,CAAC,MAAM,GAAG,GAAG,UAAU,CAAC;AAQ9B;;GAEG;AACH,MAAM,UAAU,UAAU,CACxB,MAAgB,EAChB,OAAsB;IAEtB,OAAO,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACpC,GAAG,IAAI;QACP,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAiC,CAAC;KAC9D,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAO,YAAa,SAAQ,IAAI;IAC3B,QAAQ,CAAC,KAAa,EAAE,OAAwB;QACvD,OAAO,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IAClE,CAAC;IAEQ,aAAa,CACpB,KAAa,EACb,MAA8B,EAC9B,OAAwB;QAExB,OAAO,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC/E,CAAC;CACF"}
|
package/lib/models.d.mts
CHANGED
|
@@ -1,8 +1,37 @@
|
|
|
1
1
|
import type { APIPromise } from "../core/api-promise.mjs";
|
|
2
2
|
import type { RequestOptions } from "../internal/request-options.mjs";
|
|
3
|
-
import {
|
|
3
|
+
import type { GenerateRunModelParams, GenerateRunModelResponse } from "../resources/generate.mjs";
|
|
4
|
+
import { Models, type ModelRetrieveParams, type ModelRetrieveResponse } from "../resources/models/models.mjs";
|
|
4
5
|
import { Train, type TrainTriggerParams, type TrainTriggerResponse } from "../resources/models/train.mjs";
|
|
5
6
|
import { type WithJob } from "./job.mjs";
|
|
7
|
+
import type { Scenario } from "./scenario.mjs";
|
|
8
|
+
/**
|
|
9
|
+
* Enhanced Model entity with helper methods.
|
|
10
|
+
* Has all original model fields plus `.run()`.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const { model } = await client.models.retrieve(modelId);
|
|
15
|
+
* const gen = await model.run({ body: { prompt: 'a red car' } });
|
|
16
|
+
* const completed = await gen.job.wait();
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
export declare class ModelEntity {
|
|
20
|
+
/** @internal */ readonly _client: Scenario;
|
|
21
|
+
/**
|
|
22
|
+
* Generate with this model. Shortcut for
|
|
23
|
+
* `client.generate.runModel(this.id, params)`.
|
|
24
|
+
*
|
|
25
|
+
* Returns an enhanced response where `response.job` has `.wait()`.
|
|
26
|
+
*/
|
|
27
|
+
run(this: ModelEntity & ModelRetrieveResponse.Model, params: GenerateRunModelParams, options?: RequestOptions): APIPromise<WithJob<GenerateRunModelResponse>>;
|
|
28
|
+
/** @internal Create a ModelEntity wrapping raw model data. */
|
|
29
|
+
static from(client: Scenario, data: ModelRetrieveResponse.Model): ModelRetrieveResponse.Model & ModelEntity;
|
|
30
|
+
}
|
|
31
|
+
/** Enhanced retrieve response where `model` has `.run()` on top of its original fields. */
|
|
32
|
+
export type EnhancedModelRetrieveResponse = Omit<ModelRetrieveResponse, 'model'> & {
|
|
33
|
+
model: ModelRetrieveResponse.Model & ModelEntity;
|
|
34
|
+
};
|
|
6
35
|
/**
|
|
7
36
|
* Enhanced Train resource.
|
|
8
37
|
* `trigger()` returns a response where `job` has `.wait()`.
|
|
@@ -12,9 +41,12 @@ export declare class EnhancedTrain extends Train {
|
|
|
12
41
|
}
|
|
13
42
|
/**
|
|
14
43
|
* Enhanced Models resource.
|
|
15
|
-
* All original methods inherited.
|
|
44
|
+
* All original methods inherited.
|
|
45
|
+
* - `train` is an {@link EnhancedTrain}
|
|
46
|
+
* - `retrieve()` returns a response where `model` has `.run()`
|
|
16
47
|
*/
|
|
17
48
|
export declare class EnhancedModels extends Models {
|
|
18
49
|
train: EnhancedTrain;
|
|
50
|
+
retrieve(modelID: string, query?: ModelRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<EnhancedModelRetrieveResponse>;
|
|
19
51
|
}
|
|
20
52
|
//# sourceMappingURL=models.d.mts.map
|
package/lib/models.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"models.d.mts","sourceRoot":"","sources":["../src/lib/models.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,EAAE,MAAM,EAAE;
|
|
1
|
+
{"version":3,"file":"models.d.mts","sourceRoot":"","sources":["../src/lib/models.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,KAAK,EAAE,sBAAsB,EAAE,wBAAwB,EAAE;OACzD,EAAE,MAAM,EAAE,KAAK,mBAAmB,EAAE,KAAK,qBAAqB,EAAE;OAChE,EAAE,KAAK,EAAE,KAAK,kBAAkB,EAAE,KAAK,oBAAoB,EAAE;OAC7D,EAAE,KAAK,OAAO,EAAc;OAE5B,KAAK,EAAE,QAAQ,EAAE;AAExB;;;;;;;;;;GAUG;AACH,qBAAa,WAAW;IACtB,gBAAgB,CAAC,SAAiB,OAAO,EAAE,QAAQ,CAAC;IAEpD;;;;;OAKG;IACH,GAAG,CACD,IAAI,EAAE,WAAW,GAAG,qBAAqB,CAAC,KAAK,EAC/C,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAIhD,8DAA8D;IAC9D,MAAM,CAAC,IAAI,CACT,MAAM,EAAE,QAAQ,EAChB,IAAI,EAAE,qBAAqB,CAAC,KAAK,GAChC,qBAAqB,CAAC,KAAK,GAAG,WAAW;CAK7C;AAED,2FAA2F;AAC3F,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,GAAG;IACjF,KAAK,EAAE,qBAAqB,CAAC,KAAK,GAAG,WAAW,CAAC;CAClD,CAAC;AAEF;;;GAGG;AACH,qBAAa,aAAc,SAAQ,KAAK;IAC7B,OAAO,CACd,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAG7C;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,MAAM;IAC/B,KAAK,EAAE,aAAa,CAAmC;IAEvD,QAAQ,CACf,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;CAM7C"}
|
package/lib/models.d.ts
CHANGED
|
@@ -1,8 +1,37 @@
|
|
|
1
1
|
import type { APIPromise } from "../core/api-promise.js";
|
|
2
2
|
import type { RequestOptions } from "../internal/request-options.js";
|
|
3
|
-
import {
|
|
3
|
+
import type { GenerateRunModelParams, GenerateRunModelResponse } from "../resources/generate.js";
|
|
4
|
+
import { Models, type ModelRetrieveParams, type ModelRetrieveResponse } from "../resources/models/models.js";
|
|
4
5
|
import { Train, type TrainTriggerParams, type TrainTriggerResponse } from "../resources/models/train.js";
|
|
5
6
|
import { type WithJob } from "./job.js";
|
|
7
|
+
import type { Scenario } from "./scenario.js";
|
|
8
|
+
/**
|
|
9
|
+
* Enhanced Model entity with helper methods.
|
|
10
|
+
* Has all original model fields plus `.run()`.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* const { model } = await client.models.retrieve(modelId);
|
|
15
|
+
* const gen = await model.run({ body: { prompt: 'a red car' } });
|
|
16
|
+
* const completed = await gen.job.wait();
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
export declare class ModelEntity {
|
|
20
|
+
/** @internal */ readonly _client: Scenario;
|
|
21
|
+
/**
|
|
22
|
+
* Generate with this model. Shortcut for
|
|
23
|
+
* `client.generate.runModel(this.id, params)`.
|
|
24
|
+
*
|
|
25
|
+
* Returns an enhanced response where `response.job` has `.wait()`.
|
|
26
|
+
*/
|
|
27
|
+
run(this: ModelEntity & ModelRetrieveResponse.Model, params: GenerateRunModelParams, options?: RequestOptions): APIPromise<WithJob<GenerateRunModelResponse>>;
|
|
28
|
+
/** @internal Create a ModelEntity wrapping raw model data. */
|
|
29
|
+
static from(client: Scenario, data: ModelRetrieveResponse.Model): ModelRetrieveResponse.Model & ModelEntity;
|
|
30
|
+
}
|
|
31
|
+
/** Enhanced retrieve response where `model` has `.run()` on top of its original fields. */
|
|
32
|
+
export type EnhancedModelRetrieveResponse = Omit<ModelRetrieveResponse, 'model'> & {
|
|
33
|
+
model: ModelRetrieveResponse.Model & ModelEntity;
|
|
34
|
+
};
|
|
6
35
|
/**
|
|
7
36
|
* Enhanced Train resource.
|
|
8
37
|
* `trigger()` returns a response where `job` has `.wait()`.
|
|
@@ -12,9 +41,12 @@ export declare class EnhancedTrain extends Train {
|
|
|
12
41
|
}
|
|
13
42
|
/**
|
|
14
43
|
* Enhanced Models resource.
|
|
15
|
-
* All original methods inherited.
|
|
44
|
+
* All original methods inherited.
|
|
45
|
+
* - `train` is an {@link EnhancedTrain}
|
|
46
|
+
* - `retrieve()` returns a response where `model` has `.run()`
|
|
16
47
|
*/
|
|
17
48
|
export declare class EnhancedModels extends Models {
|
|
18
49
|
train: EnhancedTrain;
|
|
50
|
+
retrieve(modelID: string, query?: ModelRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<EnhancedModelRetrieveResponse>;
|
|
19
51
|
}
|
|
20
52
|
//# sourceMappingURL=models.d.ts.map
|
package/lib/models.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../src/lib/models.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,EAAE,MAAM,EAAE;
|
|
1
|
+
{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../src/lib/models.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,UAAU,EAAE;OACnB,KAAK,EAAE,cAAc,EAAE;OACvB,KAAK,EAAE,sBAAsB,EAAE,wBAAwB,EAAE;OACzD,EAAE,MAAM,EAAE,KAAK,mBAAmB,EAAE,KAAK,qBAAqB,EAAE;OAChE,EAAE,KAAK,EAAE,KAAK,kBAAkB,EAAE,KAAK,oBAAoB,EAAE;OAC7D,EAAE,KAAK,OAAO,EAAc;OAE5B,KAAK,EAAE,QAAQ,EAAE;AAExB;;;;;;;;;;GAUG;AACH,qBAAa,WAAW;IACtB,gBAAgB,CAAC,SAAiB,OAAO,EAAE,QAAQ,CAAC;IAEpD;;;;;OAKG;IACH,GAAG,CACD,IAAI,EAAE,WAAW,GAAG,qBAAqB,CAAC,KAAK,EAC/C,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAIhD,8DAA8D;IAC9D,MAAM,CAAC,IAAI,CACT,MAAM,EAAE,QAAQ,EAChB,IAAI,EAAE,qBAAqB,CAAC,KAAK,GAChC,qBAAqB,CAAC,KAAK,GAAG,WAAW;CAK7C;AAED,2FAA2F;AAC3F,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,qBAAqB,EAAE,OAAO,CAAC,GAAG;IACjF,KAAK,EAAE,qBAAqB,CAAC,KAAK,GAAG,WAAW,CAAC;CAClD,CAAC;AAEF;;;GAGG;AACH,qBAAa,aAAc,SAAQ,KAAK;IAC7B,OAAO,CACd,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAG7C;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,MAAM;IAC/B,KAAK,EAAE,aAAa,CAAmC;IAEvD,QAAQ,CACf,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;CAM7C"}
|
package/lib/models.js
CHANGED
|
@@ -1,9 +1,38 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.EnhancedModels = exports.EnhancedTrain = void 0;
|
|
3
|
+
exports.EnhancedModels = exports.EnhancedTrain = exports.ModelEntity = void 0;
|
|
4
4
|
const models_1 = require("../resources/models/models.js");
|
|
5
5
|
const train_1 = require("../resources/models/train.js");
|
|
6
6
|
const job_1 = require("./job.js");
|
|
7
|
+
/**
|
|
8
|
+
* Enhanced Model entity with helper methods.
|
|
9
|
+
* Has all original model fields plus `.run()`.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const { model } = await client.models.retrieve(modelId);
|
|
14
|
+
* const gen = await model.run({ body: { prompt: 'a red car' } });
|
|
15
|
+
* const completed = await gen.job.wait();
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
18
|
+
class ModelEntity {
|
|
19
|
+
/**
|
|
20
|
+
* Generate with this model. Shortcut for
|
|
21
|
+
* `client.generate.runModel(this.id, params)`.
|
|
22
|
+
*
|
|
23
|
+
* Returns an enhanced response where `response.job` has `.wait()`.
|
|
24
|
+
*/
|
|
25
|
+
run(params, options) {
|
|
26
|
+
return this._client.generate.runModel(this.id, params, options);
|
|
27
|
+
}
|
|
28
|
+
/** @internal Create a ModelEntity wrapping raw model data. */
|
|
29
|
+
static from(client, data) {
|
|
30
|
+
const entity = Object.assign(Object.create(ModelEntity.prototype), data);
|
|
31
|
+
Object.defineProperty(entity, '_client', { value: client, enumerable: false });
|
|
32
|
+
return entity;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
exports.ModelEntity = ModelEntity;
|
|
7
36
|
/**
|
|
8
37
|
* Enhanced Train resource.
|
|
9
38
|
* `trigger()` returns a response where `job` has `.wait()`.
|
|
@@ -16,13 +45,21 @@ class EnhancedTrain extends train_1.Train {
|
|
|
16
45
|
exports.EnhancedTrain = EnhancedTrain;
|
|
17
46
|
/**
|
|
18
47
|
* Enhanced Models resource.
|
|
19
|
-
* All original methods inherited.
|
|
48
|
+
* All original methods inherited.
|
|
49
|
+
* - `train` is an {@link EnhancedTrain}
|
|
50
|
+
* - `retrieve()` returns a response where `model` has `.run()`
|
|
20
51
|
*/
|
|
21
52
|
class EnhancedModels extends models_1.Models {
|
|
22
53
|
constructor() {
|
|
23
54
|
super(...arguments);
|
|
24
55
|
this.train = new EnhancedTrain(this._client);
|
|
25
56
|
}
|
|
57
|
+
retrieve(modelID, query = {}, options) {
|
|
58
|
+
return super.retrieve(modelID, query, options)._thenUnwrap((data) => ({
|
|
59
|
+
...data,
|
|
60
|
+
model: ModelEntity.from(this._client, data.model),
|
|
61
|
+
}));
|
|
62
|
+
}
|
|
26
63
|
}
|
|
27
64
|
exports.EnhancedModels = EnhancedModels;
|
|
28
65
|
//# sourceMappingURL=models.js.map
|
package/lib/models.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"models.js","sourceRoot":"","sources":["../src/lib/models.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"models.js","sourceRoot":"","sources":["../src/lib/models.ts"],"names":[],"mappings":";;;AAGA,0DAA0G;AAC1G,wDAAsG;AACtG,kCAAiD;AAIjD;;;;;;;;;;GAUG;AACH,MAAa,WAAW;IAGtB;;;;;OAKG;IACH,GAAG,CAED,MAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED,8DAA8D;IAC9D,MAAM,CAAC,IAAI,CACT,MAAgB,EAChB,IAAiC;QAEjC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;QACzE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAC/E,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA1BD,kCA0BC;AAOD;;;GAGG;AACH,MAAa,aAAc,SAAQ,aAAK;IAC7B,OAAO,CACd,OAAe,EACf,MAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAA,gBAAU,EAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3E,CAAC;CACF;AARD,sCAQC;AAED;;;;;GAKG;AACH,MAAa,cAAe,SAAQ,eAAM;IAA1C;;QACW,UAAK,GAAkB,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAYlE,CAAC;IAVU,QAAQ,CACf,OAAe,EACf,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACpE,GAAG,IAAI;YACP,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,OAAmB,EAAE,IAAI,CAAC,KAAK,CAAC;SAC9D,CAAC,CAAC,CAAC;IACN,CAAC;CACF;AAbD,wCAaC"}
|