Files

TagmeClientAdvanced.clone_task_files(src_task_id: str, dst_task_id: str, ignore_files_ids: Set[str], organization_id: str | None = None, dst_organization_id: str | None = None, tqdm_on: bool | str = False, ) → int

Clone task files from one task to another.

Parameters

* src_task_id – task id to clone files from.

* dst_task_id – task id to clone files to.

* ignore_files_ids – files ids to ignore while cloning.

* organization_id – optional organization identifier. Defaults to None.

* dst_organization_id – optional organization id of destination task. Defaults to None.

Returns

number of files cloned successfully.

TagmeClientAdvanced.delete_file(file_id: str, organization_id: str | None = None, ) → None

TagmeClientAdvanced.delete_items_from_task(task_id: str, organization_id: str | None = None, ) → None

Delete all files from tasks. (warning) May not work. Hope it will be fixed soon.

Parameters

* task_id – task id to delete files from.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.delete_some_items_from_task(task_id: str, files: List[str], organization_id: str | None = None, ) → None

Delete selected task files from task.

Parameters

* task_id – task_id to delete files from.

* files – file ids to delete from task.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.disable_control_task(task_id: str, file_uid: str, organization_id: str | None = None, ) → None

Disable control task.

Parameters

* task_id – task id.

* file_uid – control task file uid to disable.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.download_file(task_id: str, file_id: str, organization_id: str | None = None, ) → bytes

Download file by id.

Parameters

* task_id – task id to download file from.

* file_id – file id to download.

* organization_id – optional organization identifier. Defaults to None.

Returns

file content.

TagmeClientAdvanced.download_task_data(task_id: str, destination_dir: str | Path, organization_id: str | None = None, ) → int

Download all files from task.

Parameters

* task_id – task id to download files from.

* destination_dir – path to directory to download files to.

* organization_id – optional organization identifier. Defaults to None.

Returns

number of files downloaded successfully.

TagmeClientAdvanced.get_file(task_id: str, file_uid: str, organization_id: str | None = None, ) → TaskFile

Get information about task file.

Parameters

* task_id – task id.

* file_uid – file uid to get information about.

* organization_id – optional organization identifier. Defaults to None.

Returns

information about task file.

TagmeClientAdvanced.get_meta_data(task_id: str, file_uid: str, types: List[MetaType] | None = None, organization_id: str | None = None, ) → MetaData

Get controls, premarkup and explanation for task file.

Parameters

* task_id – id of task to get meta data for file from.

* file_uid – id of file to get meta data from.

* types – types of metadata (MetaType). Defaults to None.

* organization_id – optional organization identifier. Defaults to None.

Returns

object which contains controls, premarkup and explanation.

TagmeClientAdvanced.get_task_files(task_id: str, query: str | None = None, types: List[FileType | str] | None = None, page: int | None = None, size: int | None = None, enabled: bool | None = True, organization_id: str | None = None, ) → List[TaskFile]

Get information about files in task.

Parameters

* task_id – id of task.

* query – optional search query for file names.

* types – file types to get (CONTROL, STUDY, DATA)

* page – page number for pagination.

* size – number of items per page for pagination.

* enabled – optional flag to get only enabled files.

* organization_id – optional organization identifier. Defaults to None.

Returns

list of task file objects.

TagmeClientAdvanced.get_task_files_meta(task_id: str, organization_id: str | None = None, ) → List[FileMetaData]

Get metadata for all files in task.

Parameters

* task_id – task id.

* organization_id – optional organization identifier. Defaults to None.

Returns

list of task files metadata.

TagmeClientAdvanced.remove_control(task: TaskData, file_id: str, ) → None

Remove control item from task.

Parameters

* task – task to remove control from.

* file_id – id of control file to remove.

TagmeClientAdvanced.replace_file(task_id: str, file_id: str, filepath: str | Path, organization_id: str | None = None, ) → UploadFilesResult

Replace file in task.

Parameters

* task_id – task id to upload file to.

* file_id – id of file to replace.

* filepath – path to new file.

* organization_id – optional organization identifier. Defaults to None.

Returns

object which contains uploaded files and errors.

TagmeClientAdvanced.update_meta_data(task_id: str, data: List[Dict] | List[UpdateMetaDataRequest], organization_id: str | None = None, ) → dict

Update information about controls, premarkup and explanation.

Parameters

* task_id – task id to update meta data.

* data – data to update meta data.

* organization_id – optional organization identifier. Defaults to None.

Returns

dict

TagmeClientAdvanced.upload_files(task_id: str, filepaths: Sequence[str | Path], batch_size: int = 16, organization_id: str | None = None, tqdm_on: bool | str = False, ) → UploadFilesResult

Upload files to task.

Parameters

* task_id – task id to upload files to.

* filepaths – paths to files to upload to task.

* batch_size – number of files downloading at once. Defaults to 16.

* organization_id – optional organization identifier. Defaults to None.

Returns

object which contains uploaded files and errors.

TagmeClientAdvanced.upload_folder(task: TaskData, folder: str | Path, organization_id: str | None = None, tqdm_on: bool | str = False, ) → UploadFilesResult

Upload all files from folder to task.

Parameters

* task – task to upload files to.

* folder – folder with files to upload to task.

* organization_id – optional organization identifier. Defaults to None.

Returns

uploaded files and errors.

TagmeClientAdvanced.upload_folder_to_task(task_id: str, folder: str | Path, exclude_ext_filter: Set[str] | None = None, organization_id: str | None = None, tqdm_on: bool | str = False, ) → UploadFilesResult

Upload all files from folder to task.

Parameters

* task_id – task id to upload files to.

* folder – path to folder to upload files from.

* exclude_ext_filter – file extensions to exclude. Defaults to None.

* organization_id – optional organization identifier. Defaults to None.

Returns

object which contains uploaded files and errors.

TagmeClientAdvanced.upload_folders_to_task(upload_data: List[Tuple[str, str | Path]], exclude_ext_filter: Set[str] | None = None, start: bool = False, organization_id: str | None = None, tqdm_on: bool | str = False, ) → Dict[str, None | bool | TaskData]

Upload many folders to many tasks.

Parameters

* upload_data – pairs of task id and folder to upload.

* exclude_ext_filter – file extensions to exclude. Defaults

* start – start tasks after uploading. Defaults to False.

* organization_id – optional organization identifier. Defaults to None.

Returns

object which contains uploaded files and errors.

* key: - task_id

* value: None - if the folder for the task is empty

TaskData - if the task was started

True - if the task didn’t need to be started

False - if the task was not started due to the problems with task constraints or an exception.

TagmeClientAdvanced.upload_folders_to_task_and_start(upload_data: List[Tuple[str, str | Path]], exclude_ext_filter: Set[str] | None = None, organization_id: str | None = None, tqdm_on: bool | str = False, ) → Dict[str, None | bool | TaskData]

Upload many folders to many tasks and start them.

Parameters

* upload_data – pairs of task id and folder to upload.

* exclude_ext_filter – file extensions to exclude. Defaults to None.

* organization_id – optional organization identifier. Defaults to None.

Returns

object which contains uploaded files and errors.

* key: - task_id

* value: None - if the folder for the task is empty

TaskData - if the task was started

True - if the task didn’t need to be started

False - if the task was not started due to the problems with task constraints or an exception.

TagmeClientAdvanced.upload_json_data(task_id: str, json_data: Iterable[Any], base_path: str | Path | None = None, organization_id: str | None = None, tqdm_on: bool | str = False, ) → None

Upload data in json format to task. Each json object can contain fields:

  • ‘file_path’: name of destination file (ends with .json).

  • ‘file_id’: name of destination file

  • ‘task’: dict which contains input data for task. Can also contain field ‘id’ for name of destination file.

  • ‘upload_file’: file with input data for task.

  • ‘premarkup’: premarkup for task.

  • ‘control’: control for task.

  • ‘hint’: explanation for task.

Parameters

* task_id – id of task to upload data to.

* json_data – data to upload.

* base_path – path to folder with json files. Defaults to None.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.upload_methodics_file(method_id: str, filepath: str | Path, file_type: MethodFileType, organization_id: str | None = None, ) → UploadFilesResult

Upload methodics file for method.

Parameters

* method_id – id of method to upload file to.

* filepath – path to file to upload.

* file_type – type of file to upload.

* organization_id – optional organization identifier. Defaults to None.

Returns

uid and url of file.

TagmeClientAdvanced.upload_table(task_id: str, file: Path, delimeter: str | None = None, quotechar: str | None = None, escapechar: str | None = None, organization_id: str | None = None, ) → None

Upload task data table. See more information at https://tagme.sberdevices.ru/docs/customer/uploading-data.html

Parameters

* task_id – task id to upload table to.

* file – path to table to upload (.csv,.tsv,.xlsx).

* delimeter – table delimiter.

* quotechar – table quotechar.

* escapechar – table escapechar.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.upload_tsv_data(task_id: str, filepath: str | Path, organization_id: str | None = None, ) → None

Upload TSV data in toloka-format, INPUT:<input-fields> GOLDEN:<meta-fields> Read the doc: https://tagme.sberdevices.ru/docs/customer/uploading-data.html

Parameters

* task_id – id of task to upload data to.

* filepath – path to TSV file.

* organization_id – optional organization identifier. Defaults to None.