Projects

TagmeClientAdvanced.add_users_to_project(project_id: str, pool_id: str, organization_id: str | None = None, ) → None

Add pool of users to project.

Parameters

* project_id – project id to add pool to.

* pool_id – pool id to add to project.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.archive_project(project_name: str, organization_id: str | None = None, ) → None

(deprecated) Archive all projects with given name. Use ‘archive_project_by_name’ instead.

Parameters

* project_name – name of projects to archive.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.archive_project_by_name(project_name: str, organization_id: str | None = None, raise_when_not_found: bool = True, ) → None

Archive all projects with given name.

Parameters

* project_name – name of projects to archive.

* organization_id – optional organization identifier. Defaults to None.

* raise_when_not_found – raise exception if no project with given name found. Defaults to True.

TagmeClientAdvanced.archive_projects(uids: List[str], organization_id: str | None = None, ) → dict | None

Archive projects.

Parameters

* uids – list of project ids to archive.

* organization_id – optional organization identifier. Defaults to None.

Returns

empty dict.

TagmeClientAdvanced.clone_project(project_id: str, organization_id: str | None = None, dst_organization_id: str | None = None, name_suffix: str | None = None, ) → Tuple[List[Tuple[TaskData, TaskData]], Project]

Clone project with all its tasks and users.

Parameters

* project_id – project id to clone.

* organization_id – optional organization identifier. Defaults to None.

* dst_organization_id – optional organization identifier to clone project to. Defaults to None.

Returns

list of pairs of old tasks and new tasks, new project.

TagmeClientAdvanced.clone_project_with_data(project_id: str, organization_id: str | None = None, dst_organization_id: str | None = None, clone_all_files: bool = False, ) → str

Clone project with all its tasks, pools and datasets.

Parameters

* project_id – project id to clone.

* organization_id – optional organization identifier. Defaults to None.

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

* clone_all_files – clone files which are already marked. Defaults to False.

Returns

id of cloned project.

TagmeClientAdvanced.create_cross_project_validation_pipeline(config: PipelineInitialConfig, organization_id: str | None = None, ) → None

Create validation pipeline between two different projects.

Parameters

* config – Configuration for the validation pipeline.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.create_project(name: str, description: str | None = None, organization_id: str | None = None, inner_comment: str | None = None, template_id: str | None = None, is_brief_autoupdate: bool | None = None, is_forms_autoupdate: bool | None = None, is_config_autoupdate: bool | None = None, is_specification_autoupdate: bool | None = None, ) → Project

Create new project.

Parameters

* name – name of new project.

* description – project’s description.

* organization_id – optional organization identifier. Defaults to None.

* inner_comment – inner comment for customers. Defaults to None.

* template_id – template id for project. Defaults to None.

* is_brief_autoupdate – whether to enable brief autoupdate. Defaults to None.

* is_forms_autoupdate – whether to enable forms autoupdate. Defaults to None.

* is_config_autoupdate – whether to enable config autoupdate. Defaults to None.

* is_specification_autoupdate – whether to enable specification autoupdate. Defaults to None.

Returns

created project.

TagmeClientAdvanced.create_project_bookmark(project_id: str, organization_id: str | None = None, ) → None

Add project to bookmarks.

Parameters

* project_id – project id to add bookmark.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.create_project_by_config(config: ProjectConfig, organization_id: str | None = None, ) → str

Create new project.

Parameters

* config – full project data.

* organization_id – optional organization identifier. Defaults to None.

Returns

created project id.

TagmeClientAdvanced.create_single_project_validation_pipeline(config: PipelineInitialConfig, organization_id: str | None = None, ) → None

Create validation pipeline within a single project. The source and destination project IDs in the config must be the same.

Parameters

* config – Configuration for the validation pipeline.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.create_validation_pipeline(config: PipelineInitialConfig, organization_id: str | None = None, ) → None

Create validation pipeline. This method acts as a dispatcher, calling either create_cross_project_validation_pipeline or create_single_project_validation_pipeline based on the provided config.

Parameters

* config – Configuration for the validation pipeline.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.delete_project_bookmark(project_id: str, organization_id: str | None = None, ) → None

Remove project from bookmarks.

Parameters

* project_id – project id to remove bookmark.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.delete_users_from_project(project_id: str, pool_id: str, organization_id: str | None = None, ) → None

Delete pool of users from project.

Parameters

* project_id – project id to delete pool from.

* pool_id – pool id to delete from project.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.download_brief_version_file(method_id: str, version: str | int = 'latest', date_time: datetime | None = None, ) → str

Download certait brief version by its number or date.

Parameters

* method_id – uid of method, brief belongs to

* version – number of brief version or ‘latest’

* date_time – datetime when version was used

Returns

file of certain brief version

TagmeClientAdvanced.download_interface_version(method_id: str, version: str | int = 'latest', date_time: datetime | None = None, ) → InterfaceVersionInfo

Download certait interface version by its number or date.

Parameters

* method_id – uid of method, interface belongs to

* version – number of interface version or ‘latest’

* date_time – datetime when version was used

Returns

data of certain interface version

TagmeClientAdvanced.get_brief_read_status(method_id: str, organization_id: str | None = None, ) → BriefReadStatusData

Get methodic brief read status by id.

Parameters

* method_id – method id.

* organization_id – optional organization identifier. Defaults to None.

Returns

information about methodic brief read status.

TagmeClientAdvanced.get_brief_version_info(method_id: str, version: str | int = 'latest', date_time: datetime | None = None, with_person_info: bool = False, ) → Tuple[BriefVersionInfo, dict]

Get certait brief version by its number or date.

Parameters

* method_id – uid of method, brief belongs to

* version – number of brief version or ‘latest’

* date_time – datetime when version was used

* with_person_info – return personal information of version’s author

Returns

information about brief version with response headers

TagmeClientAdvanced.get_interface_version_info(method_id: str, version: str | int = 'latest', date_time: datetime | None = None, with_person_info: bool | None = None, ) → InterfaceVersionInfo

Get certait interface version by its number or date.

Parameters

* method_id – uid of method, interface belongs to

* version – number of interface version or ‘latest’

* date_time – datetime when version was used

* with_person_info – return personal information of version’s author

Returns

information about interface version

TagmeClientAdvanced.get_method(method_id: str, task_id: str | None = None, organization_id: str | None = None, download_brief: bool = False, ) → MethodData

Get methodic by id. It contains brief, interface, specification and config.

If methodic is a url, brief will be downloaded and is_brief_as_url will be set to False.

Parameters

* method_id – method id.

* task_id – task id.

* organization_id – optional organization identifier. Defaults to None.

* download_brief – download brief if it is a url. Defaults to False.

Returns

information about methodic.

TagmeClientAdvanced.get_project(project_id: str, with_tasks_count: bool = False, organization_id: str | None = None, ) → Project

Get project by id.

Parameters

* project_id – project id.

* with_tasks_count – if set, return project with tasks count. Defaults to False.

* organization_id – optional organization identifier. Defaults to None.

Returns

project data.

TagmeClientAdvanced.get_project_contacts(project_id: str, organization_id: str | None = None, ) → Contacts

Get project or organization contacts.

Parameters

* project_id – project id.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.get_project_ids_by_status(is_archived: bool, organization_id: str | None = None, ) → Set[str]

Get all archived or unarchived project ids.

Parameters

* is_archived – status (archived or unarchived).

* organization_id – optional organization identifier. Defaults to None.

Returns

ids of projects with matched status.

TagmeClientAdvanced.get_project_names_by_status(is_archived: bool, organization_id: str | None = None, ) → Set[str]

Get all archived or unarchived projects.

Parameters

* is_archived – status (archived or unarchived).

* organization_id – optional organization identifier. Defaults to None.

Returns

names of projects with matched status.

TagmeClientAdvanced.get_project_results(project_name: str, task_name: str, is_archived: bool | None = None, organization_id: str | None = None, ) → List[TaskResult]

Get results for task matched by name.

Parameters

* project_name – name of project to get results from.

* task_name – name of project’s task to get results from.

* is_archived – search in archived projects. Defaults to None.

Returns

list of task results.

TagmeClientAdvanced.get_project_task(project_id: str, ignore_tasks: Tuple[str, …​] = ('Обучение', 'Экзамен'), organization_id: str | None = None, ) → TaskData

(deprecated) Get first task for project. Use ‘get_project_tasks’ instead.

Parameters

* project_id – project id to get task from.

* ignore_tasks – names of tasks to ignore. Defaults to (‘Обучение’, ‘Экзамен’).

* organization_id – optional organization identifier. Defaults to None.

Returns

found task.

TagmeClientAdvanced.get_project_tasks(project_id: str, ignore_tasks: Tuple[str, …​] = ('Обучение', 'Экзамен'), organization_id: str | None = None, ) → List[TaskData]

Get tasks for project.

Parameters

* project_id – project id to get tasks from.

* ignore_tasks – names of tasks to ignore. Defaults to (‘Обучение’, ‘Экзамен’).

* organization_id – optional organization identifier. Defaults to None.

Returns

found tasks.

TagmeClientAdvanced.get_projects(with_tasks_count: bool = False, archived: bool | None = False, with_pipeline: bool | None = False, organization_id: str | None = None, query: str | None = None, page: int | None = None, size: int | None = None, is_bookmarked: bool | None = None, is_pipelined: bool | None = None, update_date_from: str | None = None, ) → List[Project]

Get organization projects.

Parameters

* with_tasks_count – return task count for project. Defaults to False.

* archived – return archived projects. Defaults to False.

* organization_id – optional organization identifier. Defaults to None.

* with_pipeline – return projects with pipeline config. Defaults to False.

* query – text query to search by name. Defaults to None.

* page – number of page for pagination. Defaults to None.

* is_bookmarked – return only bookmarked projects. Defaults to None.

* is_pipelined – return only pipelined projects. Defaults to None.

* update_date_from – return projects whose settings changed on or after that day

Returns

list of projects matched.

TagmeClientAdvanced.get_projects_advanced(project_ids: Collection[str] | None = None, organization_id: str | None = None, with_method: bool = False, with_pipeline: bool | None = False, archived: bool | None = None, is_pipelined: bool | None = None, tqdm_on: bool | str = False, max_concurrency: int = 10, ) → List[Project]

Get organization projects.

Parameters

* project_ids – optional project identifiers. If not set, all projects are returned.

* organization_id – optional organization identifier. Defaults to None.

* with_method – if set to True, methods for projects are loaded.

* with_pipeline – return projects with pipeline config. Defaults to False.

* archived – if set to True or False, only archived or not archived projects are returned.

* is_pipelined – return only pipelined projects. Defaults to None.

* tqdm_on – if set to True or some string progress bar is shown. Defaults to False.

* max_concurrency – controls the asyncio.Semaphore value for limiting concurrent operations. Defaults to 10.

Returns

list of projects.

TagmeClientAdvanced.get_projects_advanced_with_errors(project_ids: Collection[str] | None = None, organization_id: str | None = None, with_method: bool = False, with_pipeline: bool | None = False, archived: bool | None = None, is_pipelined: bool | None = None, tqdm_on: bool | str = False, errors: Dict[str, List[str]] | DefaultDict[str, List[str]] | None = None, max_concurrency: int = 10, ) → Tuple[List[Project], Dict[str, List[str]] | DefaultDict[str, List[str]]]

Get organization projects.

Parameters

* project_ids – optional project identifiers. If not set, all projects are returned.

* organization_id – optional organization identifier. Defaults to None.

* with_method – if set to True, methods for projects are loaded.

* with_pipeline – return projects with pipeline config. Defaults to False.

* archived – if set to True or False, only archived or not archived projects are returned.

* is_pipelined – return only pipelined projects. Defaults to None.

* tqdm_on – if set to True or some string progress bar is shown. Defaults to False.

* errors – optional mapping project_id and list of errors.

* max_concurrency – controls the asyncio.Semaphore value for limiting concurrent operations. Defaults to 10.

Returns

list of projects and occured errors with mapping.

TagmeClientAdvanced.get_projects_by_name(project_name: str, archived: bool = False, organization_id: str | None = None, with_tasks_count: bool = False, ) → List[Project]

Get projects by text query.

Parameters

* project_name – project name

* archived – return archived projects. Defaults to False.

* organization_id – optional organization identifier. Defaults to None.

* with_tasks_count – return task count for project. Defaults to False.

Returns

list of projects matched.

TagmeClientAdvanced.get_taskflow_projects(page: int | None = None, size: int | None = None, query: str | None = None, only_favourite: bool | None = None, project_id: str | None = None, ) → ProjectTaskPaginated

Retrieves project-tasks available to the marker from the taskflow service.

Parameters

* page – pagination page. Defaults to None.

* size – pagination max size of requesting page. Defaults to None.

* query – look up project-tasks by query. Defaults to None.

* only_favourite – return only pinned projects. Defaults to None.

* project_id – return only specified project. Defaults to None.

Returns

list of project-tasks matched.

TagmeClientAdvanced.list_method_brief_versions(method_id: str, ) → List[BriefVersionInfo]

Get all brief versions.

Parameters method_id – uid of method, brief belongs to

Returns

information about method’s brief versions

TagmeClientAdvanced.list_method_interface_versions(method_id: str, ) → List[InterfaceVersionInfo]

Get all interface versions.

Parameters method_id – uid of method, interface belongs to

Returns

information about method’s interface versions

TagmeClientAdvanced.load_project_method(project: Project, download_brief: bool = False, ) → None

Load project methodic (it contains brief and interface).

Parameters

* project – project to load method for.

* download_brief – download brief if it is a url. Sets is_brief_as_url to False for compatibility.

TagmeClientAdvanced.restore_projects(uids: List[str], organization_id: str | None = None, ) → dict | None

Restore projects from archive.

Parameters

* uids – list of project ids to unarchive.

* organization_id – optional organization identifier. Defaults to None.

Returns

empty dict.

TagmeClientAdvanced.set_brief_read_status(method_id: str, read_token: str, organization_id: str | None = None, ) → None

Set methodic brief read status by id.

Parameters

* method_id – method id.

* read_token – token from headers get_brief method

* organization_id – optional organization identifier. Defaults to None.

Returns

Nothing.

TagmeClientAdvanced.update_method(method: MethodData | MethodDataRequest | dict, organization_id: str | None = None, ) → MethodData

Update project methodic.

Parameters

* method – new method data.

* organization_id – optional organization identifier. Defaults to None.

Returns

information about updated methodic.

TagmeClientAdvanced.update_method_brief(method_id: str, file_path: str, file_name: str, ) → None

Update brief file of method.

Parameters

* method_id – uid of method, brief belongs to

* file_path – path, where file is stored

* file_name – name of file

Returns

None

TagmeClientAdvanced.update_project(project_id: str, name: str | None = None, organization_id: str | None = None, description: str | None = None, inner_comment: str | None = None, pipeline: SyncSettings | dict | None = None, is_pipeline_enabled: bool | None = None, is_brief_autoupdate: bool | None = None, is_forms_autoupdate: bool | None = None, is_config_autoupdate: bool | None = None, is_specification_autoupdate: bool | None = None, pipeline_errors: str | None = None, ) → Project

Update project info.

Parameters

* project_id – id of project to update.

* name – new name of project.

* organization_id – optional organization identifier. Defaults to None.

* description – new description of project. Defaults to None.

* inner_comment – new inner comment for customers. Defaults to None.

* pipeline – new pipeline settings. Defaults to None.

* is_pipeline_enabled – whether to enable pipeline. Defaults to None.

* is_brief_autoupdate – whether to enable brief autoupdate. Defaults to None.

* is_forms_autoupdate – whether to enable forms autoupdate. Defaults to None.

* is_config_autoupdate – whether to enable config autoupdate. Defaults to None.

* is_specification_autoupdate – whether to enable specification autoupdate. Defaults to None.

Returns

updated project.