@scenario-labs/sdk 3.0.0 → 3.2.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 +106 -2
- package/client.d.mts +4 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -4
- package/client.d.ts.map +1 -1
- package/client.js +2 -2
- package/client.js.map +1 -1
- package/client.mjs +2 -2
- package/client.mjs.map +1 -1
- package/core/pagination.d.mts +8 -8
- package/core/pagination.d.mts.map +1 -1
- package/core/pagination.d.ts +8 -8
- package/core/pagination.d.ts.map +1 -1
- package/core/pagination.js +8 -8
- package/core/pagination.js.map +1 -1
- package/core/pagination.mjs +8 -8
- package/core/pagination.mjs.map +1 -1
- package/lib/workflow_converter.d.mts +6 -0
- package/lib/workflow_converter.d.mts.map +1 -1
- package/lib/workflow_converter.d.ts +6 -0
- package/lib/workflow_converter.d.ts.map +1 -1
- package/lib/workflow_converter.js +99 -12
- package/lib/workflow_converter.js.map +1 -1
- package/lib/workflow_converter.mjs +99 -12
- package/lib/workflow_converter.mjs.map +1 -1
- package/lib/workflow_validator.d.mts +3 -1
- package/lib/workflow_validator.d.mts.map +1 -1
- package/lib/workflow_validator.d.ts +3 -1
- package/lib/workflow_validator.d.ts.map +1 -1
- package/lib/workflow_validator.js +41 -1
- package/lib/workflow_validator.js.map +1 -1
- package/lib/workflow_validator.mjs +41 -1
- package/lib/workflow_validator.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/assets/assets.d.mts +198 -115
- package/resources/assets/assets.d.mts.map +1 -1
- package/resources/assets/assets.d.ts +198 -115
- package/resources/assets/assets.d.ts.map +1 -1
- package/resources/assets/assets.js.map +1 -1
- package/resources/assets/assets.mjs.map +1 -1
- package/resources/assets/download.d.mts +15 -0
- package/resources/assets/download.d.mts.map +1 -1
- package/resources/assets/download.d.ts +15 -0
- package/resources/assets/download.d.ts.map +1 -1
- package/resources/assets/download.js +2 -2
- package/resources/assets/download.js.map +1 -1
- package/resources/assets/download.mjs +2 -2
- package/resources/assets/download.mjs.map +1 -1
- package/resources/generate.d.mts +383 -225
- package/resources/generate.d.mts.map +1 -1
- package/resources/generate.d.ts +383 -225
- package/resources/generate.d.ts.map +1 -1
- package/resources/generate.js +2 -6
- package/resources/generate.js.map +1 -1
- package/resources/generate.mjs +2 -6
- package/resources/generate.mjs.map +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- 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 +77 -46
- package/resources/jobs.d.mts.map +1 -1
- package/resources/jobs.d.ts +77 -46
- package/resources/jobs.d.ts.map +1 -1
- package/resources/jobs.js +2 -6
- package/resources/jobs.js.map +1 -1
- package/resources/jobs.mjs +2 -6
- package/resources/jobs.mjs.map +1 -1
- package/resources/models/description.d.mts +22 -4
- package/resources/models/description.d.mts.map +1 -1
- package/resources/models/description.d.ts +22 -4
- package/resources/models/description.d.ts.map +1 -1
- package/resources/models/examples.d.mts +84 -50
- package/resources/models/examples.d.mts.map +1 -1
- package/resources/models/examples.d.ts +84 -50
- package/resources/models/examples.d.ts.map +1 -1
- package/resources/models/models.d.mts +131 -35
- package/resources/models/models.d.mts.map +1 -1
- package/resources/models/models.d.ts +131 -35
- package/resources/models/models.d.ts.map +1 -1
- package/resources/models/models.js +6 -2
- package/resources/models/models.js.map +1 -1
- package/resources/models/models.mjs +6 -2
- package/resources/models/models.mjs.map +1 -1
- package/resources/models/train.d.mts +78 -38
- package/resources/models/train.d.mts.map +1 -1
- package/resources/models/train.d.ts +78 -38
- package/resources/models/train.d.ts.map +1 -1
- package/resources/models/train.js +2 -2
- package/resources/models/train.js.map +1 -1
- package/resources/models/train.mjs +2 -2
- package/resources/models/train.mjs.map +1 -1
- package/resources/search.d.mts +168 -5
- package/resources/search.d.mts.map +1 -1
- package/resources/search.d.ts +168 -5
- package/resources/search.d.ts.map +1 -1
- package/resources/search.js +15 -2
- package/resources/search.js.map +1 -1
- package/resources/search.mjs +15 -2
- package/resources/search.mjs.map +1 -1
- package/resources/uploads.d.mts +13 -3
- package/resources/uploads.d.mts.map +1 -1
- package/resources/uploads.d.ts +13 -3
- package/resources/uploads.d.ts.map +1 -1
- package/resources/uploads.js +2 -2
- package/resources/uploads.js.map +1 -1
- package/resources/uploads.mjs +2 -2
- package/resources/uploads.mjs.map +1 -1
- package/resources/usages.d.mts +36 -29
- package/resources/usages.d.mts.map +1 -1
- package/resources/usages.d.ts +36 -29
- package/resources/usages.d.ts.map +1 -1
- package/resources/workflows.d.mts +283 -130
- package/resources/workflows.d.mts.map +1 -1
- package/resources/workflows.d.ts +283 -130
- package/resources/workflows.d.ts.map +1 -1
- package/src/client.ts +10 -4
- package/src/core/pagination.ts +20 -20
- package/src/lib/workflow_converter.ts +126 -12
- package/src/lib/workflow_validator.ts +68 -1
- package/src/resources/assets/assets.ts +590 -115
- package/src/resources/assets/download.ts +19 -2
- package/src/resources/generate.ts +499 -240
- package/src/resources/index.ts +3 -0
- package/src/resources/jobs.ts +79 -53
- package/src/resources/models/description.ts +120 -4
- package/src/resources/models/examples.ts +182 -50
- package/src/resources/models/models.ts +138 -37
- package/src/resources/models/train.ts +82 -42
- package/src/resources/search.ts +218 -7
- package/src/resources/uploads.ts +16 -5
- package/src/resources/usages.ts +42 -29
- package/src/resources/workflows.ts +283 -130
- 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/resources/generate.d.mts
CHANGED
|
@@ -47,8 +47,8 @@ export interface GenerateCaptionResponse {
|
|
|
47
47
|
/**
|
|
48
48
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
49
49
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
50
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
51
|
-
*
|
|
50
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
51
|
+
* — including on dryRun estimates.
|
|
52
52
|
*/
|
|
53
53
|
costDetails?: GenerateCaptionResponse.CostDetails;
|
|
54
54
|
/**
|
|
@@ -328,7 +328,9 @@ export declare namespace GenerateCaptionResponse {
|
|
|
328
328
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
329
329
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
330
330
|
* not able to create the asset on the flight on API side with dataurl without
|
|
331
|
-
* data:kind, prefix
|
|
331
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
332
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
333
|
+
* generation time.
|
|
332
334
|
*/
|
|
333
335
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
334
336
|
/**
|
|
@@ -351,8 +353,9 @@ export declare namespace GenerateCaptionResponse {
|
|
|
351
353
|
*/
|
|
352
354
|
maxDuration?: number;
|
|
353
355
|
/**
|
|
354
|
-
* The maximum allowed length for \`string\`
|
|
355
|
-
* \`string_array
|
|
356
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
357
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
358
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
356
359
|
*/
|
|
357
360
|
maxLength?: number;
|
|
358
361
|
/**
|
|
@@ -366,8 +369,9 @@ export declare namespace GenerateCaptionResponse {
|
|
|
366
369
|
*/
|
|
367
370
|
min?: number;
|
|
368
371
|
/**
|
|
369
|
-
* The minimum allowed length for string
|
|
370
|
-
* \`string_array
|
|
372
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
373
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
374
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
371
375
|
*/
|
|
372
376
|
minLength?: number;
|
|
373
377
|
/**
|
|
@@ -486,7 +490,9 @@ export declare namespace GenerateCaptionResponse {
|
|
|
486
490
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
487
491
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
488
492
|
* not able to create the asset on the flight on API side with dataurl without
|
|
489
|
-
* data:kind, prefix
|
|
493
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
494
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
495
|
+
* generation time.
|
|
490
496
|
*/
|
|
491
497
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
492
498
|
/**
|
|
@@ -509,8 +515,9 @@ export declare namespace GenerateCaptionResponse {
|
|
|
509
515
|
*/
|
|
510
516
|
maxDuration?: number;
|
|
511
517
|
/**
|
|
512
|
-
* The maximum allowed length for \`string\`
|
|
513
|
-
* \`string_array
|
|
518
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
519
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
520
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
514
521
|
*/
|
|
515
522
|
maxLength?: number;
|
|
516
523
|
/**
|
|
@@ -524,8 +531,9 @@ export declare namespace GenerateCaptionResponse {
|
|
|
524
531
|
*/
|
|
525
532
|
min?: number;
|
|
526
533
|
/**
|
|
527
|
-
* The minimum allowed length for string
|
|
528
|
-
* \`string_array
|
|
534
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
535
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
536
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
529
537
|
*/
|
|
530
538
|
minLength?: number;
|
|
531
539
|
/**
|
|
@@ -755,7 +763,7 @@ export declare namespace GenerateCaptionResponse {
|
|
|
755
763
|
cuDiscount: number;
|
|
756
764
|
/**
|
|
757
765
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
758
|
-
* top of the generation itself, such as `
|
|
766
|
+
* top of the generation itself, such as `quality-gate`.
|
|
759
767
|
*
|
|
760
768
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
761
769
|
* values here.
|
|
@@ -783,7 +791,7 @@ export declare namespace GenerateCaptionResponse {
|
|
|
783
791
|
namespace Billing {
|
|
784
792
|
/**
|
|
785
793
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
786
|
-
* top of the generation itself, such as `
|
|
794
|
+
* top of the generation itself, such as `quality-gate`.
|
|
787
795
|
*
|
|
788
796
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
789
797
|
* values here.
|
|
@@ -802,15 +810,15 @@ export declare namespace GenerateCaptionResponse {
|
|
|
802
810
|
*/
|
|
803
811
|
interface CuCostDetails {
|
|
804
812
|
'ip-detection'?: number;
|
|
805
|
-
'
|
|
813
|
+
'quality-gate'?: number;
|
|
806
814
|
}
|
|
807
815
|
}
|
|
808
816
|
}
|
|
809
817
|
/**
|
|
810
818
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
811
819
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
812
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
813
|
-
*
|
|
820
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
821
|
+
* — including on dryRun estimates.
|
|
814
822
|
*/
|
|
815
823
|
interface CostDetails {
|
|
816
824
|
'assistant-message'?: number;
|
|
@@ -824,13 +832,13 @@ export declare namespace GenerateCaptionResponse {
|
|
|
824
832
|
'ip-detection'?: number;
|
|
825
833
|
pixelate?: number;
|
|
826
834
|
prompt?: number;
|
|
835
|
+
'quality-gate'?: number;
|
|
827
836
|
'remove-background'?: number;
|
|
828
837
|
repaint?: number;
|
|
829
838
|
restyle?: number;
|
|
830
839
|
segmentation?: number;
|
|
831
840
|
'skybox-base-360'?: number;
|
|
832
841
|
'skybox-upscale-360'?: number;
|
|
833
|
-
'slop-detection'?: number;
|
|
834
842
|
texture?: number;
|
|
835
843
|
'train-model'?: number;
|
|
836
844
|
translate?: number;
|
|
@@ -846,8 +854,15 @@ export declare namespace GenerateCaptionResponse {
|
|
|
846
854
|
*/
|
|
847
855
|
action: 'allowed' | 'blocked' | 'flagged';
|
|
848
856
|
/**
|
|
849
|
-
*
|
|
850
|
-
*
|
|
857
|
+
* Number of images the detectors actually analyzed — a video counts as each of its
|
|
858
|
+
* extracted frames, and an image that could not be read is excluded (and not
|
|
859
|
+
* billed). Each of them is priced once per enabled filter.
|
|
860
|
+
*/
|
|
861
|
+
analyzedImagesCount: number;
|
|
862
|
+
/**
|
|
863
|
+
* IP-detection CU fee, separate from creativeUnitsCost: it follows the provider
|
|
864
|
+
* tokens the run sends — the prompt plus every analyzed image, once per enabled
|
|
865
|
+
* filter — with a 1 CU minimum per run.
|
|
851
866
|
*/
|
|
852
867
|
creativeUnitsCharged: number;
|
|
853
868
|
/**
|
|
@@ -859,7 +874,8 @@ export declare namespace GenerateCaptionResponse {
|
|
|
859
874
|
*/
|
|
860
875
|
findings: Array<IPDetection.Finding>;
|
|
861
876
|
/**
|
|
862
|
-
*
|
|
877
|
+
* Whether a filter considered the inputs an IP risk. Independent of `action`: a
|
|
878
|
+
* request blocked because a detector errored is `blocked` and NOT flagged.
|
|
863
879
|
*/
|
|
864
880
|
flagged: boolean;
|
|
865
881
|
/**
|
|
@@ -916,8 +932,8 @@ export interface GenerateDescribeStyleResponse {
|
|
|
916
932
|
/**
|
|
917
933
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
918
934
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
919
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
920
|
-
*
|
|
935
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
936
|
+
* — including on dryRun estimates.
|
|
921
937
|
*/
|
|
922
938
|
costDetails?: GenerateDescribeStyleResponse.CostDetails;
|
|
923
939
|
/**
|
|
@@ -1190,7 +1206,9 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1190
1206
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
1191
1207
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
1192
1208
|
* not able to create the asset on the flight on API side with dataurl without
|
|
1193
|
-
* data:kind, prefix
|
|
1209
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
1210
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
1211
|
+
* generation time.
|
|
1194
1212
|
*/
|
|
1195
1213
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
1196
1214
|
/**
|
|
@@ -1213,8 +1231,9 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1213
1231
|
*/
|
|
1214
1232
|
maxDuration?: number;
|
|
1215
1233
|
/**
|
|
1216
|
-
* The maximum allowed length for \`string\`
|
|
1217
|
-
* \`string_array
|
|
1234
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
1235
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
1236
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
1218
1237
|
*/
|
|
1219
1238
|
maxLength?: number;
|
|
1220
1239
|
/**
|
|
@@ -1228,8 +1247,9 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1228
1247
|
*/
|
|
1229
1248
|
min?: number;
|
|
1230
1249
|
/**
|
|
1231
|
-
* The minimum allowed length for string
|
|
1232
|
-
* \`string_array
|
|
1250
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
1251
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
1252
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
1233
1253
|
*/
|
|
1234
1254
|
minLength?: number;
|
|
1235
1255
|
/**
|
|
@@ -1348,7 +1368,9 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1348
1368
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
1349
1369
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
1350
1370
|
* not able to create the asset on the flight on API side with dataurl without
|
|
1351
|
-
* data:kind, prefix
|
|
1371
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
1372
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
1373
|
+
* generation time.
|
|
1352
1374
|
*/
|
|
1353
1375
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
1354
1376
|
/**
|
|
@@ -1371,8 +1393,9 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1371
1393
|
*/
|
|
1372
1394
|
maxDuration?: number;
|
|
1373
1395
|
/**
|
|
1374
|
-
* The maximum allowed length for \`string\`
|
|
1375
|
-
* \`string_array
|
|
1396
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
1397
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
1398
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
1376
1399
|
*/
|
|
1377
1400
|
maxLength?: number;
|
|
1378
1401
|
/**
|
|
@@ -1386,8 +1409,9 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1386
1409
|
*/
|
|
1387
1410
|
min?: number;
|
|
1388
1411
|
/**
|
|
1389
|
-
* The minimum allowed length for string
|
|
1390
|
-
* \`string_array
|
|
1412
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
1413
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
1414
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
1391
1415
|
*/
|
|
1392
1416
|
minLength?: number;
|
|
1393
1417
|
/**
|
|
@@ -1617,7 +1641,7 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1617
1641
|
cuDiscount: number;
|
|
1618
1642
|
/**
|
|
1619
1643
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
1620
|
-
* top of the generation itself, such as `
|
|
1644
|
+
* top of the generation itself, such as `quality-gate`.
|
|
1621
1645
|
*
|
|
1622
1646
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
1623
1647
|
* values here.
|
|
@@ -1645,7 +1669,7 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1645
1669
|
namespace Billing {
|
|
1646
1670
|
/**
|
|
1647
1671
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
1648
|
-
* top of the generation itself, such as `
|
|
1672
|
+
* top of the generation itself, such as `quality-gate`.
|
|
1649
1673
|
*
|
|
1650
1674
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
1651
1675
|
* values here.
|
|
@@ -1664,15 +1688,15 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1664
1688
|
*/
|
|
1665
1689
|
interface CuCostDetails {
|
|
1666
1690
|
'ip-detection'?: number;
|
|
1667
|
-
'
|
|
1691
|
+
'quality-gate'?: number;
|
|
1668
1692
|
}
|
|
1669
1693
|
}
|
|
1670
1694
|
}
|
|
1671
1695
|
/**
|
|
1672
1696
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
1673
1697
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
1674
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
1675
|
-
*
|
|
1698
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
1699
|
+
* — including on dryRun estimates.
|
|
1676
1700
|
*/
|
|
1677
1701
|
interface CostDetails {
|
|
1678
1702
|
'assistant-message'?: number;
|
|
@@ -1686,13 +1710,13 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1686
1710
|
'ip-detection'?: number;
|
|
1687
1711
|
pixelate?: number;
|
|
1688
1712
|
prompt?: number;
|
|
1713
|
+
'quality-gate'?: number;
|
|
1689
1714
|
'remove-background'?: number;
|
|
1690
1715
|
repaint?: number;
|
|
1691
1716
|
restyle?: number;
|
|
1692
1717
|
segmentation?: number;
|
|
1693
1718
|
'skybox-base-360'?: number;
|
|
1694
1719
|
'skybox-upscale-360'?: number;
|
|
1695
|
-
'slop-detection'?: number;
|
|
1696
1720
|
texture?: number;
|
|
1697
1721
|
'train-model'?: number;
|
|
1698
1722
|
translate?: number;
|
|
@@ -1708,8 +1732,15 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1708
1732
|
*/
|
|
1709
1733
|
action: 'allowed' | 'blocked' | 'flagged';
|
|
1710
1734
|
/**
|
|
1711
|
-
*
|
|
1712
|
-
*
|
|
1735
|
+
* Number of images the detectors actually analyzed — a video counts as each of its
|
|
1736
|
+
* extracted frames, and an image that could not be read is excluded (and not
|
|
1737
|
+
* billed). Each of them is priced once per enabled filter.
|
|
1738
|
+
*/
|
|
1739
|
+
analyzedImagesCount: number;
|
|
1740
|
+
/**
|
|
1741
|
+
* IP-detection CU fee, separate from creativeUnitsCost: it follows the provider
|
|
1742
|
+
* tokens the run sends — the prompt plus every analyzed image, once per enabled
|
|
1743
|
+
* filter — with a 1 CU minimum per run.
|
|
1713
1744
|
*/
|
|
1714
1745
|
creativeUnitsCharged: number;
|
|
1715
1746
|
/**
|
|
@@ -1721,7 +1752,8 @@ export declare namespace GenerateDescribeStyleResponse {
|
|
|
1721
1752
|
*/
|
|
1722
1753
|
findings: Array<IPDetection.Finding>;
|
|
1723
1754
|
/**
|
|
1724
|
-
*
|
|
1755
|
+
* Whether a filter considered the inputs an IP risk. Independent of `action`: a
|
|
1756
|
+
* request blocked because a detector errored is `blocked` and NOT flagged.
|
|
1725
1757
|
*/
|
|
1726
1758
|
flagged: boolean;
|
|
1727
1759
|
/**
|
|
@@ -1771,8 +1803,8 @@ export interface GenerateDetectResponse {
|
|
|
1771
1803
|
/**
|
|
1772
1804
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
1773
1805
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
1774
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
1775
|
-
*
|
|
1806
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
1807
|
+
* — including on dryRun estimates.
|
|
1776
1808
|
*/
|
|
1777
1809
|
costDetails?: GenerateDetectResponse.CostDetails;
|
|
1778
1810
|
/**
|
|
@@ -2045,7 +2077,9 @@ export declare namespace GenerateDetectResponse {
|
|
|
2045
2077
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
2046
2078
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
2047
2079
|
* not able to create the asset on the flight on API side with dataurl without
|
|
2048
|
-
* data:kind, prefix
|
|
2080
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
2081
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
2082
|
+
* generation time.
|
|
2049
2083
|
*/
|
|
2050
2084
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
2051
2085
|
/**
|
|
@@ -2068,8 +2102,9 @@ export declare namespace GenerateDetectResponse {
|
|
|
2068
2102
|
*/
|
|
2069
2103
|
maxDuration?: number;
|
|
2070
2104
|
/**
|
|
2071
|
-
* The maximum allowed length for \`string\`
|
|
2072
|
-
* \`string_array
|
|
2105
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
2106
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
2107
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
2073
2108
|
*/
|
|
2074
2109
|
maxLength?: number;
|
|
2075
2110
|
/**
|
|
@@ -2083,8 +2118,9 @@ export declare namespace GenerateDetectResponse {
|
|
|
2083
2118
|
*/
|
|
2084
2119
|
min?: number;
|
|
2085
2120
|
/**
|
|
2086
|
-
* The minimum allowed length for string
|
|
2087
|
-
* \`string_array
|
|
2121
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
2122
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
2123
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
2088
2124
|
*/
|
|
2089
2125
|
minLength?: number;
|
|
2090
2126
|
/**
|
|
@@ -2203,7 +2239,9 @@ export declare namespace GenerateDetectResponse {
|
|
|
2203
2239
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
2204
2240
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
2205
2241
|
* not able to create the asset on the flight on API side with dataurl without
|
|
2206
|
-
* data:kind, prefix
|
|
2242
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
2243
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
2244
|
+
* generation time.
|
|
2207
2245
|
*/
|
|
2208
2246
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
2209
2247
|
/**
|
|
@@ -2226,8 +2264,9 @@ export declare namespace GenerateDetectResponse {
|
|
|
2226
2264
|
*/
|
|
2227
2265
|
maxDuration?: number;
|
|
2228
2266
|
/**
|
|
2229
|
-
* The maximum allowed length for \`string\`
|
|
2230
|
-
* \`string_array
|
|
2267
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
2268
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
2269
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
2231
2270
|
*/
|
|
2232
2271
|
maxLength?: number;
|
|
2233
2272
|
/**
|
|
@@ -2241,8 +2280,9 @@ export declare namespace GenerateDetectResponse {
|
|
|
2241
2280
|
*/
|
|
2242
2281
|
min?: number;
|
|
2243
2282
|
/**
|
|
2244
|
-
* The minimum allowed length for string
|
|
2245
|
-
* \`string_array
|
|
2283
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
2284
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
2285
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
2246
2286
|
*/
|
|
2247
2287
|
minLength?: number;
|
|
2248
2288
|
/**
|
|
@@ -2472,7 +2512,7 @@ export declare namespace GenerateDetectResponse {
|
|
|
2472
2512
|
cuDiscount: number;
|
|
2473
2513
|
/**
|
|
2474
2514
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
2475
|
-
* top of the generation itself, such as `
|
|
2515
|
+
* top of the generation itself, such as `quality-gate`.
|
|
2476
2516
|
*
|
|
2477
2517
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
2478
2518
|
* values here.
|
|
@@ -2500,7 +2540,7 @@ export declare namespace GenerateDetectResponse {
|
|
|
2500
2540
|
namespace Billing {
|
|
2501
2541
|
/**
|
|
2502
2542
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
2503
|
-
* top of the generation itself, such as `
|
|
2543
|
+
* top of the generation itself, such as `quality-gate`.
|
|
2504
2544
|
*
|
|
2505
2545
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
2506
2546
|
* values here.
|
|
@@ -2519,7 +2559,7 @@ export declare namespace GenerateDetectResponse {
|
|
|
2519
2559
|
*/
|
|
2520
2560
|
interface CuCostDetails {
|
|
2521
2561
|
'ip-detection'?: number;
|
|
2522
|
-
'
|
|
2562
|
+
'quality-gate'?: number;
|
|
2523
2563
|
}
|
|
2524
2564
|
}
|
|
2525
2565
|
}
|
|
@@ -2636,6 +2676,15 @@ export declare namespace GenerateDetectResponse {
|
|
|
2636
2676
|
* asset data has been replaced with a new file during the creation of the asset.
|
|
2637
2677
|
*/
|
|
2638
2678
|
originalFileUrl?: string;
|
|
2679
|
+
/**
|
|
2680
|
+
* The mime type of the original file url.
|
|
2681
|
+
*
|
|
2682
|
+
* The original file is stored under a key that carries no extension, so this is
|
|
2683
|
+
* the only way to know which format `originalFileUrl` serves (e.g. an HDRi skybox
|
|
2684
|
+
* exposes a JPEG preview as `url` and its `.exr` or `.hdr` file as the original).
|
|
2685
|
+
* Omitted when the stored format could not be determined.
|
|
2686
|
+
*/
|
|
2687
|
+
originalMimeType?: 'application/gzip' | 'application/json' | 'application/octet-stream' | 'application/pdf' | 'application/safetensors' | 'application/vnd.autodesk.fbx' | 'application/x-authorware-bin' | 'application/x-zip-compressed' | 'application/x.autodesk.fbx' | 'application/zip' | 'audio/m4a' | 'audio/mpeg' | 'audio/ogg' | 'audio/wav' | 'image/aces' | 'image/avif' | 'image/bmp' | 'image/gif' | 'image/heic' | 'image/jpeg' | 'image/png' | 'image/svg+xml' | 'image/tiff' | 'image/vnd.radiance' | 'image/webp' | 'image/x-exr' | 'model/glb' | 'model/gltf+json' | 'model/gltf-binary' | 'model/ksplat' | 'model/mtl' | 'model/obj' | 'model/ply' | 'model/sog' | 'model/splat' | 'model/spz' | 'model/stl' | 'model/vnd.collada+xml' | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml' | 'model/x-3d-vox' | 'model/x-fbx' | 'model/x-maya-ascii' | 'model/x-maya-binary' | 'model/x3d+xml' | 'text/plain' | 'video/mp4' | 'video/quicktime' | 'video/webm';
|
|
2639
2688
|
/**
|
|
2640
2689
|
* The output index of the asset within a job This index is an positive integer
|
|
2641
2690
|
* that starts at 0 It is used to differentiate between multiple outputs of the
|
|
@@ -2649,12 +2698,12 @@ export declare namespace GenerateDetectResponse {
|
|
|
2649
2698
|
*/
|
|
2650
2699
|
preview?: Asset.Preview;
|
|
2651
2700
|
/**
|
|
2652
|
-
*
|
|
2701
|
+
* Quality Gate result, computed asynchronously after generation.
|
|
2653
2702
|
*
|
|
2654
2703
|
* `details` (the per-dimension reasons and suggestions) is returned only when the
|
|
2655
|
-
* asset is read with `
|
|
2704
|
+
* asset is read with `withQualityGateDetails=true`.
|
|
2656
2705
|
*/
|
|
2657
|
-
|
|
2706
|
+
qualityGate?: Asset.QualityGate;
|
|
2658
2707
|
/**
|
|
2659
2708
|
* The asset's thumbnail.
|
|
2660
2709
|
*
|
|
@@ -3226,11 +3275,11 @@ export declare namespace GenerateDetectResponse {
|
|
|
3226
3275
|
/**
|
|
3227
3276
|
* Camera eye position in the splat's world frame.
|
|
3228
3277
|
*/
|
|
3229
|
-
position: Array<
|
|
3278
|
+
position: Array<number>;
|
|
3230
3279
|
/**
|
|
3231
3280
|
* Look-at point in the splat's world frame.
|
|
3232
3281
|
*/
|
|
3233
|
-
target: Array<
|
|
3282
|
+
target: Array<number>;
|
|
3234
3283
|
/**
|
|
3235
3284
|
* Vertical field of view in degrees (defaults to 50 in the renderer).
|
|
3236
3285
|
*/
|
|
@@ -3271,12 +3320,12 @@ export declare namespace GenerateDetectResponse {
|
|
|
3271
3320
|
url: string;
|
|
3272
3321
|
}
|
|
3273
3322
|
/**
|
|
3274
|
-
*
|
|
3323
|
+
* Quality Gate result, computed asynchronously after generation.
|
|
3275
3324
|
*
|
|
3276
3325
|
* `details` (the per-dimension reasons and suggestions) is returned only when the
|
|
3277
|
-
* asset is read with `
|
|
3326
|
+
* asset is read with `withQualityGateDetails=true`.
|
|
3278
3327
|
*/
|
|
3279
|
-
interface
|
|
3328
|
+
interface QualityGate {
|
|
3280
3329
|
/**
|
|
3281
3330
|
* ISO-8601 timestamp of when scoring ran
|
|
3282
3331
|
*/
|
|
@@ -3304,13 +3353,13 @@ export declare namespace GenerateDetectResponse {
|
|
|
3304
3353
|
/**
|
|
3305
3354
|
* Per-dimension reasons and suggestions, as produced by the detector.
|
|
3306
3355
|
*
|
|
3307
|
-
* Returned only when the asset is read with `
|
|
3356
|
+
* Returned only when the asset is read with `withQualityGateDetails=true` by the
|
|
3308
3357
|
* project that owns it — the brief-compliance text paraphrases that project's
|
|
3309
3358
|
* brief, so a cross-project read of a public asset gets the summary alone. Also
|
|
3310
3359
|
* omitted when the archived verdict is unavailable (asset scored by an older
|
|
3311
3360
|
* version, or an unreadable archive).
|
|
3312
3361
|
*/
|
|
3313
|
-
details?:
|
|
3362
|
+
details?: QualityGate.Details;
|
|
3314
3363
|
/**
|
|
3315
3364
|
* Error message when status is 'error' (truncated)
|
|
3316
3365
|
*/
|
|
@@ -3328,11 +3377,11 @@ export declare namespace GenerateDetectResponse {
|
|
|
3328
3377
|
*/
|
|
3329
3378
|
verdict?: 'fail' | 'pass' | 'warn';
|
|
3330
3379
|
}
|
|
3331
|
-
namespace
|
|
3380
|
+
namespace QualityGate {
|
|
3332
3381
|
/**
|
|
3333
3382
|
* Per-dimension reasons and suggestions, as produced by the detector.
|
|
3334
3383
|
*
|
|
3335
|
-
* Returned only when the asset is read with `
|
|
3384
|
+
* Returned only when the asset is read with `withQualityGateDetails=true` by the
|
|
3336
3385
|
* project that owns it — the brief-compliance text paraphrases that project's
|
|
3337
3386
|
* brief, so a cross-project read of a public asset gets the summary alone. Also
|
|
3338
3387
|
* omitted when the archived verdict is unavailable (asset scored by an older
|
|
@@ -3398,8 +3447,8 @@ export declare namespace GenerateDetectResponse {
|
|
|
3398
3447
|
/**
|
|
3399
3448
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
3400
3449
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
3401
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
3402
|
-
*
|
|
3450
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
3451
|
+
* — including on dryRun estimates.
|
|
3403
3452
|
*/
|
|
3404
3453
|
interface CostDetails {
|
|
3405
3454
|
'assistant-message'?: number;
|
|
@@ -3413,13 +3462,13 @@ export declare namespace GenerateDetectResponse {
|
|
|
3413
3462
|
'ip-detection'?: number;
|
|
3414
3463
|
pixelate?: number;
|
|
3415
3464
|
prompt?: number;
|
|
3465
|
+
'quality-gate'?: number;
|
|
3416
3466
|
'remove-background'?: number;
|
|
3417
3467
|
repaint?: number;
|
|
3418
3468
|
restyle?: number;
|
|
3419
3469
|
segmentation?: number;
|
|
3420
3470
|
'skybox-base-360'?: number;
|
|
3421
3471
|
'skybox-upscale-360'?: number;
|
|
3422
|
-
'slop-detection'?: number;
|
|
3423
3472
|
texture?: number;
|
|
3424
3473
|
'train-model'?: number;
|
|
3425
3474
|
translate?: number;
|
|
@@ -3435,8 +3484,15 @@ export declare namespace GenerateDetectResponse {
|
|
|
3435
3484
|
*/
|
|
3436
3485
|
action: 'allowed' | 'blocked' | 'flagged';
|
|
3437
3486
|
/**
|
|
3438
|
-
*
|
|
3439
|
-
*
|
|
3487
|
+
* Number of images the detectors actually analyzed — a video counts as each of its
|
|
3488
|
+
* extracted frames, and an image that could not be read is excluded (and not
|
|
3489
|
+
* billed). Each of them is priced once per enabled filter.
|
|
3490
|
+
*/
|
|
3491
|
+
analyzedImagesCount: number;
|
|
3492
|
+
/**
|
|
3493
|
+
* IP-detection CU fee, separate from creativeUnitsCost: it follows the provider
|
|
3494
|
+
* tokens the run sends — the prompt plus every analyzed image, once per enabled
|
|
3495
|
+
* filter — with a 1 CU minimum per run.
|
|
3440
3496
|
*/
|
|
3441
3497
|
creativeUnitsCharged: number;
|
|
3442
3498
|
/**
|
|
@@ -3448,7 +3504,8 @@ export declare namespace GenerateDetectResponse {
|
|
|
3448
3504
|
*/
|
|
3449
3505
|
findings: Array<IPDetection.Finding>;
|
|
3450
3506
|
/**
|
|
3451
|
-
*
|
|
3507
|
+
* Whether a filter considered the inputs an IP risk. Independent of `action`: a
|
|
3508
|
+
* request blocked because a detector errored is `blocked` and NOT flagged.
|
|
3452
3509
|
*/
|
|
3453
3510
|
flagged: boolean;
|
|
3454
3511
|
/**
|
|
@@ -3503,8 +3560,8 @@ export interface GenerateEmbedResponse {
|
|
|
3503
3560
|
/**
|
|
3504
3561
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
3505
3562
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
3506
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
3507
|
-
*
|
|
3563
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
3564
|
+
* — including on dryRun estimates.
|
|
3508
3565
|
*/
|
|
3509
3566
|
costDetails?: GenerateEmbedResponse.CostDetails;
|
|
3510
3567
|
/**
|
|
@@ -3777,7 +3834,9 @@ export declare namespace GenerateEmbedResponse {
|
|
|
3777
3834
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
3778
3835
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
3779
3836
|
* not able to create the asset on the flight on API side with dataurl without
|
|
3780
|
-
* data:kind, prefix
|
|
3837
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
3838
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
3839
|
+
* generation time.
|
|
3781
3840
|
*/
|
|
3782
3841
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
3783
3842
|
/**
|
|
@@ -3800,8 +3859,9 @@ export declare namespace GenerateEmbedResponse {
|
|
|
3800
3859
|
*/
|
|
3801
3860
|
maxDuration?: number;
|
|
3802
3861
|
/**
|
|
3803
|
-
* The maximum allowed length for \`string\`
|
|
3804
|
-
* \`string_array
|
|
3862
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
3863
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
3864
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
3805
3865
|
*/
|
|
3806
3866
|
maxLength?: number;
|
|
3807
3867
|
/**
|
|
@@ -3815,8 +3875,9 @@ export declare namespace GenerateEmbedResponse {
|
|
|
3815
3875
|
*/
|
|
3816
3876
|
min?: number;
|
|
3817
3877
|
/**
|
|
3818
|
-
* The minimum allowed length for string
|
|
3819
|
-
* \`string_array
|
|
3878
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
3879
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
3880
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
3820
3881
|
*/
|
|
3821
3882
|
minLength?: number;
|
|
3822
3883
|
/**
|
|
@@ -3935,7 +3996,9 @@ export declare namespace GenerateEmbedResponse {
|
|
|
3935
3996
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
3936
3997
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
3937
3998
|
* not able to create the asset on the flight on API side with dataurl without
|
|
3938
|
-
* data:kind, prefix
|
|
3999
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
4000
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
4001
|
+
* generation time.
|
|
3939
4002
|
*/
|
|
3940
4003
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
3941
4004
|
/**
|
|
@@ -3958,8 +4021,9 @@ export declare namespace GenerateEmbedResponse {
|
|
|
3958
4021
|
*/
|
|
3959
4022
|
maxDuration?: number;
|
|
3960
4023
|
/**
|
|
3961
|
-
* The maximum allowed length for \`string\`
|
|
3962
|
-
* \`string_array
|
|
4024
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
4025
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
4026
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
3963
4027
|
*/
|
|
3964
4028
|
maxLength?: number;
|
|
3965
4029
|
/**
|
|
@@ -3973,8 +4037,9 @@ export declare namespace GenerateEmbedResponse {
|
|
|
3973
4037
|
*/
|
|
3974
4038
|
min?: number;
|
|
3975
4039
|
/**
|
|
3976
|
-
* The minimum allowed length for string
|
|
3977
|
-
* \`string_array
|
|
4040
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
4041
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
4042
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
3978
4043
|
*/
|
|
3979
4044
|
minLength?: number;
|
|
3980
4045
|
/**
|
|
@@ -4204,7 +4269,7 @@ export declare namespace GenerateEmbedResponse {
|
|
|
4204
4269
|
cuDiscount: number;
|
|
4205
4270
|
/**
|
|
4206
4271
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
4207
|
-
* top of the generation itself, such as `
|
|
4272
|
+
* top of the generation itself, such as `quality-gate`.
|
|
4208
4273
|
*
|
|
4209
4274
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
4210
4275
|
* values here.
|
|
@@ -4232,7 +4297,7 @@ export declare namespace GenerateEmbedResponse {
|
|
|
4232
4297
|
namespace Billing {
|
|
4233
4298
|
/**
|
|
4234
4299
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
4235
|
-
* top of the generation itself, such as `
|
|
4300
|
+
* top of the generation itself, such as `quality-gate`.
|
|
4236
4301
|
*
|
|
4237
4302
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
4238
4303
|
* values here.
|
|
@@ -4251,15 +4316,15 @@ export declare namespace GenerateEmbedResponse {
|
|
|
4251
4316
|
*/
|
|
4252
4317
|
interface CuCostDetails {
|
|
4253
4318
|
'ip-detection'?: number;
|
|
4254
|
-
'
|
|
4319
|
+
'quality-gate'?: number;
|
|
4255
4320
|
}
|
|
4256
4321
|
}
|
|
4257
4322
|
}
|
|
4258
4323
|
/**
|
|
4259
4324
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
4260
4325
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
4261
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
4262
|
-
*
|
|
4326
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
4327
|
+
* — including on dryRun estimates.
|
|
4263
4328
|
*/
|
|
4264
4329
|
interface CostDetails {
|
|
4265
4330
|
'assistant-message'?: number;
|
|
@@ -4273,13 +4338,13 @@ export declare namespace GenerateEmbedResponse {
|
|
|
4273
4338
|
'ip-detection'?: number;
|
|
4274
4339
|
pixelate?: number;
|
|
4275
4340
|
prompt?: number;
|
|
4341
|
+
'quality-gate'?: number;
|
|
4276
4342
|
'remove-background'?: number;
|
|
4277
4343
|
repaint?: number;
|
|
4278
4344
|
restyle?: number;
|
|
4279
4345
|
segmentation?: number;
|
|
4280
4346
|
'skybox-base-360'?: number;
|
|
4281
4347
|
'skybox-upscale-360'?: number;
|
|
4282
|
-
'slop-detection'?: number;
|
|
4283
4348
|
texture?: number;
|
|
4284
4349
|
'train-model'?: number;
|
|
4285
4350
|
translate?: number;
|
|
@@ -4295,8 +4360,15 @@ export declare namespace GenerateEmbedResponse {
|
|
|
4295
4360
|
*/
|
|
4296
4361
|
action: 'allowed' | 'blocked' | 'flagged';
|
|
4297
4362
|
/**
|
|
4298
|
-
*
|
|
4299
|
-
*
|
|
4363
|
+
* Number of images the detectors actually analyzed — a video counts as each of its
|
|
4364
|
+
* extracted frames, and an image that could not be read is excluded (and not
|
|
4365
|
+
* billed). Each of them is priced once per enabled filter.
|
|
4366
|
+
*/
|
|
4367
|
+
analyzedImagesCount: number;
|
|
4368
|
+
/**
|
|
4369
|
+
* IP-detection CU fee, separate from creativeUnitsCost: it follows the provider
|
|
4370
|
+
* tokens the run sends — the prompt plus every analyzed image, once per enabled
|
|
4371
|
+
* filter — with a 1 CU minimum per run.
|
|
4300
4372
|
*/
|
|
4301
4373
|
creativeUnitsCharged: number;
|
|
4302
4374
|
/**
|
|
@@ -4308,7 +4380,8 @@ export declare namespace GenerateEmbedResponse {
|
|
|
4308
4380
|
*/
|
|
4309
4381
|
findings: Array<IPDetection.Finding>;
|
|
4310
4382
|
/**
|
|
4311
|
-
*
|
|
4383
|
+
* Whether a filter considered the inputs an IP risk. Independent of `action`: a
|
|
4384
|
+
* request blocked because a detector errored is `blocked` and NOT flagged.
|
|
4312
4385
|
*/
|
|
4313
4386
|
flagged: boolean;
|
|
4314
4387
|
/**
|
|
@@ -4358,8 +4431,8 @@ export interface GeneratePatchResponse {
|
|
|
4358
4431
|
/**
|
|
4359
4432
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
4360
4433
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
4361
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
4362
|
-
*
|
|
4434
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
4435
|
+
* — including on dryRun estimates.
|
|
4363
4436
|
*/
|
|
4364
4437
|
costDetails?: GeneratePatchResponse.CostDetails;
|
|
4365
4438
|
/**
|
|
@@ -4632,7 +4705,9 @@ export declare namespace GeneratePatchResponse {
|
|
|
4632
4705
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
4633
4706
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
4634
4707
|
* not able to create the asset on the flight on API side with dataurl without
|
|
4635
|
-
* data:kind, prefix
|
|
4708
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
4709
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
4710
|
+
* generation time.
|
|
4636
4711
|
*/
|
|
4637
4712
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
4638
4713
|
/**
|
|
@@ -4655,8 +4730,9 @@ export declare namespace GeneratePatchResponse {
|
|
|
4655
4730
|
*/
|
|
4656
4731
|
maxDuration?: number;
|
|
4657
4732
|
/**
|
|
4658
|
-
* The maximum allowed length for \`string\`
|
|
4659
|
-
* \`string_array
|
|
4733
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
4734
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
4735
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
4660
4736
|
*/
|
|
4661
4737
|
maxLength?: number;
|
|
4662
4738
|
/**
|
|
@@ -4670,8 +4746,9 @@ export declare namespace GeneratePatchResponse {
|
|
|
4670
4746
|
*/
|
|
4671
4747
|
min?: number;
|
|
4672
4748
|
/**
|
|
4673
|
-
* The minimum allowed length for string
|
|
4674
|
-
* \`string_array
|
|
4749
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
4750
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
4751
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
4675
4752
|
*/
|
|
4676
4753
|
minLength?: number;
|
|
4677
4754
|
/**
|
|
@@ -4790,7 +4867,9 @@ export declare namespace GeneratePatchResponse {
|
|
|
4790
4867
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
4791
4868
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
4792
4869
|
* not able to create the asset on the flight on API side with dataurl without
|
|
4793
|
-
* data:kind, prefix
|
|
4870
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
4871
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
4872
|
+
* generation time.
|
|
4794
4873
|
*/
|
|
4795
4874
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
4796
4875
|
/**
|
|
@@ -4813,8 +4892,9 @@ export declare namespace GeneratePatchResponse {
|
|
|
4813
4892
|
*/
|
|
4814
4893
|
maxDuration?: number;
|
|
4815
4894
|
/**
|
|
4816
|
-
* The maximum allowed length for \`string\`
|
|
4817
|
-
* \`string_array
|
|
4895
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
4896
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
4897
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
4818
4898
|
*/
|
|
4819
4899
|
maxLength?: number;
|
|
4820
4900
|
/**
|
|
@@ -4828,8 +4908,9 @@ export declare namespace GeneratePatchResponse {
|
|
|
4828
4908
|
*/
|
|
4829
4909
|
min?: number;
|
|
4830
4910
|
/**
|
|
4831
|
-
* The minimum allowed length for string
|
|
4832
|
-
* \`string_array
|
|
4911
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
4912
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
4913
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
4833
4914
|
*/
|
|
4834
4915
|
minLength?: number;
|
|
4835
4916
|
/**
|
|
@@ -5059,7 +5140,7 @@ export declare namespace GeneratePatchResponse {
|
|
|
5059
5140
|
cuDiscount: number;
|
|
5060
5141
|
/**
|
|
5061
5142
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
5062
|
-
* top of the generation itself, such as `
|
|
5143
|
+
* top of the generation itself, such as `quality-gate`.
|
|
5063
5144
|
*
|
|
5064
5145
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
5065
5146
|
* values here.
|
|
@@ -5087,7 +5168,7 @@ export declare namespace GeneratePatchResponse {
|
|
|
5087
5168
|
namespace Billing {
|
|
5088
5169
|
/**
|
|
5089
5170
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
5090
|
-
* top of the generation itself, such as `
|
|
5171
|
+
* top of the generation itself, such as `quality-gate`.
|
|
5091
5172
|
*
|
|
5092
5173
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
5093
5174
|
* values here.
|
|
@@ -5106,7 +5187,7 @@ export declare namespace GeneratePatchResponse {
|
|
|
5106
5187
|
*/
|
|
5107
5188
|
interface CuCostDetails {
|
|
5108
5189
|
'ip-detection'?: number;
|
|
5109
|
-
'
|
|
5190
|
+
'quality-gate'?: number;
|
|
5110
5191
|
}
|
|
5111
5192
|
}
|
|
5112
5193
|
}
|
|
@@ -5223,6 +5304,15 @@ export declare namespace GeneratePatchResponse {
|
|
|
5223
5304
|
* asset data has been replaced with a new file during the creation of the asset.
|
|
5224
5305
|
*/
|
|
5225
5306
|
originalFileUrl?: string;
|
|
5307
|
+
/**
|
|
5308
|
+
* The mime type of the original file url.
|
|
5309
|
+
*
|
|
5310
|
+
* The original file is stored under a key that carries no extension, so this is
|
|
5311
|
+
* the only way to know which format `originalFileUrl` serves (e.g. an HDRi skybox
|
|
5312
|
+
* exposes a JPEG preview as `url` and its `.exr` or `.hdr` file as the original).
|
|
5313
|
+
* Omitted when the stored format could not be determined.
|
|
5314
|
+
*/
|
|
5315
|
+
originalMimeType?: 'application/gzip' | 'application/json' | 'application/octet-stream' | 'application/pdf' | 'application/safetensors' | 'application/vnd.autodesk.fbx' | 'application/x-authorware-bin' | 'application/x-zip-compressed' | 'application/x.autodesk.fbx' | 'application/zip' | 'audio/m4a' | 'audio/mpeg' | 'audio/ogg' | 'audio/wav' | 'image/aces' | 'image/avif' | 'image/bmp' | 'image/gif' | 'image/heic' | 'image/jpeg' | 'image/png' | 'image/svg+xml' | 'image/tiff' | 'image/vnd.radiance' | 'image/webp' | 'image/x-exr' | 'model/glb' | 'model/gltf+json' | 'model/gltf-binary' | 'model/ksplat' | 'model/mtl' | 'model/obj' | 'model/ply' | 'model/sog' | 'model/splat' | 'model/spz' | 'model/stl' | 'model/vnd.collada+xml' | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml' | 'model/x-3d-vox' | 'model/x-fbx' | 'model/x-maya-ascii' | 'model/x-maya-binary' | 'model/x3d+xml' | 'text/plain' | 'video/mp4' | 'video/quicktime' | 'video/webm';
|
|
5226
5316
|
/**
|
|
5227
5317
|
* The output index of the asset within a job This index is an positive integer
|
|
5228
5318
|
* that starts at 0 It is used to differentiate between multiple outputs of the
|
|
@@ -5236,12 +5326,12 @@ export declare namespace GeneratePatchResponse {
|
|
|
5236
5326
|
*/
|
|
5237
5327
|
preview?: Asset.Preview;
|
|
5238
5328
|
/**
|
|
5239
|
-
*
|
|
5329
|
+
* Quality Gate result, computed asynchronously after generation.
|
|
5240
5330
|
*
|
|
5241
5331
|
* `details` (the per-dimension reasons and suggestions) is returned only when the
|
|
5242
|
-
* asset is read with `
|
|
5332
|
+
* asset is read with `withQualityGateDetails=true`.
|
|
5243
5333
|
*/
|
|
5244
|
-
|
|
5334
|
+
qualityGate?: Asset.QualityGate;
|
|
5245
5335
|
/**
|
|
5246
5336
|
* The asset's thumbnail.
|
|
5247
5337
|
*
|
|
@@ -5813,11 +5903,11 @@ export declare namespace GeneratePatchResponse {
|
|
|
5813
5903
|
/**
|
|
5814
5904
|
* Camera eye position in the splat's world frame.
|
|
5815
5905
|
*/
|
|
5816
|
-
position: Array<
|
|
5906
|
+
position: Array<number>;
|
|
5817
5907
|
/**
|
|
5818
5908
|
* Look-at point in the splat's world frame.
|
|
5819
5909
|
*/
|
|
5820
|
-
target: Array<
|
|
5910
|
+
target: Array<number>;
|
|
5821
5911
|
/**
|
|
5822
5912
|
* Vertical field of view in degrees (defaults to 50 in the renderer).
|
|
5823
5913
|
*/
|
|
@@ -5858,12 +5948,12 @@ export declare namespace GeneratePatchResponse {
|
|
|
5858
5948
|
url: string;
|
|
5859
5949
|
}
|
|
5860
5950
|
/**
|
|
5861
|
-
*
|
|
5951
|
+
* Quality Gate result, computed asynchronously after generation.
|
|
5862
5952
|
*
|
|
5863
5953
|
* `details` (the per-dimension reasons and suggestions) is returned only when the
|
|
5864
|
-
* asset is read with `
|
|
5954
|
+
* asset is read with `withQualityGateDetails=true`.
|
|
5865
5955
|
*/
|
|
5866
|
-
interface
|
|
5956
|
+
interface QualityGate {
|
|
5867
5957
|
/**
|
|
5868
5958
|
* ISO-8601 timestamp of when scoring ran
|
|
5869
5959
|
*/
|
|
@@ -5891,13 +5981,13 @@ export declare namespace GeneratePatchResponse {
|
|
|
5891
5981
|
/**
|
|
5892
5982
|
* Per-dimension reasons and suggestions, as produced by the detector.
|
|
5893
5983
|
*
|
|
5894
|
-
* Returned only when the asset is read with `
|
|
5984
|
+
* Returned only when the asset is read with `withQualityGateDetails=true` by the
|
|
5895
5985
|
* project that owns it — the brief-compliance text paraphrases that project's
|
|
5896
5986
|
* brief, so a cross-project read of a public asset gets the summary alone. Also
|
|
5897
5987
|
* omitted when the archived verdict is unavailable (asset scored by an older
|
|
5898
5988
|
* version, or an unreadable archive).
|
|
5899
5989
|
*/
|
|
5900
|
-
details?:
|
|
5990
|
+
details?: QualityGate.Details;
|
|
5901
5991
|
/**
|
|
5902
5992
|
* Error message when status is 'error' (truncated)
|
|
5903
5993
|
*/
|
|
@@ -5915,11 +6005,11 @@ export declare namespace GeneratePatchResponse {
|
|
|
5915
6005
|
*/
|
|
5916
6006
|
verdict?: 'fail' | 'pass' | 'warn';
|
|
5917
6007
|
}
|
|
5918
|
-
namespace
|
|
6008
|
+
namespace QualityGate {
|
|
5919
6009
|
/**
|
|
5920
6010
|
* Per-dimension reasons and suggestions, as produced by the detector.
|
|
5921
6011
|
*
|
|
5922
|
-
* Returned only when the asset is read with `
|
|
6012
|
+
* Returned only when the asset is read with `withQualityGateDetails=true` by the
|
|
5923
6013
|
* project that owns it — the brief-compliance text paraphrases that project's
|
|
5924
6014
|
* brief, so a cross-project read of a public asset gets the summary alone. Also
|
|
5925
6015
|
* omitted when the archived verdict is unavailable (asset scored by an older
|
|
@@ -5985,8 +6075,8 @@ export declare namespace GeneratePatchResponse {
|
|
|
5985
6075
|
/**
|
|
5986
6076
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
5987
6077
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
5988
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
5989
|
-
*
|
|
6078
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
6079
|
+
* — including on dryRun estimates.
|
|
5990
6080
|
*/
|
|
5991
6081
|
interface CostDetails {
|
|
5992
6082
|
'assistant-message'?: number;
|
|
@@ -6000,13 +6090,13 @@ export declare namespace GeneratePatchResponse {
|
|
|
6000
6090
|
'ip-detection'?: number;
|
|
6001
6091
|
pixelate?: number;
|
|
6002
6092
|
prompt?: number;
|
|
6093
|
+
'quality-gate'?: number;
|
|
6003
6094
|
'remove-background'?: number;
|
|
6004
6095
|
repaint?: number;
|
|
6005
6096
|
restyle?: number;
|
|
6006
6097
|
segmentation?: number;
|
|
6007
6098
|
'skybox-base-360'?: number;
|
|
6008
6099
|
'skybox-upscale-360'?: number;
|
|
6009
|
-
'slop-detection'?: number;
|
|
6010
6100
|
texture?: number;
|
|
6011
6101
|
'train-model'?: number;
|
|
6012
6102
|
translate?: number;
|
|
@@ -6022,8 +6112,15 @@ export declare namespace GeneratePatchResponse {
|
|
|
6022
6112
|
*/
|
|
6023
6113
|
action: 'allowed' | 'blocked' | 'flagged';
|
|
6024
6114
|
/**
|
|
6025
|
-
*
|
|
6026
|
-
*
|
|
6115
|
+
* Number of images the detectors actually analyzed — a video counts as each of its
|
|
6116
|
+
* extracted frames, and an image that could not be read is excluded (and not
|
|
6117
|
+
* billed). Each of them is priced once per enabled filter.
|
|
6118
|
+
*/
|
|
6119
|
+
analyzedImagesCount: number;
|
|
6120
|
+
/**
|
|
6121
|
+
* IP-detection CU fee, separate from creativeUnitsCost: it follows the provider
|
|
6122
|
+
* tokens the run sends — the prompt plus every analyzed image, once per enabled
|
|
6123
|
+
* filter — with a 1 CU minimum per run.
|
|
6027
6124
|
*/
|
|
6028
6125
|
creativeUnitsCharged: number;
|
|
6029
6126
|
/**
|
|
@@ -6035,7 +6132,8 @@ export declare namespace GeneratePatchResponse {
|
|
|
6035
6132
|
*/
|
|
6036
6133
|
findings: Array<IPDetection.Finding>;
|
|
6037
6134
|
/**
|
|
6038
|
-
*
|
|
6135
|
+
* Whether a filter considered the inputs an IP risk. Independent of `action`: a
|
|
6136
|
+
* request blocked because a detector errored is `blocked` and NOT flagged.
|
|
6039
6137
|
*/
|
|
6040
6138
|
flagged: boolean;
|
|
6041
6139
|
/**
|
|
@@ -6093,8 +6191,8 @@ export interface GeneratePromptResponse {
|
|
|
6093
6191
|
/**
|
|
6094
6192
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
6095
6193
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
6096
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
6097
|
-
*
|
|
6194
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
6195
|
+
* — including on dryRun estimates.
|
|
6098
6196
|
*/
|
|
6099
6197
|
costDetails?: GeneratePromptResponse.CostDetails;
|
|
6100
6198
|
/**
|
|
@@ -6371,7 +6469,9 @@ export declare namespace GeneratePromptResponse {
|
|
|
6371
6469
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
6372
6470
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
6373
6471
|
* not able to create the asset on the flight on API side with dataurl without
|
|
6374
|
-
* data:kind, prefix
|
|
6472
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
6473
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
6474
|
+
* generation time.
|
|
6375
6475
|
*/
|
|
6376
6476
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
6377
6477
|
/**
|
|
@@ -6394,8 +6494,9 @@ export declare namespace GeneratePromptResponse {
|
|
|
6394
6494
|
*/
|
|
6395
6495
|
maxDuration?: number;
|
|
6396
6496
|
/**
|
|
6397
|
-
* The maximum allowed length for \`string\`
|
|
6398
|
-
* \`string_array
|
|
6497
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
6498
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
6499
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
6399
6500
|
*/
|
|
6400
6501
|
maxLength?: number;
|
|
6401
6502
|
/**
|
|
@@ -6409,8 +6510,9 @@ export declare namespace GeneratePromptResponse {
|
|
|
6409
6510
|
*/
|
|
6410
6511
|
min?: number;
|
|
6411
6512
|
/**
|
|
6412
|
-
* The minimum allowed length for string
|
|
6413
|
-
* \`string_array
|
|
6513
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
6514
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
6515
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
6414
6516
|
*/
|
|
6415
6517
|
minLength?: number;
|
|
6416
6518
|
/**
|
|
@@ -6529,7 +6631,9 @@ export declare namespace GeneratePromptResponse {
|
|
|
6529
6631
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
6530
6632
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
6531
6633
|
* not able to create the asset on the flight on API side with dataurl without
|
|
6532
|
-
* data:kind, prefix
|
|
6634
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
6635
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
6636
|
+
* generation time.
|
|
6533
6637
|
*/
|
|
6534
6638
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
6535
6639
|
/**
|
|
@@ -6552,8 +6656,9 @@ export declare namespace GeneratePromptResponse {
|
|
|
6552
6656
|
*/
|
|
6553
6657
|
maxDuration?: number;
|
|
6554
6658
|
/**
|
|
6555
|
-
* The maximum allowed length for \`string\`
|
|
6556
|
-
* \`string_array
|
|
6659
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
6660
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
6661
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
6557
6662
|
*/
|
|
6558
6663
|
maxLength?: number;
|
|
6559
6664
|
/**
|
|
@@ -6567,8 +6672,9 @@ export declare namespace GeneratePromptResponse {
|
|
|
6567
6672
|
*/
|
|
6568
6673
|
min?: number;
|
|
6569
6674
|
/**
|
|
6570
|
-
* The minimum allowed length for string
|
|
6571
|
-
* \`string_array
|
|
6675
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
6676
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
6677
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
6572
6678
|
*/
|
|
6573
6679
|
minLength?: number;
|
|
6574
6680
|
/**
|
|
@@ -6798,7 +6904,7 @@ export declare namespace GeneratePromptResponse {
|
|
|
6798
6904
|
cuDiscount: number;
|
|
6799
6905
|
/**
|
|
6800
6906
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
6801
|
-
* top of the generation itself, such as `
|
|
6907
|
+
* top of the generation itself, such as `quality-gate`.
|
|
6802
6908
|
*
|
|
6803
6909
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
6804
6910
|
* values here.
|
|
@@ -6826,7 +6932,7 @@ export declare namespace GeneratePromptResponse {
|
|
|
6826
6932
|
namespace Billing {
|
|
6827
6933
|
/**
|
|
6828
6934
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
6829
|
-
* top of the generation itself, such as `
|
|
6935
|
+
* top of the generation itself, such as `quality-gate`.
|
|
6830
6936
|
*
|
|
6831
6937
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
6832
6938
|
* values here.
|
|
@@ -6845,7 +6951,7 @@ export declare namespace GeneratePromptResponse {
|
|
|
6845
6951
|
*/
|
|
6846
6952
|
interface CuCostDetails {
|
|
6847
6953
|
'ip-detection'?: number;
|
|
6848
|
-
'
|
|
6954
|
+
'quality-gate'?: number;
|
|
6849
6955
|
}
|
|
6850
6956
|
}
|
|
6851
6957
|
}
|
|
@@ -6873,8 +6979,8 @@ export declare namespace GeneratePromptResponse {
|
|
|
6873
6979
|
/**
|
|
6874
6980
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
6875
6981
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
6876
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
6877
|
-
*
|
|
6982
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
6983
|
+
* — including on dryRun estimates.
|
|
6878
6984
|
*/
|
|
6879
6985
|
interface CostDetails {
|
|
6880
6986
|
'assistant-message'?: number;
|
|
@@ -6888,13 +6994,13 @@ export declare namespace GeneratePromptResponse {
|
|
|
6888
6994
|
'ip-detection'?: number;
|
|
6889
6995
|
pixelate?: number;
|
|
6890
6996
|
prompt?: number;
|
|
6997
|
+
'quality-gate'?: number;
|
|
6891
6998
|
'remove-background'?: number;
|
|
6892
6999
|
repaint?: number;
|
|
6893
7000
|
restyle?: number;
|
|
6894
7001
|
segmentation?: number;
|
|
6895
7002
|
'skybox-base-360'?: number;
|
|
6896
7003
|
'skybox-upscale-360'?: number;
|
|
6897
|
-
'slop-detection'?: number;
|
|
6898
7004
|
texture?: number;
|
|
6899
7005
|
'train-model'?: number;
|
|
6900
7006
|
translate?: number;
|
|
@@ -6910,8 +7016,15 @@ export declare namespace GeneratePromptResponse {
|
|
|
6910
7016
|
*/
|
|
6911
7017
|
action: 'allowed' | 'blocked' | 'flagged';
|
|
6912
7018
|
/**
|
|
6913
|
-
*
|
|
6914
|
-
*
|
|
7019
|
+
* Number of images the detectors actually analyzed — a video counts as each of its
|
|
7020
|
+
* extracted frames, and an image that could not be read is excluded (and not
|
|
7021
|
+
* billed). Each of them is priced once per enabled filter.
|
|
7022
|
+
*/
|
|
7023
|
+
analyzedImagesCount: number;
|
|
7024
|
+
/**
|
|
7025
|
+
* IP-detection CU fee, separate from creativeUnitsCost: it follows the provider
|
|
7026
|
+
* tokens the run sends — the prompt plus every analyzed image, once per enabled
|
|
7027
|
+
* filter — with a 1 CU minimum per run.
|
|
6915
7028
|
*/
|
|
6916
7029
|
creativeUnitsCharged: number;
|
|
6917
7030
|
/**
|
|
@@ -6923,7 +7036,8 @@ export declare namespace GeneratePromptResponse {
|
|
|
6923
7036
|
*/
|
|
6924
7037
|
findings: Array<IPDetection.Finding>;
|
|
6925
7038
|
/**
|
|
6926
|
-
*
|
|
7039
|
+
* Whether a filter considered the inputs an IP risk. Independent of `action`: a
|
|
7040
|
+
* request blocked because a detector errored is `blocked` and NOT flagged.
|
|
6927
7041
|
*/
|
|
6928
7042
|
flagged: boolean;
|
|
6929
7043
|
/**
|
|
@@ -6972,8 +7086,8 @@ export interface GenerateRunModelResponse {
|
|
|
6972
7086
|
/**
|
|
6973
7087
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
6974
7088
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
6975
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
6976
|
-
*
|
|
7089
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
7090
|
+
* — including on dryRun estimates.
|
|
6977
7091
|
*/
|
|
6978
7092
|
costDetails?: GenerateRunModelResponse.CostDetails;
|
|
6979
7093
|
/**
|
|
@@ -7246,7 +7360,9 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7246
7360
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
7247
7361
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
7248
7362
|
* not able to create the asset on the flight on API side with dataurl without
|
|
7249
|
-
* data:kind, prefix
|
|
7363
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
7364
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
7365
|
+
* generation time.
|
|
7250
7366
|
*/
|
|
7251
7367
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
7252
7368
|
/**
|
|
@@ -7269,8 +7385,9 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7269
7385
|
*/
|
|
7270
7386
|
maxDuration?: number;
|
|
7271
7387
|
/**
|
|
7272
|
-
* The maximum allowed length for \`string\`
|
|
7273
|
-
* \`string_array
|
|
7388
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
7389
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
7390
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
7274
7391
|
*/
|
|
7275
7392
|
maxLength?: number;
|
|
7276
7393
|
/**
|
|
@@ -7284,8 +7401,9 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7284
7401
|
*/
|
|
7285
7402
|
min?: number;
|
|
7286
7403
|
/**
|
|
7287
|
-
* The minimum allowed length for string
|
|
7288
|
-
* \`string_array
|
|
7404
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
7405
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
7406
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
7289
7407
|
*/
|
|
7290
7408
|
minLength?: number;
|
|
7291
7409
|
/**
|
|
@@ -7404,7 +7522,9 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7404
7522
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
7405
7523
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
7406
7524
|
* not able to create the asset on the flight on API side with dataurl without
|
|
7407
|
-
* data:kind, prefix
|
|
7525
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
7526
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
7527
|
+
* generation time.
|
|
7408
7528
|
*/
|
|
7409
7529
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
7410
7530
|
/**
|
|
@@ -7427,8 +7547,9 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7427
7547
|
*/
|
|
7428
7548
|
maxDuration?: number;
|
|
7429
7549
|
/**
|
|
7430
|
-
* The maximum allowed length for \`string\`
|
|
7431
|
-
* \`string_array
|
|
7550
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
7551
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
7552
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
7432
7553
|
*/
|
|
7433
7554
|
maxLength?: number;
|
|
7434
7555
|
/**
|
|
@@ -7442,8 +7563,9 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7442
7563
|
*/
|
|
7443
7564
|
min?: number;
|
|
7444
7565
|
/**
|
|
7445
|
-
* The minimum allowed length for string
|
|
7446
|
-
* \`string_array
|
|
7566
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
7567
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
7568
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
7447
7569
|
*/
|
|
7448
7570
|
minLength?: number;
|
|
7449
7571
|
/**
|
|
@@ -7673,7 +7795,7 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7673
7795
|
cuDiscount: number;
|
|
7674
7796
|
/**
|
|
7675
7797
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
7676
|
-
* top of the generation itself, such as `
|
|
7798
|
+
* top of the generation itself, such as `quality-gate`.
|
|
7677
7799
|
*
|
|
7678
7800
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
7679
7801
|
* values here.
|
|
@@ -7701,7 +7823,7 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7701
7823
|
namespace Billing {
|
|
7702
7824
|
/**
|
|
7703
7825
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
7704
|
-
* top of the generation itself, such as `
|
|
7826
|
+
* top of the generation itself, such as `quality-gate`.
|
|
7705
7827
|
*
|
|
7706
7828
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
7707
7829
|
* values here.
|
|
@@ -7720,15 +7842,15 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7720
7842
|
*/
|
|
7721
7843
|
interface CuCostDetails {
|
|
7722
7844
|
'ip-detection'?: number;
|
|
7723
|
-
'
|
|
7845
|
+
'quality-gate'?: number;
|
|
7724
7846
|
}
|
|
7725
7847
|
}
|
|
7726
7848
|
}
|
|
7727
7849
|
/**
|
|
7728
7850
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
7729
7851
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
7730
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
7731
|
-
*
|
|
7852
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
7853
|
+
* — including on dryRun estimates.
|
|
7732
7854
|
*/
|
|
7733
7855
|
interface CostDetails {
|
|
7734
7856
|
'assistant-message'?: number;
|
|
@@ -7742,13 +7864,13 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7742
7864
|
'ip-detection'?: number;
|
|
7743
7865
|
pixelate?: number;
|
|
7744
7866
|
prompt?: number;
|
|
7867
|
+
'quality-gate'?: number;
|
|
7745
7868
|
'remove-background'?: number;
|
|
7746
7869
|
repaint?: number;
|
|
7747
7870
|
restyle?: number;
|
|
7748
7871
|
segmentation?: number;
|
|
7749
7872
|
'skybox-base-360'?: number;
|
|
7750
7873
|
'skybox-upscale-360'?: number;
|
|
7751
|
-
'slop-detection'?: number;
|
|
7752
7874
|
texture?: number;
|
|
7753
7875
|
'train-model'?: number;
|
|
7754
7876
|
translate?: number;
|
|
@@ -7764,8 +7886,15 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7764
7886
|
*/
|
|
7765
7887
|
action: 'allowed' | 'blocked' | 'flagged';
|
|
7766
7888
|
/**
|
|
7767
|
-
*
|
|
7768
|
-
*
|
|
7889
|
+
* Number of images the detectors actually analyzed — a video counts as each of its
|
|
7890
|
+
* extracted frames, and an image that could not be read is excluded (and not
|
|
7891
|
+
* billed). Each of them is priced once per enabled filter.
|
|
7892
|
+
*/
|
|
7893
|
+
analyzedImagesCount: number;
|
|
7894
|
+
/**
|
|
7895
|
+
* IP-detection CU fee, separate from creativeUnitsCost: it follows the provider
|
|
7896
|
+
* tokens the run sends — the prompt plus every analyzed image, once per enabled
|
|
7897
|
+
* filter — with a 1 CU minimum per run.
|
|
7769
7898
|
*/
|
|
7770
7899
|
creativeUnitsCharged: number;
|
|
7771
7900
|
/**
|
|
@@ -7777,7 +7906,8 @@ export declare namespace GenerateRunModelResponse {
|
|
|
7777
7906
|
*/
|
|
7778
7907
|
findings: Array<IPDetection.Finding>;
|
|
7779
7908
|
/**
|
|
7780
|
-
*
|
|
7909
|
+
* Whether a filter considered the inputs an IP risk. Independent of `action`: a
|
|
7910
|
+
* request blocked because a detector errored is `blocked` and NOT flagged.
|
|
7781
7911
|
*/
|
|
7782
7912
|
flagged: boolean;
|
|
7783
7913
|
/**
|
|
@@ -7834,8 +7964,8 @@ export interface GenerateTranslateResponse {
|
|
|
7834
7964
|
/**
|
|
7835
7965
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
7836
7966
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
7837
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
7838
|
-
*
|
|
7967
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
7968
|
+
* — including on dryRun estimates.
|
|
7839
7969
|
*/
|
|
7840
7970
|
costDetails?: GenerateTranslateResponse.CostDetails;
|
|
7841
7971
|
/**
|
|
@@ -8108,7 +8238,9 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8108
8238
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
8109
8239
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
8110
8240
|
* not able to create the asset on the flight on API side with dataurl without
|
|
8111
|
-
* data:kind, prefix
|
|
8241
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
8242
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
8243
|
+
* generation time.
|
|
8112
8244
|
*/
|
|
8113
8245
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
8114
8246
|
/**
|
|
@@ -8131,8 +8263,9 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8131
8263
|
*/
|
|
8132
8264
|
maxDuration?: number;
|
|
8133
8265
|
/**
|
|
8134
|
-
* The maximum allowed length for \`string\`
|
|
8135
|
-
* \`string_array
|
|
8266
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
8267
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
8268
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
8136
8269
|
*/
|
|
8137
8270
|
maxLength?: number;
|
|
8138
8271
|
/**
|
|
@@ -8146,8 +8279,9 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8146
8279
|
*/
|
|
8147
8280
|
min?: number;
|
|
8148
8281
|
/**
|
|
8149
|
-
* The minimum allowed length for string
|
|
8150
|
-
* \`string_array
|
|
8282
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
8283
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
8284
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
8151
8285
|
*/
|
|
8152
8286
|
minLength?: number;
|
|
8153
8287
|
/**
|
|
@@ -8266,7 +8400,9 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8266
8400
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
8267
8401
|
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
8268
8402
|
* not able to create the asset on the flight on API side with dataurl without
|
|
8269
|
-
* data:kind, prefix
|
|
8403
|
+
* data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
|
|
8404
|
+
* a model does not declare one, \`image\` is returned, which is the kind used at
|
|
8405
|
+
* generation time.
|
|
8270
8406
|
*/
|
|
8271
8407
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
8272
8408
|
/**
|
|
@@ -8289,8 +8425,9 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8289
8425
|
*/
|
|
8290
8426
|
maxDuration?: number;
|
|
8291
8427
|
/**
|
|
8292
|
-
* The maximum allowed length for \`string\`
|
|
8293
|
-
* \`string_array
|
|
8428
|
+
* The maximum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
8429
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
8430
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
8294
8431
|
*/
|
|
8295
8432
|
maxLength?: number;
|
|
8296
8433
|
/**
|
|
@@ -8304,8 +8441,9 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8304
8441
|
*/
|
|
8305
8442
|
min?: number;
|
|
8306
8443
|
/**
|
|
8307
|
-
* The minimum allowed length for string
|
|
8308
|
-
* \`string_array
|
|
8444
|
+
* The minimum allowed length for \`string\` and \`model\` inputs, in characters.
|
|
8445
|
+
* For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
|
|
8446
|
+
* ITEMS instead — the length of each item is not constrained.
|
|
8309
8447
|
*/
|
|
8310
8448
|
minLength?: number;
|
|
8311
8449
|
/**
|
|
@@ -8535,7 +8673,7 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8535
8673
|
cuDiscount: number;
|
|
8536
8674
|
/**
|
|
8537
8675
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
8538
|
-
* top of the generation itself, such as `
|
|
8676
|
+
* top of the generation itself, such as `quality-gate`.
|
|
8539
8677
|
*
|
|
8540
8678
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
8541
8679
|
* values here.
|
|
@@ -8563,7 +8701,7 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8563
8701
|
namespace Billing {
|
|
8564
8702
|
/**
|
|
8565
8703
|
* Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
|
|
8566
|
-
* top of the generation itself, such as `
|
|
8704
|
+
* top of the generation itself, such as `quality-gate`.
|
|
8567
8705
|
*
|
|
8568
8706
|
* `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
|
|
8569
8707
|
* values here.
|
|
@@ -8582,15 +8720,15 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8582
8720
|
*/
|
|
8583
8721
|
interface CuCostDetails {
|
|
8584
8722
|
'ip-detection'?: number;
|
|
8585
|
-
'
|
|
8723
|
+
'quality-gate'?: number;
|
|
8586
8724
|
}
|
|
8587
8725
|
}
|
|
8588
8726
|
}
|
|
8589
8727
|
/**
|
|
8590
8728
|
* Compute Units cost per billing action for this request, after discount. Values
|
|
8591
8729
|
* sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
|
|
8592
|
-
* charge appear. Lets clients split the total (e.g. generation vs
|
|
8593
|
-
*
|
|
8730
|
+
* charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
|
|
8731
|
+
* — including on dryRun estimates.
|
|
8594
8732
|
*/
|
|
8595
8733
|
interface CostDetails {
|
|
8596
8734
|
'assistant-message'?: number;
|
|
@@ -8604,13 +8742,13 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8604
8742
|
'ip-detection'?: number;
|
|
8605
8743
|
pixelate?: number;
|
|
8606
8744
|
prompt?: number;
|
|
8745
|
+
'quality-gate'?: number;
|
|
8607
8746
|
'remove-background'?: number;
|
|
8608
8747
|
repaint?: number;
|
|
8609
8748
|
restyle?: number;
|
|
8610
8749
|
segmentation?: number;
|
|
8611
8750
|
'skybox-base-360'?: number;
|
|
8612
8751
|
'skybox-upscale-360'?: number;
|
|
8613
|
-
'slop-detection'?: number;
|
|
8614
8752
|
texture?: number;
|
|
8615
8753
|
'train-model'?: number;
|
|
8616
8754
|
translate?: number;
|
|
@@ -8626,8 +8764,15 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8626
8764
|
*/
|
|
8627
8765
|
action: 'allowed' | 'blocked' | 'flagged';
|
|
8628
8766
|
/**
|
|
8629
|
-
*
|
|
8630
|
-
*
|
|
8767
|
+
* Number of images the detectors actually analyzed — a video counts as each of its
|
|
8768
|
+
* extracted frames, and an image that could not be read is excluded (and not
|
|
8769
|
+
* billed). Each of them is priced once per enabled filter.
|
|
8770
|
+
*/
|
|
8771
|
+
analyzedImagesCount: number;
|
|
8772
|
+
/**
|
|
8773
|
+
* IP-detection CU fee, separate from creativeUnitsCost: it follows the provider
|
|
8774
|
+
* tokens the run sends — the prompt plus every analyzed image, once per enabled
|
|
8775
|
+
* filter — with a 1 CU minimum per run.
|
|
8631
8776
|
*/
|
|
8632
8777
|
creativeUnitsCharged: number;
|
|
8633
8778
|
/**
|
|
@@ -8639,7 +8784,8 @@ export declare namespace GenerateTranslateResponse {
|
|
|
8639
8784
|
*/
|
|
8640
8785
|
findings: Array<IPDetection.Finding>;
|
|
8641
8786
|
/**
|
|
8642
|
-
*
|
|
8787
|
+
* Whether a filter considered the inputs an IP risk. Independent of `action`: a
|
|
8788
|
+
* request blocked because a detector errored is `blocked` and NOT flagged.
|
|
8643
8789
|
*/
|
|
8644
8790
|
flagged: boolean;
|
|
8645
8791
|
/**
|
|
@@ -8704,13 +8850,15 @@ export interface GenerateCaptionParams {
|
|
|
8704
8850
|
*/
|
|
8705
8851
|
images: Array<string>;
|
|
8706
8852
|
/**
|
|
8707
|
-
* Query param
|
|
8853
|
+
* Query param: Estimate the operation instead of running it: the call returns a
|
|
8854
|
+
* 269 response carrying the creative units cost. `api` estimates at the API tier.
|
|
8708
8855
|
*/
|
|
8709
|
-
dryRun?:
|
|
8856
|
+
dryRun?: 'true' | 'api';
|
|
8710
8857
|
/**
|
|
8711
|
-
* Query param
|
|
8858
|
+
* Query param: The projectId used for ownership resource management. Either to
|
|
8859
|
+
* assert ownership or to set the owner of the resource(s)
|
|
8712
8860
|
*/
|
|
8713
|
-
projectId?:
|
|
8861
|
+
projectId?: string;
|
|
8714
8862
|
/**
|
|
8715
8863
|
* Body param: The assetIds to generate captions. Results are returned in the same
|
|
8716
8864
|
* order as the given assetIds. Deprecated, use `images` parameter instead.
|
|
@@ -8764,13 +8912,15 @@ export interface GenerateCaptionParams {
|
|
|
8764
8912
|
}
|
|
8765
8913
|
export interface GenerateDescribeStyleParams {
|
|
8766
8914
|
/**
|
|
8767
|
-
* Query param
|
|
8915
|
+
* Query param: Estimate the operation instead of running it: the call returns a
|
|
8916
|
+
* 269 response carrying the creative units cost. `api` estimates at the API tier.
|
|
8768
8917
|
*/
|
|
8769
|
-
dryRun?:
|
|
8918
|
+
dryRun?: 'true' | 'api';
|
|
8770
8919
|
/**
|
|
8771
|
-
* Query param
|
|
8920
|
+
* Query param: The projectId used for ownership resource management. Either to
|
|
8921
|
+
* assert ownership or to set the owner of the resource(s)
|
|
8772
8922
|
*/
|
|
8773
|
-
projectId?:
|
|
8923
|
+
projectId?: string;
|
|
8774
8924
|
/**
|
|
8775
8925
|
* Body param: The asset ids used to condition the generation.
|
|
8776
8926
|
*/
|
|
@@ -8844,17 +8994,19 @@ export interface GenerateDetectParams {
|
|
|
8844
8994
|
*/
|
|
8845
8995
|
modality: 'canny' | 'depth' | 'grayscale' | 'lineart_anime' | 'mlsd' | 'normal' | 'pose' | 'scribble' | 'segmentation' | 'sketch';
|
|
8846
8996
|
/**
|
|
8847
|
-
* Query param
|
|
8997
|
+
* Query param: Estimate the operation instead of running it: the call returns a
|
|
8998
|
+
* 269 response carrying the creative units cost. `api` estimates at the API tier.
|
|
8848
8999
|
*/
|
|
8849
|
-
dryRun?:
|
|
9000
|
+
dryRun?: 'true' | 'api';
|
|
8850
9001
|
/**
|
|
8851
9002
|
* Query param: If set to true, returns the original asset without transformation
|
|
8852
9003
|
*/
|
|
8853
9004
|
originalAssets?: boolean;
|
|
8854
9005
|
/**
|
|
8855
|
-
* Query param
|
|
9006
|
+
* Query param: The projectId used for ownership resource management. Either to
|
|
9007
|
+
* assert ownership or to set the owner of the resource(s)
|
|
8856
9008
|
*/
|
|
8857
|
-
projectId?:
|
|
9009
|
+
projectId?: string;
|
|
8858
9010
|
/**
|
|
8859
9011
|
* Body param: Contrast factor for Grayscale detector
|
|
8860
9012
|
*/
|
|
@@ -8891,17 +9043,19 @@ export interface GenerateEmbedParams {
|
|
|
8891
9043
|
*/
|
|
8892
9044
|
text: string;
|
|
8893
9045
|
/**
|
|
8894
|
-
* Query param
|
|
9046
|
+
* Query param: Estimate the operation instead of running it: the call returns a
|
|
9047
|
+
* 269 response carrying the creative units cost. `api` estimates at the API tier.
|
|
8895
9048
|
*/
|
|
8896
|
-
dryRun?:
|
|
9049
|
+
dryRun?: 'true' | 'api';
|
|
8897
9050
|
/**
|
|
8898
9051
|
* Query param: If set to true, returns the original asset without transformation
|
|
8899
9052
|
*/
|
|
8900
9053
|
originalAssets?: boolean;
|
|
8901
9054
|
/**
|
|
8902
|
-
* Query param
|
|
9055
|
+
* Query param: The projectId used for ownership resource management. Either to
|
|
9056
|
+
* assert ownership or to set the owner of the resource(s)
|
|
8903
9057
|
*/
|
|
8904
|
-
projectId?:
|
|
9058
|
+
projectId?: string;
|
|
8905
9059
|
}
|
|
8906
9060
|
export interface GeneratePatchParams {
|
|
8907
9061
|
/**
|
|
@@ -8910,18 +9064,15 @@ export interface GeneratePatchParams {
|
|
|
8910
9064
|
* or the asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
8911
9065
|
*/
|
|
8912
9066
|
image: string;
|
|
8913
|
-
/**
|
|
8914
|
-
* Query param
|
|
8915
|
-
*/
|
|
8916
|
-
dryRun?: unknown;
|
|
8917
9067
|
/**
|
|
8918
9068
|
* Query param: If set to true, returns the original asset without transformation
|
|
8919
9069
|
*/
|
|
8920
9070
|
originalAssets?: boolean;
|
|
8921
9071
|
/**
|
|
8922
|
-
* Query param
|
|
9072
|
+
* Query param: The projectId used for ownership resource management. Either to
|
|
9073
|
+
* assert ownership or to set the owner of the resource(s)
|
|
8923
9074
|
*/
|
|
8924
|
-
projectId?:
|
|
9075
|
+
projectId?: string;
|
|
8925
9076
|
/**
|
|
8926
9077
|
* Body param: Whether to allow the merged image to extend the size of the original
|
|
8927
9078
|
* (when x or y are negative or merged image is bigger)
|
|
@@ -8997,13 +9148,15 @@ export interface GeneratePromptParams {
|
|
|
8997
9148
|
*/
|
|
8998
9149
|
mode: 'completion' | 'contextual' | 'contextual-v2' | 'image-editing' | 'inventive' | 'structured';
|
|
8999
9150
|
/**
|
|
9000
|
-
* Query param
|
|
9151
|
+
* Query param: Estimate the operation instead of running it: the call returns a
|
|
9152
|
+
* 269 response carrying the creative units cost. `api` estimates at the API tier.
|
|
9001
9153
|
*/
|
|
9002
|
-
dryRun?:
|
|
9154
|
+
dryRun?: 'true' | 'api';
|
|
9003
9155
|
/**
|
|
9004
|
-
* Query param
|
|
9156
|
+
* Query param: The projectId used for ownership resource management. Either to
|
|
9157
|
+
* assert ownership or to set the owner of the resource(s)
|
|
9005
9158
|
*/
|
|
9006
|
-
projectId?:
|
|
9159
|
+
projectId?: string;
|
|
9007
9160
|
/**
|
|
9008
9161
|
* Body param: The asset ids used to condition the generation.
|
|
9009
9162
|
*
|
|
@@ -9097,13 +9250,16 @@ export interface GenerateRunModelParams {
|
|
|
9097
9250
|
*/
|
|
9098
9251
|
body: unknown;
|
|
9099
9252
|
/**
|
|
9100
|
-
* Query param
|
|
9253
|
+
* Query param: Estimate the operation instead of running it: the call returns a
|
|
9254
|
+
* 269 response carrying the creative units cost. `api` estimates at the API tier.
|
|
9101
9255
|
*/
|
|
9102
|
-
dryRun?:
|
|
9256
|
+
dryRun?: 'true' | 'api';
|
|
9103
9257
|
/**
|
|
9104
9258
|
* Query param: Set to "true" to run an IP-detection preflight on this request.
|
|
9105
9259
|
* Combine with ?dryRun=true for an advisory check that returns findings without
|
|
9106
|
-
* generating.
|
|
9260
|
+
* generating — note the detection fee is charged even then. Ignored (no detection,
|
|
9261
|
+
* no fee) for a team without the Enterprise plan. To check prompts or assets
|
|
9262
|
+
* without a generation, use POST /generate/ip-detection.
|
|
9107
9263
|
*/
|
|
9108
9264
|
ipDetection?: boolean;
|
|
9109
9265
|
/**
|
|
@@ -9118,13 +9274,15 @@ export interface GenerateTranslateParams {
|
|
|
9118
9274
|
*/
|
|
9119
9275
|
prompt: string;
|
|
9120
9276
|
/**
|
|
9121
|
-
* Query param
|
|
9277
|
+
* Query param: Estimate the operation instead of running it: the call returns a
|
|
9278
|
+
* 269 response carrying the creative units cost. `api` estimates at the API tier.
|
|
9122
9279
|
*/
|
|
9123
|
-
dryRun?:
|
|
9280
|
+
dryRun?: 'true' | 'api';
|
|
9124
9281
|
/**
|
|
9125
|
-
* Query param
|
|
9282
|
+
* Query param: The projectId used for ownership resource management. Either to
|
|
9283
|
+
* assert ownership or to set the owner of the resource(s)
|
|
9126
9284
|
*/
|
|
9127
|
-
projectId?:
|
|
9285
|
+
projectId?: string;
|
|
9128
9286
|
/**
|
|
9129
9287
|
* Body param: Whether we try to ensure IP removal for new prompt generation.
|
|
9130
9288
|
*/
|