DataRequest class reference

Properties

Name	Type	Description	Notes
image_quality	int	Image quality to use during annotation
chunk_size	int, none_type	Maximum number of frames per chunk	[optional]
start_frame	int	First frame index	[optional]
stop_frame	int	Last frame index	[optional]
frame_filter	str	Frame filter. The only supported syntax is: ‘step=N’	[optional]
client_files	[file_type]	Uploaded files. Must contain all files from job_file_mapping if job_file_mapping is not empty.	[optional] if omitted the server will use the default value of []
server_files	[str]	Paths to files from a file share mounted on the server, or from a cloud storage. Must contain all files from job_file_mapping if job_file_mapping is not empty.	[optional] if omitted the server will use the default value of []
remote_files	[str]	Direct download URLs for files. Must contain all files from job_file_mapping if job_file_mapping is not empty.	[optional] if omitted the server will use the default value of []
use_zip_chunks	bool	When true, video chunks will be represented as zip archives with decoded video frames. When false, video chunks are represented as video segments	[optional] if omitted the server will use the default value of False
server_files_exclude	[str]	Paths to files and directories from a file share mounted on the server, or from a cloud storage that should be excluded from the directories specified in server_files. This option cannot be used together with filename_pattern. The server_files_exclude parameter cannot be used to exclude a part of dataset from an archive. Examples: Exclude all files from subfolder ‘sub/sub_1/sub_2’and single file ‘sub/image.jpg’ from specified folder: server_files = [‘sub/’], server_files_exclude = [‘sub/sub_1/sub_2/’, ‘sub/image.jpg’] Exclude all cloud storage files with prefix ‘sub’ from the content of manifest file: server_files = [‘manifest.jsonl’], server_files_exclude = [‘sub/’]	[optional] if omitted the server will use the default value of []
cloud_storage_id	int, none_type	If not null, the files referenced by server_files will be retrieved from the cloud storage with the specified ID. The cloud storages applicable depend on the context. In the user sandbox, only the user sandbox cloud storages can be used. In an organization, only the organization cloud storages can be used.	[optional]
use_cache	bool	Enable or disable task data chunk caching for the task. Read more: https://docs.cvat.ai/docs/manual/advanced/data_on_fly/	[optional] if omitted the server will use the default value of False
copy_data	bool	Copy data from the server file share to CVAT during the task creation. This will create a copy of the data, making the server independent from the file share availability	[optional] if omitted the server will use the default value of False
storage_method	StorageMethod		[optional]
storage	StorageType		[optional]
sorting_method	SortingMethod		[optional]
filename_pattern	str, none_type	A filename filter for cloud storage files listed in the manifest. Supports fnmatch wildcards. Read more: https://docs.python.org/3/library/fnmatch.html	[optional]
job_file_mapping	[[str]]	Represents a file-to-job mapping. Useful to specify a custom job configuration during task creation. This option is not compatible with most other job split-related options. Files in the jobs must not overlap or repeat. Job file mapping files must be a subset of the input files. If directories are specified in server_files, all files obtained by recursive search in the specified directories will be used as input files. In case of missing items in the input files, an error will be raised. Example: [ ["file1.jpg", "file2.jpg"], # job #1 files ["file3.png"], # job #2 files ["file4.jpg", "file5.png", "file6.bmp"], # job #3 files ]	[optional]
upload_file_order	[str]	Allows to specify file order for client_file uploads. Only valid with the "predefined" sorting method selected. To state that the input files are sent in the correct order, pass an empty list. If you want to send files in an arbitrary order and reorder them afterwards on the server, pass the list of file names in the required order.	[optional]
validation_params	DataRequestValidationParams		[optional]