Quality

API to be used by the clients to submit task reviewed info which is used to capture task attributes of reviewed unit of work across different workstreams.

Quality API

post

API to be used by the clients to submit task reviewed info which is used to capture task attributes of reviewed unit of work across different workstreams.

Path parameters

workstream_idstringRequired

CloudFactory platform WorkStream ID

Header parameters

x-api-keystringRequired

API key of the associated workstream

Example: loAwlMCCxv4TlpLWR8a2e6

Body

workstream_idstringRequired

ID of the workstream that the task belongs to

Example: 345d6802-0efa-46de-a73c-6c24f094dfcf

use_case_idstringRequired

The ID of the Use Case to which the task belongs. It is validated against the WorkStream configuration

Example: rr3d6802-0efa-46de-a73c-6c24f094dfcf

task_definition_idstringRequired

The ID of the Task Definition to which the task belongs. It is validated against the WorkStream configuration.

Example: 032d6802-0efa-46de-a73c-6c24f094dfcf

dataset_idstringOptional

The ID of the dataset to which the task belongs. Useful for AI (Artificial Intelligence)/ML (Machine Learning) WorkStreams.

Example: 6c24f094dfcf

asset_idstringOptional

The ID of the parent asset to which the task belongs. For example, for an image/frame annotation task, the asset_id could be the ID of the video clip from which the image/frame was taken.

Example: 6c24f094dfcf

task_idstringOptional

Identifier (ID) of the original task.

Example: 032d6802-0efa-46de-a73c-6c24f094dfcf

unique_idstringOptional

Any unique identifier that if sent will be checked for uniqueness in the system for any given WorkStream, use case and task definition

Example: 032d6802-0efa-46de-a73c-6c24f094dfcf

replace_duplicatebooleanOptional

If this is set to true (the default), then the attributes sent in the previous API call are replaced by those in the new call. If this is set to false, then the attributes sent in the previous API call are ignored.

Example: true

task_urlstringOptional

The URL of the original task, if available.

Example: https://taskus.com/annotate/123412

task_completed_atstring · date-timeOptional

Timestamp (in ISO 8601 datetime format) for when the original task was completed.

Example: 2020-12-22T10:13:24.127Z

worker_idstringRequired

Email address or any other identifier of the worker who completed the original task.

Example: [e-mail]

review_completed_atstring · date-timeRequired

Timestamp (in ISO 8601 datetime format) for when the task review was completed.

Example: 2020-12-22T10:13:24.127Z

review_durationnumberOptional

The time taken to review the task (in seconds).

Example: 120

reviewed_bystringOptional

Email address of the reviewer.

Example: [e-mail]

review_scorenumberRequired

Review score between 0 and 1 to denote the accuracy with which the task was completed (where '0' means that the task was completed incorrectly, and '1.0' means that the task was completed 100% correctly).

Example: 0.78

review_explanationstringOptional

Any text explaining or justifying the 'review_score' and/or any feedback to be passed onto the original CloudWorker(s).

Example: Some of the fields are filled wrong

errorsobjectOptional

These are key-value pairs used to define the errors. Each key represents the name of the error type, and value represents the number of occurrences of that error type.

Example: {"missing_label":24,"incorrect_label":12,"boundary_not_captured":1}

review_typestringOptional

The type of review, which can any of the following types: 'QA', 'QC', 'Spot Check', or 'Others'

Example: QA

task_review_countnumberOptional

The total number of tasks that were reviewed.

Example: 120

subtask_review_countnumberOptional

The total number of subtasks that were reviewed.

Example: 240

review_metadataobjectOptional

These are key-value pairs used to further define the review.

Example: {"Person accuracy":"0.9","Date accuracy":"1","Organization accuracy":"0.85","Address accuracy":"0.25","Vendor accuracy":"0.9"}

Responses

202

Successful

application/json

400

Bad Request

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/workstreams/{workstream_id}/task_reviewed HTTP/1.1
Host: api.cloudfactory.app
x-api-key: loAwlMCCxv4TlpLWR8a2e6
Content-Type: application/json
Accept: */*
Content-Length: 1030

{
  "workstream_id": "345d6802-0efa-46de-a73c-6c24f094dfcf",
  "use_case_id": "rr3d6802-0efa-46de-a73c-6c24f094dfcf",
  "task_definition_id": "032d6802-0efa-46de-a73c-6c24f094dfcf",
  "dataset_id": "6c24f094dfcf",
  "asset_id": "6c24f094dfcf",
  "task_id": "032d6802-0efa-46de-a73c-6c24f094dfcf",
  "unique_id": "032d6802-0efa-46de-a73c-6c24f094dfcf",
  "replace_duplicate": true,
  "task_url": "https://taskus.com/annotate/123412",
  "task_completed_at": "2020-12-22T10:13:24.127Z",
  "worker_id": "[e-mail]",
  "review_completed_at": "2020-12-22T10:13:24.127Z",
  "review_duration": 120,
  "reviewed_by": "[e-mail]",
  "review_score": 0.78,
  "review_explanation": "Some of the fields are filled wrong",
  "errors": {
    "missing_label": 24,
    "incorrect_label": 12,
    "boundary_not_captured": 1
  },
  "review_type": "QA",
  "task_review_count": 120,
  "subtask_review_count": 240,
  "review_metadata": {
    "Person accuracy": "0.9",
    "Date accuracy": "1",
    "Organization accuracy": "0.85",
    "Address accuracy": "0.25",
    "Vendor accuracy": "0.9"
  },
  "review_measurements": {
    "attribute_1_count": 0.5,
    "attribute_1_label": "Header"
  }
}

{
  "message": "Data successfully received."
}