Schema of Workflow Definition for Media Cloud AI
Schema information
Properties
schema_version
(
string
)
Version of the schema used to describe this workflow
1.9
1.10
1.11
1.12
1.13
identifier
(
string
)
The Identifier of the workflow, used to reference it
^([a-z_]+)$
speech_to_text
reference
(
string
)
External reference identifier for this workflow, can be UUID, string etc.
label
(
string
)
The label of the workflow, used as displayed name
^(.*)$
speech_to_text
icon
(
string
)
The icon used with the label. One of https://material.io/resources/icons/
^([a-z_]+)$
subtitles
is_live
(
boolean
)
Define if the workflow is a live workflow or not (default: false)
false
start_parameters
(
array<#/definitions/start_parameter>
)
Definition of available parameters to start the workflow definition
parameters
(
array<parameter.schema.json#>
)
Storage of dynamic parameters during process of the workflow instance
version_major
(
integer
)
Major version of this Workflow definition
version_minor
(
integer
)
Minor version of this Workflow definition
version_micro
(
integer
)
Micro version of this Workflow definition
notification_hook
Type: object
label
(
string
)
Label for the Notification
endpoint
(
string
)
Endpoint for the Notification
credentials
(
string
)
Credentials for the Notification
conditions
(
object
)
Triggering conditions for the Notification
start_parameter
Type: object
id
(
string
)
Identifier of the parameter
^(.*)$
label
(
string
)
Label of the parameter
^(.*)$
type
(
string
)
Type of the data value for this parameter
^(.*)$
file
choice
string
number
accept
(
string
)
A list of acceptable file type
default
(
integer, number, string, array
)
Default value of the parameter
^(.*)$
value
(
integer, number, string, array
)
Value of the parameter
^(.*)$
required
(
boolean
)
Set the parameter required
icon
(
string
)
Set the icon for this parameter
step
(
number
)
Step for float input
work_dir
(
string
)
Overwrite de default workers work directory
items
(
array<object>
)
List of choice identifier and value
step
Title: Step definition
Type: object
allow_failure
(
boolean
)
Allow step failure
true
icon
(
string
)
The Icon Schema
^(.*)$
file_download
id
(
integer
)
The Id Schema
0
0
label
(
string
)
The Label Schema
^(.*)$
Download source elements
mode
(
string
)
Mode for this step
one_for_one
^(.*)$
one_for_many
one_for_one
notification
workflow_one_for_one
workflow_one_for_many
multiple_jobs
(
string
)
The data ranges parameter to process in different jobs
^(.*)$
segments
name
(
string
)
Name of the parameter
^([a-z_]+)$
job_transfer
condition
(
string
)
Expression which requires to return a boolean. On false condition, the step will be skipped.
skip_destination_path
(
boolean
)
Skip generation of a destination path parameter, it requires to add it in parameters.
parent_ids
(
array<integer>
)
Reference(s) of parent steps
required_to_start
(
array<integer>
)
Reference(s) of required steps to run that step
work_dir
(
string
)
Overwrite the default workdir for this step
tag
Title: The Items Schema
Type: string
Pattern: ^(.*)$