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

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.

POSThttps://api.cloudfactory.app/v1/workstreams/{workstream_id}/task_reviewed

Path parameters

workstream_id*string

CloudFactory platform WorkStream ID

Header parameters

Body

application/json

Task parameters object

workstream_id*string

ID of the workstream that the task belongs to

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

use_case_id*string

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_id*string

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_idstring

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

Example: "6c24f094dfcf"

asset_idstring

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_idstring

Identifier (ID) of the original task.

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

unique_idstring

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_duplicateboolean

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_urlstring

The URL of the original task, if available.

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

task_completed_atstring (date-time)

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

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

worker_id*string

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

Example: "[e-mail]"

review_completed_at*string (date-time)

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

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

review_durationnumber

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

Example: 120

reviewed_bystring

Email address of the reviewer.

Example: "[e-mail]"

review_score*number

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_explanationstring

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"

errorsobject

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.

review_typestring

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

Example: "QA"

task_review_countnumber

The total number of tasks that were reviewed.

Example: 120

subtask_review_countnumber

The total number of subtasks that were reviewed.

Example: 240

review_metadataobject

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

review_measurementsobject

This can be used to provide up to three different levels of accuracy.

Response

202400403500

Successful

Body

application/json

messagestring

Example: "Data successfully received."

Request

JavaScriptCurlPython

const response = await fetch('https://api.cloudfactory.app/v1/workstreams/{workstream_id}/task_reviewed', {
    method: 'POST',
    headers: {
      "x-api-key": "loAwlMCCxv4TlpLWR8a2e6",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "workstream_id": "345d6802-0efa-46de-a73c-6c24f094dfcf",
      "use_case_id": "rr3d6802-0efa-46de-a73c-6c24f094dfcf",
      "task_definition_id": "032d6802-0efa-46de-a73c-6c24f094dfcf",
      "worker_id": "[e-mail]",
      "review_completed_at": "2020-12-22T10:13:24.127Z",
      "review_score": 0.78
    }),
});
const data = await response.json();

Response

202400403500

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