Skip to main content

Analyze

NameTypeDescription
optionsobjectOptions for the Analyze Task.
source_pipelineobjectPipeline modifications (such as trimming) to apply prior to running the analysis task.
compare_assetobjectCompare asset to use for comparative analyzers.
general_propertiesobjectMetadata analysis of a file or stream. Does not require decoding of the asset
deep_propertiesobjectObject specifying which deep properties to analyze. Deep properties require decoding the asset.
reportsarrayAn object or array of objects describing the location and creation conditions for reports.
overridesobjectChoose which options should be overridden during analysis.

Example analyze

{
"name": "Hybrik Analyze Example",
"payload": {
"elements": [
{
"uid": "source_file",
"kind": "source",
"payload": {
"kind": "asset_url",
"payload": {
"storage_provider": "s3",
"url": "s3://my_bucket/my_input_folder/my_file.mp4"
}
}
},
{
"uid": "analyze_task",
"kind": "analyze",
"payload": {
"general_properties": {
"enabled": true
},
"deep_properties": {
"audio": [
{
"volume": {
"enabled": true
},
"levels": {
"enabled": true
}
}
],
"video": {
"black": {
"duration_sec": 5,
"enabled": true
},
"black_borders": {
"black_level": 0.08,
"enabled": true
},
"interlacing": {
"enabled": true
},
"levels": {
"chroma_levels": true,
"histograms": true,
"enabled": true
}
}
}
}
}
],
"connections": [
{
"from": [
{
"element": "source_file"
}
],
"to": {
"success": [
{
"element": "analyze_task"
}
]
}
}
]
}
}