@civitai/client 0.1.1-beta.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/README.md +0 -0
- package/dist/client/CivitaiClient.d.ts +17 -0
- package/dist/client/CivitaiClient.js +24 -0
- package/dist/client/RequestsClient.d.ts +0 -0
- package/dist/client/RequestsClient.js +58 -0
- package/dist/generated/GeneratedClient.d.ts +20 -0
- package/dist/generated/GeneratedClient.js +38 -0
- package/dist/generated/core/ApiError.d.ts +10 -0
- package/dist/generated/core/ApiError.js +15 -0
- package/dist/generated/core/ApiRequestOptions.d.ts +13 -0
- package/dist/generated/core/ApiRequestOptions.js +2 -0
- package/dist/generated/core/ApiResult.d.ts +7 -0
- package/dist/generated/core/ApiResult.js +2 -0
- package/dist/generated/core/AxiosHttpRequest.d.ts +14 -0
- package/dist/generated/core/AxiosHttpRequest.js +20 -0
- package/dist/generated/core/BaseHttpRequest.d.ts +8 -0
- package/dist/generated/core/BaseHttpRequest.js +9 -0
- package/dist/generated/core/CancelablePromise.d.ts +37 -0
- package/dist/generated/core/CancelablePromise.js +93 -0
- package/dist/generated/core/FetchHttpRequest.d.ts +14 -0
- package/dist/generated/core/FetchHttpRequest.js +20 -0
- package/dist/generated/core/OpenAPI.d.ts +27 -0
- package/dist/generated/core/OpenAPI.js +33 -0
- package/dist/generated/core/request.d.ts +49 -0
- package/dist/generated/core/request.js +277 -0
- package/dist/generated/enums.gen.d.ts +93 -0
- package/dist/generated/enums.gen.js +97 -0
- package/dist/generated/index.d.ts +9 -0
- package/dist/generated/index.js +20 -0
- package/dist/generated/schemas.gen.d.ts +2243 -0
- package/dist/generated/schemas.gen.js +2244 -0
- package/dist/generated/services.gen.d.ts +242 -0
- package/dist/generated/services.gen.js +469 -0
- package/dist/generated/types.gen.d.ts +1931 -0
- package/dist/generated/types.gen.js +3 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +6 -0
- package/dist/utils/Air.d.ts +19 -0
- package/dist/utils/Air.js +18 -0
- package/dist/utils/CivitaiClientError.d.ts +0 -0
- package/dist/utils/CivitaiClientError.js +4 -0
- package/dist/utils/TimeSpan.d.ts +45 -0
- package/dist/utils/TimeSpan.js +101 -0
- package/dist/utils/createClient.d.ts +1 -0
- package/dist/utils/createClient.js +119 -0
- package/dist/utils/index.d.ts +2 -0
- package/dist/utils/index.js +5 -0
- package/package.json +48 -0
|
@@ -0,0 +1,2244 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.$WorkerImageImageToImageCapabilities = exports.$WorkerImageEmbeddingCapabilities = exports.$WorkerImageCapabilities = exports.$WorkerDetails = exports.$WorkerConfigurationCapabilities = exports.$WorkerCapabilities = exports.$UpdateWorkflowStatus = exports.$UpdateWorkflowRequest = exports.$TransactionInfo = exports.$TextToImageV2Job = exports.$TextToImageStepTemplate = exports.$TextToImageStep = exports.$TextToImageOutput = exports.$TextToImageJobSlot = exports.$TextToImageJob = exports.$TextToImageInput = exports.$Subscription = exports.$SimilaritySearchJob = exports.$Scheduler = exports.$ProcessingStatistics = exports.$ProblemDetails = exports.$Priority = exports.$ModelInfo = exports.$LLMPromptAugmentationJob = exports.$LLMPromptAugmentationCapabilities = exports.$JobSupport = exports.$Job = exports.$ImageTransformer = exports.$ImageResourceTrainingStepTemplate = exports.$ImageResourceTrainingStep = exports.$ImageResourceTrainingOutput = exports.$ImageResourceTrainingJob = exports.$ImageResourceTrainingInput = exports.$ImageJobParams = exports.$ImageJobNetworkParams = exports.$ImageJobControlNet = exports.$Image = exports.$Expression = exports.$EpochResult = exports.$EcosystemElement = exports.$EchoStepTemplate = exports.$EchoStep = exports.$EchoOutput = exports.$EchoInput = exports.$DynamicAssignment = exports.$CursedArrayOfTelemetryCursorAndWorkflow = exports.$CreateWorkerResult = exports.$CreateConfigurationResult = exports.$ConfigurationStatus = exports.$ConfigurationOptions = void 0;
|
|
5
|
+
exports.$WorkflowTemplate = exports.$WorkflowStepTemplate = exports.$WorkflowStepJobQueuePosition = exports.$WorkflowStepJobEvent = exports.$WorkflowStepJob = exports.$WorkflowStepEvent = exports.$WorkflowStep = exports.$WorkflowStatus = exports.$WorkflowEvent = exports.$WorkflowCallback = exports.$Workflow = exports.$WorkerType = exports.$WorkerSimilaritySearchCapabilities = exports.$WorkerRegistration = exports.$WorkerModelStatus = exports.$WorkerModelPreparationCapabilities = exports.$WorkerModelAvailability = exports.$WorkerMediaWDTaggingCapabilities = exports.$WorkerMediaTaggingCapabilities = exports.$WorkerMediaMovieRatingCapabilities = exports.$WorkerMediaComfyCapabilities = exports.$WorkerMediaCapabilities = exports.$WorkerImageTransformCapabilities = exports.$WorkerImageTextToImageCapabilities = exports.$WorkerImageResourceTrainingCapabilities = void 0;
|
|
6
|
+
exports.$ConfigurationOptions = {
|
|
7
|
+
required: ['selector', 'spec'],
|
|
8
|
+
type: 'object',
|
|
9
|
+
properties: {
|
|
10
|
+
priority: {
|
|
11
|
+
type: 'integer',
|
|
12
|
+
description: 'Get or set the priority of this configuration if multiple configurations apply to the same worker',
|
|
13
|
+
format: 'int64',
|
|
14
|
+
},
|
|
15
|
+
selector: {
|
|
16
|
+
$ref: '#/components/schemas/Expression',
|
|
17
|
+
},
|
|
18
|
+
spec: {
|
|
19
|
+
description: 'Get or set the specification associated with this configuration',
|
|
20
|
+
nullable: true,
|
|
21
|
+
},
|
|
22
|
+
},
|
|
23
|
+
additionalProperties: false,
|
|
24
|
+
};
|
|
25
|
+
exports.$ConfigurationStatus = {
|
|
26
|
+
required: ['configurationId'],
|
|
27
|
+
type: 'object',
|
|
28
|
+
properties: {
|
|
29
|
+
configurationId: {
|
|
30
|
+
minLength: 1,
|
|
31
|
+
type: 'string',
|
|
32
|
+
},
|
|
33
|
+
assigned: {
|
|
34
|
+
type: 'integer',
|
|
35
|
+
format: 'int32',
|
|
36
|
+
},
|
|
37
|
+
targeted: {
|
|
38
|
+
type: 'integer',
|
|
39
|
+
format: 'int32',
|
|
40
|
+
},
|
|
41
|
+
applied: {
|
|
42
|
+
type: 'integer',
|
|
43
|
+
format: 'int32',
|
|
44
|
+
},
|
|
45
|
+
},
|
|
46
|
+
additionalProperties: false,
|
|
47
|
+
};
|
|
48
|
+
exports.$CreateConfigurationResult = {
|
|
49
|
+
required: ['configurationId'],
|
|
50
|
+
type: 'object',
|
|
51
|
+
properties: {
|
|
52
|
+
configurationId: {
|
|
53
|
+
minLength: 1,
|
|
54
|
+
type: 'string',
|
|
55
|
+
},
|
|
56
|
+
},
|
|
57
|
+
additionalProperties: false,
|
|
58
|
+
};
|
|
59
|
+
exports.$CreateWorkerResult = {
|
|
60
|
+
required: ['workerId'],
|
|
61
|
+
type: 'object',
|
|
62
|
+
properties: {
|
|
63
|
+
workerId: {
|
|
64
|
+
minLength: 1,
|
|
65
|
+
type: 'string',
|
|
66
|
+
},
|
|
67
|
+
},
|
|
68
|
+
additionalProperties: false,
|
|
69
|
+
};
|
|
70
|
+
exports.$CursedArrayOfTelemetryCursorAndWorkflow = {
|
|
71
|
+
required: ['items', 'next'],
|
|
72
|
+
type: 'object',
|
|
73
|
+
properties: {
|
|
74
|
+
next: {
|
|
75
|
+
type: 'string',
|
|
76
|
+
},
|
|
77
|
+
items: {
|
|
78
|
+
type: 'array',
|
|
79
|
+
items: {
|
|
80
|
+
$ref: '#/components/schemas/Workflow',
|
|
81
|
+
},
|
|
82
|
+
},
|
|
83
|
+
},
|
|
84
|
+
additionalProperties: false,
|
|
85
|
+
};
|
|
86
|
+
exports.$DynamicAssignment = {
|
|
87
|
+
required: ['fromPath', 'toPath'],
|
|
88
|
+
type: 'object',
|
|
89
|
+
properties: {
|
|
90
|
+
fromPath: {
|
|
91
|
+
minLength: 1,
|
|
92
|
+
type: 'string',
|
|
93
|
+
},
|
|
94
|
+
toPath: {
|
|
95
|
+
minLength: 1,
|
|
96
|
+
type: 'string',
|
|
97
|
+
},
|
|
98
|
+
defaultValue: {
|
|
99
|
+
nullable: true,
|
|
100
|
+
},
|
|
101
|
+
},
|
|
102
|
+
additionalProperties: false,
|
|
103
|
+
};
|
|
104
|
+
exports.$EchoInput = {
|
|
105
|
+
required: ['message'],
|
|
106
|
+
type: 'object',
|
|
107
|
+
properties: {
|
|
108
|
+
message: {
|
|
109
|
+
minLength: 1,
|
|
110
|
+
type: 'string',
|
|
111
|
+
description: 'The message to be returned in the output.',
|
|
112
|
+
},
|
|
113
|
+
},
|
|
114
|
+
additionalProperties: false,
|
|
115
|
+
description: 'Represents the input information needed for the Echo workflow step.',
|
|
116
|
+
};
|
|
117
|
+
exports.$EchoOutput = {
|
|
118
|
+
required: ['message'],
|
|
119
|
+
type: 'object',
|
|
120
|
+
properties: {
|
|
121
|
+
message: {
|
|
122
|
+
minLength: 1,
|
|
123
|
+
type: 'string',
|
|
124
|
+
description: 'The message to be returned.',
|
|
125
|
+
},
|
|
126
|
+
},
|
|
127
|
+
additionalProperties: false,
|
|
128
|
+
description: 'Represents the output information returned from the Echo workflow step.',
|
|
129
|
+
};
|
|
130
|
+
exports.$EchoStep = {
|
|
131
|
+
title: 'A workflow step that takes a message string and retuns it.',
|
|
132
|
+
required: ['$type', 'input'],
|
|
133
|
+
type: 'object',
|
|
134
|
+
allOf: [
|
|
135
|
+
{
|
|
136
|
+
$ref: '#/components/schemas/WorkflowStep',
|
|
137
|
+
},
|
|
138
|
+
],
|
|
139
|
+
properties: {
|
|
140
|
+
name: {
|
|
141
|
+
type: 'string',
|
|
142
|
+
description: 'The name of the workflow step. Used to allow steps to refer to one another.',
|
|
143
|
+
nullable: true,
|
|
144
|
+
},
|
|
145
|
+
priority: {
|
|
146
|
+
$ref: '#/components/schemas/Priority',
|
|
147
|
+
},
|
|
148
|
+
timeout: {
|
|
149
|
+
type: 'string',
|
|
150
|
+
description: 'The maximum time to wait for this step to complete.',
|
|
151
|
+
nullable: true,
|
|
152
|
+
example: '00:00:00',
|
|
153
|
+
},
|
|
154
|
+
retries: {
|
|
155
|
+
type: 'integer',
|
|
156
|
+
description: 'The maximum number of times this step should be retried.',
|
|
157
|
+
format: 'int32',
|
|
158
|
+
nullable: true,
|
|
159
|
+
},
|
|
160
|
+
jobs: {
|
|
161
|
+
type: 'array',
|
|
162
|
+
items: {
|
|
163
|
+
$ref: '#/components/schemas/WorkflowStepJob',
|
|
164
|
+
},
|
|
165
|
+
description: 'The jobs generated by this step.',
|
|
166
|
+
},
|
|
167
|
+
status: {
|
|
168
|
+
$ref: '#/components/schemas/WorkflowStatus',
|
|
169
|
+
},
|
|
170
|
+
startedAt: {
|
|
171
|
+
type: 'string',
|
|
172
|
+
description: 'The date / time the step was started. Null if not yet started.',
|
|
173
|
+
format: 'date-time',
|
|
174
|
+
nullable: true,
|
|
175
|
+
},
|
|
176
|
+
completedAt: {
|
|
177
|
+
type: 'string',
|
|
178
|
+
description: 'The date / time the step was completed. Null if not yet completed.',
|
|
179
|
+
format: 'date-time',
|
|
180
|
+
nullable: true,
|
|
181
|
+
},
|
|
182
|
+
input: {
|
|
183
|
+
$ref: '#/components/schemas/EchoInput',
|
|
184
|
+
},
|
|
185
|
+
output: {
|
|
186
|
+
$ref: '#/components/schemas/EchoOutput',
|
|
187
|
+
},
|
|
188
|
+
$type: {
|
|
189
|
+
enum: ['echo'],
|
|
190
|
+
type: 'string',
|
|
191
|
+
},
|
|
192
|
+
},
|
|
193
|
+
additionalProperties: false,
|
|
194
|
+
description: 'This step is intended for testing purposes.',
|
|
195
|
+
};
|
|
196
|
+
exports.$EchoStepTemplate = {
|
|
197
|
+
required: ['$type', 'input'],
|
|
198
|
+
type: 'object',
|
|
199
|
+
allOf: [
|
|
200
|
+
{
|
|
201
|
+
$ref: '#/components/schemas/WorkflowStepTemplate',
|
|
202
|
+
},
|
|
203
|
+
],
|
|
204
|
+
properties: {
|
|
205
|
+
$type: {
|
|
206
|
+
enum: ['echo'],
|
|
207
|
+
type: 'string',
|
|
208
|
+
},
|
|
209
|
+
input: {
|
|
210
|
+
$ref: '#/components/schemas/EchoInput',
|
|
211
|
+
},
|
|
212
|
+
},
|
|
213
|
+
additionalProperties: false,
|
|
214
|
+
};
|
|
215
|
+
exports.$EcosystemElement = {
|
|
216
|
+
type: 'object',
|
|
217
|
+
additionalProperties: {
|
|
218
|
+
$ref: '#/components/schemas/EcosystemElement',
|
|
219
|
+
},
|
|
220
|
+
};
|
|
221
|
+
exports.$EpochResult = {
|
|
222
|
+
required: ['blobName', 'blobSize'],
|
|
223
|
+
type: 'object',
|
|
224
|
+
properties: {
|
|
225
|
+
blobName: {
|
|
226
|
+
minLength: 1,
|
|
227
|
+
type: 'string',
|
|
228
|
+
description: 'Get the name of the generated epoch assets',
|
|
229
|
+
},
|
|
230
|
+
blobSize: {
|
|
231
|
+
type: 'integer',
|
|
232
|
+
description: 'Get the total size in bytes of the asset',
|
|
233
|
+
format: 'int64',
|
|
234
|
+
},
|
|
235
|
+
sampleImages: {
|
|
236
|
+
type: 'array',
|
|
237
|
+
items: {
|
|
238
|
+
type: 'string',
|
|
239
|
+
},
|
|
240
|
+
description: 'Get a list of the names of the blobs that represent sample images',
|
|
241
|
+
},
|
|
242
|
+
},
|
|
243
|
+
additionalProperties: false,
|
|
244
|
+
description: 'An epock result.',
|
|
245
|
+
};
|
|
246
|
+
exports.$Expression = {
|
|
247
|
+
type: 'object',
|
|
248
|
+
additionalProperties: false,
|
|
249
|
+
};
|
|
250
|
+
exports.$Image = {
|
|
251
|
+
required: ['available', 'id', 'jobId'],
|
|
252
|
+
type: 'object',
|
|
253
|
+
properties: {
|
|
254
|
+
id: {
|
|
255
|
+
minLength: 1,
|
|
256
|
+
type: 'string',
|
|
257
|
+
description: 'Gets the id of the blob that contains this image.',
|
|
258
|
+
},
|
|
259
|
+
available: {
|
|
260
|
+
type: 'boolean',
|
|
261
|
+
description: 'Gets a value indicating whether the image is available.',
|
|
262
|
+
},
|
|
263
|
+
url: {
|
|
264
|
+
type: 'string',
|
|
265
|
+
description: 'Gets a url that can be used to preview the image.',
|
|
266
|
+
format: 'uri',
|
|
267
|
+
nullable: true,
|
|
268
|
+
},
|
|
269
|
+
urlExpiresAt: {
|
|
270
|
+
type: 'string',
|
|
271
|
+
description: 'Get when the url is set to expire',
|
|
272
|
+
format: 'date-time',
|
|
273
|
+
nullable: true,
|
|
274
|
+
},
|
|
275
|
+
jobId: {
|
|
276
|
+
minLength: 1,
|
|
277
|
+
type: 'string',
|
|
278
|
+
description: 'Get the id of the job that is associated with this image.',
|
|
279
|
+
},
|
|
280
|
+
},
|
|
281
|
+
additionalProperties: false,
|
|
282
|
+
description: 'Represents an image that is the result of a TextToImage workflow step.',
|
|
283
|
+
};
|
|
284
|
+
exports.$ImageJobControlNet = {
|
|
285
|
+
type: 'object',
|
|
286
|
+
properties: {
|
|
287
|
+
preprocessor: {
|
|
288
|
+
$ref: '#/components/schemas/ImageTransformer',
|
|
289
|
+
},
|
|
290
|
+
weight: {
|
|
291
|
+
type: 'number',
|
|
292
|
+
description: 'A value representing the weight applied to the ControlNet.',
|
|
293
|
+
format: 'double',
|
|
294
|
+
},
|
|
295
|
+
startStep: {
|
|
296
|
+
type: 'number',
|
|
297
|
+
description: 'A value representing the start step selected for the ControlNet.',
|
|
298
|
+
format: 'double',
|
|
299
|
+
},
|
|
300
|
+
endStep: {
|
|
301
|
+
type: 'number',
|
|
302
|
+
description: 'A value representing the end step selected for the ControlNet.',
|
|
303
|
+
format: 'double',
|
|
304
|
+
},
|
|
305
|
+
},
|
|
306
|
+
additionalProperties: false,
|
|
307
|
+
description: 'Information for a controlnet provided for a text to image input.',
|
|
308
|
+
};
|
|
309
|
+
exports.$ImageJobNetworkParams = {
|
|
310
|
+
type: 'object',
|
|
311
|
+
properties: {
|
|
312
|
+
strength: {
|
|
313
|
+
type: 'number',
|
|
314
|
+
description: 'In case of Lora and LoCon, set the strength of the network',
|
|
315
|
+
format: 'double',
|
|
316
|
+
nullable: true,
|
|
317
|
+
},
|
|
318
|
+
triggerWord: {
|
|
319
|
+
type: 'string',
|
|
320
|
+
description: 'In case of a TextualInversion, set the trigger word of the network',
|
|
321
|
+
nullable: true,
|
|
322
|
+
},
|
|
323
|
+
type: {
|
|
324
|
+
type: 'string',
|
|
325
|
+
description: 'A legacy type set by the consumer',
|
|
326
|
+
nullable: true,
|
|
327
|
+
},
|
|
328
|
+
},
|
|
329
|
+
additionalProperties: false,
|
|
330
|
+
};
|
|
331
|
+
exports.$ImageJobParams = {
|
|
332
|
+
required: ['height', 'width'],
|
|
333
|
+
type: 'object',
|
|
334
|
+
properties: {
|
|
335
|
+
prompt: {
|
|
336
|
+
type: 'string',
|
|
337
|
+
description: 'The prompt for the text to image generation.',
|
|
338
|
+
nullable: true,
|
|
339
|
+
},
|
|
340
|
+
negativePrompt: {
|
|
341
|
+
type: 'string',
|
|
342
|
+
description: 'The negative prompt for the text to image generation.',
|
|
343
|
+
nullable: true,
|
|
344
|
+
},
|
|
345
|
+
scheduler: {
|
|
346
|
+
$ref: '#/components/schemas/Scheduler',
|
|
347
|
+
},
|
|
348
|
+
steps: {
|
|
349
|
+
maximum: 150,
|
|
350
|
+
minimum: 1,
|
|
351
|
+
type: 'integer',
|
|
352
|
+
description: 'The number of steps for the text to image generation.',
|
|
353
|
+
format: 'int32',
|
|
354
|
+
default: 30,
|
|
355
|
+
},
|
|
356
|
+
cfgScale: {
|
|
357
|
+
maximum: 30,
|
|
358
|
+
minimum: 1,
|
|
359
|
+
type: 'number',
|
|
360
|
+
description: 'The CFG scale value for the text to image generation.',
|
|
361
|
+
format: 'double',
|
|
362
|
+
default: 7.5,
|
|
363
|
+
nullable: true,
|
|
364
|
+
},
|
|
365
|
+
width: {
|
|
366
|
+
maximum: 2048,
|
|
367
|
+
minimum: 64,
|
|
368
|
+
type: 'integer',
|
|
369
|
+
description: 'The width for the image to be generated in pixels.',
|
|
370
|
+
format: 'int32',
|
|
371
|
+
default: 512,
|
|
372
|
+
},
|
|
373
|
+
height: {
|
|
374
|
+
maximum: 2048,
|
|
375
|
+
minimum: 64,
|
|
376
|
+
type: 'integer',
|
|
377
|
+
description: 'The height for the image to be generated in pixels.',
|
|
378
|
+
format: 'int32',
|
|
379
|
+
default: 512,
|
|
380
|
+
},
|
|
381
|
+
seed: {
|
|
382
|
+
maximum: 4294967295,
|
|
383
|
+
minimum: -1,
|
|
384
|
+
type: 'integer',
|
|
385
|
+
description: 'The seed for the text to image generation.',
|
|
386
|
+
format: 'int64',
|
|
387
|
+
default: -1,
|
|
388
|
+
},
|
|
389
|
+
clipSkip: {
|
|
390
|
+
type: 'integer',
|
|
391
|
+
description: 'The clip skip value for the text to image generation.',
|
|
392
|
+
format: 'int32',
|
|
393
|
+
default: 2,
|
|
394
|
+
},
|
|
395
|
+
},
|
|
396
|
+
additionalProperties: false,
|
|
397
|
+
description: 'Parameters for a text to image step.',
|
|
398
|
+
};
|
|
399
|
+
exports.$ImageResourceTrainingInput = {
|
|
400
|
+
required: ['model', 'trainingData'],
|
|
401
|
+
type: 'object',
|
|
402
|
+
properties: {
|
|
403
|
+
model: {
|
|
404
|
+
pattern: '^(?:urn:)?(?:air:)?(?:(?<ecosystem>[a-zA-Z0-9_-/]+):)?(?:(?<type>[a-zA-Z0-9_-/]+):)?(?<source>[a-zA-Z0-9_-/]+):(?<id>[a-zA-Z0-9_-/.]+)(?:@(?<version>[a-zA-Z0-9_-.]+))?(?:.(?<format>[a-zA-Z0-9_-]+))?$',
|
|
405
|
+
type: 'string',
|
|
406
|
+
description: 'The primary model to train upon.',
|
|
407
|
+
},
|
|
408
|
+
trainingData: {
|
|
409
|
+
type: 'string',
|
|
410
|
+
description: 'A url referring data to use in training.',
|
|
411
|
+
format: 'uri',
|
|
412
|
+
},
|
|
413
|
+
unetLR: {
|
|
414
|
+
type: 'number',
|
|
415
|
+
description: 'The desired learning rate for the U-Net.',
|
|
416
|
+
format: 'double',
|
|
417
|
+
default: 0.00005,
|
|
418
|
+
},
|
|
419
|
+
textEncoderLR: {
|
|
420
|
+
type: 'number',
|
|
421
|
+
description: 'The desired learning rate for the text encoder.',
|
|
422
|
+
format: 'double',
|
|
423
|
+
default: 0.00005,
|
|
424
|
+
},
|
|
425
|
+
optimizerType: {
|
|
426
|
+
type: 'string',
|
|
427
|
+
description: 'The desired optimizer type.',
|
|
428
|
+
default: 'Adafactor',
|
|
429
|
+
},
|
|
430
|
+
networkDim: {
|
|
431
|
+
type: 'integer',
|
|
432
|
+
description: 'The desired network dimensionality.',
|
|
433
|
+
format: 'int32',
|
|
434
|
+
default: 16,
|
|
435
|
+
},
|
|
436
|
+
networkAlpha: {
|
|
437
|
+
type: 'integer',
|
|
438
|
+
description: 'The desired network alpha.',
|
|
439
|
+
format: 'int32',
|
|
440
|
+
default: 16,
|
|
441
|
+
},
|
|
442
|
+
lrScheduler: {
|
|
443
|
+
type: 'string',
|
|
444
|
+
description: 'The desired learning rate scheduler.',
|
|
445
|
+
default: 'cosine_with_restarts',
|
|
446
|
+
},
|
|
447
|
+
maxTrainEpochs: {
|
|
448
|
+
type: 'integer',
|
|
449
|
+
description: 'The desired maximum number of training epochs.',
|
|
450
|
+
format: 'int32',
|
|
451
|
+
default: 3,
|
|
452
|
+
},
|
|
453
|
+
numRepeats: {
|
|
454
|
+
type: 'integer',
|
|
455
|
+
description: 'The desired number of repeats.',
|
|
456
|
+
format: 'int32',
|
|
457
|
+
default: 8,
|
|
458
|
+
},
|
|
459
|
+
resolution: {
|
|
460
|
+
type: 'integer',
|
|
461
|
+
description: 'The desired resolution.',
|
|
462
|
+
format: 'int32',
|
|
463
|
+
default: 512,
|
|
464
|
+
},
|
|
465
|
+
loraType: {
|
|
466
|
+
type: 'string',
|
|
467
|
+
description: 'The lora type.',
|
|
468
|
+
default: 'lora',
|
|
469
|
+
},
|
|
470
|
+
enableBucket: {
|
|
471
|
+
type: 'boolean',
|
|
472
|
+
description: 'EnableBucket?',
|
|
473
|
+
default: true,
|
|
474
|
+
},
|
|
475
|
+
keepTokens: {
|
|
476
|
+
type: 'integer',
|
|
477
|
+
description: 'KeepTokens?',
|
|
478
|
+
format: 'int32',
|
|
479
|
+
default: 0,
|
|
480
|
+
},
|
|
481
|
+
lrSchedulerNumCycles: {
|
|
482
|
+
type: 'integer',
|
|
483
|
+
description: 'The desired number of cycles for the learning rate scheduler.',
|
|
484
|
+
format: 'int32',
|
|
485
|
+
default: 3,
|
|
486
|
+
},
|
|
487
|
+
trainBatchSize: {
|
|
488
|
+
type: 'integer',
|
|
489
|
+
description: 'The desired training batch size.',
|
|
490
|
+
format: 'int32',
|
|
491
|
+
default: 1,
|
|
492
|
+
},
|
|
493
|
+
minSnrGamma: {
|
|
494
|
+
type: 'integer',
|
|
495
|
+
description: 'MinSnrGamm?',
|
|
496
|
+
format: 'int32',
|
|
497
|
+
default: 5,
|
|
498
|
+
},
|
|
499
|
+
optimizerArgs: {
|
|
500
|
+
type: 'string',
|
|
501
|
+
description: 'Provided arguments for the optimizer.',
|
|
502
|
+
default: '',
|
|
503
|
+
},
|
|
504
|
+
shuffleCaption: {
|
|
505
|
+
type: 'boolean',
|
|
506
|
+
description: 'ShuffleCaption?',
|
|
507
|
+
default: false,
|
|
508
|
+
},
|
|
509
|
+
loraName: {
|
|
510
|
+
type: 'string',
|
|
511
|
+
description: 'The desired lora name.',
|
|
512
|
+
default: 'my-lora',
|
|
513
|
+
},
|
|
514
|
+
noiseOffset: {
|
|
515
|
+
type: 'number',
|
|
516
|
+
description: 'The desired noise offset.',
|
|
517
|
+
format: 'double',
|
|
518
|
+
default: 0.5,
|
|
519
|
+
},
|
|
520
|
+
samplePrompts: {
|
|
521
|
+
type: 'array',
|
|
522
|
+
items: {
|
|
523
|
+
type: 'string',
|
|
524
|
+
},
|
|
525
|
+
description: 'A selection of sample prompts.',
|
|
526
|
+
},
|
|
527
|
+
},
|
|
528
|
+
additionalProperties: false,
|
|
529
|
+
description: 'Input for an image resource training step.',
|
|
530
|
+
};
|
|
531
|
+
exports.$ImageResourceTrainingJob = {
|
|
532
|
+
required: ['$type', 'model', 'params', 'trainingData'],
|
|
533
|
+
type: 'object',
|
|
534
|
+
allOf: [
|
|
535
|
+
{
|
|
536
|
+
$ref: '#/components/schemas/Job',
|
|
537
|
+
},
|
|
538
|
+
],
|
|
539
|
+
properties: {
|
|
540
|
+
model: {
|
|
541
|
+
pattern: '^(?:urn:)?(?:air:)?(?:(?<ecosystem>[a-zA-Z0-9_-/]+):)?(?:(?<type>[a-zA-Z0-9_-/]+):)?(?<source>[a-zA-Z0-9_-/]+):(?<id>[a-zA-Z0-9_-/.]+)(?:@(?<version>[a-zA-Z0-9_-.]+))?(?:.(?<format>[a-zA-Z0-9_-]+))?$',
|
|
542
|
+
type: 'string',
|
|
543
|
+
description: 'An AIR representing the model to use.',
|
|
544
|
+
},
|
|
545
|
+
trainingData: {
|
|
546
|
+
type: 'string',
|
|
547
|
+
description: 'A url referring data that needs to be trained upon',
|
|
548
|
+
format: 'uri',
|
|
549
|
+
},
|
|
550
|
+
params: {
|
|
551
|
+
type: 'object',
|
|
552
|
+
additionalProperties: {},
|
|
553
|
+
description: 'A untyped set of parameters that are associated with this job',
|
|
554
|
+
},
|
|
555
|
+
cost: {
|
|
556
|
+
type: 'number',
|
|
557
|
+
description: 'Get cost associated with this job',
|
|
558
|
+
format: 'double',
|
|
559
|
+
},
|
|
560
|
+
customCost: {
|
|
561
|
+
type: 'number',
|
|
562
|
+
description: 'Get or set a custom cost value for this job',
|
|
563
|
+
format: 'double',
|
|
564
|
+
},
|
|
565
|
+
output: {
|
|
566
|
+
type: 'string',
|
|
567
|
+
description: 'An application provided output of the current status of this job',
|
|
568
|
+
nullable: true,
|
|
569
|
+
},
|
|
570
|
+
type: {
|
|
571
|
+
type: 'string',
|
|
572
|
+
description: 'The job type.',
|
|
573
|
+
},
|
|
574
|
+
claimDuration: {
|
|
575
|
+
type: 'string',
|
|
576
|
+
description: `Rick: yeah i think for LoRA we need it to be 5-10 minutes.
|
|
577
|
+
lora training has this lame effect where it can't send updates while it is uploading... so we need to give it extra buffer`,
|
|
578
|
+
example: '00:00:00',
|
|
579
|
+
},
|
|
580
|
+
$type: {
|
|
581
|
+
enum: ['ImageResourceTrainingJob'],
|
|
582
|
+
type: 'string',
|
|
583
|
+
},
|
|
584
|
+
},
|
|
585
|
+
additionalProperties: false,
|
|
586
|
+
};
|
|
587
|
+
exports.$ImageResourceTrainingOutput = {
|
|
588
|
+
required: ['epochs'],
|
|
589
|
+
type: 'object',
|
|
590
|
+
properties: {
|
|
591
|
+
epochs: {
|
|
592
|
+
type: 'array',
|
|
593
|
+
items: {
|
|
594
|
+
$ref: '#/components/schemas/EpochResult',
|
|
595
|
+
},
|
|
596
|
+
description: 'An array of epochs.',
|
|
597
|
+
},
|
|
598
|
+
storedAsAssets: {
|
|
599
|
+
type: 'boolean',
|
|
600
|
+
description: `Get wether the blobs are actually stored as assets
|
|
601
|
+
Assets are deprecated and require a different retrieval mechanism`,
|
|
602
|
+
nullable: true,
|
|
603
|
+
},
|
|
604
|
+
},
|
|
605
|
+
additionalProperties: false,
|
|
606
|
+
};
|
|
607
|
+
exports.$ImageResourceTrainingStep = {
|
|
608
|
+
required: ['$type', 'input'],
|
|
609
|
+
type: 'object',
|
|
610
|
+
allOf: [
|
|
611
|
+
{
|
|
612
|
+
$ref: '#/components/schemas/WorkflowStep',
|
|
613
|
+
},
|
|
614
|
+
],
|
|
615
|
+
properties: {
|
|
616
|
+
name: {
|
|
617
|
+
type: 'string',
|
|
618
|
+
description: 'The name of the workflow step. Used to allow steps to refer to one another.',
|
|
619
|
+
nullable: true,
|
|
620
|
+
},
|
|
621
|
+
priority: {
|
|
622
|
+
$ref: '#/components/schemas/Priority',
|
|
623
|
+
},
|
|
624
|
+
timeout: {
|
|
625
|
+
type: 'string',
|
|
626
|
+
description: 'The maximum time to wait for this step to complete.',
|
|
627
|
+
nullable: true,
|
|
628
|
+
example: '00:00:00',
|
|
629
|
+
},
|
|
630
|
+
retries: {
|
|
631
|
+
type: 'integer',
|
|
632
|
+
description: 'The maximum number of times this step should be retried.',
|
|
633
|
+
format: 'int32',
|
|
634
|
+
nullable: true,
|
|
635
|
+
},
|
|
636
|
+
jobs: {
|
|
637
|
+
type: 'array',
|
|
638
|
+
items: {
|
|
639
|
+
$ref: '#/components/schemas/WorkflowStepJob',
|
|
640
|
+
},
|
|
641
|
+
description: 'The jobs generated by this step.',
|
|
642
|
+
},
|
|
643
|
+
status: {
|
|
644
|
+
$ref: '#/components/schemas/WorkflowStatus',
|
|
645
|
+
},
|
|
646
|
+
startedAt: {
|
|
647
|
+
type: 'string',
|
|
648
|
+
description: 'The date / time the step was started. Null if not yet started.',
|
|
649
|
+
format: 'date-time',
|
|
650
|
+
nullable: true,
|
|
651
|
+
},
|
|
652
|
+
completedAt: {
|
|
653
|
+
type: 'string',
|
|
654
|
+
description: 'The date / time the step was completed. Null if not yet completed.',
|
|
655
|
+
format: 'date-time',
|
|
656
|
+
nullable: true,
|
|
657
|
+
},
|
|
658
|
+
input: {
|
|
659
|
+
$ref: '#/components/schemas/ImageResourceTrainingInput',
|
|
660
|
+
},
|
|
661
|
+
output: {
|
|
662
|
+
$ref: '#/components/schemas/ImageResourceTrainingOutput',
|
|
663
|
+
},
|
|
664
|
+
$type: {
|
|
665
|
+
enum: ['imageResourceTraining'],
|
|
666
|
+
type: 'string',
|
|
667
|
+
},
|
|
668
|
+
},
|
|
669
|
+
additionalProperties: false,
|
|
670
|
+
description: 'A workflow step for training image resources.',
|
|
671
|
+
};
|
|
672
|
+
exports.$ImageResourceTrainingStepTemplate = {
|
|
673
|
+
required: ['$type', 'input'],
|
|
674
|
+
type: 'object',
|
|
675
|
+
allOf: [
|
|
676
|
+
{
|
|
677
|
+
$ref: '#/components/schemas/WorkflowStepTemplate',
|
|
678
|
+
},
|
|
679
|
+
],
|
|
680
|
+
properties: {
|
|
681
|
+
$type: {
|
|
682
|
+
enum: ['imageResourceTraining'],
|
|
683
|
+
type: 'string',
|
|
684
|
+
},
|
|
685
|
+
input: {
|
|
686
|
+
$ref: '#/components/schemas/ImageResourceTrainingInput',
|
|
687
|
+
},
|
|
688
|
+
},
|
|
689
|
+
additionalProperties: false,
|
|
690
|
+
};
|
|
691
|
+
exports.$ImageTransformer = {
|
|
692
|
+
enum: ['canny', 'depthZoe', 'softedgePidinet', 'rembg'],
|
|
693
|
+
type: 'string',
|
|
694
|
+
description: 'Available image transformers.',
|
|
695
|
+
};
|
|
696
|
+
exports.$Job = {
|
|
697
|
+
required: ['$type'],
|
|
698
|
+
type: 'object',
|
|
699
|
+
properties: {
|
|
700
|
+
$type: {
|
|
701
|
+
type: 'string',
|
|
702
|
+
},
|
|
703
|
+
id: {
|
|
704
|
+
type: 'string',
|
|
705
|
+
description: 'A unique id for this job',
|
|
706
|
+
},
|
|
707
|
+
createdAt: {
|
|
708
|
+
type: 'string',
|
|
709
|
+
description: 'The date when this job got created',
|
|
710
|
+
format: 'date-time',
|
|
711
|
+
},
|
|
712
|
+
expireAt: {
|
|
713
|
+
type: 'string',
|
|
714
|
+
description: 'The date for when this job was set to expire',
|
|
715
|
+
format: 'date-time',
|
|
716
|
+
nullable: true,
|
|
717
|
+
},
|
|
718
|
+
webhook: {
|
|
719
|
+
type: 'string',
|
|
720
|
+
description: 'A webhook to be invoked when the job receives a status update',
|
|
721
|
+
format: 'uri',
|
|
722
|
+
nullable: true,
|
|
723
|
+
},
|
|
724
|
+
properties: {
|
|
725
|
+
type: 'object',
|
|
726
|
+
additionalProperties: {},
|
|
727
|
+
description: 'A set of user defined properties that can be used to index and partition this job',
|
|
728
|
+
},
|
|
729
|
+
type: {
|
|
730
|
+
type: 'string',
|
|
731
|
+
description: 'The type of this job as a string',
|
|
732
|
+
},
|
|
733
|
+
cost: {
|
|
734
|
+
type: 'number',
|
|
735
|
+
description: 'Get a cost estimate for this job',
|
|
736
|
+
format: 'double',
|
|
737
|
+
},
|
|
738
|
+
maxRetryAttempt: {
|
|
739
|
+
type: 'integer',
|
|
740
|
+
description: 'The max number of retries before we give up',
|
|
741
|
+
format: 'int32',
|
|
742
|
+
},
|
|
743
|
+
dependencies: {
|
|
744
|
+
type: 'object',
|
|
745
|
+
additionalProperties: {
|
|
746
|
+
type: 'array',
|
|
747
|
+
items: {
|
|
748
|
+
$ref: '#/components/schemas/DynamicAssignment',
|
|
749
|
+
},
|
|
750
|
+
nullable: true,
|
|
751
|
+
},
|
|
752
|
+
description: 'Get or set a list of dependencies that this job has',
|
|
753
|
+
},
|
|
754
|
+
issuedBy: {
|
|
755
|
+
type: 'string',
|
|
756
|
+
description: 'Get or set the name of the consumer that issued this job',
|
|
757
|
+
nullable: true,
|
|
758
|
+
},
|
|
759
|
+
version: {
|
|
760
|
+
type: 'integer',
|
|
761
|
+
description: 'Get or set the version of this job, this is used to track changes to the job schema',
|
|
762
|
+
format: 'int32',
|
|
763
|
+
default: 0,
|
|
764
|
+
},
|
|
765
|
+
claimDuration: {
|
|
766
|
+
type: 'string',
|
|
767
|
+
description: 'The total duration that the job can be claimed',
|
|
768
|
+
example: '00:00:00',
|
|
769
|
+
},
|
|
770
|
+
recovered: {
|
|
771
|
+
type: 'boolean',
|
|
772
|
+
description: 'An internal property to mark that the job has been recovered. We use this to not fiddle with up/down counters as we may have missed other counters',
|
|
773
|
+
},
|
|
774
|
+
},
|
|
775
|
+
additionalProperties: false,
|
|
776
|
+
discriminator: {
|
|
777
|
+
propertyName: '$type',
|
|
778
|
+
mapping: {
|
|
779
|
+
ImageResourceTrainingJob: '#/components/schemas/ImageResourceTrainingJob',
|
|
780
|
+
LLMPromptAugmentationJob: '#/components/schemas/LLMPromptAugmentationJob',
|
|
781
|
+
SimilaritySearchJob: '#/components/schemas/SimilaritySearchJob',
|
|
782
|
+
TextToImageJob: '#/components/schemas/TextToImageJob',
|
|
783
|
+
TextToImageV2Job: '#/components/schemas/TextToImageV2Job',
|
|
784
|
+
},
|
|
785
|
+
},
|
|
786
|
+
};
|
|
787
|
+
exports.$JobSupport = {
|
|
788
|
+
enum: ['unsupported', 'unavailable', 'available'],
|
|
789
|
+
type: 'string',
|
|
790
|
+
description: 'Available levels of job support.',
|
|
791
|
+
};
|
|
792
|
+
exports.$LLMPromptAugmentationCapabilities = {
|
|
793
|
+
type: 'object',
|
|
794
|
+
additionalProperties: false,
|
|
795
|
+
description: 'LLM prompt augmentaition capabilities.',
|
|
796
|
+
};
|
|
797
|
+
exports.$LLMPromptAugmentationJob = {
|
|
798
|
+
required: ['$type', 'model'],
|
|
799
|
+
type: 'object',
|
|
800
|
+
allOf: [
|
|
801
|
+
{
|
|
802
|
+
$ref: '#/components/schemas/Job',
|
|
803
|
+
},
|
|
804
|
+
],
|
|
805
|
+
properties: {
|
|
806
|
+
model: {
|
|
807
|
+
minLength: 1,
|
|
808
|
+
type: 'string',
|
|
809
|
+
description: 'The primary model to use.',
|
|
810
|
+
},
|
|
811
|
+
basePrompt: {
|
|
812
|
+
type: 'string',
|
|
813
|
+
description: 'The base prompt.',
|
|
814
|
+
nullable: true,
|
|
815
|
+
},
|
|
816
|
+
prompts: {
|
|
817
|
+
type: 'array',
|
|
818
|
+
items: {
|
|
819
|
+
type: 'string',
|
|
820
|
+
},
|
|
821
|
+
description: 'A list of prompts.',
|
|
822
|
+
},
|
|
823
|
+
temp: {
|
|
824
|
+
type: 'number',
|
|
825
|
+
description: 'The temp.',
|
|
826
|
+
format: 'double',
|
|
827
|
+
},
|
|
828
|
+
type: {
|
|
829
|
+
type: 'string',
|
|
830
|
+
description: 'The type.',
|
|
831
|
+
},
|
|
832
|
+
$type: {
|
|
833
|
+
enum: ['LLMPromptAugmentationJob'],
|
|
834
|
+
type: 'string',
|
|
835
|
+
},
|
|
836
|
+
},
|
|
837
|
+
additionalProperties: false,
|
|
838
|
+
};
|
|
839
|
+
exports.$ModelInfo = {
|
|
840
|
+
required: ['air', 'downloadUrls', 'hashes', 'size'],
|
|
841
|
+
type: 'object',
|
|
842
|
+
properties: {
|
|
843
|
+
air: {
|
|
844
|
+
pattern: '^(?:urn:)?(?:air:)?(?:(?<ecosystem>[a-zA-Z0-9_-/]+):)?(?:(?<type>[a-zA-Z0-9_-/]+):)?(?<source>[a-zA-Z0-9_-/]+):(?<id>[a-zA-Z0-9_-/.]+)(?:@(?<version>[a-zA-Z0-9_-.]+))?(?:.(?<format>[a-zA-Z0-9_-]+))?$',
|
|
845
|
+
type: 'string',
|
|
846
|
+
description: 'An AIR ID for the model.',
|
|
847
|
+
},
|
|
848
|
+
size: {
|
|
849
|
+
type: 'integer',
|
|
850
|
+
description: 'The model size in bytes.',
|
|
851
|
+
format: 'int64',
|
|
852
|
+
},
|
|
853
|
+
hashes: {
|
|
854
|
+
type: 'object',
|
|
855
|
+
additionalProperties: {
|
|
856
|
+
type: 'string',
|
|
857
|
+
},
|
|
858
|
+
description: 'A collection of hashes.',
|
|
859
|
+
},
|
|
860
|
+
downloadUrls: {
|
|
861
|
+
type: 'array',
|
|
862
|
+
items: {
|
|
863
|
+
type: 'string',
|
|
864
|
+
format: 'uri',
|
|
865
|
+
},
|
|
866
|
+
description: 'An array of download urls.',
|
|
867
|
+
},
|
|
868
|
+
modelName: {
|
|
869
|
+
type: 'string',
|
|
870
|
+
description: 'The name of the model.',
|
|
871
|
+
nullable: true,
|
|
872
|
+
},
|
|
873
|
+
versionName: {
|
|
874
|
+
type: 'string',
|
|
875
|
+
description: 'The name of the version.',
|
|
876
|
+
nullable: true,
|
|
877
|
+
},
|
|
878
|
+
invalidateAt: {
|
|
879
|
+
type: 'string',
|
|
880
|
+
description: 'A date time to invalidate at.',
|
|
881
|
+
format: 'date-time',
|
|
882
|
+
nullable: true,
|
|
883
|
+
},
|
|
884
|
+
},
|
|
885
|
+
additionalProperties: false,
|
|
886
|
+
description: 'Details for a specific model.',
|
|
887
|
+
};
|
|
888
|
+
exports.$Priority = {
|
|
889
|
+
enum: ['high', 'normal', 'low'],
|
|
890
|
+
type: 'string',
|
|
891
|
+
description: 'Available options for priority.',
|
|
892
|
+
};
|
|
893
|
+
exports.$ProblemDetails = {
|
|
894
|
+
type: 'object',
|
|
895
|
+
properties: {
|
|
896
|
+
type: {
|
|
897
|
+
type: 'string',
|
|
898
|
+
nullable: true,
|
|
899
|
+
},
|
|
900
|
+
title: {
|
|
901
|
+
type: 'string',
|
|
902
|
+
nullable: true,
|
|
903
|
+
},
|
|
904
|
+
status: {
|
|
905
|
+
type: 'integer',
|
|
906
|
+
format: 'int32',
|
|
907
|
+
nullable: true,
|
|
908
|
+
},
|
|
909
|
+
detail: {
|
|
910
|
+
type: 'string',
|
|
911
|
+
nullable: true,
|
|
912
|
+
},
|
|
913
|
+
instance: {
|
|
914
|
+
type: 'string',
|
|
915
|
+
nullable: true,
|
|
916
|
+
},
|
|
917
|
+
},
|
|
918
|
+
additionalProperties: {},
|
|
919
|
+
};
|
|
920
|
+
exports.$ProcessingStatistics = {
|
|
921
|
+
type: 'object',
|
|
922
|
+
properties: {
|
|
923
|
+
totalJobsRequested: {
|
|
924
|
+
type: 'integer',
|
|
925
|
+
description: 'The total number of jobs requested.',
|
|
926
|
+
format: 'int64',
|
|
927
|
+
},
|
|
928
|
+
totalCostRequested: {
|
|
929
|
+
type: 'number',
|
|
930
|
+
description: 'The total cost of jobs requested.',
|
|
931
|
+
format: 'double',
|
|
932
|
+
},
|
|
933
|
+
totalJobsSucceeded: {
|
|
934
|
+
type: 'integer',
|
|
935
|
+
description: 'The total number of successful jobs.',
|
|
936
|
+
format: 'int64',
|
|
937
|
+
},
|
|
938
|
+
totalCostSucceeded: {
|
|
939
|
+
type: 'number',
|
|
940
|
+
description: 'The total cost of successful jobs.',
|
|
941
|
+
format: 'double',
|
|
942
|
+
},
|
|
943
|
+
totalJobsRejected: {
|
|
944
|
+
type: 'integer',
|
|
945
|
+
description: 'The total number of rejected jobs.',
|
|
946
|
+
format: 'int64',
|
|
947
|
+
},
|
|
948
|
+
totalCostRejected: {
|
|
949
|
+
type: 'number',
|
|
950
|
+
description: 'The total cost of rejected jobs.',
|
|
951
|
+
format: 'double',
|
|
952
|
+
},
|
|
953
|
+
totalJobsLateRejected: {
|
|
954
|
+
type: 'integer',
|
|
955
|
+
description: 'The total number of late rejected jobs.',
|
|
956
|
+
format: 'int64',
|
|
957
|
+
},
|
|
958
|
+
totalCostLateRejected: {
|
|
959
|
+
type: 'number',
|
|
960
|
+
description: 'The total cost of laterejected jobs.',
|
|
961
|
+
format: 'double',
|
|
962
|
+
},
|
|
963
|
+
totalJobsExpired: {
|
|
964
|
+
type: 'integer',
|
|
965
|
+
description: 'The total number of expired jobs.',
|
|
966
|
+
format: 'int64',
|
|
967
|
+
},
|
|
968
|
+
totalCostExpired: {
|
|
969
|
+
type: 'number',
|
|
970
|
+
description: 'The total cost of expired jobs.',
|
|
971
|
+
format: 'double',
|
|
972
|
+
},
|
|
973
|
+
totalJobsFailed: {
|
|
974
|
+
type: 'integer',
|
|
975
|
+
description: 'The total number of failed jobs.',
|
|
976
|
+
format: 'int64',
|
|
977
|
+
},
|
|
978
|
+
totalCostFailed: {
|
|
979
|
+
type: 'number',
|
|
980
|
+
description: 'The total cost of failed jobs.',
|
|
981
|
+
format: 'double',
|
|
982
|
+
},
|
|
983
|
+
totalJobsCompleted: {
|
|
984
|
+
type: 'integer',
|
|
985
|
+
description: 'The total number of completed jobs.',
|
|
986
|
+
format: 'int64',
|
|
987
|
+
},
|
|
988
|
+
totalCostCompleted: {
|
|
989
|
+
type: 'number',
|
|
990
|
+
description: 'The total cost of completed jobs.',
|
|
991
|
+
format: 'double',
|
|
992
|
+
},
|
|
993
|
+
},
|
|
994
|
+
additionalProperties: false,
|
|
995
|
+
description: 'Details of processing statistics.',
|
|
996
|
+
};
|
|
997
|
+
exports.$Scheduler = {
|
|
998
|
+
enum: [
|
|
999
|
+
'eulerA',
|
|
1000
|
+
'euler',
|
|
1001
|
+
'lms',
|
|
1002
|
+
'heun',
|
|
1003
|
+
'dpM2',
|
|
1004
|
+
'dpM2A',
|
|
1005
|
+
'dpM2SA',
|
|
1006
|
+
'dpM2M',
|
|
1007
|
+
'dpmsde',
|
|
1008
|
+
'dpmFast',
|
|
1009
|
+
'dpmAdaptive',
|
|
1010
|
+
'lmsKarras',
|
|
1011
|
+
'dpM2Karras',
|
|
1012
|
+
'dpM2AKarras',
|
|
1013
|
+
'dpM2SAKarras',
|
|
1014
|
+
'dpM2MKarras',
|
|
1015
|
+
'dpmsdeKarras',
|
|
1016
|
+
'ddim',
|
|
1017
|
+
'plms',
|
|
1018
|
+
'uniPC',
|
|
1019
|
+
'undefined',
|
|
1020
|
+
'lcm',
|
|
1021
|
+
'ddpm',
|
|
1022
|
+
'deis',
|
|
1023
|
+
],
|
|
1024
|
+
type: 'string',
|
|
1025
|
+
description: 'The available options for schedulers used in image generation.',
|
|
1026
|
+
};
|
|
1027
|
+
exports.$SimilaritySearchJob = {
|
|
1028
|
+
required: ['$type', 'model', 'nsfwFilter', 'params', 'prompt'],
|
|
1029
|
+
type: 'object',
|
|
1030
|
+
allOf: [
|
|
1031
|
+
{
|
|
1032
|
+
$ref: '#/components/schemas/Job',
|
|
1033
|
+
},
|
|
1034
|
+
],
|
|
1035
|
+
properties: {
|
|
1036
|
+
model: {
|
|
1037
|
+
pattern: '^(?:urn:)?(?:air:)?(?:(?<ecosystem>[a-zA-Z0-9_-/]+):)?(?:(?<type>[a-zA-Z0-9_-/]+):)?(?<source>[a-zA-Z0-9_-/]+):(?<id>[a-zA-Z0-9_-/.]+)(?:@(?<version>[a-zA-Z0-9_-.]+))?(?:.(?<format>[a-zA-Z0-9_-]+))?$',
|
|
1038
|
+
type: 'string',
|
|
1039
|
+
description: 'An AIR ID representing the primary model.',
|
|
1040
|
+
},
|
|
1041
|
+
nsfwFilter: {
|
|
1042
|
+
minLength: 1,
|
|
1043
|
+
type: 'string',
|
|
1044
|
+
description: 'A value for the NSFW filter.',
|
|
1045
|
+
},
|
|
1046
|
+
prompt: {
|
|
1047
|
+
minLength: 1,
|
|
1048
|
+
type: 'string',
|
|
1049
|
+
description: 'The prompt provided.',
|
|
1050
|
+
},
|
|
1051
|
+
params: {
|
|
1052
|
+
type: 'object',
|
|
1053
|
+
additionalProperties: {},
|
|
1054
|
+
description: 'A collection of parameters.',
|
|
1055
|
+
},
|
|
1056
|
+
cost: {
|
|
1057
|
+
type: 'number',
|
|
1058
|
+
description: 'A value representing the cost of the job.',
|
|
1059
|
+
format: 'double',
|
|
1060
|
+
},
|
|
1061
|
+
type: {
|
|
1062
|
+
type: 'string',
|
|
1063
|
+
description: 'The job type.',
|
|
1064
|
+
},
|
|
1065
|
+
$type: {
|
|
1066
|
+
enum: ['SimilaritySearchJob'],
|
|
1067
|
+
type: 'string',
|
|
1068
|
+
},
|
|
1069
|
+
},
|
|
1070
|
+
additionalProperties: false,
|
|
1071
|
+
description: 'Details for a similarity search job.',
|
|
1072
|
+
};
|
|
1073
|
+
exports.$Subscription = {
|
|
1074
|
+
required: ['webhook'],
|
|
1075
|
+
type: 'object',
|
|
1076
|
+
properties: {
|
|
1077
|
+
webhook: {
|
|
1078
|
+
minLength: 1,
|
|
1079
|
+
type: 'string',
|
|
1080
|
+
description: 'The webhook url.',
|
|
1081
|
+
},
|
|
1082
|
+
},
|
|
1083
|
+
additionalProperties: false,
|
|
1084
|
+
description: 'A subscription for pushed based notifications.',
|
|
1085
|
+
};
|
|
1086
|
+
exports.$TextToImageInput = {
|
|
1087
|
+
required: ['height', 'model', 'width'],
|
|
1088
|
+
type: 'object',
|
|
1089
|
+
properties: {
|
|
1090
|
+
quantity: {
|
|
1091
|
+
maximum: 100,
|
|
1092
|
+
minimum: 1,
|
|
1093
|
+
type: 'integer',
|
|
1094
|
+
description: 'Get or sets the number of images to generate in a batch.',
|
|
1095
|
+
format: 'int32',
|
|
1096
|
+
default: 1,
|
|
1097
|
+
},
|
|
1098
|
+
batchSize: {
|
|
1099
|
+
maximum: 100,
|
|
1100
|
+
minimum: 1,
|
|
1101
|
+
type: 'integer',
|
|
1102
|
+
description: 'The size of each batch.',
|
|
1103
|
+
format: 'int32',
|
|
1104
|
+
default: 1,
|
|
1105
|
+
},
|
|
1106
|
+
model: {
|
|
1107
|
+
pattern: '^(?:urn:)?(?:air:)?(?:(?<ecosystem>[a-zA-Z0-9_-/]+):)?(?:(?<type>[a-zA-Z0-9_-/]+):)?(?<source>[a-zA-Z0-9_-/]+):(?<id>[a-zA-Z0-9_-/.]+)(?:@(?<version>[a-zA-Z0-9_-.]+))?(?:.(?<format>[a-zA-Z0-9_-]+))?$',
|
|
1108
|
+
type: 'string',
|
|
1109
|
+
description: 'The AIR of the checkpoint model to use for generation.',
|
|
1110
|
+
},
|
|
1111
|
+
additionalNetworks: {
|
|
1112
|
+
type: 'object',
|
|
1113
|
+
additionalProperties: {
|
|
1114
|
+
$ref: '#/components/schemas/ImageJobNetworkParams',
|
|
1115
|
+
},
|
|
1116
|
+
description: 'Get or set a associative list of additional networks. Use the AIR of the network as the key.',
|
|
1117
|
+
},
|
|
1118
|
+
controlNets: {
|
|
1119
|
+
type: 'array',
|
|
1120
|
+
items: {
|
|
1121
|
+
$ref: '#/components/schemas/ImageJobControlNet',
|
|
1122
|
+
},
|
|
1123
|
+
description: 'Get or set a associative list of ControlNets.',
|
|
1124
|
+
},
|
|
1125
|
+
prompt: {
|
|
1126
|
+
type: 'string',
|
|
1127
|
+
description: 'The provided text prompt.',
|
|
1128
|
+
default: '',
|
|
1129
|
+
},
|
|
1130
|
+
negativePrompt: {
|
|
1131
|
+
type: 'string',
|
|
1132
|
+
description: 'The provided negative text prompt.',
|
|
1133
|
+
default: '',
|
|
1134
|
+
},
|
|
1135
|
+
scheduler: {
|
|
1136
|
+
$ref: '#/components/schemas/Scheduler',
|
|
1137
|
+
},
|
|
1138
|
+
steps: {
|
|
1139
|
+
maximum: 150,
|
|
1140
|
+
minimum: 1,
|
|
1141
|
+
type: 'integer',
|
|
1142
|
+
description: 'The number of steps for image generation.',
|
|
1143
|
+
format: 'int32',
|
|
1144
|
+
default: 30,
|
|
1145
|
+
},
|
|
1146
|
+
cfgScale: {
|
|
1147
|
+
maximum: 30,
|
|
1148
|
+
minimum: 1,
|
|
1149
|
+
type: 'number',
|
|
1150
|
+
description: 'The CFG scale value for image generation.',
|
|
1151
|
+
format: 'double',
|
|
1152
|
+
default: 7.5,
|
|
1153
|
+
},
|
|
1154
|
+
width: {
|
|
1155
|
+
maximum: 2048,
|
|
1156
|
+
minimum: 64,
|
|
1157
|
+
type: 'integer',
|
|
1158
|
+
description: 'The desired image width in pixels.',
|
|
1159
|
+
format: 'int32',
|
|
1160
|
+
default: 512,
|
|
1161
|
+
},
|
|
1162
|
+
height: {
|
|
1163
|
+
maximum: 2048,
|
|
1164
|
+
minimum: 64,
|
|
1165
|
+
type: 'integer',
|
|
1166
|
+
description: 'The desired image height in pixels.',
|
|
1167
|
+
format: 'int32',
|
|
1168
|
+
default: 512,
|
|
1169
|
+
},
|
|
1170
|
+
seed: {
|
|
1171
|
+
maximum: 4294967295,
|
|
1172
|
+
minimum: 0,
|
|
1173
|
+
type: 'integer',
|
|
1174
|
+
description: 'The seed to use in image generation. Defaults to a random value if left unpopulated.',
|
|
1175
|
+
format: 'int64',
|
|
1176
|
+
},
|
|
1177
|
+
clipSkip: {
|
|
1178
|
+
type: 'integer',
|
|
1179
|
+
description: 'The clip skip value for image generation.',
|
|
1180
|
+
format: 'int32',
|
|
1181
|
+
default: 2,
|
|
1182
|
+
},
|
|
1183
|
+
},
|
|
1184
|
+
additionalProperties: false,
|
|
1185
|
+
description: 'Input for an text to image step.',
|
|
1186
|
+
};
|
|
1187
|
+
exports.$TextToImageJob = {
|
|
1188
|
+
required: ['$type', 'imageHash', 'model', 'params'],
|
|
1189
|
+
type: 'object',
|
|
1190
|
+
allOf: [
|
|
1191
|
+
{
|
|
1192
|
+
$ref: '#/components/schemas/Job',
|
|
1193
|
+
},
|
|
1194
|
+
],
|
|
1195
|
+
properties: {
|
|
1196
|
+
model: {
|
|
1197
|
+
pattern: '^(?:urn:)?(?:air:)?(?:(?<ecosystem>[a-zA-Z0-9_-/]+):)?(?:(?<type>[a-zA-Z0-9_-/]+):)?(?<source>[a-zA-Z0-9_-/]+):(?<id>[a-zA-Z0-9_-/.]+)(?:@(?<version>[a-zA-Z0-9_-.]+))?(?:.(?<format>[a-zA-Z0-9_-]+))?$',
|
|
1198
|
+
type: 'string',
|
|
1199
|
+
description: 'An AIR representing the model to use.',
|
|
1200
|
+
},
|
|
1201
|
+
params: {
|
|
1202
|
+
$ref: '#/components/schemas/ImageJobParams',
|
|
1203
|
+
},
|
|
1204
|
+
imageHash: {
|
|
1205
|
+
minLength: 1,
|
|
1206
|
+
type: 'string',
|
|
1207
|
+
description: 'The hash for the output image.',
|
|
1208
|
+
},
|
|
1209
|
+
additionalNetworks: {
|
|
1210
|
+
type: 'object',
|
|
1211
|
+
additionalProperties: {
|
|
1212
|
+
$ref: '#/components/schemas/ImageJobNetworkParams',
|
|
1213
|
+
},
|
|
1214
|
+
description: 'Get or set a associative list of additional networks. Each network is identified by a hash code.',
|
|
1215
|
+
},
|
|
1216
|
+
destinationUrl: {
|
|
1217
|
+
type: 'string',
|
|
1218
|
+
description: 'Get or set the URL where the image will be uploaded to.',
|
|
1219
|
+
format: 'uri',
|
|
1220
|
+
nullable: true,
|
|
1221
|
+
},
|
|
1222
|
+
storeAsBlob: {
|
|
1223
|
+
type: 'boolean',
|
|
1224
|
+
description: 'A value indicating whether to store the image as a blob or as a legacy image.',
|
|
1225
|
+
},
|
|
1226
|
+
controlNets: {
|
|
1227
|
+
type: 'array',
|
|
1228
|
+
items: {
|
|
1229
|
+
$ref: '#/components/schemas/ImageJobControlNet',
|
|
1230
|
+
},
|
|
1231
|
+
description: 'Get or set a list of control nets that should be applied with this textToImage job.',
|
|
1232
|
+
},
|
|
1233
|
+
cost: {
|
|
1234
|
+
type: 'number',
|
|
1235
|
+
description: 'A value representing the cost of the job.',
|
|
1236
|
+
format: 'double',
|
|
1237
|
+
},
|
|
1238
|
+
claimDuration: {
|
|
1239
|
+
type: 'string',
|
|
1240
|
+
description: 'The duration for which this job can be claimed for.',
|
|
1241
|
+
example: '00:00:00',
|
|
1242
|
+
},
|
|
1243
|
+
type: {
|
|
1244
|
+
type: 'string',
|
|
1245
|
+
description: 'The job type.',
|
|
1246
|
+
},
|
|
1247
|
+
$type: {
|
|
1248
|
+
enum: ['TextToImageJob'],
|
|
1249
|
+
type: 'string',
|
|
1250
|
+
},
|
|
1251
|
+
},
|
|
1252
|
+
additionalProperties: false,
|
|
1253
|
+
description: 'A text to image generation job.',
|
|
1254
|
+
};
|
|
1255
|
+
exports.$TextToImageJobSlot = {
|
|
1256
|
+
required: ['destinationUrl', 'imageHash'],
|
|
1257
|
+
type: 'object',
|
|
1258
|
+
properties: {
|
|
1259
|
+
imageHash: {
|
|
1260
|
+
minLength: 1,
|
|
1261
|
+
type: 'string',
|
|
1262
|
+
description: 'The hash for the image output.',
|
|
1263
|
+
},
|
|
1264
|
+
destinationUrl: {
|
|
1265
|
+
type: 'string',
|
|
1266
|
+
description: 'The destination url for image upload.',
|
|
1267
|
+
format: 'uri',
|
|
1268
|
+
},
|
|
1269
|
+
},
|
|
1270
|
+
additionalProperties: false,
|
|
1271
|
+
description: 'Contains slot information for an image generated by a TextToImageJob.',
|
|
1272
|
+
};
|
|
1273
|
+
exports.$TextToImageOutput = {
|
|
1274
|
+
required: ['images'],
|
|
1275
|
+
type: 'object',
|
|
1276
|
+
properties: {
|
|
1277
|
+
images: {
|
|
1278
|
+
type: 'array',
|
|
1279
|
+
items: {
|
|
1280
|
+
$ref: '#/components/schemas/Image',
|
|
1281
|
+
},
|
|
1282
|
+
description: 'A collection of output images.',
|
|
1283
|
+
},
|
|
1284
|
+
},
|
|
1285
|
+
additionalProperties: false,
|
|
1286
|
+
description: 'Represents the output of a TextToImage workflow step.',
|
|
1287
|
+
};
|
|
1288
|
+
exports.$TextToImageStep = {
|
|
1289
|
+
required: ['$type', 'input'],
|
|
1290
|
+
type: 'object',
|
|
1291
|
+
allOf: [
|
|
1292
|
+
{
|
|
1293
|
+
$ref: '#/components/schemas/WorkflowStep',
|
|
1294
|
+
},
|
|
1295
|
+
],
|
|
1296
|
+
properties: {
|
|
1297
|
+
name: {
|
|
1298
|
+
type: 'string',
|
|
1299
|
+
description: 'The name of the workflow step. Used to allow steps to refer to one another.',
|
|
1300
|
+
nullable: true,
|
|
1301
|
+
},
|
|
1302
|
+
priority: {
|
|
1303
|
+
$ref: '#/components/schemas/Priority',
|
|
1304
|
+
},
|
|
1305
|
+
timeout: {
|
|
1306
|
+
type: 'string',
|
|
1307
|
+
description: 'The maximum time to wait for this step to complete.',
|
|
1308
|
+
nullable: true,
|
|
1309
|
+
example: '00:00:00',
|
|
1310
|
+
},
|
|
1311
|
+
retries: {
|
|
1312
|
+
type: 'integer',
|
|
1313
|
+
description: 'The maximum number of times this step should be retried.',
|
|
1314
|
+
format: 'int32',
|
|
1315
|
+
nullable: true,
|
|
1316
|
+
},
|
|
1317
|
+
jobs: {
|
|
1318
|
+
type: 'array',
|
|
1319
|
+
items: {
|
|
1320
|
+
$ref: '#/components/schemas/WorkflowStepJob',
|
|
1321
|
+
},
|
|
1322
|
+
description: 'The jobs generated by this step.',
|
|
1323
|
+
},
|
|
1324
|
+
status: {
|
|
1325
|
+
$ref: '#/components/schemas/WorkflowStatus',
|
|
1326
|
+
},
|
|
1327
|
+
startedAt: {
|
|
1328
|
+
type: 'string',
|
|
1329
|
+
description: 'The date / time the step was started. Null if not yet started.',
|
|
1330
|
+
format: 'date-time',
|
|
1331
|
+
nullable: true,
|
|
1332
|
+
},
|
|
1333
|
+
completedAt: {
|
|
1334
|
+
type: 'string',
|
|
1335
|
+
description: 'The date / time the step was completed. Null if not yet completed.',
|
|
1336
|
+
format: 'date-time',
|
|
1337
|
+
nullable: true,
|
|
1338
|
+
},
|
|
1339
|
+
input: {
|
|
1340
|
+
$ref: '#/components/schemas/TextToImageInput',
|
|
1341
|
+
},
|
|
1342
|
+
output: {
|
|
1343
|
+
$ref: '#/components/schemas/TextToImageOutput',
|
|
1344
|
+
},
|
|
1345
|
+
$type: {
|
|
1346
|
+
enum: ['textToImage'],
|
|
1347
|
+
type: 'string',
|
|
1348
|
+
},
|
|
1349
|
+
},
|
|
1350
|
+
additionalProperties: false,
|
|
1351
|
+
description: 'A workflow step for text to image generations.',
|
|
1352
|
+
};
|
|
1353
|
+
exports.$TextToImageStepTemplate = {
|
|
1354
|
+
required: ['$type', 'input'],
|
|
1355
|
+
type: 'object',
|
|
1356
|
+
allOf: [
|
|
1357
|
+
{
|
|
1358
|
+
$ref: '#/components/schemas/WorkflowStepTemplate',
|
|
1359
|
+
},
|
|
1360
|
+
],
|
|
1361
|
+
properties: {
|
|
1362
|
+
$type: {
|
|
1363
|
+
enum: ['textToImage'],
|
|
1364
|
+
type: 'string',
|
|
1365
|
+
},
|
|
1366
|
+
input: {
|
|
1367
|
+
$ref: '#/components/schemas/TextToImageInput',
|
|
1368
|
+
},
|
|
1369
|
+
},
|
|
1370
|
+
additionalProperties: false,
|
|
1371
|
+
};
|
|
1372
|
+
exports.$TextToImageV2Job = {
|
|
1373
|
+
required: ['$type', 'model', 'params', 'slots'],
|
|
1374
|
+
type: 'object',
|
|
1375
|
+
allOf: [
|
|
1376
|
+
{
|
|
1377
|
+
$ref: '#/components/schemas/Job',
|
|
1378
|
+
},
|
|
1379
|
+
],
|
|
1380
|
+
properties: {
|
|
1381
|
+
model: {
|
|
1382
|
+
pattern: '^(?:urn:)?(?:air:)?(?:(?<ecosystem>[a-zA-Z0-9_-/]+):)?(?:(?<type>[a-zA-Z0-9_-/]+):)?(?<source>[a-zA-Z0-9_-/]+):(?<id>[a-zA-Z0-9_-/.]+)(?:@(?<version>[a-zA-Z0-9_-.]+))?(?:.(?<format>[a-zA-Z0-9_-]+))?$',
|
|
1383
|
+
type: 'string',
|
|
1384
|
+
description: 'An AIR representing the model to use.',
|
|
1385
|
+
},
|
|
1386
|
+
params: {
|
|
1387
|
+
$ref: '#/components/schemas/ImageJobParams',
|
|
1388
|
+
},
|
|
1389
|
+
slots: {
|
|
1390
|
+
type: 'array',
|
|
1391
|
+
items: {
|
|
1392
|
+
$ref: '#/components/schemas/TextToImageJobSlot',
|
|
1393
|
+
},
|
|
1394
|
+
description: 'Slots for the resulting image outputs.',
|
|
1395
|
+
},
|
|
1396
|
+
additionalNetworks: {
|
|
1397
|
+
type: 'object',
|
|
1398
|
+
additionalProperties: {
|
|
1399
|
+
$ref: '#/components/schemas/ImageJobNetworkParams',
|
|
1400
|
+
},
|
|
1401
|
+
description: 'Get or set a associative list of additional networks. Each network is identified by a hash code',
|
|
1402
|
+
},
|
|
1403
|
+
controlNets: {
|
|
1404
|
+
type: 'array',
|
|
1405
|
+
items: {
|
|
1406
|
+
$ref: '#/components/schemas/ImageJobControlNet',
|
|
1407
|
+
},
|
|
1408
|
+
description: 'Get or set a list of control nets that should be applied with this textToImage job',
|
|
1409
|
+
},
|
|
1410
|
+
cost: {
|
|
1411
|
+
type: 'number',
|
|
1412
|
+
description: 'A value representing the cost of the job.',
|
|
1413
|
+
format: 'double',
|
|
1414
|
+
},
|
|
1415
|
+
claimDuration: {
|
|
1416
|
+
type: 'string',
|
|
1417
|
+
description: 'The duration for which this job can be claimed for.',
|
|
1418
|
+
example: '00:00:00',
|
|
1419
|
+
},
|
|
1420
|
+
type: {
|
|
1421
|
+
type: 'string',
|
|
1422
|
+
description: 'The job type.',
|
|
1423
|
+
},
|
|
1424
|
+
$type: {
|
|
1425
|
+
enum: ['TextToImageV2Job'],
|
|
1426
|
+
type: 'string',
|
|
1427
|
+
},
|
|
1428
|
+
},
|
|
1429
|
+
additionalProperties: false,
|
|
1430
|
+
};
|
|
1431
|
+
exports.$TransactionInfo = {
|
|
1432
|
+
required: ['amount', 'id'],
|
|
1433
|
+
type: 'object',
|
|
1434
|
+
properties: {
|
|
1435
|
+
amount: {
|
|
1436
|
+
type: 'integer',
|
|
1437
|
+
description: 'The transaction amount.',
|
|
1438
|
+
format: 'int32',
|
|
1439
|
+
},
|
|
1440
|
+
id: {
|
|
1441
|
+
minLength: 1,
|
|
1442
|
+
type: 'string',
|
|
1443
|
+
description: 'The transaction ID.',
|
|
1444
|
+
nullable: true,
|
|
1445
|
+
},
|
|
1446
|
+
},
|
|
1447
|
+
additionalProperties: false,
|
|
1448
|
+
description: 'Transaction information.',
|
|
1449
|
+
};
|
|
1450
|
+
exports.$UpdateWorkflowRequest = {
|
|
1451
|
+
type: 'object',
|
|
1452
|
+
properties: {
|
|
1453
|
+
status: {
|
|
1454
|
+
$ref: '#/components/schemas/UpdateWorkflowStatus',
|
|
1455
|
+
},
|
|
1456
|
+
metadata: {
|
|
1457
|
+
type: 'object',
|
|
1458
|
+
additionalProperties: {},
|
|
1459
|
+
description: 'An optional set of new properties to set on the workflow.',
|
|
1460
|
+
nullable: true,
|
|
1461
|
+
},
|
|
1462
|
+
},
|
|
1463
|
+
additionalProperties: false,
|
|
1464
|
+
description: 'An request for updating a workflow.',
|
|
1465
|
+
};
|
|
1466
|
+
exports.$UpdateWorkflowStatus = {
|
|
1467
|
+
enum: ['canceled'],
|
|
1468
|
+
type: 'string',
|
|
1469
|
+
description: 'Available statuses for updating workflows.',
|
|
1470
|
+
nullable: true,
|
|
1471
|
+
};
|
|
1472
|
+
exports.$WorkerCapabilities = {
|
|
1473
|
+
type: 'object',
|
|
1474
|
+
properties: {
|
|
1475
|
+
image: {
|
|
1476
|
+
$ref: '#/components/schemas/WorkerImageCapabilities',
|
|
1477
|
+
},
|
|
1478
|
+
media: {
|
|
1479
|
+
$ref: '#/components/schemas/WorkerMediaCapabilities',
|
|
1480
|
+
},
|
|
1481
|
+
modelManagement: {
|
|
1482
|
+
$ref: '#/components/schemas/WorkerModelPreparationCapabilities',
|
|
1483
|
+
},
|
|
1484
|
+
configurationManagement: {
|
|
1485
|
+
$ref: '#/components/schemas/WorkerConfigurationCapabilities',
|
|
1486
|
+
},
|
|
1487
|
+
similaritySearch: {
|
|
1488
|
+
$ref: '#/components/schemas/WorkerSimilaritySearchCapabilities',
|
|
1489
|
+
},
|
|
1490
|
+
llmPromptAugmentation: {
|
|
1491
|
+
$ref: '#/components/schemas/LLMPromptAugmentationCapabilities',
|
|
1492
|
+
},
|
|
1493
|
+
},
|
|
1494
|
+
additionalProperties: false,
|
|
1495
|
+
description: "Details of a worker's capabilities.",
|
|
1496
|
+
};
|
|
1497
|
+
exports.$WorkerConfigurationCapabilities = {
|
|
1498
|
+
type: 'object',
|
|
1499
|
+
additionalProperties: false,
|
|
1500
|
+
description: "Details of a worker's configuration capabilities.",
|
|
1501
|
+
};
|
|
1502
|
+
exports.$WorkerDetails = {
|
|
1503
|
+
required: ['id', 'name'],
|
|
1504
|
+
type: 'object',
|
|
1505
|
+
properties: {
|
|
1506
|
+
id: {
|
|
1507
|
+
minLength: 1,
|
|
1508
|
+
type: 'string',
|
|
1509
|
+
description: "The worker's ID.",
|
|
1510
|
+
},
|
|
1511
|
+
name: {
|
|
1512
|
+
minLength: 1,
|
|
1513
|
+
type: 'string',
|
|
1514
|
+
description: "The worker's name.",
|
|
1515
|
+
},
|
|
1516
|
+
activeJobs: {
|
|
1517
|
+
type: 'integer',
|
|
1518
|
+
description: "The worker's active job count.",
|
|
1519
|
+
format: 'int32',
|
|
1520
|
+
},
|
|
1521
|
+
queueSize: {
|
|
1522
|
+
type: 'integer',
|
|
1523
|
+
description: "The number of jobs in the worker's queue.",
|
|
1524
|
+
format: 'int32',
|
|
1525
|
+
},
|
|
1526
|
+
queueDepth: {
|
|
1527
|
+
type: 'number',
|
|
1528
|
+
description: "The total cost of job's in the worker's queue.",
|
|
1529
|
+
format: 'double',
|
|
1530
|
+
},
|
|
1531
|
+
startDate: {
|
|
1532
|
+
type: 'string',
|
|
1533
|
+
description: "The worker's start date / time.",
|
|
1534
|
+
format: 'date-time',
|
|
1535
|
+
},
|
|
1536
|
+
lastRequestDate: {
|
|
1537
|
+
type: 'string',
|
|
1538
|
+
description: "The worker's last request date / time.",
|
|
1539
|
+
format: 'date-time',
|
|
1540
|
+
nullable: true,
|
|
1541
|
+
},
|
|
1542
|
+
expirationDate: {
|
|
1543
|
+
type: 'string',
|
|
1544
|
+
description: "The worker's expiration date / time.",
|
|
1545
|
+
format: 'date-time',
|
|
1546
|
+
nullable: true,
|
|
1547
|
+
},
|
|
1548
|
+
statistics: {
|
|
1549
|
+
$ref: '#/components/schemas/ProcessingStatistics',
|
|
1550
|
+
},
|
|
1551
|
+
succeededThroughputRate: {
|
|
1552
|
+
type: 'number',
|
|
1553
|
+
description: "The worker's succeeded job throughput rate.",
|
|
1554
|
+
format: 'double',
|
|
1555
|
+
},
|
|
1556
|
+
failedThroughputRate: {
|
|
1557
|
+
type: 'number',
|
|
1558
|
+
description: "The worker's failed job throughput rate.",
|
|
1559
|
+
format: 'double',
|
|
1560
|
+
},
|
|
1561
|
+
idleRate: {
|
|
1562
|
+
type: 'number',
|
|
1563
|
+
description: "The worker's idle rate.",
|
|
1564
|
+
format: 'double',
|
|
1565
|
+
},
|
|
1566
|
+
lastSuccesfullyCompletedJobDate: {
|
|
1567
|
+
type: 'string',
|
|
1568
|
+
description: "The date / time of the worker's last successfully completed job.",
|
|
1569
|
+
format: 'date-time',
|
|
1570
|
+
nullable: true,
|
|
1571
|
+
},
|
|
1572
|
+
lastJobUpdateDate: {
|
|
1573
|
+
type: 'string',
|
|
1574
|
+
description: "The date / time of the worker's last job update.",
|
|
1575
|
+
format: 'date-time',
|
|
1576
|
+
nullable: true,
|
|
1577
|
+
},
|
|
1578
|
+
subscriptionSetDate: {
|
|
1579
|
+
type: 'string',
|
|
1580
|
+
description: "The date / time that the worker's subscription was set.",
|
|
1581
|
+
format: 'date-time',
|
|
1582
|
+
nullable: true,
|
|
1583
|
+
},
|
|
1584
|
+
quarantineDate: {
|
|
1585
|
+
type: 'string',
|
|
1586
|
+
description: 'The date / time that the worker was quarantined.',
|
|
1587
|
+
format: 'date-time',
|
|
1588
|
+
nullable: true,
|
|
1589
|
+
},
|
|
1590
|
+
},
|
|
1591
|
+
additionalProperties: false,
|
|
1592
|
+
description: 'Details for a particular worker.',
|
|
1593
|
+
};
|
|
1594
|
+
exports.$WorkerImageCapabilities = {
|
|
1595
|
+
type: 'object',
|
|
1596
|
+
properties: {
|
|
1597
|
+
textToImage: {
|
|
1598
|
+
$ref: '#/components/schemas/WorkerImageTextToImageCapabilities',
|
|
1599
|
+
},
|
|
1600
|
+
imageToImage: {
|
|
1601
|
+
$ref: '#/components/schemas/WorkerImageImageToImageCapabilities',
|
|
1602
|
+
},
|
|
1603
|
+
transform: {
|
|
1604
|
+
$ref: '#/components/schemas/WorkerImageTransformCapabilities',
|
|
1605
|
+
},
|
|
1606
|
+
resourceTraining: {
|
|
1607
|
+
$ref: '#/components/schemas/WorkerImageResourceTrainingCapabilities',
|
|
1608
|
+
},
|
|
1609
|
+
embedding: {
|
|
1610
|
+
$ref: '#/components/schemas/WorkerImageEmbeddingCapabilities',
|
|
1611
|
+
},
|
|
1612
|
+
},
|
|
1613
|
+
additionalProperties: false,
|
|
1614
|
+
description: "Details of a worker's image capabilities.",
|
|
1615
|
+
};
|
|
1616
|
+
exports.$WorkerImageEmbeddingCapabilities = {
|
|
1617
|
+
type: 'object',
|
|
1618
|
+
additionalProperties: false,
|
|
1619
|
+
description: "Details of a worker's image embedding capabilities.",
|
|
1620
|
+
};
|
|
1621
|
+
exports.$WorkerImageImageToImageCapabilities = {
|
|
1622
|
+
type: 'object',
|
|
1623
|
+
properties: {
|
|
1624
|
+
size: {
|
|
1625
|
+
type: 'integer',
|
|
1626
|
+
description: "The worker's maximum supported image size for image to image (squared).",
|
|
1627
|
+
format: 'int32',
|
|
1628
|
+
},
|
|
1629
|
+
schedulers: {
|
|
1630
|
+
type: 'array',
|
|
1631
|
+
items: {
|
|
1632
|
+
$ref: '#/components/schemas/Scheduler',
|
|
1633
|
+
},
|
|
1634
|
+
description: 'A list of schedulers the worker supports for image to image.',
|
|
1635
|
+
},
|
|
1636
|
+
controlNet: {
|
|
1637
|
+
maximum: 10,
|
|
1638
|
+
minimum: 0,
|
|
1639
|
+
type: 'integer',
|
|
1640
|
+
description: 'The number of ControlNets the worker supports for image to image (at once).',
|
|
1641
|
+
format: 'int32',
|
|
1642
|
+
},
|
|
1643
|
+
inpainting: {
|
|
1644
|
+
type: 'boolean',
|
|
1645
|
+
description: 'Indicates whether the worker supports inpaiting.',
|
|
1646
|
+
},
|
|
1647
|
+
},
|
|
1648
|
+
additionalProperties: false,
|
|
1649
|
+
description: "Details of a worker's image to image capabilities.",
|
|
1650
|
+
};
|
|
1651
|
+
exports.$WorkerImageResourceTrainingCapabilities = {
|
|
1652
|
+
type: 'object',
|
|
1653
|
+
additionalProperties: false,
|
|
1654
|
+
description: "Details of a worker's image resource training capabilities.",
|
|
1655
|
+
};
|
|
1656
|
+
exports.$WorkerImageTextToImageCapabilities = {
|
|
1657
|
+
type: 'object',
|
|
1658
|
+
properties: {
|
|
1659
|
+
size: {
|
|
1660
|
+
type: 'integer',
|
|
1661
|
+
description: "The worker's maximum supported image size for text to image (squared).",
|
|
1662
|
+
format: 'int32',
|
|
1663
|
+
},
|
|
1664
|
+
schedulers: {
|
|
1665
|
+
type: 'array',
|
|
1666
|
+
items: {
|
|
1667
|
+
$ref: '#/components/schemas/Scheduler',
|
|
1668
|
+
},
|
|
1669
|
+
description: 'A list of schedulers the worker supports for text to image.',
|
|
1670
|
+
},
|
|
1671
|
+
controlNet: {
|
|
1672
|
+
maximum: 10,
|
|
1673
|
+
minimum: 0,
|
|
1674
|
+
type: 'integer',
|
|
1675
|
+
description: 'The number of ControlNets the worker supports for text to image (at once).',
|
|
1676
|
+
format: 'int32',
|
|
1677
|
+
},
|
|
1678
|
+
},
|
|
1679
|
+
additionalProperties: false,
|
|
1680
|
+
description: "Details of a worker's text to image capabilities.",
|
|
1681
|
+
};
|
|
1682
|
+
exports.$WorkerImageTransformCapabilities = {
|
|
1683
|
+
type: 'object',
|
|
1684
|
+
properties: {
|
|
1685
|
+
transformers: {
|
|
1686
|
+
type: 'array',
|
|
1687
|
+
items: {
|
|
1688
|
+
$ref: '#/components/schemas/ImageTransformer',
|
|
1689
|
+
},
|
|
1690
|
+
description: 'A list of supported image transformers.',
|
|
1691
|
+
},
|
|
1692
|
+
},
|
|
1693
|
+
additionalProperties: false,
|
|
1694
|
+
description: "Details of a worker's image transform capabilities.",
|
|
1695
|
+
};
|
|
1696
|
+
exports.$WorkerMediaCapabilities = {
|
|
1697
|
+
type: 'object',
|
|
1698
|
+
properties: {
|
|
1699
|
+
wdTagging: {
|
|
1700
|
+
$ref: '#/components/schemas/WorkerMediaWDTaggingCapabilities',
|
|
1701
|
+
},
|
|
1702
|
+
comfy: {
|
|
1703
|
+
$ref: '#/components/schemas/WorkerMediaComfyCapabilities',
|
|
1704
|
+
},
|
|
1705
|
+
tagging: {
|
|
1706
|
+
$ref: '#/components/schemas/WorkerMediaTaggingCapabilities',
|
|
1707
|
+
},
|
|
1708
|
+
movieRating: {
|
|
1709
|
+
$ref: '#/components/schemas/WorkerMediaMovieRatingCapabilities',
|
|
1710
|
+
},
|
|
1711
|
+
},
|
|
1712
|
+
additionalProperties: false,
|
|
1713
|
+
description: "Details of a worker's media capabilities.",
|
|
1714
|
+
};
|
|
1715
|
+
exports.$WorkerMediaComfyCapabilities = {
|
|
1716
|
+
type: 'object',
|
|
1717
|
+
additionalProperties: false,
|
|
1718
|
+
description: "Details of a worker's media comfy capabilities.",
|
|
1719
|
+
};
|
|
1720
|
+
exports.$WorkerMediaMovieRatingCapabilities = {
|
|
1721
|
+
type: 'object',
|
|
1722
|
+
additionalProperties: false,
|
|
1723
|
+
description: "Details of a worker's media movie rating capabilities.",
|
|
1724
|
+
};
|
|
1725
|
+
exports.$WorkerMediaTaggingCapabilities = {
|
|
1726
|
+
type: 'object',
|
|
1727
|
+
additionalProperties: false,
|
|
1728
|
+
description: "Details of a worker's media tagging capabilities.",
|
|
1729
|
+
};
|
|
1730
|
+
exports.$WorkerMediaWDTaggingCapabilities = {
|
|
1731
|
+
type: 'object',
|
|
1732
|
+
additionalProperties: false,
|
|
1733
|
+
description: "Details of a worker's media WD tagging capabilities.",
|
|
1734
|
+
};
|
|
1735
|
+
exports.$WorkerModelAvailability = {
|
|
1736
|
+
enum: ['unknown', 'unsupported', 'unavailable', 'available', 'providerUnsupported'],
|
|
1737
|
+
type: 'string',
|
|
1738
|
+
description: 'Options for representing the status for a model on a worker.',
|
|
1739
|
+
};
|
|
1740
|
+
exports.$WorkerModelPreparationCapabilities = {
|
|
1741
|
+
type: 'object',
|
|
1742
|
+
additionalProperties: false,
|
|
1743
|
+
description: "Details of a worker's model preparation capabilities.",
|
|
1744
|
+
};
|
|
1745
|
+
exports.$WorkerModelStatus = {
|
|
1746
|
+
required: ['availability'],
|
|
1747
|
+
type: 'object',
|
|
1748
|
+
properties: {
|
|
1749
|
+
availability: {
|
|
1750
|
+
$ref: '#/components/schemas/WorkerModelAvailability',
|
|
1751
|
+
},
|
|
1752
|
+
cost: {
|
|
1753
|
+
type: 'number',
|
|
1754
|
+
description: 'The cost associated with this model.',
|
|
1755
|
+
format: 'float',
|
|
1756
|
+
},
|
|
1757
|
+
},
|
|
1758
|
+
additionalProperties: false,
|
|
1759
|
+
description: 'Details for the status of a model on a particular worker.',
|
|
1760
|
+
};
|
|
1761
|
+
exports.$WorkerRegistration = {
|
|
1762
|
+
required: ['name'],
|
|
1763
|
+
type: 'object',
|
|
1764
|
+
properties: {
|
|
1765
|
+
legacyName: {
|
|
1766
|
+
type: 'string',
|
|
1767
|
+
nullable: true,
|
|
1768
|
+
},
|
|
1769
|
+
name: {
|
|
1770
|
+
minLength: 1,
|
|
1771
|
+
type: 'string',
|
|
1772
|
+
description: "The worker's name.",
|
|
1773
|
+
},
|
|
1774
|
+
onDemandModelTypesAsArray: {
|
|
1775
|
+
type: 'array',
|
|
1776
|
+
items: {
|
|
1777
|
+
type: 'string',
|
|
1778
|
+
},
|
|
1779
|
+
description: 'An array of asset types the worker can retrieve on demand.',
|
|
1780
|
+
},
|
|
1781
|
+
onDemandModelTypes: {
|
|
1782
|
+
uniqueItems: true,
|
|
1783
|
+
type: 'array',
|
|
1784
|
+
items: {
|
|
1785
|
+
type: 'string',
|
|
1786
|
+
},
|
|
1787
|
+
description: 'A hash set of asset types the worker can retrieve on demand.',
|
|
1788
|
+
},
|
|
1789
|
+
capabilities: {
|
|
1790
|
+
$ref: '#/components/schemas/WorkerCapabilities',
|
|
1791
|
+
},
|
|
1792
|
+
subscription: {
|
|
1793
|
+
$ref: '#/components/schemas/Subscription',
|
|
1794
|
+
},
|
|
1795
|
+
type: {
|
|
1796
|
+
$ref: '#/components/schemas/WorkerType',
|
|
1797
|
+
},
|
|
1798
|
+
concurrentLimit: {
|
|
1799
|
+
type: 'integer',
|
|
1800
|
+
description: 'The number of requests the worker can handle at once.',
|
|
1801
|
+
format: 'int32',
|
|
1802
|
+
},
|
|
1803
|
+
ecosystems: {
|
|
1804
|
+
type: 'object',
|
|
1805
|
+
additionalProperties: {
|
|
1806
|
+
$ref: '#/components/schemas/EcosystemElement',
|
|
1807
|
+
},
|
|
1808
|
+
description: 'A collection of ecosystems the worker supports.',
|
|
1809
|
+
},
|
|
1810
|
+
models: {
|
|
1811
|
+
type: 'object',
|
|
1812
|
+
additionalProperties: {
|
|
1813
|
+
$ref: '#/components/schemas/WorkerModelStatus',
|
|
1814
|
+
},
|
|
1815
|
+
description: 'A collection of information about the availability of particular models on this worker.',
|
|
1816
|
+
},
|
|
1817
|
+
cacheLevel: {
|
|
1818
|
+
type: 'string',
|
|
1819
|
+
description: 'The name of the closest cache level that this worker can interact with.',
|
|
1820
|
+
nullable: true,
|
|
1821
|
+
},
|
|
1822
|
+
maxColdSwapQueueSize: {
|
|
1823
|
+
type: 'integer',
|
|
1824
|
+
description: 'The max queue size before the worker stops accepting requests that require cold swapping.',
|
|
1825
|
+
format: 'int32',
|
|
1826
|
+
nullable: true,
|
|
1827
|
+
},
|
|
1828
|
+
maxPendingModelSize: {
|
|
1829
|
+
type: 'integer',
|
|
1830
|
+
description: 'The max size in Mb of downloads that can be pending.',
|
|
1831
|
+
format: 'int32',
|
|
1832
|
+
nullable: true,
|
|
1833
|
+
},
|
|
1834
|
+
consumeUnavailableJobs: {
|
|
1835
|
+
type: 'boolean',
|
|
1836
|
+
description: 'A value indicating if worker should consume jobs that are not yet available.',
|
|
1837
|
+
},
|
|
1838
|
+
nodeIdentifier: {
|
|
1839
|
+
type: 'string',
|
|
1840
|
+
description: 'An optional identifier unique to this worker.',
|
|
1841
|
+
nullable: true,
|
|
1842
|
+
},
|
|
1843
|
+
},
|
|
1844
|
+
additionalProperties: false,
|
|
1845
|
+
description: "Details of a worker's registration.",
|
|
1846
|
+
};
|
|
1847
|
+
exports.$WorkerSimilaritySearchCapabilities = {
|
|
1848
|
+
type: 'object',
|
|
1849
|
+
additionalProperties: false,
|
|
1850
|
+
description: "Details of a worker's similarity search capabilities.",
|
|
1851
|
+
};
|
|
1852
|
+
exports.$WorkerType = {
|
|
1853
|
+
enum: ['normal', 'deferred'],
|
|
1854
|
+
type: 'string',
|
|
1855
|
+
description: 'Available values for worker type.',
|
|
1856
|
+
};
|
|
1857
|
+
exports.$Workflow = {
|
|
1858
|
+
type: 'object',
|
|
1859
|
+
properties: {
|
|
1860
|
+
id: {
|
|
1861
|
+
type: 'string',
|
|
1862
|
+
description: 'The ID for the workflow.',
|
|
1863
|
+
nullable: true,
|
|
1864
|
+
},
|
|
1865
|
+
createdAt: {
|
|
1866
|
+
type: 'string',
|
|
1867
|
+
description: 'The date / time the workflow was created.',
|
|
1868
|
+
format: 'date-time',
|
|
1869
|
+
},
|
|
1870
|
+
transactions: {
|
|
1871
|
+
type: 'array',
|
|
1872
|
+
items: {
|
|
1873
|
+
$ref: '#/components/schemas/TransactionInfo',
|
|
1874
|
+
},
|
|
1875
|
+
description: 'An array of transactions on this workflow.',
|
|
1876
|
+
nullable: true,
|
|
1877
|
+
},
|
|
1878
|
+
metadata: {
|
|
1879
|
+
type: 'object',
|
|
1880
|
+
additionalProperties: {},
|
|
1881
|
+
description: 'A collection of user defined metadata for the workflow.',
|
|
1882
|
+
nullable: true,
|
|
1883
|
+
},
|
|
1884
|
+
status: {
|
|
1885
|
+
$ref: '#/components/schemas/WorkflowStatus',
|
|
1886
|
+
},
|
|
1887
|
+
startedAt: {
|
|
1888
|
+
type: 'string',
|
|
1889
|
+
description: 'The date / time the workflow was started. Null if not yet started.',
|
|
1890
|
+
format: 'date-time',
|
|
1891
|
+
nullable: true,
|
|
1892
|
+
},
|
|
1893
|
+
completedAt: {
|
|
1894
|
+
type: 'string',
|
|
1895
|
+
description: 'The date / time the workflow was completed. Null if not yet complete.',
|
|
1896
|
+
format: 'date-time',
|
|
1897
|
+
nullable: true,
|
|
1898
|
+
},
|
|
1899
|
+
steps: {
|
|
1900
|
+
type: 'array',
|
|
1901
|
+
items: {
|
|
1902
|
+
$ref: '#/components/schemas/WorkflowStep',
|
|
1903
|
+
},
|
|
1904
|
+
description: 'The steps for the workflow.',
|
|
1905
|
+
},
|
|
1906
|
+
callbacks: {
|
|
1907
|
+
type: 'array',
|
|
1908
|
+
items: {
|
|
1909
|
+
$ref: '#/components/schemas/WorkflowCallback',
|
|
1910
|
+
},
|
|
1911
|
+
description: 'An array of callback details for the workflow.',
|
|
1912
|
+
},
|
|
1913
|
+
},
|
|
1914
|
+
additionalProperties: false,
|
|
1915
|
+
description: 'Details of a workflow.',
|
|
1916
|
+
};
|
|
1917
|
+
exports.$WorkflowCallback = {
|
|
1918
|
+
required: ['type', 'url'],
|
|
1919
|
+
type: 'object',
|
|
1920
|
+
properties: {
|
|
1921
|
+
url: {
|
|
1922
|
+
type: 'string',
|
|
1923
|
+
description: 'The url for the callback.',
|
|
1924
|
+
format: 'uri',
|
|
1925
|
+
},
|
|
1926
|
+
type: {
|
|
1927
|
+
type: 'array',
|
|
1928
|
+
items: {
|
|
1929
|
+
enum: [
|
|
1930
|
+
'workflow:*',
|
|
1931
|
+
'workflow:unassigned',
|
|
1932
|
+
'workflow:processing',
|
|
1933
|
+
'workflow:succeeded',
|
|
1934
|
+
'workflow:failed',
|
|
1935
|
+
'workflow:expired',
|
|
1936
|
+
'workflow:canceled',
|
|
1937
|
+
'step:*',
|
|
1938
|
+
'step:unassigned',
|
|
1939
|
+
'step:processing',
|
|
1940
|
+
'step:succeeded',
|
|
1941
|
+
'step:failed',
|
|
1942
|
+
'step:expired',
|
|
1943
|
+
'step:canceled',
|
|
1944
|
+
'job:*',
|
|
1945
|
+
'job:unassigned',
|
|
1946
|
+
'job:processing',
|
|
1947
|
+
'job:succeeded',
|
|
1948
|
+
'job:failed',
|
|
1949
|
+
'job:expired',
|
|
1950
|
+
'job:canceled',
|
|
1951
|
+
],
|
|
1952
|
+
type: 'string',
|
|
1953
|
+
example: 'workflow:succeeded',
|
|
1954
|
+
},
|
|
1955
|
+
description: 'An array of event types to send to the callback.',
|
|
1956
|
+
},
|
|
1957
|
+
},
|
|
1958
|
+
additionalProperties: false,
|
|
1959
|
+
description: 'Details of a callback setup for a workflow.',
|
|
1960
|
+
};
|
|
1961
|
+
exports.$WorkflowEvent = {
|
|
1962
|
+
required: ['status', 'workflowId'],
|
|
1963
|
+
type: 'object',
|
|
1964
|
+
properties: {
|
|
1965
|
+
workflowId: {
|
|
1966
|
+
minLength: 1,
|
|
1967
|
+
type: 'string',
|
|
1968
|
+
description: 'The ID that represents the corresponding workflow.',
|
|
1969
|
+
},
|
|
1970
|
+
status: {
|
|
1971
|
+
$ref: '#/components/schemas/WorkflowStatus',
|
|
1972
|
+
},
|
|
1973
|
+
$type: {
|
|
1974
|
+
type: 'string',
|
|
1975
|
+
nullable: true,
|
|
1976
|
+
},
|
|
1977
|
+
},
|
|
1978
|
+
additionalProperties: false,
|
|
1979
|
+
description: 'Details of a workflow event.',
|
|
1980
|
+
};
|
|
1981
|
+
exports.$WorkflowStatus = {
|
|
1982
|
+
enum: [
|
|
1983
|
+
'unassigned',
|
|
1984
|
+
'preparing',
|
|
1985
|
+
'scheduled',
|
|
1986
|
+
'processing',
|
|
1987
|
+
'succeeded',
|
|
1988
|
+
'failed',
|
|
1989
|
+
'expired',
|
|
1990
|
+
'canceled',
|
|
1991
|
+
],
|
|
1992
|
+
type: 'string',
|
|
1993
|
+
description: 'Values available to represent workflow status.',
|
|
1994
|
+
};
|
|
1995
|
+
exports.$WorkflowStep = {
|
|
1996
|
+
required: ['$type'],
|
|
1997
|
+
type: 'object',
|
|
1998
|
+
properties: {
|
|
1999
|
+
$type: {
|
|
2000
|
+
type: 'string',
|
|
2001
|
+
},
|
|
2002
|
+
name: {
|
|
2003
|
+
type: 'string',
|
|
2004
|
+
description: 'The name of the workflow step. Used to allow steps to refer to one another.',
|
|
2005
|
+
nullable: true,
|
|
2006
|
+
},
|
|
2007
|
+
priority: {
|
|
2008
|
+
$ref: '#/components/schemas/Priority',
|
|
2009
|
+
},
|
|
2010
|
+
timeout: {
|
|
2011
|
+
type: 'string',
|
|
2012
|
+
description: 'The maximum time to wait for this step to complete.',
|
|
2013
|
+
nullable: true,
|
|
2014
|
+
example: '00:00:00',
|
|
2015
|
+
},
|
|
2016
|
+
retries: {
|
|
2017
|
+
type: 'integer',
|
|
2018
|
+
description: 'The maximum number of times this step should be retried.',
|
|
2019
|
+
format: 'int32',
|
|
2020
|
+
nullable: true,
|
|
2021
|
+
},
|
|
2022
|
+
jobs: {
|
|
2023
|
+
type: 'array',
|
|
2024
|
+
items: {
|
|
2025
|
+
$ref: '#/components/schemas/WorkflowStepJob',
|
|
2026
|
+
},
|
|
2027
|
+
description: 'The jobs generated by this step.',
|
|
2028
|
+
},
|
|
2029
|
+
status: {
|
|
2030
|
+
$ref: '#/components/schemas/WorkflowStatus',
|
|
2031
|
+
},
|
|
2032
|
+
startedAt: {
|
|
2033
|
+
type: 'string',
|
|
2034
|
+
description: 'The date / time the step was started. Null if not yet started.',
|
|
2035
|
+
format: 'date-time',
|
|
2036
|
+
nullable: true,
|
|
2037
|
+
},
|
|
2038
|
+
completedAt: {
|
|
2039
|
+
type: 'string',
|
|
2040
|
+
description: 'The date / time the step was completed. Null if not yet completed.',
|
|
2041
|
+
format: 'date-time',
|
|
2042
|
+
nullable: true,
|
|
2043
|
+
},
|
|
2044
|
+
},
|
|
2045
|
+
additionalProperties: false,
|
|
2046
|
+
description: 'Details of a workflow step.',
|
|
2047
|
+
discriminator: {
|
|
2048
|
+
propertyName: '$type',
|
|
2049
|
+
mapping: {
|
|
2050
|
+
textToImage: '#/components/schemas/TextToImageStep',
|
|
2051
|
+
imageResourceTraining: '#/components/schemas/ImageResourceTrainingStep',
|
|
2052
|
+
echo: '#/components/schemas/EchoStep',
|
|
2053
|
+
},
|
|
2054
|
+
},
|
|
2055
|
+
};
|
|
2056
|
+
exports.$WorkflowStepEvent = {
|
|
2057
|
+
required: ['status', 'stepName', 'workflowId'],
|
|
2058
|
+
type: 'object',
|
|
2059
|
+
properties: {
|
|
2060
|
+
workflowId: {
|
|
2061
|
+
minLength: 1,
|
|
2062
|
+
type: 'string',
|
|
2063
|
+
description: 'The workflow ID.',
|
|
2064
|
+
},
|
|
2065
|
+
stepName: {
|
|
2066
|
+
minLength: 1,
|
|
2067
|
+
type: 'string',
|
|
2068
|
+
description: "The workflow step's name.",
|
|
2069
|
+
},
|
|
2070
|
+
status: {
|
|
2071
|
+
$ref: '#/components/schemas/WorkflowStatus',
|
|
2072
|
+
},
|
|
2073
|
+
$type: {
|
|
2074
|
+
type: 'string',
|
|
2075
|
+
nullable: true,
|
|
2076
|
+
},
|
|
2077
|
+
},
|
|
2078
|
+
additionalProperties: false,
|
|
2079
|
+
description: 'Details of a workflow step event.',
|
|
2080
|
+
};
|
|
2081
|
+
exports.$WorkflowStepJob = {
|
|
2082
|
+
required: ['cost', 'id'],
|
|
2083
|
+
type: 'object',
|
|
2084
|
+
properties: {
|
|
2085
|
+
id: {
|
|
2086
|
+
minLength: 1,
|
|
2087
|
+
type: 'string',
|
|
2088
|
+
description: "The job's ID.",
|
|
2089
|
+
},
|
|
2090
|
+
cost: {
|
|
2091
|
+
type: 'number',
|
|
2092
|
+
description: "The job's cost.",
|
|
2093
|
+
format: 'double',
|
|
2094
|
+
},
|
|
2095
|
+
status: {
|
|
2096
|
+
$ref: '#/components/schemas/WorkflowStatus',
|
|
2097
|
+
},
|
|
2098
|
+
startedAt: {
|
|
2099
|
+
type: 'string',
|
|
2100
|
+
description: 'The date / time the job started. Null if not yet started.',
|
|
2101
|
+
format: 'date-time',
|
|
2102
|
+
nullable: true,
|
|
2103
|
+
},
|
|
2104
|
+
completedAt: {
|
|
2105
|
+
type: 'string',
|
|
2106
|
+
description: 'The date / time the job completed. Null if not yet completed.',
|
|
2107
|
+
format: 'date-time',
|
|
2108
|
+
nullable: true,
|
|
2109
|
+
},
|
|
2110
|
+
queuePosition: {
|
|
2111
|
+
$ref: '#/components/schemas/WorkflowStepJobQueuePosition',
|
|
2112
|
+
},
|
|
2113
|
+
},
|
|
2114
|
+
additionalProperties: false,
|
|
2115
|
+
description: 'Details of a job produced by a workflow step.',
|
|
2116
|
+
};
|
|
2117
|
+
exports.$WorkflowStepJobEvent = {
|
|
2118
|
+
required: ['jobId', 'status', 'stepName', 'workflowId'],
|
|
2119
|
+
type: 'object',
|
|
2120
|
+
properties: {
|
|
2121
|
+
workflowId: {
|
|
2122
|
+
minLength: 1,
|
|
2123
|
+
type: 'string',
|
|
2124
|
+
description: 'The workflow ID.',
|
|
2125
|
+
},
|
|
2126
|
+
stepName: {
|
|
2127
|
+
minLength: 1,
|
|
2128
|
+
type: 'string',
|
|
2129
|
+
description: "The step's name.",
|
|
2130
|
+
},
|
|
2131
|
+
jobId: {
|
|
2132
|
+
minLength: 1,
|
|
2133
|
+
type: 'string',
|
|
2134
|
+
description: "The job's ID.",
|
|
2135
|
+
},
|
|
2136
|
+
status: {
|
|
2137
|
+
$ref: '#/components/schemas/WorkflowStatus',
|
|
2138
|
+
},
|
|
2139
|
+
$type: {
|
|
2140
|
+
type: 'string',
|
|
2141
|
+
nullable: true,
|
|
2142
|
+
},
|
|
2143
|
+
},
|
|
2144
|
+
additionalProperties: false,
|
|
2145
|
+
description: 'Details of a workflow step job event.',
|
|
2146
|
+
};
|
|
2147
|
+
exports.$WorkflowStepJobQueuePosition = {
|
|
2148
|
+
type: 'object',
|
|
2149
|
+
properties: {
|
|
2150
|
+
support: {
|
|
2151
|
+
$ref: '#/components/schemas/JobSupport',
|
|
2152
|
+
},
|
|
2153
|
+
precedingJobs: {
|
|
2154
|
+
type: 'integer',
|
|
2155
|
+
description: 'The number of preceding jobs in the queue.',
|
|
2156
|
+
format: 'int32',
|
|
2157
|
+
nullable: true,
|
|
2158
|
+
},
|
|
2159
|
+
startAt: {
|
|
2160
|
+
type: 'string',
|
|
2161
|
+
description: 'An estimated date / time for when the job will start.',
|
|
2162
|
+
format: 'date-time',
|
|
2163
|
+
nullable: true,
|
|
2164
|
+
},
|
|
2165
|
+
completeAt: {
|
|
2166
|
+
type: 'string',
|
|
2167
|
+
description: 'An estimated date / time for when the job will complete.',
|
|
2168
|
+
format: 'date-time',
|
|
2169
|
+
nullable: true,
|
|
2170
|
+
},
|
|
2171
|
+
},
|
|
2172
|
+
additionalProperties: false,
|
|
2173
|
+
description: "Details of the workflow step job's queue position.",
|
|
2174
|
+
};
|
|
2175
|
+
exports.$WorkflowStepTemplate = {
|
|
2176
|
+
required: ['$type', 'input'],
|
|
2177
|
+
type: 'object',
|
|
2178
|
+
properties: {
|
|
2179
|
+
$type: {
|
|
2180
|
+
minLength: 1,
|
|
2181
|
+
type: 'string',
|
|
2182
|
+
description: 'The type of step the template represents.',
|
|
2183
|
+
},
|
|
2184
|
+
name: {
|
|
2185
|
+
type: 'string',
|
|
2186
|
+
description: 'The name of the workflow step. Used to allow steps to refer to one another.',
|
|
2187
|
+
nullable: true,
|
|
2188
|
+
},
|
|
2189
|
+
priority: {
|
|
2190
|
+
$ref: '#/components/schemas/Priority',
|
|
2191
|
+
},
|
|
2192
|
+
timeout: {
|
|
2193
|
+
type: 'string',
|
|
2194
|
+
description: 'The maximum time to wait for this step to complete.',
|
|
2195
|
+
nullable: true,
|
|
2196
|
+
example: '00:00:00',
|
|
2197
|
+
},
|
|
2198
|
+
retries: {
|
|
2199
|
+
type: 'integer',
|
|
2200
|
+
description: 'The maximum number of times this step should be retried.',
|
|
2201
|
+
format: 'int32',
|
|
2202
|
+
nullable: true,
|
|
2203
|
+
},
|
|
2204
|
+
},
|
|
2205
|
+
additionalProperties: false,
|
|
2206
|
+
description: 'Details of a workflow step template.',
|
|
2207
|
+
discriminator: {
|
|
2208
|
+
propertyName: '$type',
|
|
2209
|
+
mapping: {
|
|
2210
|
+
textToImage: 'TextToImageStepTemplate',
|
|
2211
|
+
imageResourceTraining: 'ImageResourceTrainingStepTemplate',
|
|
2212
|
+
echo: 'EchoStepTemplate',
|
|
2213
|
+
},
|
|
2214
|
+
},
|
|
2215
|
+
};
|
|
2216
|
+
exports.$WorkflowTemplate = {
|
|
2217
|
+
required: ['steps'],
|
|
2218
|
+
type: 'object',
|
|
2219
|
+
properties: {
|
|
2220
|
+
metadata: {
|
|
2221
|
+
type: 'object',
|
|
2222
|
+
additionalProperties: {},
|
|
2223
|
+
description: 'A colletion of user defined metadata that can be used to store additional information about the workflow.',
|
|
2224
|
+
nullable: true,
|
|
2225
|
+
},
|
|
2226
|
+
steps: {
|
|
2227
|
+
minItems: 1,
|
|
2228
|
+
type: 'array',
|
|
2229
|
+
items: {
|
|
2230
|
+
$ref: '#/components/schemas/WorkflowStepTemplate',
|
|
2231
|
+
},
|
|
2232
|
+
description: 'An array of steps that compose this workflow.',
|
|
2233
|
+
},
|
|
2234
|
+
callbacks: {
|
|
2235
|
+
type: 'array',
|
|
2236
|
+
items: {
|
|
2237
|
+
$ref: '#/components/schemas/WorkflowCallback',
|
|
2238
|
+
},
|
|
2239
|
+
description: 'An array of callbacks to be triggered during the lifetime of the workflow.',
|
|
2240
|
+
},
|
|
2241
|
+
},
|
|
2242
|
+
additionalProperties: false,
|
|
2243
|
+
description: 'Details of a requested workflow.',
|
|
2244
|
+
};
|