@scenario-labs/sdk 0.3.0 → 1.0.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 +22 -0
- package/README.md +40 -6
- package/client.d.mts +34 -14
- package/client.d.mts.map +1 -1
- package/client.d.ts +34 -14
- 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 +2 -0
- package/index.d.mts.map +1 -1
- package/index.d.ts +2 -0
- package/index.d.ts.map +1 -1
- package/index.js +7 -1
- package/index.js.map +1 -1
- package/index.mjs +2 -0
- package/index.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 +2 -0
- package/lib/scenario.d.mts.map +1 -1
- package/lib/scenario.d.ts +2 -0
- package/lib/scenario.d.ts.map +1 -1
- package/lib/scenario.js +2 -0
- package/lib/scenario.js.map +1 -1
- package/lib/scenario.mjs +2 -0
- package/lib/scenario.mjs.map +1 -1
- package/lib/upload.d.mts +89 -0
- package/lib/upload.d.mts.map +1 -0
- package/lib/upload.d.ts +89 -0
- package/lib/upload.d.ts.map +1 -0
- package/lib/upload.js +193 -0
- package/lib/upload.js.map +1 -0
- package/lib/upload.mjs +156 -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 +623 -646
- package/resources/assets/assets.d.mts.map +1 -1
- package/resources/assets/assets.d.ts +623 -646
- 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/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/index.d.mts +7 -7
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +7 -7
- 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/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 +839 -850
- package/resources/models/models.d.mts.map +1 -1
- package/resources/models/models.d.ts +839 -850
- 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/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/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 +103 -2
- package/src/core/pagination.ts +497 -0
- package/src/index.ts +8 -0
- package/src/lib/models.ts +62 -2
- package/src/lib/scenario.ts +2 -0
- package/src/lib/upload.ts +250 -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 +887 -902
- package/src/resources/assets/index.ts +2 -0
- package/src/resources/collections/collections.ts +45 -54
- package/src/resources/collections/index.ts +1 -0
- package/src/resources/index.ts +9 -1
- package/src/resources/jobs.ts +613 -622
- package/src/resources/models/index.ts +1 -0
- package/src/resources/models/models.ts +1052 -1064
- package/src/resources/search.ts +239 -327
- package/src/resources/tags.ts +32 -39
- 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
|
@@ -8,6 +8,7 @@ import { Train, TrainActionParams, TrainActionResponse, TrainTriggerParams, Trai
|
|
|
8
8
|
import * as TrainingImagesAPI from "./training-images.mjs";
|
|
9
9
|
import { TrainingImageAddParams, TrainingImageAddResponse, TrainingImageDeleteParams, TrainingImageDeleteResponse, TrainingImageReplacePairsParams, TrainingImageReplacePairsResponse, TrainingImageReplaceParams, TrainingImageReplaceResponse, TrainingImages } from "./training-images.mjs";
|
|
10
10
|
import { APIPromise } from "../../core/api-promise.mjs";
|
|
11
|
+
import { ModelsCursor, type ModelsCursorParams, PagePromise } from "../../core/pagination.mjs";
|
|
11
12
|
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
12
13
|
export declare class Models extends APIResource {
|
|
13
14
|
description: DescriptionAPI.Description;
|
|
@@ -33,7 +34,7 @@ export declare class Models extends APIResource {
|
|
|
33
34
|
* List all models. Supports both public access (via the `Authorization` header set
|
|
34
35
|
* to `public-auth-token`) and authenticated user access (including API keys).
|
|
35
36
|
*/
|
|
36
|
-
list(query?: ModelListParams | null | undefined, options?: RequestOptions):
|
|
37
|
+
list(query?: ModelListParams | null | undefined, options?: RequestOptions): PagePromise<ModelListResponsesModelsCursor, ModelListResponse>;
|
|
37
38
|
/**
|
|
38
39
|
* Delete a model
|
|
39
40
|
*/
|
|
@@ -65,6 +66,7 @@ export declare class Models extends APIResource {
|
|
|
65
66
|
*/
|
|
66
67
|
updateTags(modelID: string, body: ModelUpdateTagsParams, options?: RequestOptions): APIPromise<ModelUpdateTagsResponse>;
|
|
67
68
|
}
|
|
69
|
+
export type ModelListResponsesModelsCursor = ModelsCursor<ModelListResponse>;
|
|
68
70
|
export interface ModelCreateResponse {
|
|
69
71
|
model: ModelCreateResponse.Model;
|
|
70
72
|
}
|
|
@@ -3060,1004 +3062,995 @@ export declare namespace ModelUpdateResponse {
|
|
|
3060
3062
|
}
|
|
3061
3063
|
}
|
|
3062
3064
|
export interface ModelListResponse {
|
|
3063
|
-
models: Array<ModelListResponse.Model>;
|
|
3064
3065
|
/**
|
|
3065
|
-
*
|
|
3066
|
+
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
3066
3067
|
*/
|
|
3067
|
-
|
|
3068
|
+
id: string;
|
|
3069
|
+
/**
|
|
3070
|
+
* List of model capabilities (example: ["txt2img", "img2img",
|
|
3071
|
+
* "txt2img_ip_adapter", ...])
|
|
3072
|
+
*/
|
|
3073
|
+
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video23d' | 'video2img' | 'video2video'>;
|
|
3074
|
+
/**
|
|
3075
|
+
* A list of CollectionId this model belongs to
|
|
3076
|
+
*/
|
|
3077
|
+
collectionIds: Array<string>;
|
|
3078
|
+
/**
|
|
3079
|
+
* The model creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
|
|
3080
|
+
*/
|
|
3081
|
+
createdAt: string;
|
|
3082
|
+
/**
|
|
3083
|
+
* Whether the model is a custom model and can be used only with POST
|
|
3084
|
+
* /generate/custom/{modelId} endpoint
|
|
3085
|
+
*/
|
|
3086
|
+
custom: boolean;
|
|
3087
|
+
/**
|
|
3088
|
+
* List of all example asset IDs setup by the model owner
|
|
3089
|
+
*/
|
|
3090
|
+
exampleAssetIds: Array<string>;
|
|
3091
|
+
/**
|
|
3092
|
+
* The privacy of the model (default: private)
|
|
3093
|
+
*/
|
|
3094
|
+
privacy: 'private' | 'public' | 'unlisted';
|
|
3095
|
+
/**
|
|
3096
|
+
* The source of the model
|
|
3097
|
+
*/
|
|
3098
|
+
source: 'civitai' | 'huggingface' | 'other' | 'scenario';
|
|
3099
|
+
/**
|
|
3100
|
+
* The model status
|
|
3101
|
+
*/
|
|
3102
|
+
status: 'copying' | 'failed' | 'new' | 'trained' | 'training' | 'training-canceled';
|
|
3103
|
+
/**
|
|
3104
|
+
* The associated tags (example: ["sci-fi", "landscape"])
|
|
3105
|
+
*/
|
|
3106
|
+
tags: Array<string>;
|
|
3107
|
+
/**
|
|
3108
|
+
* The total number of training images
|
|
3109
|
+
*/
|
|
3110
|
+
trainingImagesNumber: number;
|
|
3111
|
+
/**
|
|
3112
|
+
* The model type (example: "flux.1-lora")
|
|
3113
|
+
*/
|
|
3114
|
+
type: 'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
3115
|
+
/**
|
|
3116
|
+
* The model last update date as an ISO string (example:
|
|
3117
|
+
* "2023-02-03T11:19:41.579Z")
|
|
3118
|
+
*/
|
|
3119
|
+
updatedAt: string;
|
|
3120
|
+
/**
|
|
3121
|
+
* The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
|
|
3122
|
+
* 75: Team plan 100: Enterprise plan
|
|
3123
|
+
*/
|
|
3124
|
+
accessRestrictions?: 0 | 100 | 25 | 50 | 75;
|
|
3125
|
+
/**
|
|
3126
|
+
* The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
|
|
3127
|
+
*/
|
|
3128
|
+
authorId?: string;
|
|
3129
|
+
/**
|
|
3130
|
+
* The class of the model
|
|
3131
|
+
*/
|
|
3132
|
+
class?: ModelListResponse.Class;
|
|
3133
|
+
/**
|
|
3134
|
+
* List of base model IDs compliant with the model (example: ["flux.1-dev",
|
|
3135
|
+
* "flux.1-schnell"]) This attribute is mainly used for Flux LoRA models
|
|
3136
|
+
*/
|
|
3137
|
+
compliantModelIds?: Array<string>;
|
|
3138
|
+
/**
|
|
3139
|
+
* The concepts is required for the type model: composition
|
|
3140
|
+
*/
|
|
3141
|
+
concepts?: Array<ModelListResponse.Concept>;
|
|
3142
|
+
/**
|
|
3143
|
+
* The epoch of the model. Only available for Flux Lora Trained models. If not set,
|
|
3144
|
+
* uses the final model epoch (latest)
|
|
3145
|
+
*/
|
|
3146
|
+
epoch?: string;
|
|
3147
|
+
/**
|
|
3148
|
+
* The epochs of the model. Only available for Flux Lora Trained models.
|
|
3149
|
+
*/
|
|
3150
|
+
epochs?: Array<ModelListResponse.Epoch>;
|
|
3151
|
+
/**
|
|
3152
|
+
* The inputs of the model. Only used for custom models. To retrieve this list, get
|
|
3153
|
+
* it by modelId with GET /models/{modelId}
|
|
3154
|
+
*/
|
|
3155
|
+
inputs?: Array<ModelListResponse.Input>;
|
|
3156
|
+
/**
|
|
3157
|
+
* The model keyword, this is a legacy parameter, please use conceptPrompt in
|
|
3158
|
+
* parameters
|
|
3159
|
+
*/
|
|
3160
|
+
modelKeyword?: string;
|
|
3161
|
+
/**
|
|
3162
|
+
* The model name (example: "Cinematic Realism")
|
|
3163
|
+
*/
|
|
3164
|
+
name?: string;
|
|
3165
|
+
/**
|
|
3166
|
+
* Fine-tune the model's inferences with negative prompt embedding
|
|
3167
|
+
*/
|
|
3168
|
+
negativePromptEmbedding?: string;
|
|
3169
|
+
/**
|
|
3170
|
+
* The owner ID (example: "team_VFhihHKMRZyDDnZAJwLb2Q")
|
|
3171
|
+
*/
|
|
3172
|
+
ownerId?: string;
|
|
3173
|
+
/**
|
|
3174
|
+
* The parameters of the model
|
|
3175
|
+
*/
|
|
3176
|
+
parameters?: ModelListResponse.Parameters;
|
|
3177
|
+
/**
|
|
3178
|
+
* The id of the parent model
|
|
3179
|
+
*/
|
|
3180
|
+
parentModelId?: string;
|
|
3181
|
+
/**
|
|
3182
|
+
* Aggregated performance stats
|
|
3183
|
+
*/
|
|
3184
|
+
performanceStats?: ModelListResponse.PerformanceStats;
|
|
3185
|
+
/**
|
|
3186
|
+
* Fine-tune the model's inferences with prompt embedding
|
|
3187
|
+
*/
|
|
3188
|
+
promptEmbedding?: string;
|
|
3189
|
+
/**
|
|
3190
|
+
* The model short description (example: "This model generates highly detailed
|
|
3191
|
+
* cinematic scenes.")
|
|
3192
|
+
*/
|
|
3193
|
+
shortDescription?: string;
|
|
3194
|
+
/**
|
|
3195
|
+
* The date when the model will be soft deleted (only for Free plan)
|
|
3196
|
+
*/
|
|
3197
|
+
softDeletionOn?: string;
|
|
3198
|
+
/**
|
|
3199
|
+
* A thumbnail for your model
|
|
3200
|
+
*/
|
|
3201
|
+
thumbnail?: ModelListResponse.Thumbnail;
|
|
3202
|
+
/**
|
|
3203
|
+
* Array of training image pairs
|
|
3204
|
+
*/
|
|
3205
|
+
trainingImagePairs?: Array<ModelListResponse.TrainingImagePair>;
|
|
3206
|
+
/**
|
|
3207
|
+
* The URLs of the first 3 training images of the model. To retrieve the full set
|
|
3208
|
+
* of images, get it by modelId
|
|
3209
|
+
*/
|
|
3210
|
+
trainingImages?: Array<ModelListResponse.TrainingImage>;
|
|
3211
|
+
/**
|
|
3212
|
+
* Additional information about the training progress of the model
|
|
3213
|
+
*/
|
|
3214
|
+
trainingProgress?: ModelListResponse.TrainingProgress;
|
|
3215
|
+
/**
|
|
3216
|
+
* Additional information about the model's training
|
|
3217
|
+
*/
|
|
3218
|
+
trainingStats?: ModelListResponse.TrainingStats;
|
|
3219
|
+
/**
|
|
3220
|
+
* The UI configuration for the model
|
|
3221
|
+
*/
|
|
3222
|
+
uiConfig?: ModelListResponse.UiConfig;
|
|
3223
|
+
/**
|
|
3224
|
+
* (Deprecated) The user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
|
|
3225
|
+
*/
|
|
3226
|
+
userId?: string;
|
|
3068
3227
|
}
|
|
3069
3228
|
export declare namespace ModelListResponse {
|
|
3070
|
-
|
|
3229
|
+
/**
|
|
3230
|
+
* The class of the model
|
|
3231
|
+
*/
|
|
3232
|
+
interface Class {
|
|
3071
3233
|
/**
|
|
3072
|
-
* The
|
|
3234
|
+
* The category slug of the class (example: "art-style")
|
|
3073
3235
|
*/
|
|
3074
|
-
|
|
3236
|
+
category: string;
|
|
3075
3237
|
/**
|
|
3076
|
-
*
|
|
3077
|
-
* "txt2img_ip_adapter", ...])
|
|
3238
|
+
* The concept prompt of the class (example: "a sks character design")
|
|
3078
3239
|
*/
|
|
3079
|
-
|
|
3240
|
+
conceptPrompt: string;
|
|
3080
3241
|
/**
|
|
3081
|
-
*
|
|
3242
|
+
* The model ID of the class (example: "stable-diffusion-v1-5")
|
|
3082
3243
|
*/
|
|
3083
|
-
|
|
3244
|
+
modelId: string;
|
|
3084
3245
|
/**
|
|
3085
|
-
* The
|
|
3246
|
+
* The class name (example: "Character Design")
|
|
3086
3247
|
*/
|
|
3087
|
-
|
|
3248
|
+
name: string;
|
|
3088
3249
|
/**
|
|
3089
|
-
*
|
|
3090
|
-
* /generate/custom/{modelId} endpoint
|
|
3250
|
+
* The class prompt (example: "a character design")
|
|
3091
3251
|
*/
|
|
3092
|
-
|
|
3252
|
+
prompt: string;
|
|
3093
3253
|
/**
|
|
3094
|
-
*
|
|
3254
|
+
* The class slug (example: "art-style-character-design")
|
|
3095
3255
|
*/
|
|
3096
|
-
|
|
3256
|
+
slug: string;
|
|
3097
3257
|
/**
|
|
3098
|
-
* The
|
|
3258
|
+
* The class status (only published classes are listed, but unpublished classes can
|
|
3259
|
+
* still appear in existing models)
|
|
3099
3260
|
*/
|
|
3100
|
-
|
|
3261
|
+
status: 'published' | 'unpublished';
|
|
3101
3262
|
/**
|
|
3102
|
-
*
|
|
3263
|
+
* Some example images URLs to showcase the class
|
|
3103
3264
|
*/
|
|
3104
|
-
|
|
3265
|
+
thumbnails: Array<string>;
|
|
3266
|
+
}
|
|
3267
|
+
interface Concept {
|
|
3105
3268
|
/**
|
|
3106
|
-
* The model
|
|
3269
|
+
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
3107
3270
|
*/
|
|
3108
|
-
|
|
3271
|
+
modelId: string;
|
|
3109
3272
|
/**
|
|
3110
|
-
* The
|
|
3273
|
+
* The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
|
|
3274
|
+
* is between 0 and 2.
|
|
3111
3275
|
*/
|
|
3112
|
-
|
|
3276
|
+
scale: number;
|
|
3113
3277
|
/**
|
|
3114
|
-
* The
|
|
3278
|
+
* The epoch of the model (example: "000001") Only available for Flux Lora Trained
|
|
3279
|
+
* models
|
|
3115
3280
|
*/
|
|
3116
|
-
|
|
3281
|
+
modelEpoch?: string;
|
|
3282
|
+
}
|
|
3283
|
+
interface Epoch {
|
|
3117
3284
|
/**
|
|
3118
|
-
* The
|
|
3285
|
+
* The epoch hash to identify the epoch
|
|
3119
3286
|
*/
|
|
3120
|
-
|
|
3287
|
+
epoch: string;
|
|
3121
3288
|
/**
|
|
3122
|
-
* The
|
|
3123
|
-
* "2023-02-03T11:19:41.579Z")
|
|
3289
|
+
* The assets of the epoch if sample prompts as been supplied during training
|
|
3124
3290
|
*/
|
|
3125
|
-
|
|
3291
|
+
assets?: Array<Epoch.Asset>;
|
|
3292
|
+
}
|
|
3293
|
+
namespace Epoch {
|
|
3294
|
+
interface Asset {
|
|
3295
|
+
/**
|
|
3296
|
+
* The AssetId of the image during training (example:
|
|
3297
|
+
* "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
3298
|
+
*/
|
|
3299
|
+
assetId: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* The url of the asset
|
|
3302
|
+
*/
|
|
3303
|
+
url: string;
|
|
3304
|
+
}
|
|
3305
|
+
}
|
|
3306
|
+
/**
|
|
3307
|
+
* Defines the input parameters for a model. Use this to understand the available
|
|
3308
|
+
* input parameters for a given `modelId` when calling
|
|
3309
|
+
* `POST /generate/custom/{modelId}`. See {@link
|
|
3310
|
+
* https://docs.scenario.com/docs/video-generation} for examples.
|
|
3311
|
+
*/
|
|
3312
|
+
interface Input {
|
|
3126
3313
|
/**
|
|
3127
|
-
* The
|
|
3128
|
-
* 75: Team plan 100: Enterprise plan
|
|
3314
|
+
* The name that must be user to call the model through the API
|
|
3129
3315
|
*/
|
|
3130
|
-
|
|
3316
|
+
name: string;
|
|
3131
3317
|
/**
|
|
3132
|
-
* The
|
|
3318
|
+
* The data type of the input
|
|
3133
3319
|
*/
|
|
3134
|
-
|
|
3320
|
+
type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
|
|
3135
3321
|
/**
|
|
3136
|
-
* The
|
|
3322
|
+
* The allowed values for the input. For \`string\` or \`number\` types, creates a
|
|
3323
|
+
* single-select dropdown. For \`string_array\` type, creates a multi-select
|
|
3324
|
+
* dropdown.
|
|
3137
3325
|
*/
|
|
3138
|
-
|
|
3326
|
+
allowedValues?: Array<unknown>;
|
|
3139
3327
|
/**
|
|
3140
|
-
*
|
|
3141
|
-
*
|
|
3328
|
+
* Specifies the background behavior for the input. Only available for \`file\` and
|
|
3329
|
+
* \`file_array\` input types with kind \`image\`.
|
|
3142
3330
|
*/
|
|
3143
|
-
|
|
3331
|
+
backgroundBehavior?: 'opaque' | 'transparent';
|
|
3144
3332
|
/**
|
|
3145
|
-
*
|
|
3333
|
+
* Whether the input is a color or not. Only available for \`string\` input type.
|
|
3146
3334
|
*/
|
|
3147
|
-
|
|
3335
|
+
color?: boolean;
|
|
3148
3336
|
/**
|
|
3149
|
-
*
|
|
3150
|
-
* uses the final model epoch (latest)
|
|
3337
|
+
* Whether this input affects the model's cost calculation
|
|
3151
3338
|
*/
|
|
3152
|
-
|
|
3339
|
+
costImpact?: boolean;
|
|
3153
3340
|
/**
|
|
3154
|
-
* The
|
|
3341
|
+
* The default value for the input
|
|
3155
3342
|
*/
|
|
3156
|
-
|
|
3343
|
+
default?: unknown;
|
|
3157
3344
|
/**
|
|
3158
|
-
*
|
|
3159
|
-
* it by modelId with GET /models/{modelId}
|
|
3345
|
+
* Help text displayed in the UI to provide additional information about the input
|
|
3160
3346
|
*/
|
|
3161
|
-
|
|
3347
|
+
description?: string;
|
|
3162
3348
|
/**
|
|
3163
|
-
*
|
|
3164
|
-
*
|
|
3349
|
+
* Used to visually group inputs together in the UI. Inputs with the same group
|
|
3350
|
+
* value appear consecutively in the UI.
|
|
3165
3351
|
*/
|
|
3166
|
-
|
|
3352
|
+
group?: string;
|
|
3167
3353
|
/**
|
|
3168
|
-
*
|
|
3354
|
+
* Hint text displayed in the UI as a tooltip to guide the user
|
|
3169
3355
|
*/
|
|
3170
|
-
|
|
3356
|
+
hint?: string;
|
|
3171
3357
|
/**
|
|
3172
|
-
*
|
|
3358
|
+
* The list of inputs which form an object within a container array. All inputs are
|
|
3359
|
+
* the same as the current object. This is only available for type inputs_array
|
|
3360
|
+
* inputs.
|
|
3173
3361
|
*/
|
|
3174
|
-
|
|
3362
|
+
inputs?: Array<{
|
|
3363
|
+
[key: string]: unknown;
|
|
3364
|
+
}>;
|
|
3175
3365
|
/**
|
|
3176
|
-
* The
|
|
3366
|
+
* The asset kind of the input. Only taken into account for \`file\` and
|
|
3367
|
+
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
3368
|
+
* not able to create the asset on the flight on API side with dataurl without
|
|
3369
|
+
* data:kind, prefix
|
|
3177
3370
|
*/
|
|
3178
|
-
|
|
3371
|
+
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
3179
3372
|
/**
|
|
3180
|
-
* The
|
|
3373
|
+
* The label displayed in the UI for this input
|
|
3181
3374
|
*/
|
|
3182
|
-
|
|
3375
|
+
label?: string;
|
|
3183
3376
|
/**
|
|
3184
|
-
* The
|
|
3377
|
+
* The name of the file input field to use as the mask source
|
|
3185
3378
|
*/
|
|
3186
|
-
|
|
3379
|
+
maskFrom?: string;
|
|
3187
3380
|
/**
|
|
3188
|
-
*
|
|
3381
|
+
* The maximum allowed value. Only available for \`number\` and \`array\` input
|
|
3382
|
+
* types.
|
|
3189
3383
|
*/
|
|
3190
|
-
|
|
3384
|
+
max?: number;
|
|
3191
3385
|
/**
|
|
3192
|
-
*
|
|
3386
|
+
* The maximum allowed length for \`string\` inputs. Also applies to each item in
|
|
3387
|
+
* \`string_array\`.
|
|
3193
3388
|
*/
|
|
3194
|
-
|
|
3389
|
+
maxLength?: number;
|
|
3195
3390
|
/**
|
|
3196
|
-
* The
|
|
3197
|
-
*
|
|
3391
|
+
* The maximum allowed file size in bytes. Only applies to \`file\` and
|
|
3392
|
+
* \`file_array\` input types. Validated against \`asset.properties.size\` at job
|
|
3393
|
+
* creation time.
|
|
3198
3394
|
*/
|
|
3199
|
-
|
|
3395
|
+
maxSize?: number;
|
|
3200
3396
|
/**
|
|
3201
|
-
* The
|
|
3397
|
+
* The minimum allowed value. Only available for \`number\` and array input types.
|
|
3202
3398
|
*/
|
|
3203
|
-
|
|
3399
|
+
min?: number;
|
|
3204
3400
|
/**
|
|
3205
|
-
*
|
|
3401
|
+
* The minimum allowed length for string inputs. Also applies to each item in
|
|
3402
|
+
* \`string_array\`.
|
|
3206
3403
|
*/
|
|
3207
|
-
|
|
3404
|
+
minLength?: number;
|
|
3208
3405
|
/**
|
|
3209
|
-
*
|
|
3406
|
+
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
3407
|
+
* available for \`model_array\` input type.
|
|
3210
3408
|
*/
|
|
3211
|
-
|
|
3409
|
+
modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
|
|
3212
3410
|
/**
|
|
3213
|
-
*
|
|
3214
|
-
*
|
|
3411
|
+
* Whether this input represents a parent asset to assign to the produced assets.
|
|
3412
|
+
* Only available for \`file\` and \`file_array\` input types.
|
|
3413
|
+
*
|
|
3414
|
+
* For \`file_array\`, the parent asset is the first item in the array.
|
|
3215
3415
|
*/
|
|
3216
|
-
|
|
3416
|
+
parent?: boolean;
|
|
3217
3417
|
/**
|
|
3218
|
-
*
|
|
3418
|
+
* Placeholder text for the input. Only available for 'string' input type.
|
|
3219
3419
|
*/
|
|
3220
|
-
|
|
3420
|
+
placeholder?: string;
|
|
3221
3421
|
/**
|
|
3222
|
-
*
|
|
3422
|
+
* Whether the input is a prompt. When true, displays as a text area with prompt
|
|
3423
|
+
* spark feature. Only available for \`string\` input type.
|
|
3223
3424
|
*/
|
|
3224
|
-
|
|
3425
|
+
prompt?: boolean;
|
|
3225
3426
|
/**
|
|
3226
|
-
*
|
|
3427
|
+
* Whether the input is used with prompt spark. Only available for \`string\` input
|
|
3428
|
+
* type.
|
|
3227
3429
|
*/
|
|
3228
|
-
|
|
3430
|
+
promptSpark?: boolean;
|
|
3229
3431
|
/**
|
|
3230
|
-
*
|
|
3432
|
+
* Set of rules that describes when this input is required:
|
|
3433
|
+
*
|
|
3434
|
+
* - \`always\`: Input is always required
|
|
3435
|
+
* - \`ifNotDefined\`: Input is required when another specified input is not
|
|
3436
|
+
* defined
|
|
3437
|
+
* - \`ifDefined\`: Input is required when another specified input is defined
|
|
3438
|
+
* - \`conditionalValues\`: Input is required when another input has a specific
|
|
3439
|
+
* value
|
|
3440
|
+
*
|
|
3441
|
+
* By default, the input is not required.
|
|
3231
3442
|
*/
|
|
3232
|
-
|
|
3443
|
+
required?: Input.Required;
|
|
3444
|
+
/**
|
|
3445
|
+
* The step increment for numeric inputs. Only available for \`number\` input type.
|
|
3446
|
+
*/
|
|
3447
|
+
step?: number;
|
|
3233
3448
|
}
|
|
3234
|
-
namespace
|
|
3449
|
+
namespace Input {
|
|
3235
3450
|
/**
|
|
3236
|
-
*
|
|
3451
|
+
* Set of rules that describes when this input is required:
|
|
3452
|
+
*
|
|
3453
|
+
* - \`always\`: Input is always required
|
|
3454
|
+
* - \`ifNotDefined\`: Input is required when another specified input is not
|
|
3455
|
+
* defined
|
|
3456
|
+
* - \`ifDefined\`: Input is required when another specified input is defined
|
|
3457
|
+
* - \`conditionalValues\`: Input is required when another input has a specific
|
|
3458
|
+
* value
|
|
3459
|
+
*
|
|
3460
|
+
* By default, the input is not required.
|
|
3237
3461
|
*/
|
|
3238
|
-
interface
|
|
3239
|
-
/**
|
|
3240
|
-
* The category slug of the class (example: "art-style")
|
|
3241
|
-
*/
|
|
3242
|
-
category: string;
|
|
3243
|
-
/**
|
|
3244
|
-
* The concept prompt of the class (example: "a sks character design")
|
|
3245
|
-
*/
|
|
3246
|
-
conceptPrompt: string;
|
|
3247
|
-
/**
|
|
3248
|
-
* The model ID of the class (example: "stable-diffusion-v1-5")
|
|
3249
|
-
*/
|
|
3250
|
-
modelId: string;
|
|
3251
|
-
/**
|
|
3252
|
-
* The class name (example: "Character Design")
|
|
3253
|
-
*/
|
|
3254
|
-
name: string;
|
|
3255
|
-
/**
|
|
3256
|
-
* The class prompt (example: "a character design")
|
|
3257
|
-
*/
|
|
3258
|
-
prompt: string;
|
|
3259
|
-
/**
|
|
3260
|
-
* The class slug (example: "art-style-character-design")
|
|
3261
|
-
*/
|
|
3262
|
-
slug: string;
|
|
3263
|
-
/**
|
|
3264
|
-
* The class status (only published classes are listed, but unpublished classes can
|
|
3265
|
-
* still appear in existing models)
|
|
3266
|
-
*/
|
|
3267
|
-
status: 'published' | 'unpublished';
|
|
3268
|
-
/**
|
|
3269
|
-
* Some example images URLs to showcase the class
|
|
3270
|
-
*/
|
|
3271
|
-
thumbnails: Array<string>;
|
|
3272
|
-
}
|
|
3273
|
-
interface Concept {
|
|
3274
|
-
/**
|
|
3275
|
-
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
3276
|
-
*/
|
|
3277
|
-
modelId: string;
|
|
3462
|
+
interface Required {
|
|
3278
3463
|
/**
|
|
3279
|
-
*
|
|
3280
|
-
* is between 0 and 2.
|
|
3464
|
+
* Whether the input is always required
|
|
3281
3465
|
*/
|
|
3282
|
-
|
|
3466
|
+
always?: boolean;
|
|
3283
3467
|
/**
|
|
3284
|
-
*
|
|
3285
|
-
*
|
|
3468
|
+
* Makes this input required when another input has a specific value:
|
|
3469
|
+
*
|
|
3470
|
+
* - Key: name of the input to check
|
|
3471
|
+
* - Value: operation and allowed values that trigger the requirement
|
|
3286
3472
|
*/
|
|
3287
|
-
|
|
3288
|
-
}
|
|
3289
|
-
interface Epoch {
|
|
3473
|
+
conditionalValues?: unknown;
|
|
3290
3474
|
/**
|
|
3291
|
-
*
|
|
3475
|
+
* Makes this input required when another input is defined:
|
|
3476
|
+
*
|
|
3477
|
+
* - Key: name of the input that must be defined
|
|
3478
|
+
* - Value: message to display when this input is required
|
|
3292
3479
|
*/
|
|
3293
|
-
|
|
3480
|
+
ifDefined?: unknown;
|
|
3294
3481
|
/**
|
|
3295
|
-
*
|
|
3482
|
+
* Makes this input required when another input is not defined:
|
|
3483
|
+
*
|
|
3484
|
+
* - Key: name of the input that must be undefined
|
|
3485
|
+
* - Value: message to display when this input is required
|
|
3296
3486
|
*/
|
|
3297
|
-
|
|
3298
|
-
}
|
|
3299
|
-
namespace Epoch {
|
|
3300
|
-
interface Asset {
|
|
3301
|
-
/**
|
|
3302
|
-
* The AssetId of the image during training (example:
|
|
3303
|
-
* "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
3304
|
-
*/
|
|
3305
|
-
assetId: string;
|
|
3306
|
-
/**
|
|
3307
|
-
* The url of the asset
|
|
3308
|
-
*/
|
|
3309
|
-
url: string;
|
|
3310
|
-
}
|
|
3487
|
+
ifNotDefined?: unknown;
|
|
3311
3488
|
}
|
|
3489
|
+
}
|
|
3490
|
+
/**
|
|
3491
|
+
* The parameters of the model
|
|
3492
|
+
*/
|
|
3493
|
+
interface Parameters {
|
|
3312
3494
|
/**
|
|
3313
|
-
*
|
|
3314
|
-
*
|
|
3315
|
-
*
|
|
3316
|
-
* https://docs.scenario.com/docs/video-generation} for examples.
|
|
3495
|
+
* Age group of the voice (for professional cloning)
|
|
3496
|
+
*
|
|
3497
|
+
* Only available for ElevenLabs voice training
|
|
3317
3498
|
*/
|
|
3318
|
-
|
|
3319
|
-
/**
|
|
3320
|
-
* The name that must be user to call the model through the API
|
|
3321
|
-
*/
|
|
3322
|
-
name: string;
|
|
3323
|
-
/**
|
|
3324
|
-
* The data type of the input
|
|
3325
|
-
*/
|
|
3326
|
-
type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
|
|
3327
|
-
/**
|
|
3328
|
-
* The allowed values for the input. For \`string\` or \`number\` types, creates a
|
|
3329
|
-
* single-select dropdown. For \`string_array\` type, creates a multi-select
|
|
3330
|
-
* dropdown.
|
|
3331
|
-
*/
|
|
3332
|
-
allowedValues?: Array<unknown>;
|
|
3333
|
-
/**
|
|
3334
|
-
* Specifies the background behavior for the input. Only available for \`file\` and
|
|
3335
|
-
* \`file_array\` input types with kind \`image\`.
|
|
3336
|
-
*/
|
|
3337
|
-
backgroundBehavior?: 'opaque' | 'transparent';
|
|
3338
|
-
/**
|
|
3339
|
-
* Whether the input is a color or not. Only available for \`string\` input type.
|
|
3340
|
-
*/
|
|
3341
|
-
color?: boolean;
|
|
3342
|
-
/**
|
|
3343
|
-
* Whether this input affects the model's cost calculation
|
|
3344
|
-
*/
|
|
3345
|
-
costImpact?: boolean;
|
|
3346
|
-
/**
|
|
3347
|
-
* The default value for the input
|
|
3348
|
-
*/
|
|
3349
|
-
default?: unknown;
|
|
3350
|
-
/**
|
|
3351
|
-
* Help text displayed in the UI to provide additional information about the input
|
|
3352
|
-
*/
|
|
3353
|
-
description?: string;
|
|
3354
|
-
/**
|
|
3355
|
-
* Used to visually group inputs together in the UI. Inputs with the same group
|
|
3356
|
-
* value appear consecutively in the UI.
|
|
3357
|
-
*/
|
|
3358
|
-
group?: string;
|
|
3359
|
-
/**
|
|
3360
|
-
* Hint text displayed in the UI as a tooltip to guide the user
|
|
3361
|
-
*/
|
|
3362
|
-
hint?: string;
|
|
3363
|
-
/**
|
|
3364
|
-
* The list of inputs which form an object within a container array. All inputs are
|
|
3365
|
-
* the same as the current object. This is only available for type inputs_array
|
|
3366
|
-
* inputs.
|
|
3367
|
-
*/
|
|
3368
|
-
inputs?: Array<{
|
|
3369
|
-
[key: string]: unknown;
|
|
3370
|
-
}>;
|
|
3371
|
-
/**
|
|
3372
|
-
* The asset kind of the input. Only taken into account for \`file\` and
|
|
3373
|
-
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
3374
|
-
* not able to create the asset on the flight on API side with dataurl without
|
|
3375
|
-
* data:kind, prefix
|
|
3376
|
-
*/
|
|
3377
|
-
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
3378
|
-
/**
|
|
3379
|
-
* The label displayed in the UI for this input
|
|
3380
|
-
*/
|
|
3381
|
-
label?: string;
|
|
3382
|
-
/**
|
|
3383
|
-
* The name of the file input field to use as the mask source
|
|
3384
|
-
*/
|
|
3385
|
-
maskFrom?: string;
|
|
3386
|
-
/**
|
|
3387
|
-
* The maximum allowed value. Only available for \`number\` and \`array\` input
|
|
3388
|
-
* types.
|
|
3389
|
-
*/
|
|
3390
|
-
max?: number;
|
|
3391
|
-
/**
|
|
3392
|
-
* The maximum allowed length for \`string\` inputs. Also applies to each item in
|
|
3393
|
-
* \`string_array\`.
|
|
3394
|
-
*/
|
|
3395
|
-
maxLength?: number;
|
|
3396
|
-
/**
|
|
3397
|
-
* The maximum allowed file size in bytes. Only applies to \`file\` and
|
|
3398
|
-
* \`file_array\` input types. Validated against \`asset.properties.size\` at job
|
|
3399
|
-
* creation time.
|
|
3400
|
-
*/
|
|
3401
|
-
maxSize?: number;
|
|
3402
|
-
/**
|
|
3403
|
-
* The minimum allowed value. Only available for \`number\` and array input types.
|
|
3404
|
-
*/
|
|
3405
|
-
min?: number;
|
|
3406
|
-
/**
|
|
3407
|
-
* The minimum allowed length for string inputs. Also applies to each item in
|
|
3408
|
-
* \`string_array\`.
|
|
3409
|
-
*/
|
|
3410
|
-
minLength?: number;
|
|
3411
|
-
/**
|
|
3412
|
-
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
3413
|
-
* available for \`model_array\` input type.
|
|
3414
|
-
*/
|
|
3415
|
-
modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
|
|
3416
|
-
/**
|
|
3417
|
-
* Whether this input represents a parent asset to assign to the produced assets.
|
|
3418
|
-
* Only available for \`file\` and \`file_array\` input types.
|
|
3419
|
-
*
|
|
3420
|
-
* For \`file_array\`, the parent asset is the first item in the array.
|
|
3421
|
-
*/
|
|
3422
|
-
parent?: boolean;
|
|
3423
|
-
/**
|
|
3424
|
-
* Placeholder text for the input. Only available for 'string' input type.
|
|
3425
|
-
*/
|
|
3426
|
-
placeholder?: string;
|
|
3427
|
-
/**
|
|
3428
|
-
* Whether the input is a prompt. When true, displays as a text area with prompt
|
|
3429
|
-
* spark feature. Only available for \`string\` input type.
|
|
3430
|
-
*/
|
|
3431
|
-
prompt?: boolean;
|
|
3432
|
-
/**
|
|
3433
|
-
* Whether the input is used with prompt spark. Only available for \`string\` input
|
|
3434
|
-
* type.
|
|
3435
|
-
*/
|
|
3436
|
-
promptSpark?: boolean;
|
|
3437
|
-
/**
|
|
3438
|
-
* Set of rules that describes when this input is required:
|
|
3439
|
-
*
|
|
3440
|
-
* - \`always\`: Input is always required
|
|
3441
|
-
* - \`ifNotDefined\`: Input is required when another specified input is not
|
|
3442
|
-
* defined
|
|
3443
|
-
* - \`ifDefined\`: Input is required when another specified input is defined
|
|
3444
|
-
* - \`conditionalValues\`: Input is required when another input has a specific
|
|
3445
|
-
* value
|
|
3446
|
-
*
|
|
3447
|
-
* By default, the input is not required.
|
|
3448
|
-
*/
|
|
3449
|
-
required?: Input.Required;
|
|
3450
|
-
/**
|
|
3451
|
-
* The step increment for numeric inputs. Only available for \`number\` input type.
|
|
3452
|
-
*/
|
|
3453
|
-
step?: number;
|
|
3454
|
-
}
|
|
3455
|
-
namespace Input {
|
|
3456
|
-
/**
|
|
3457
|
-
* Set of rules that describes when this input is required:
|
|
3458
|
-
*
|
|
3459
|
-
* - \`always\`: Input is always required
|
|
3460
|
-
* - \`ifNotDefined\`: Input is required when another specified input is not
|
|
3461
|
-
* defined
|
|
3462
|
-
* - \`ifDefined\`: Input is required when another specified input is defined
|
|
3463
|
-
* - \`conditionalValues\`: Input is required when another input has a specific
|
|
3464
|
-
* value
|
|
3465
|
-
*
|
|
3466
|
-
* By default, the input is not required.
|
|
3467
|
-
*/
|
|
3468
|
-
interface Required {
|
|
3469
|
-
/**
|
|
3470
|
-
* Whether the input is always required
|
|
3471
|
-
*/
|
|
3472
|
-
always?: boolean;
|
|
3473
|
-
/**
|
|
3474
|
-
* Makes this input required when another input has a specific value:
|
|
3475
|
-
*
|
|
3476
|
-
* - Key: name of the input to check
|
|
3477
|
-
* - Value: operation and allowed values that trigger the requirement
|
|
3478
|
-
*/
|
|
3479
|
-
conditionalValues?: unknown;
|
|
3480
|
-
/**
|
|
3481
|
-
* Makes this input required when another input is defined:
|
|
3482
|
-
*
|
|
3483
|
-
* - Key: name of the input that must be defined
|
|
3484
|
-
* - Value: message to display when this input is required
|
|
3485
|
-
*/
|
|
3486
|
-
ifDefined?: unknown;
|
|
3487
|
-
/**
|
|
3488
|
-
* Makes this input required when another input is not defined:
|
|
3489
|
-
*
|
|
3490
|
-
* - Key: name of the input that must be undefined
|
|
3491
|
-
* - Value: message to display when this input is required
|
|
3492
|
-
*/
|
|
3493
|
-
ifNotDefined?: unknown;
|
|
3494
|
-
}
|
|
3495
|
-
}
|
|
3499
|
+
age?: string;
|
|
3496
3500
|
/**
|
|
3497
|
-
* The
|
|
3501
|
+
* The batch size Less steps, and will increase the learning rate
|
|
3502
|
+
*
|
|
3503
|
+
* Only available for Flux LoRA training
|
|
3498
3504
|
*/
|
|
3499
|
-
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
|
|
3514
|
-
|
|
3515
|
-
|
|
3516
|
-
|
|
3517
|
-
|
|
3518
|
-
|
|
3519
|
-
|
|
3520
|
-
|
|
3521
|
-
|
|
3522
|
-
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
|
|
3526
|
-
|
|
3527
|
-
|
|
3528
|
-
|
|
3529
|
-
|
|
3530
|
-
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
|
-
|
|
3541
|
-
|
|
3542
|
-
|
|
3543
|
-
|
|
3544
|
-
|
|
3545
|
-
|
|
3546
|
-
|
|
3547
|
-
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
|
|
3555
|
-
|
|
3556
|
-
|
|
3557
|
-
|
|
3558
|
-
|
|
3559
|
-
|
|
3560
|
-
|
|
3561
|
-
|
|
3562
|
-
|
|
3563
|
-
|
|
3564
|
-
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
|
|
3571
|
-
|
|
3572
|
-
|
|
3573
|
-
|
|
3574
|
-
|
|
3575
|
-
|
|
3576
|
-
|
|
3577
|
-
|
|
3578
|
-
|
|
3579
|
-
|
|
3580
|
-
|
|
3581
|
-
|
|
3582
|
-
|
|
3583
|
-
* Default value varies depending on the model type:
|
|
3584
|
-
*
|
|
3585
|
-
* - For SD1.5: round((number of training images \* 225) / 3)
|
|
3586
|
-
* - For SDXL: number of training images \* 175
|
|
3587
|
-
* - For Flux: number of training images \* 100
|
|
3588
|
-
*
|
|
3589
|
-
* Maximum value varies depending on the model type:
|
|
3590
|
-
*
|
|
3591
|
-
* - For SD1.5 and SDXL: [0, 40000]
|
|
3592
|
-
* - For Flux: [0, 10000]
|
|
3593
|
-
*/
|
|
3594
|
-
maxTrainSteps?: number;
|
|
3595
|
-
/**
|
|
3596
|
-
* The number of epochs to train for
|
|
3597
|
-
*
|
|
3598
|
-
* Only available for Flux LoRA training
|
|
3599
|
-
*/
|
|
3600
|
-
nbEpochs?: number;
|
|
3601
|
-
/**
|
|
3602
|
-
* The number of times to repeat the training
|
|
3603
|
-
*
|
|
3604
|
-
* Only available for Flux LoRA training
|
|
3605
|
-
*/
|
|
3606
|
-
nbRepeats?: number;
|
|
3607
|
-
/**
|
|
3608
|
-
* The number of training steps for the text encoder
|
|
3609
|
-
*
|
|
3610
|
-
* Only available for SDXL LoRA training
|
|
3611
|
-
*/
|
|
3612
|
-
numTextTrainSteps?: number;
|
|
3613
|
-
/**
|
|
3614
|
-
* The number of training steps for the UNet
|
|
3615
|
-
*
|
|
3616
|
-
* Only available for SDXL LoRA training
|
|
3617
|
-
*/
|
|
3618
|
-
numUNetTrainSteps?: number;
|
|
3619
|
-
/**
|
|
3620
|
-
* Optimize the model training task for a specific type of input images. The
|
|
3621
|
-
* available values are:
|
|
3622
|
-
*
|
|
3623
|
-
* - "likeness": optimize training for likeness or portrait (targets specific
|
|
3624
|
-
* transformer blocks)
|
|
3625
|
-
* - "all": train all transformer blocks
|
|
3626
|
-
* - "none": train no specific transformer blocks
|
|
3627
|
-
*
|
|
3628
|
-
* This parameter controls which double and single transformer blocks are trained
|
|
3629
|
-
* during the LoRA training process.
|
|
3630
|
-
*
|
|
3631
|
-
* Only available for Flux LoRA training
|
|
3632
|
-
*/
|
|
3633
|
-
optimizeFor?: 'likeness';
|
|
3634
|
-
/**
|
|
3635
|
-
* The weight of prior preservation loss
|
|
3636
|
-
*
|
|
3637
|
-
* Only available for SD15 and SDXL LoRA training
|
|
3638
|
-
*/
|
|
3639
|
-
priorLossWeight?: number;
|
|
3640
|
-
/**
|
|
3641
|
-
* Whether to random crop or center crop images before resizing to the working
|
|
3642
|
-
* resolution
|
|
3643
|
-
*
|
|
3644
|
-
* Only available for SD15 and SDXL LoRA training
|
|
3645
|
-
*/
|
|
3646
|
-
randomCrop?: boolean;
|
|
3647
|
-
/**
|
|
3648
|
-
* Ratio of random crops
|
|
3649
|
-
*
|
|
3650
|
-
* Only available for SD15 and SDXL LoRA training
|
|
3651
|
-
*/
|
|
3652
|
-
randomCropRatio?: number;
|
|
3653
|
-
/**
|
|
3654
|
-
* Scale of random crops
|
|
3655
|
-
*
|
|
3656
|
-
* Only available for SD15 and SDXL LoRA training
|
|
3657
|
-
*/
|
|
3658
|
-
randomCropScale?: number;
|
|
3659
|
-
/**
|
|
3660
|
-
* The dimension of the LoRA update matrices
|
|
3661
|
-
*
|
|
3662
|
-
* Only available for SDXL (deprecated), Flux LoRA and Musubi training
|
|
3663
|
-
*
|
|
3664
|
-
* Default value varies depending on the model type:
|
|
3665
|
-
*
|
|
3666
|
-
* - For SDXL (deprecated): 64
|
|
3667
|
-
* - For Flux: 16
|
|
3668
|
-
* - For Musubi: 64
|
|
3669
|
-
*
|
|
3670
|
-
* Each trainer enforces its own tighter limit (Flux LoRA: [2; 64], Musubi: [2;
|
|
3671
|
-
* 128])
|
|
3672
|
-
*/
|
|
3673
|
-
rank?: number;
|
|
3674
|
-
/**
|
|
3675
|
-
* Whether to remove background noise from audio samples before cloning. When
|
|
3676
|
-
* enabled, each sample must be at least 5 seconds long.
|
|
3677
|
-
*
|
|
3678
|
-
* Only available for ElevenLabs voice training
|
|
3679
|
-
*/
|
|
3680
|
-
removeBackgroundNoise?: boolean;
|
|
3681
|
-
/**
|
|
3682
|
-
* The prompts to use for each epoch Only available for Flux LoRA training
|
|
3683
|
-
*/
|
|
3684
|
-
samplePrompts?: Array<string>;
|
|
3685
|
-
/**
|
|
3686
|
-
* The sample prompt images (AssetIds) paired with samplePrompts Only available for
|
|
3687
|
-
* Flux LoRA training Must be the same length as samplePrompts
|
|
3688
|
-
*/
|
|
3689
|
-
sampleSourceImages?: Array<string>;
|
|
3690
|
-
/**
|
|
3691
|
-
* Whether to scale the learning rate
|
|
3692
|
-
*
|
|
3693
|
-
* Note: Legacy parameter, will be ignored
|
|
3694
|
-
*
|
|
3695
|
-
* Only available for SD15 and SDXL LoRA training
|
|
3696
|
-
*/
|
|
3697
|
-
scaleLr?: boolean;
|
|
3698
|
-
/**
|
|
3699
|
-
* Used to reproduce previous results. Default: randomly generated number.
|
|
3700
|
-
*
|
|
3701
|
-
* Only available for SD15 and SDXL LoRA training
|
|
3702
|
-
*/
|
|
3703
|
-
seed?: number;
|
|
3704
|
-
/**
|
|
3705
|
-
* Whether to train the text encoder or not
|
|
3706
|
-
*
|
|
3707
|
-
* Example: For 100 steps and a value of 0.2, it means that the text encoder will
|
|
3708
|
-
* be trained for 20 steps and then the UNet for 80 steps
|
|
3709
|
-
*
|
|
3710
|
-
* Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
3711
|
-
*
|
|
3712
|
-
* Only available for SD15 and SDXL LoRA training
|
|
3713
|
-
*/
|
|
3714
|
-
textEncoderTrainingRatio?: number;
|
|
3715
|
-
/**
|
|
3716
|
-
* Validation frequency. Cannot be greater than maxTrainSteps value
|
|
3717
|
-
*
|
|
3718
|
-
* Only available for SD15 and SDXL LoRA training
|
|
3719
|
-
*/
|
|
3720
|
-
validationFrequency?: number;
|
|
3721
|
-
/**
|
|
3722
|
-
* Validation prompt
|
|
3723
|
-
*
|
|
3724
|
-
* Only available for SD15 and SDXL LoRA training
|
|
3725
|
-
*/
|
|
3726
|
-
validationPrompt?: string;
|
|
3727
|
-
/**
|
|
3728
|
-
* Description of the voice characteristics
|
|
3729
|
-
*
|
|
3730
|
-
* Only available for ElevenLabs voice training
|
|
3731
|
-
*/
|
|
3732
|
-
voiceDescription?: string;
|
|
3733
|
-
/**
|
|
3734
|
-
* The Weights And Bias key to use for logging. The maximum length is 40 characters
|
|
3735
|
-
*/
|
|
3736
|
-
wandbKey?: string;
|
|
3737
|
-
}
|
|
3505
|
+
batchSize?: number;
|
|
3506
|
+
/**
|
|
3507
|
+
* The prompt to specify images in the same class as provided instance images
|
|
3508
|
+
*
|
|
3509
|
+
* Only available for SD15 training
|
|
3510
|
+
*/
|
|
3511
|
+
classPrompt?: string;
|
|
3512
|
+
/**
|
|
3513
|
+
* Type of voice cloning: "instant" (fast) or "professional" (higher quality,
|
|
3514
|
+
* requires captcha)
|
|
3515
|
+
*
|
|
3516
|
+
* Only available for ElevenLabs voice training
|
|
3517
|
+
*/
|
|
3518
|
+
cloneType?: string;
|
|
3519
|
+
/**
|
|
3520
|
+
* The prompt with identifier specifying the instance (or subject) of the class
|
|
3521
|
+
* (example: "a daiton dog")
|
|
3522
|
+
*
|
|
3523
|
+
* Default value varies depending on the model type:
|
|
3524
|
+
*
|
|
3525
|
+
* - For SD1.5: "daiton" if no class is associated with the model
|
|
3526
|
+
* - For SDXL: "daiton"
|
|
3527
|
+
* - For Flux: ""
|
|
3528
|
+
*/
|
|
3529
|
+
conceptPrompt?: string;
|
|
3530
|
+
/**
|
|
3531
|
+
* Gender of the voice (for professional cloning)
|
|
3532
|
+
*
|
|
3533
|
+
* Only available for ElevenLabs voice training
|
|
3534
|
+
*/
|
|
3535
|
+
gender?: string;
|
|
3536
|
+
/**
|
|
3537
|
+
* Language of the audio samples (ISO 639-1 code)
|
|
3538
|
+
*
|
|
3539
|
+
* Only available for ElevenLabs voice training
|
|
3540
|
+
*/
|
|
3541
|
+
language?: string;
|
|
3542
|
+
/**
|
|
3543
|
+
* Initial learning rate (after the potential warmup period)
|
|
3544
|
+
*
|
|
3545
|
+
* Default value varies depending on the model type:
|
|
3546
|
+
*
|
|
3547
|
+
* - For SD1.5 and SDXL: 0.000005
|
|
3548
|
+
* - For Flux: 0.0001
|
|
3549
|
+
*/
|
|
3550
|
+
learningRate?: number;
|
|
3551
|
+
/**
|
|
3552
|
+
* Initial learning rate (after the potential warmup period) for the text encoder
|
|
3553
|
+
*
|
|
3554
|
+
* Maximum [Flux LoRA: 0.001] Default [SDXL: 0.00005 | Flux LoRA: 0.00001] Minimum
|
|
3555
|
+
* [SDXL: 0 | Flux LoRA: 0.000001]
|
|
3556
|
+
*/
|
|
3557
|
+
learningRateTextEncoder?: number;
|
|
3558
|
+
/**
|
|
3559
|
+
* Initial learning rate (after the potential warmup period) for the UNet
|
|
3560
|
+
*
|
|
3561
|
+
* Only available for SDXL LoRA training
|
|
3562
|
+
*/
|
|
3563
|
+
learningRateUnet?: number;
|
|
3564
|
+
/**
|
|
3565
|
+
* The scheduler type to use (default: "constant")
|
|
3566
|
+
*
|
|
3567
|
+
* Only available for SD15 and SDXL LoRA training
|
|
3568
|
+
*/
|
|
3569
|
+
lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
|
|
3570
|
+
/**
|
|
3571
|
+
* Maximum number of training steps to execute (default: varies depending on the
|
|
3572
|
+
* model type)
|
|
3573
|
+
*
|
|
3574
|
+
* For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
3575
|
+
* instead
|
|
3576
|
+
*
|
|
3577
|
+
* Default value varies depending on the model type:
|
|
3578
|
+
*
|
|
3579
|
+
* - For SD1.5: round((number of training images \* 225) / 3)
|
|
3580
|
+
* - For SDXL: number of training images \* 175
|
|
3581
|
+
* - For Flux: number of training images \* 100
|
|
3582
|
+
*
|
|
3583
|
+
* Maximum value varies depending on the model type:
|
|
3584
|
+
*
|
|
3585
|
+
* - For SD1.5 and SDXL: [0, 40000]
|
|
3586
|
+
* - For Flux: [0, 10000]
|
|
3587
|
+
*/
|
|
3588
|
+
maxTrainSteps?: number;
|
|
3738
3589
|
/**
|
|
3739
|
-
*
|
|
3590
|
+
* The number of epochs to train for
|
|
3591
|
+
*
|
|
3592
|
+
* Only available for Flux LoRA training
|
|
3740
3593
|
*/
|
|
3741
|
-
|
|
3742
|
-
/**
|
|
3743
|
-
* Performance metrics per variant
|
|
3744
|
-
*/
|
|
3745
|
-
variants: Array<PerformanceStats.Variant>;
|
|
3746
|
-
/**
|
|
3747
|
-
* Default variant key for quick model comparison
|
|
3748
|
-
*/
|
|
3749
|
-
default?: string;
|
|
3750
|
-
}
|
|
3751
|
-
namespace PerformanceStats {
|
|
3752
|
-
/**
|
|
3753
|
-
* Performance stats for a model variant
|
|
3754
|
-
*/
|
|
3755
|
-
interface Variant {
|
|
3756
|
-
/**
|
|
3757
|
-
* The generation capability (example: "txt2img", "img2video", "txt2audio")
|
|
3758
|
-
*/
|
|
3759
|
-
capability: string;
|
|
3760
|
-
/**
|
|
3761
|
-
* When these stats were last computed (ISO date)
|
|
3762
|
-
*/
|
|
3763
|
-
computedAt: string;
|
|
3764
|
-
/**
|
|
3765
|
-
* Unique variant identifier (example: "txt2img:1K", "img2video:2K", "txt2audio")
|
|
3766
|
-
*/
|
|
3767
|
-
variantKey: string;
|
|
3768
|
-
/**
|
|
3769
|
-
* External quality score from arena.ai leaderboard
|
|
3770
|
-
*/
|
|
3771
|
-
arenaScore?: Variant.ArenaScore;
|
|
3772
|
-
/**
|
|
3773
|
-
* Maximum cost per output asset (CU)
|
|
3774
|
-
*/
|
|
3775
|
-
costPerAssetMaxCU?: number;
|
|
3776
|
-
/**
|
|
3777
|
-
* Minimum cost per output asset (CU)
|
|
3778
|
-
*/
|
|
3779
|
-
costPerAssetMinCU?: number;
|
|
3780
|
-
/**
|
|
3781
|
-
* Median cost per output asset (CU)
|
|
3782
|
-
*/
|
|
3783
|
-
costPerAssetP50CU?: number;
|
|
3784
|
-
/**
|
|
3785
|
-
* Inference latency P50 per output asset (seconds)
|
|
3786
|
-
*/
|
|
3787
|
-
inferenceLatencyP50Sec?: number;
|
|
3788
|
-
/**
|
|
3789
|
-
* Inference latency P75 per output asset (seconds)
|
|
3790
|
-
*/
|
|
3791
|
-
inferenceLatencyP75Sec?: number;
|
|
3792
|
-
/**
|
|
3793
|
-
* The resolution bucket (example: "0.5K", "1K", "2K", "4K")
|
|
3794
|
-
*/
|
|
3795
|
-
resolution?: string;
|
|
3796
|
-
/**
|
|
3797
|
-
* Total latency P50 per output asset, including queue time (seconds)
|
|
3798
|
-
*/
|
|
3799
|
-
totalLatencyP50Sec?: number;
|
|
3800
|
-
/**
|
|
3801
|
-
* Total latency P75 per output asset, including queue time (seconds)
|
|
3802
|
-
*/
|
|
3803
|
-
totalLatencyP75Sec?: number;
|
|
3804
|
-
}
|
|
3805
|
-
namespace Variant {
|
|
3806
|
-
/**
|
|
3807
|
-
* External quality score from arena.ai leaderboard
|
|
3808
|
-
*/
|
|
3809
|
-
interface ArenaScore {
|
|
3810
|
-
/**
|
|
3811
|
-
* Arena category (example: "text_to_image", "image_to_video")
|
|
3812
|
-
*/
|
|
3813
|
-
arenaCategory: string;
|
|
3814
|
-
/**
|
|
3815
|
-
* Model name on arena.ai
|
|
3816
|
-
*/
|
|
3817
|
-
arenaModelName: string;
|
|
3818
|
-
/**
|
|
3819
|
-
* When this score was last fetched (ISO date)
|
|
3820
|
-
*/
|
|
3821
|
-
fetchedAt: string;
|
|
3822
|
-
/**
|
|
3823
|
-
* Rank in the arena category
|
|
3824
|
-
*/
|
|
3825
|
-
rank: number;
|
|
3826
|
-
/**
|
|
3827
|
-
* ELO rating
|
|
3828
|
-
*/
|
|
3829
|
-
rating: number;
|
|
3830
|
-
/**
|
|
3831
|
-
* ELO rating confidence interval lower bound
|
|
3832
|
-
*/
|
|
3833
|
-
ratingLower: number;
|
|
3834
|
-
/**
|
|
3835
|
-
* ELO rating confidence interval upper bound
|
|
3836
|
-
*/
|
|
3837
|
-
ratingUpper: number;
|
|
3838
|
-
/**
|
|
3839
|
-
* Number of human votes
|
|
3840
|
-
*/
|
|
3841
|
-
votes: number;
|
|
3842
|
-
}
|
|
3843
|
-
}
|
|
3844
|
-
}
|
|
3594
|
+
nbEpochs?: number;
|
|
3845
3595
|
/**
|
|
3846
|
-
*
|
|
3596
|
+
* The number of times to repeat the training
|
|
3597
|
+
*
|
|
3598
|
+
* Only available for Flux LoRA training
|
|
3599
|
+
*/
|
|
3600
|
+
nbRepeats?: number;
|
|
3601
|
+
/**
|
|
3602
|
+
* The number of training steps for the text encoder
|
|
3603
|
+
*
|
|
3604
|
+
* Only available for SDXL LoRA training
|
|
3605
|
+
*/
|
|
3606
|
+
numTextTrainSteps?: number;
|
|
3607
|
+
/**
|
|
3608
|
+
* The number of training steps for the UNet
|
|
3609
|
+
*
|
|
3610
|
+
* Only available for SDXL LoRA training
|
|
3611
|
+
*/
|
|
3612
|
+
numUNetTrainSteps?: number;
|
|
3613
|
+
/**
|
|
3614
|
+
* Optimize the model training task for a specific type of input images. The
|
|
3615
|
+
* available values are:
|
|
3616
|
+
*
|
|
3617
|
+
* - "likeness": optimize training for likeness or portrait (targets specific
|
|
3618
|
+
* transformer blocks)
|
|
3619
|
+
* - "all": train all transformer blocks
|
|
3620
|
+
* - "none": train no specific transformer blocks
|
|
3621
|
+
*
|
|
3622
|
+
* This parameter controls which double and single transformer blocks are trained
|
|
3623
|
+
* during the LoRA training process.
|
|
3624
|
+
*
|
|
3625
|
+
* Only available for Flux LoRA training
|
|
3626
|
+
*/
|
|
3627
|
+
optimizeFor?: 'likeness';
|
|
3628
|
+
/**
|
|
3629
|
+
* The weight of prior preservation loss
|
|
3630
|
+
*
|
|
3631
|
+
* Only available for SD15 and SDXL LoRA training
|
|
3632
|
+
*/
|
|
3633
|
+
priorLossWeight?: number;
|
|
3634
|
+
/**
|
|
3635
|
+
* Whether to random crop or center crop images before resizing to the working
|
|
3636
|
+
* resolution
|
|
3637
|
+
*
|
|
3638
|
+
* Only available for SD15 and SDXL LoRA training
|
|
3639
|
+
*/
|
|
3640
|
+
randomCrop?: boolean;
|
|
3641
|
+
/**
|
|
3642
|
+
* Ratio of random crops
|
|
3643
|
+
*
|
|
3644
|
+
* Only available for SD15 and SDXL LoRA training
|
|
3645
|
+
*/
|
|
3646
|
+
randomCropRatio?: number;
|
|
3647
|
+
/**
|
|
3648
|
+
* Scale of random crops
|
|
3649
|
+
*
|
|
3650
|
+
* Only available for SD15 and SDXL LoRA training
|
|
3651
|
+
*/
|
|
3652
|
+
randomCropScale?: number;
|
|
3653
|
+
/**
|
|
3654
|
+
* The dimension of the LoRA update matrices
|
|
3655
|
+
*
|
|
3656
|
+
* Only available for SDXL (deprecated), Flux LoRA and Musubi training
|
|
3657
|
+
*
|
|
3658
|
+
* Default value varies depending on the model type:
|
|
3659
|
+
*
|
|
3660
|
+
* - For SDXL (deprecated): 64
|
|
3661
|
+
* - For Flux: 16
|
|
3662
|
+
* - For Musubi: 64
|
|
3663
|
+
*
|
|
3664
|
+
* Each trainer enforces its own tighter limit (Flux LoRA: [2; 64], Musubi: [2;
|
|
3665
|
+
* 128])
|
|
3666
|
+
*/
|
|
3667
|
+
rank?: number;
|
|
3668
|
+
/**
|
|
3669
|
+
* Whether to remove background noise from audio samples before cloning. When
|
|
3670
|
+
* enabled, each sample must be at least 5 seconds long.
|
|
3671
|
+
*
|
|
3672
|
+
* Only available for ElevenLabs voice training
|
|
3673
|
+
*/
|
|
3674
|
+
removeBackgroundNoise?: boolean;
|
|
3675
|
+
/**
|
|
3676
|
+
* The prompts to use for each epoch Only available for Flux LoRA training
|
|
3677
|
+
*/
|
|
3678
|
+
samplePrompts?: Array<string>;
|
|
3679
|
+
/**
|
|
3680
|
+
* The sample prompt images (AssetIds) paired with samplePrompts Only available for
|
|
3681
|
+
* Flux LoRA training Must be the same length as samplePrompts
|
|
3682
|
+
*/
|
|
3683
|
+
sampleSourceImages?: Array<string>;
|
|
3684
|
+
/**
|
|
3685
|
+
* Whether to scale the learning rate
|
|
3686
|
+
*
|
|
3687
|
+
* Note: Legacy parameter, will be ignored
|
|
3688
|
+
*
|
|
3689
|
+
* Only available for SD15 and SDXL LoRA training
|
|
3690
|
+
*/
|
|
3691
|
+
scaleLr?: boolean;
|
|
3692
|
+
/**
|
|
3693
|
+
* Used to reproduce previous results. Default: randomly generated number.
|
|
3694
|
+
*
|
|
3695
|
+
* Only available for SD15 and SDXL LoRA training
|
|
3696
|
+
*/
|
|
3697
|
+
seed?: number;
|
|
3698
|
+
/**
|
|
3699
|
+
* Whether to train the text encoder or not
|
|
3700
|
+
*
|
|
3701
|
+
* Example: For 100 steps and a value of 0.2, it means that the text encoder will
|
|
3702
|
+
* be trained for 20 steps and then the UNet for 80 steps
|
|
3703
|
+
*
|
|
3704
|
+
* Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
3705
|
+
*
|
|
3706
|
+
* Only available for SD15 and SDXL LoRA training
|
|
3707
|
+
*/
|
|
3708
|
+
textEncoderTrainingRatio?: number;
|
|
3709
|
+
/**
|
|
3710
|
+
* Validation frequency. Cannot be greater than maxTrainSteps value
|
|
3711
|
+
*
|
|
3712
|
+
* Only available for SD15 and SDXL LoRA training
|
|
3713
|
+
*/
|
|
3714
|
+
validationFrequency?: number;
|
|
3715
|
+
/**
|
|
3716
|
+
* Validation prompt
|
|
3717
|
+
*
|
|
3718
|
+
* Only available for SD15 and SDXL LoRA training
|
|
3719
|
+
*/
|
|
3720
|
+
validationPrompt?: string;
|
|
3721
|
+
/**
|
|
3722
|
+
* Description of the voice characteristics
|
|
3723
|
+
*
|
|
3724
|
+
* Only available for ElevenLabs voice training
|
|
3725
|
+
*/
|
|
3726
|
+
voiceDescription?: string;
|
|
3727
|
+
/**
|
|
3728
|
+
* The Weights And Bias key to use for logging. The maximum length is 40 characters
|
|
3729
|
+
*/
|
|
3730
|
+
wandbKey?: string;
|
|
3731
|
+
}
|
|
3732
|
+
/**
|
|
3733
|
+
* Aggregated performance stats
|
|
3734
|
+
*/
|
|
3735
|
+
interface PerformanceStats {
|
|
3736
|
+
/**
|
|
3737
|
+
* Performance metrics per variant
|
|
3738
|
+
*/
|
|
3739
|
+
variants: Array<PerformanceStats.Variant>;
|
|
3740
|
+
/**
|
|
3741
|
+
* Default variant key for quick model comparison
|
|
3742
|
+
*/
|
|
3743
|
+
default?: string;
|
|
3744
|
+
}
|
|
3745
|
+
namespace PerformanceStats {
|
|
3746
|
+
/**
|
|
3747
|
+
* Performance stats for a model variant
|
|
3847
3748
|
*/
|
|
3848
|
-
interface
|
|
3849
|
-
/**
|
|
3850
|
-
* The AssetId of the image used as a thumbnail for your model (example:
|
|
3851
|
-
* "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
3852
|
-
*/
|
|
3853
|
-
assetId: string;
|
|
3854
|
-
/**
|
|
3855
|
-
* The url of the image used as a thumbnail for your model
|
|
3856
|
-
*/
|
|
3857
|
-
url: string;
|
|
3858
|
-
}
|
|
3859
|
-
interface TrainingImagePair {
|
|
3860
|
-
/**
|
|
3861
|
-
* The instruction for the image pair, source to target
|
|
3862
|
-
*/
|
|
3863
|
-
instruction?: string;
|
|
3749
|
+
interface Variant {
|
|
3864
3750
|
/**
|
|
3865
|
-
* The
|
|
3866
|
-
*/
|
|
3867
|
-
sourceId?: string;
|
|
3868
|
-
/**
|
|
3869
|
-
* The target asset ID (must be a training asset)
|
|
3751
|
+
* The generation capability (example: "txt2img", "img2video", "txt2audio")
|
|
3870
3752
|
*/
|
|
3871
|
-
|
|
3872
|
-
}
|
|
3873
|
-
interface TrainingImage {
|
|
3753
|
+
capability: string;
|
|
3874
3754
|
/**
|
|
3875
|
-
*
|
|
3755
|
+
* When these stats were last computed (ISO date)
|
|
3876
3756
|
*/
|
|
3877
|
-
|
|
3757
|
+
computedAt: string;
|
|
3878
3758
|
/**
|
|
3879
|
-
*
|
|
3759
|
+
* Unique variant identifier (example: "txt2img:1K", "img2video:2K", "txt2audio")
|
|
3880
3760
|
*/
|
|
3881
|
-
|
|
3761
|
+
variantKey: string;
|
|
3882
3762
|
/**
|
|
3883
|
-
*
|
|
3884
|
-
* "2023-02-03T11:19:41.579Z")
|
|
3763
|
+
* External quality score from arena.ai leaderboard
|
|
3885
3764
|
*/
|
|
3886
|
-
|
|
3765
|
+
arenaScore?: Variant.ArenaScore;
|
|
3887
3766
|
/**
|
|
3888
|
-
*
|
|
3767
|
+
* Maximum cost per output asset (CU)
|
|
3889
3768
|
*/
|
|
3890
|
-
|
|
3769
|
+
costPerAssetMaxCU?: number;
|
|
3891
3770
|
/**
|
|
3892
|
-
*
|
|
3771
|
+
* Minimum cost per output asset (CU)
|
|
3893
3772
|
*/
|
|
3894
|
-
|
|
3773
|
+
costPerAssetMinCU?: number;
|
|
3895
3774
|
/**
|
|
3896
|
-
*
|
|
3775
|
+
* Median cost per output asset (CU)
|
|
3897
3776
|
*/
|
|
3898
|
-
|
|
3899
|
-
}
|
|
3900
|
-
/**
|
|
3901
|
-
* Additional information about the training progress of the model
|
|
3902
|
-
*/
|
|
3903
|
-
interface TrainingProgress {
|
|
3777
|
+
costPerAssetP50CU?: number;
|
|
3904
3778
|
/**
|
|
3905
|
-
*
|
|
3779
|
+
* Inference latency P50 per output asset (seconds)
|
|
3906
3780
|
*/
|
|
3907
|
-
|
|
3781
|
+
inferenceLatencyP50Sec?: number;
|
|
3908
3782
|
/**
|
|
3909
|
-
*
|
|
3783
|
+
* Inference latency P75 per output asset (seconds)
|
|
3910
3784
|
*/
|
|
3911
|
-
|
|
3785
|
+
inferenceLatencyP75Sec?: number;
|
|
3912
3786
|
/**
|
|
3913
|
-
*
|
|
3914
|
-
* one)
|
|
3787
|
+
* The resolution bucket (example: "0.5K", "1K", "2K", "4K")
|
|
3915
3788
|
*/
|
|
3916
|
-
|
|
3789
|
+
resolution?: string;
|
|
3917
3790
|
/**
|
|
3918
|
-
*
|
|
3791
|
+
* Total latency P50 per output asset, including queue time (seconds)
|
|
3919
3792
|
*/
|
|
3920
|
-
|
|
3793
|
+
totalLatencyP50Sec?: number;
|
|
3921
3794
|
/**
|
|
3922
|
-
*
|
|
3795
|
+
* Total latency P75 per output asset, including queue time (seconds)
|
|
3923
3796
|
*/
|
|
3924
|
-
|
|
3797
|
+
totalLatencyP75Sec?: number;
|
|
3798
|
+
}
|
|
3799
|
+
namespace Variant {
|
|
3925
3800
|
/**
|
|
3926
|
-
*
|
|
3801
|
+
* External quality score from arena.ai leaderboard
|
|
3927
3802
|
*/
|
|
3928
|
-
|
|
3803
|
+
interface ArenaScore {
|
|
3804
|
+
/**
|
|
3805
|
+
* Arena category (example: "text_to_image", "image_to_video")
|
|
3806
|
+
*/
|
|
3807
|
+
arenaCategory: string;
|
|
3808
|
+
/**
|
|
3809
|
+
* Model name on arena.ai
|
|
3810
|
+
*/
|
|
3811
|
+
arenaModelName: string;
|
|
3812
|
+
/**
|
|
3813
|
+
* When this score was last fetched (ISO date)
|
|
3814
|
+
*/
|
|
3815
|
+
fetchedAt: string;
|
|
3816
|
+
/**
|
|
3817
|
+
* Rank in the arena category
|
|
3818
|
+
*/
|
|
3819
|
+
rank: number;
|
|
3820
|
+
/**
|
|
3821
|
+
* ELO rating
|
|
3822
|
+
*/
|
|
3823
|
+
rating: number;
|
|
3824
|
+
/**
|
|
3825
|
+
* ELO rating confidence interval lower bound
|
|
3826
|
+
*/
|
|
3827
|
+
ratingLower: number;
|
|
3828
|
+
/**
|
|
3829
|
+
* ELO rating confidence interval upper bound
|
|
3830
|
+
*/
|
|
3831
|
+
ratingUpper: number;
|
|
3832
|
+
/**
|
|
3833
|
+
* Number of human votes
|
|
3834
|
+
*/
|
|
3835
|
+
votes: number;
|
|
3836
|
+
}
|
|
3929
3837
|
}
|
|
3838
|
+
}
|
|
3839
|
+
/**
|
|
3840
|
+
* A thumbnail for your model
|
|
3841
|
+
*/
|
|
3842
|
+
interface Thumbnail {
|
|
3930
3843
|
/**
|
|
3931
|
-
*
|
|
3844
|
+
* The AssetId of the image used as a thumbnail for your model (example:
|
|
3845
|
+
* "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
3932
3846
|
*/
|
|
3933
|
-
|
|
3847
|
+
assetId: string;
|
|
3848
|
+
/**
|
|
3849
|
+
* The url of the image used as a thumbnail for your model
|
|
3850
|
+
*/
|
|
3851
|
+
url: string;
|
|
3852
|
+
}
|
|
3853
|
+
interface TrainingImagePair {
|
|
3854
|
+
/**
|
|
3855
|
+
* The instruction for the image pair, source to target
|
|
3856
|
+
*/
|
|
3857
|
+
instruction?: string;
|
|
3858
|
+
/**
|
|
3859
|
+
* The source asset ID (must be a training asset)
|
|
3860
|
+
*/
|
|
3861
|
+
sourceId?: string;
|
|
3862
|
+
/**
|
|
3863
|
+
* The target asset ID (must be a training asset)
|
|
3864
|
+
*/
|
|
3865
|
+
targetId?: string;
|
|
3866
|
+
}
|
|
3867
|
+
interface TrainingImage {
|
|
3868
|
+
/**
|
|
3869
|
+
* The training image ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
3870
|
+
*/
|
|
3871
|
+
id: string;
|
|
3872
|
+
/**
|
|
3873
|
+
* Automatic captioning of the image
|
|
3874
|
+
*/
|
|
3875
|
+
automaticCaptioning: string;
|
|
3876
|
+
/**
|
|
3877
|
+
* The training image upload date as an ISO string (example:
|
|
3878
|
+
* "2023-02-03T11:19:41.579Z")
|
|
3879
|
+
*/
|
|
3880
|
+
createdAt: string;
|
|
3881
|
+
/**
|
|
3882
|
+
* Description for the image
|
|
3883
|
+
*/
|
|
3884
|
+
description: string;
|
|
3885
|
+
/**
|
|
3886
|
+
* The URL of the image
|
|
3887
|
+
*/
|
|
3888
|
+
downloadUrl: string;
|
|
3889
|
+
/**
|
|
3890
|
+
* The original file name of the image (example: "my-training-image.jpg")
|
|
3891
|
+
*/
|
|
3892
|
+
name: string;
|
|
3893
|
+
}
|
|
3894
|
+
/**
|
|
3895
|
+
* Additional information about the training progress of the model
|
|
3896
|
+
*/
|
|
3897
|
+
interface TrainingProgress {
|
|
3898
|
+
/**
|
|
3899
|
+
* The stage of the request
|
|
3900
|
+
*/
|
|
3901
|
+
stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
3902
|
+
/**
|
|
3903
|
+
* Timestamp in milliseconds of the last time the training progress was updated
|
|
3904
|
+
*/
|
|
3905
|
+
updatedAt: number;
|
|
3906
|
+
/**
|
|
3907
|
+
* Position of the job in the queue (ie. the number of job in the queue before this
|
|
3908
|
+
* one)
|
|
3909
|
+
*/
|
|
3910
|
+
position?: number;
|
|
3911
|
+
/**
|
|
3912
|
+
* The progress of the job
|
|
3913
|
+
*/
|
|
3914
|
+
progress?: number;
|
|
3915
|
+
/**
|
|
3916
|
+
* The remaining time in milliseconds
|
|
3917
|
+
*/
|
|
3918
|
+
remainingTimeMs?: number;
|
|
3919
|
+
/**
|
|
3920
|
+
* The timestamp in millisecond marking the start of the process
|
|
3921
|
+
*/
|
|
3922
|
+
startedAt?: number;
|
|
3923
|
+
}
|
|
3924
|
+
/**
|
|
3925
|
+
* Additional information about the model's training
|
|
3926
|
+
*/
|
|
3927
|
+
interface TrainingStats {
|
|
3928
|
+
/**
|
|
3929
|
+
* The training end time as an ISO date string
|
|
3930
|
+
*/
|
|
3931
|
+
endedAt?: string;
|
|
3932
|
+
/**
|
|
3933
|
+
* The training queued duration in seconds
|
|
3934
|
+
*/
|
|
3935
|
+
queueDuration?: number;
|
|
3936
|
+
/**
|
|
3937
|
+
* The training start time as an ISO date string
|
|
3938
|
+
*/
|
|
3939
|
+
startedAt?: string;
|
|
3940
|
+
/**
|
|
3941
|
+
* The training duration in seconds
|
|
3942
|
+
*/
|
|
3943
|
+
trainDuration?: number;
|
|
3944
|
+
}
|
|
3945
|
+
/**
|
|
3946
|
+
* The UI configuration for the model
|
|
3947
|
+
*/
|
|
3948
|
+
interface UiConfig {
|
|
3949
|
+
/**
|
|
3950
|
+
* Configuration for the input properties
|
|
3951
|
+
*/
|
|
3952
|
+
inputProperties?: {
|
|
3953
|
+
[key: string]: UiConfig.InputProperties;
|
|
3954
|
+
};
|
|
3955
|
+
/**
|
|
3956
|
+
* Configuration for the loras component
|
|
3957
|
+
*/
|
|
3958
|
+
lorasComponent?: UiConfig.LorasComponent;
|
|
3959
|
+
/**
|
|
3960
|
+
* Configuration for the presets
|
|
3961
|
+
*/
|
|
3962
|
+
presets?: Array<UiConfig.Preset>;
|
|
3963
|
+
/**
|
|
3964
|
+
* Configuration for the resolution component
|
|
3965
|
+
*/
|
|
3966
|
+
resolutionComponent?: UiConfig.ResolutionComponent;
|
|
3967
|
+
/**
|
|
3968
|
+
* Configuration for the selects
|
|
3969
|
+
*/
|
|
3970
|
+
selects?: {
|
|
3971
|
+
[key: string]: unknown;
|
|
3972
|
+
};
|
|
3973
|
+
/**
|
|
3974
|
+
* Configuration for the trigger generate button
|
|
3975
|
+
*/
|
|
3976
|
+
triggerGenerate?: UiConfig.TriggerGenerate;
|
|
3977
|
+
}
|
|
3978
|
+
namespace UiConfig {
|
|
3979
|
+
interface InputProperties {
|
|
3980
|
+
collapsed?: boolean;
|
|
3981
|
+
}
|
|
3982
|
+
/**
|
|
3983
|
+
* Configuration for the loras component
|
|
3984
|
+
*/
|
|
3985
|
+
interface LorasComponent {
|
|
3934
3986
|
/**
|
|
3935
|
-
* The
|
|
3987
|
+
* The label of the component
|
|
3936
3988
|
*/
|
|
3937
|
-
|
|
3989
|
+
label: string;
|
|
3938
3990
|
/**
|
|
3939
|
-
* The
|
|
3991
|
+
* The input name of the model (model_array)
|
|
3940
3992
|
*/
|
|
3941
|
-
|
|
3993
|
+
modelInput: string;
|
|
3942
3994
|
/**
|
|
3943
|
-
* The
|
|
3995
|
+
* The input name of the scale (number_array)
|
|
3944
3996
|
*/
|
|
3945
|
-
|
|
3997
|
+
scaleInput: string;
|
|
3946
3998
|
/**
|
|
3947
|
-
* The
|
|
3999
|
+
* The input model id (example: a composition or a single LoRA modelId) If
|
|
4000
|
+
* specified, the model id will be attached to the output asset as a metadata If
|
|
4001
|
+
* the model-decomposer parser is specified on it, modelInput and scaleInput will
|
|
4002
|
+
* be automatically populated
|
|
3948
4003
|
*/
|
|
3949
|
-
|
|
4004
|
+
modelIdInput?: string;
|
|
4005
|
+
}
|
|
4006
|
+
interface Preset {
|
|
4007
|
+
fields: Array<string>;
|
|
4008
|
+
presets: unknown;
|
|
3950
4009
|
}
|
|
3951
4010
|
/**
|
|
3952
|
-
*
|
|
4011
|
+
* Configuration for the resolution component
|
|
3953
4012
|
*/
|
|
3954
|
-
interface
|
|
3955
|
-
/**
|
|
3956
|
-
* Configuration for the input properties
|
|
3957
|
-
*/
|
|
3958
|
-
inputProperties?: {
|
|
3959
|
-
[key: string]: UiConfig.InputProperties;
|
|
3960
|
-
};
|
|
3961
|
-
/**
|
|
3962
|
-
* Configuration for the loras component
|
|
3963
|
-
*/
|
|
3964
|
-
lorasComponent?: UiConfig.LorasComponent;
|
|
4013
|
+
interface ResolutionComponent {
|
|
3965
4014
|
/**
|
|
3966
|
-
*
|
|
4015
|
+
* The input name of the height
|
|
3967
4016
|
*/
|
|
3968
|
-
|
|
4017
|
+
heightInput: string;
|
|
3969
4018
|
/**
|
|
3970
|
-
*
|
|
4019
|
+
* The label of the component
|
|
3971
4020
|
*/
|
|
3972
|
-
|
|
4021
|
+
label: string;
|
|
3973
4022
|
/**
|
|
3974
|
-
*
|
|
4023
|
+
* The resolution presets
|
|
3975
4024
|
*/
|
|
3976
|
-
|
|
3977
|
-
[key: string]: unknown;
|
|
3978
|
-
};
|
|
4025
|
+
presets: Array<ResolutionComponent.Preset>;
|
|
3979
4026
|
/**
|
|
3980
|
-
*
|
|
4027
|
+
* The input name of the width
|
|
3981
4028
|
*/
|
|
3982
|
-
|
|
4029
|
+
widthInput: string;
|
|
3983
4030
|
}
|
|
3984
|
-
namespace
|
|
3985
|
-
interface InputProperties {
|
|
3986
|
-
collapsed?: boolean;
|
|
3987
|
-
}
|
|
3988
|
-
/**
|
|
3989
|
-
* Configuration for the loras component
|
|
3990
|
-
*/
|
|
3991
|
-
interface LorasComponent {
|
|
3992
|
-
/**
|
|
3993
|
-
* The label of the component
|
|
3994
|
-
*/
|
|
3995
|
-
label: string;
|
|
3996
|
-
/**
|
|
3997
|
-
* The input name of the model (model_array)
|
|
3998
|
-
*/
|
|
3999
|
-
modelInput: string;
|
|
4000
|
-
/**
|
|
4001
|
-
* The input name of the scale (number_array)
|
|
4002
|
-
*/
|
|
4003
|
-
scaleInput: string;
|
|
4004
|
-
/**
|
|
4005
|
-
* The input model id (example: a composition or a single LoRA modelId) If
|
|
4006
|
-
* specified, the model id will be attached to the output asset as a metadata If
|
|
4007
|
-
* the model-decomposer parser is specified on it, modelInput and scaleInput will
|
|
4008
|
-
* be automatically populated
|
|
4009
|
-
*/
|
|
4010
|
-
modelIdInput?: string;
|
|
4011
|
-
}
|
|
4031
|
+
namespace ResolutionComponent {
|
|
4012
4032
|
interface Preset {
|
|
4013
|
-
|
|
4014
|
-
|
|
4033
|
+
height: number;
|
|
4034
|
+
label: string;
|
|
4035
|
+
width: number;
|
|
4015
4036
|
}
|
|
4037
|
+
}
|
|
4038
|
+
/**
|
|
4039
|
+
* Configuration for the trigger generate button
|
|
4040
|
+
*/
|
|
4041
|
+
interface TriggerGenerate {
|
|
4042
|
+
label: string;
|
|
4016
4043
|
/**
|
|
4017
|
-
*
|
|
4044
|
+
* The 'name' of the input where the trigger generate button will be displayed
|
|
4045
|
+
* (after the input). Do not specify both position and after.
|
|
4018
4046
|
*/
|
|
4019
|
-
|
|
4020
|
-
/**
|
|
4021
|
-
* The input name of the height
|
|
4022
|
-
*/
|
|
4023
|
-
heightInput: string;
|
|
4024
|
-
/**
|
|
4025
|
-
* The label of the component
|
|
4026
|
-
*/
|
|
4027
|
-
label: string;
|
|
4028
|
-
/**
|
|
4029
|
-
* The resolution presets
|
|
4030
|
-
*/
|
|
4031
|
-
presets: Array<ResolutionComponent.Preset>;
|
|
4032
|
-
/**
|
|
4033
|
-
* The input name of the width
|
|
4034
|
-
*/
|
|
4035
|
-
widthInput: string;
|
|
4036
|
-
}
|
|
4037
|
-
namespace ResolutionComponent {
|
|
4038
|
-
interface Preset {
|
|
4039
|
-
height: number;
|
|
4040
|
-
label: string;
|
|
4041
|
-
width: number;
|
|
4042
|
-
}
|
|
4043
|
-
}
|
|
4047
|
+
after?: string;
|
|
4044
4048
|
/**
|
|
4045
|
-
*
|
|
4049
|
+
* The position of the trigger generate button. If position specified, the button
|
|
4050
|
+
* will be displayed at the specified position. Do not specify both position and
|
|
4051
|
+
* after.
|
|
4046
4052
|
*/
|
|
4047
|
-
|
|
4048
|
-
label: string;
|
|
4049
|
-
/**
|
|
4050
|
-
* The 'name' of the input where the trigger generate button will be displayed
|
|
4051
|
-
* (after the input). Do not specify both position and after.
|
|
4052
|
-
*/
|
|
4053
|
-
after?: string;
|
|
4054
|
-
/**
|
|
4055
|
-
* The position of the trigger generate button. If position specified, the button
|
|
4056
|
-
* will be displayed at the specified position. Do not specify both position and
|
|
4057
|
-
* after.
|
|
4058
|
-
*/
|
|
4059
|
-
position?: 'bottom' | 'top';
|
|
4060
|
-
}
|
|
4053
|
+
position?: 'bottom' | 'top';
|
|
4061
4054
|
}
|
|
4062
4055
|
}
|
|
4063
4056
|
}
|
|
@@ -7476,7 +7469,7 @@ export declare namespace ModelUpdateParams {
|
|
|
7476
7469
|
wandbKey?: string;
|
|
7477
7470
|
}
|
|
7478
7471
|
}
|
|
7479
|
-
export interface ModelListParams {
|
|
7472
|
+
export interface ModelListParams extends ModelsCursorParams {
|
|
7480
7473
|
/**
|
|
7481
7474
|
* If set to true, returns the full list of models (including blacklisted models)
|
|
7482
7475
|
* (only available for team admins)
|
|
@@ -7517,10 +7510,6 @@ export interface ModelListParams {
|
|
|
7517
7510
|
* value is 500, minimum value is 1
|
|
7518
7511
|
*/
|
|
7519
7512
|
pageSize?: number;
|
|
7520
|
-
/**
|
|
7521
|
-
* A token you received in a previous request to query the next page of items
|
|
7522
|
-
*/
|
|
7523
|
-
paginationToken?: string;
|
|
7524
7513
|
/**
|
|
7525
7514
|
* The privacy of the models to return. The default value is `private`, possible
|
|
7526
7515
|
* values are `private` and `public`
|
|
@@ -7689,7 +7678,7 @@ export interface ModelUpdateTagsParams {
|
|
|
7689
7678
|
strict?: boolean;
|
|
7690
7679
|
}
|
|
7691
7680
|
export declare namespace Models {
|
|
7692
|
-
export { type ModelCreateResponse as ModelCreateResponse, type ModelRetrieveResponse as ModelRetrieveResponse, type ModelUpdateResponse as ModelUpdateResponse, type ModelListResponse as ModelListResponse, type ModelDeleteResponse as ModelDeleteResponse, type ModelCopyResponse as ModelCopyResponse, type ModelDeleteImagesResponse as ModelDeleteImagesResponse, type ModelDownloadResponse as ModelDownloadResponse, type ModelGetBulkResponse as ModelGetBulkResponse, type ModelTransferResponse as ModelTransferResponse, type ModelUpdateTagsResponse as ModelUpdateTagsResponse, type ModelCreateParams as ModelCreateParams, type ModelRetrieveParams as ModelRetrieveParams, type ModelUpdateParams as ModelUpdateParams, type ModelListParams as ModelListParams, type ModelCopyParams as ModelCopyParams, type ModelDeleteImagesParams as ModelDeleteImagesParams, type ModelDownloadParams as ModelDownloadParams, type ModelGetBulkParams as ModelGetBulkParams, type ModelTransferParams as ModelTransferParams, type ModelUpdateTagsParams as ModelUpdateTagsParams, };
|
|
7681
|
+
export { type ModelCreateResponse as ModelCreateResponse, type ModelRetrieveResponse as ModelRetrieveResponse, type ModelUpdateResponse as ModelUpdateResponse, type ModelListResponse as ModelListResponse, type ModelDeleteResponse as ModelDeleteResponse, type ModelCopyResponse as ModelCopyResponse, type ModelDeleteImagesResponse as ModelDeleteImagesResponse, type ModelDownloadResponse as ModelDownloadResponse, type ModelGetBulkResponse as ModelGetBulkResponse, type ModelTransferResponse as ModelTransferResponse, type ModelUpdateTagsResponse as ModelUpdateTagsResponse, type ModelListResponsesModelsCursor as ModelListResponsesModelsCursor, type ModelCreateParams as ModelCreateParams, type ModelRetrieveParams as ModelRetrieveParams, type ModelUpdateParams as ModelUpdateParams, type ModelListParams as ModelListParams, type ModelCopyParams as ModelCopyParams, type ModelDeleteImagesParams as ModelDeleteImagesParams, type ModelDownloadParams as ModelDownloadParams, type ModelGetBulkParams as ModelGetBulkParams, type ModelTransferParams as ModelTransferParams, type ModelUpdateTagsParams as ModelUpdateTagsParams, };
|
|
7693
7682
|
export { Description as Description, type DescriptionRetrieveResponse as DescriptionRetrieveResponse, type DescriptionUpdateResponse as DescriptionUpdateResponse, type DescriptionRetrieveParams as DescriptionRetrieveParams, type DescriptionUpdateParams as DescriptionUpdateParams, };
|
|
7694
7683
|
export { Examples as Examples, type ExampleUpdateResponse as ExampleUpdateResponse, type ExampleListResponse as ExampleListResponse, type ExampleUpdateParams as ExampleUpdateParams, type ExampleListParams as ExampleListParams, };
|
|
7695
7684
|
export { Train as Train, type TrainActionResponse as TrainActionResponse, type TrainTriggerResponse as TrainTriggerResponse, type TrainActionParams as TrainActionParams, type TrainTriggerParams as TrainTriggerParams, };
|