Results

TagmeClientAdvanced.download_table_results(task_id: str, date_from: str | None = None, date_to: str | None = None, file_format: ExportFormat = ExportFormat.CSV, organization_id: str | None = None, ) → None

Get table with markup results and save to file.

Parameters

* task_id – task id to get results from.

* date_from – minimal date of results to get. Defaults to None.

* date_to – maximal date of results to get. Defaults to None.

* file_format – file format to save results (‘csv’, ‘json’, ‘xlsx’, ‘tsv’). Defaults to ‘csv’.

TagmeClientAdvanced.download_task_results(task_id: str, destination: str | Path, organization_id: str | None = None, ) → None

Get task assignments’ results and save to file.

Parameters

* task_id – task id to download results from.

* destination – path to file to save results to.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.get_markup_result(assignment_id: str, organization_id: str, ) → MarkupResult | None

Get result of assignment markup.

Parameters

* assignment_id – id of markup task.

* organization_id – optional organization identifier. Defaults to None.

Returns

object which contains information about markup task result.

TagmeClientAdvanced.get_markup_results(task_id: str, organization_id: str, marker_ids: List[str] | None = None, file_name: str | None = None, file_ids: List[str] | None = None, statuses: List[str] | None = None, file_types: List[FileType] | None = None, submitted_ats: List[date] | None = None, assignment_ids: List[str] | None = None, page: int | None = None, size: int | None = None, sort_field: MarkupResultSortField | None = None, sort_order: SortOrder | None = None, ) → MarkupResults

Get results of markup.

Parameters

* task_id – id of markup task.

* organization_id – optional organization identifier. Defaults to None.

* marker_ids – optional list of marker ids.

* file_name – filter by file name.

* file_ids – filter by file ids.

* statuses – filter by assignment status.

* file_types – filter by file type.

* submitted_ats – filter by submission date.

* assignment_ids – filter by assignment id.

* page – optional page number for pagination.

* size – optional page size for pagination.

* sort_field – field to sort results by.

* sort_order – sort order (‘asc’, ‘desc’).

Returns

markup results.

TagmeClientAdvanced.get_task_assignments(task_id: str, date_from: str | None = None, date_to: str | None = None, updated_date_from: str | None = None, updated_date_to: str | None = None, with_input_data: bool = False, join_markers: bool = False, control_only: bool = False, organization_id: str | None = None, msk_time: bool = True, tqdm_on: bool = False, with_assignment_link: bool = False, ) → List[Assignment]

Get list of task assignments.

Parameters

* task_id – task id to get assignments for.

* date_from – minimal date of assignment completion. Defaults to None.

* date_to – maximal date of assignment completion. Defaults to None.

* with_input_data – add input fields to result. Defaults to False.

* join_markers – add markers’ emails to result. Defaults to False.

* control_only – return only control tasks. Defaults to False.

* organization_id – optional organization identifier. Defaults to None.

* msk_time – use MSK time for date_from and date_to filter. Defaults to True.

* tqdm_on – show progress bar while downloading results. Defaults to False.

Returns

list of assignments for task.

TagmeClientAdvanced.get_task_assignments_df(task_id: str, date_from: str | None = None, date_to: str | None = None, with_input_data: bool = False, organization_id: str | None = None, msk_time: bool = True, with_assignment_link: bool = False, ) → Any

Get pandas.DataFrame which contains task assignments.

Parameters

* task_id – task id to get assignments for.

* date_from – minimal date of assignment completion. Defaults to None.

* date_to – maximal date of assignment completion. Defaults to None.

* with_input_data – add input fields to result. Defaults to False.

* organization_id – optional organization identifier. Defaults to None.

* msk_time – use MSK time for date_from and date_to filter. Defaults to True.

Returns

pandas.DataFrame with task assignments.

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

(deprecated) Get markup result for task. Use ‘get_task_assignments’ instead.

Parameters

* task_id – task id to get results for.

* organization_id – optional organization identifier. Defaults to None.

Returns

list of task assignments’ results.

TagmeClientAdvanced.get_task_results_flat(task_id: str, join_markers: bool = False, organization_id: str | None = None, ) → List[Assignment]

(deprecated) Get markup result for task in new format. Use ‘get_task_assignments’ instead.

Parameters

* task_id – task_id to get results for.

* join_markers – add markers’ emails to result. Defaults to False

* organization_id – optional organization identifier. Defaults to None.

Returns

list of task assignments’ results.

TagmeClientAdvanced.get_task_src_flat(task_id: str, organization_id: str | None = None, ) → List[Dict[str, Any]]

Get rows of task data. Contains file data:

  • hints (HINT:<field name>)

  • premarkup (GOLDEN:<field name>)

  • premarkup (PREMARKUP:<field name>)

  • input data (INPUT:<field name>)

Parameters

* task_id – task id to get data from.

* organization_id – optional organization identifier. Defaults to None.

Returns

list of rows with task data.

TagmeClientAdvanced.review_markup(review: MarkupReview, organization_id: str, ) → None

Leave review on markup task.

Parameters

* review – status (ACCEPTED, REJECTED), comment and quality to set to assignment.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.review_multiple_markups(reviews: List[MarkupReview], organization_id: str, ) → MarkupReviewResult

Leave reviews on multiple markup tasks.

Parameters

* reviews – status (ACCEPTED, REJECTED), comment and quality to set to assignment.

* organization_id – optional organization identifier. Defaults to None.