Skip to content

Commit 85247aa

Browse files
author
MOSTLY CI
committed
Updating OpenAPI Specification for release 4.3.0
1 parent 2be441e commit 85247aa

1 file changed

Lines changed: 37 additions & 11 deletions

File tree

public-api.yaml

Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,7 @@ paths:
435435
Export the generator as a self-contained single file, that can then be imported as a fully functional
436436
generator on a MOSTLY AI server.
437437
operationId: "exportGeneratorToFile"
438+
x-stream-response: true
438439
tags: [ "Generators" ]
439440
responses:
440441
"200":
@@ -727,6 +728,7 @@ paths:
727728
get:
728729
summary: "Download training logs"
729730
operationId: "downloadTrainingLogs"
731+
x-stream-response: true
730732
tags: [ "Generator Training" ]
731733
parameters:
732734
- $ref: "#/components/parameters/shortLivedFileToken"
@@ -1021,6 +1023,7 @@ paths:
10211023
get:
10221024
summary: "Download generation logs"
10231025
operationId: "downloadGenerationLogs"
1026+
x-stream-response: true
10241027
tags: [ "Synthetic Generation" ]
10251028
parameters:
10261029
- $ref: "#/components/parameters/shortLivedFileToken"
@@ -1038,6 +1041,7 @@ paths:
10381041
get:
10391042
summary: "Download synthetic dataset"
10401043
operationId: "downloadSyntheticDataset"
1044+
x-stream-response: true
10411045
tags: [ "Synthetic Datasets" ]
10421046
parameters:
10431047
- name: "format"
@@ -1245,6 +1249,7 @@ paths:
12451249
get:
12461250
summary: "Export the assistant thread"
12471251
operationId: "exportThread"
1252+
x-stream-response: true
12481253
parameters:
12491254
- $ref: "#/components/parameters/shortLivedFileToken"
12501255
responses:
@@ -1261,7 +1266,7 @@ paths:
12611266
post:
12621267
summary: "Create a message"
12631268
operationId: "createAssistantMessage"
1264-
x-codegen-ignore: true
1269+
x-flow-response: true
12651270
tags: [ "Assistant" ]
12661271
requestBody:
12671272
required: true
@@ -1321,6 +1326,7 @@ paths:
13211326
get:
13221327
summary: "Fetch file in assistant thread"
13231328
operationId: "fetchAssistantThreadFile"
1329+
x-stream-response: true
13241330
tags: [ "Assistant" ]
13251331
parameters:
13261332
- name: "filepath"
@@ -1573,6 +1579,7 @@ paths:
15731579
get:
15741580
summary: "Download usage report as CSV"
15751581
operationId: "downloadUsageReport"
1582+
x-stream-response: true
15761583
responses:
15771584
"200":
15781585
description: "OK"
@@ -3106,6 +3113,11 @@ components:
31063113
$ref: "#/components/schemas/DifferentialPrivacyConfig"
31073114
compute:
31083115
$ref: "#/components/schemas/ComputeId"
3116+
enableModelReport:
3117+
type: "boolean"
3118+
description: |
3119+
If false, then the Model report is not generated.
3120+
default: true
31093121

31103122
# JOB_PROGRESS
31113123
JobProgress:
@@ -3195,12 +3207,14 @@ components:
31953207
- "TRAIN_TABULAR"
31963208
- "TRAIN_LANGUAGE"
31973209
- "FINALIZE_TRAINING"
3198-
- "GENERATE_TABULAR"
3199-
- "GENERATE_LANGUAGE"
3210+
- "GENERATE_TABULAR" # DEPRECATED
3211+
- "GENERATE_LANGUAGE" # DEPRECATED
32003212
- "FINALIZE_GENERATION"
3201-
- "PROBE_TABULAR"
3202-
- "PROBE_LANGUAGE"
3213+
- "PROBE_TABULAR" # DEPRECATED
3214+
- "PROBE_LANGUAGE" # DEPRECATED
32033215
- "FINALIZE_PROBING"
3216+
- "GENERATE"
3217+
- "PROBE"
32043218
StepCode:
32053219
type: "string"
32063220
description: "The unique code for the step."
@@ -3209,11 +3223,15 @@ components:
32093223
- "ANALYZE_TRAINING_DATA"
32103224
- "ENCODE_TRAINING_DATA"
32113225
- "TRAIN_MODEL"
3226+
- "GENERATE_DATA" # DEPRECATED
32123227
- "GENERATE_MODEL_REPORT_DATA"
32133228
- "CREATE_MODEL_REPORT"
32143229
- "FINALIZE_TRAINING"
3215-
- "GENERATE_DATA"
3216-
- "CREATE_DATA_REPORT"
3230+
- "GENERATE_DATA_TABULAR"
3231+
- "GENERATE_DATA_LANGUAGE"
3232+
- "CREATE_DATA_REPORT" # DEPRECATED
3233+
- "CREATE_DATA_REPORT_TABULAR"
3234+
- "CREATE_DATA_REPORT_LANGUAGE"
32173235
- "FINALIZE_GENERATION"
32183236
- "DELIVER_DATA"
32193237
- "FINALIZE_PROBING"
@@ -3336,6 +3354,8 @@ components:
33363354
$ref: "#/components/schemas/GeneratorAccuracy"
33373355
usage:
33383356
$ref: "#/components/schemas/SyntheticDatasetUsage"
3357+
compute:
3358+
$ref: "#/components/schemas/ComputeId"
33393359
required:
33403360
- "id"
33413361
- "generationStatus"
@@ -3413,10 +3433,12 @@ components:
34133433
$ref: "#/components/schemas/ImputationConfig"
34143434
fairness:
34153435
$ref: "#/components/schemas/FairnessConfig"
3416-
tabularCompute:
3417-
$ref: "#/components/schemas/ComputeId"
3418-
languageCompute:
3419-
$ref: "#/components/schemas/ComputeId"
3436+
enableDataReport:
3437+
type: "boolean"
3438+
description: |
3439+
If false, then the Data report is not generated.
3440+
If enableDataReport is set to false on generator, then enableDataReport is automatically set to false.
3441+
default: true
34203442
SyntheticTableId:
34213443
type: "string"
34223444
description: "The unique identifier of a synthetic table."
@@ -3494,6 +3516,8 @@ components:
34943516
$ref: "#/components/schemas/SyntheticTableConfig"
34953517
delivery:
34963518
$ref: "#/components/schemas/SyntheticDatasetDelivery"
3519+
compute:
3520+
$ref: "#/components/schemas/ComputeId"
34973521
SyntheticDatasetPatchConfig:
34983522
type: "object"
34993523
properties:
@@ -3503,6 +3527,8 @@ components:
35033527
$ref: "#/components/schemas/SyntheticDatasetDescription"
35043528
delivery:
35053529
$ref: "#/components/schemas/SyntheticDatasetDelivery"
3530+
compute:
3531+
$ref: "#/components/schemas/ComputeId"
35063532
SyntheticTablePatchConfig:
35073533
type: "object"
35083534
description: "The configuration for updating a synthetic table."

0 commit comments

Comments
 (0)