Clarifai · Schema

apiTask

Task is the work that needs to be done for labeling the inputs in an app.

AIComputer VisionNLPImage RecognitionObject DetectionText AnalysisVisual SearchMachine LearningCustom Model TraininggRPC

Properties

Name	Type	Description
id	string	Unique ID for the task.
created_at	string	When the task was created. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".
modified_at	string	Most recent time when the task was updated. The format is https://www.ietf.org/rfc/rfc3339.txt. Example: "2006-01-02T15:04:05.999999Z".
type	object	Task type.
description	string	Description of the task.
worker	object	Worker details.
concept_ids	array	List of concept ids used in the work of this task. DEPRECATED: Use task.concepts instead.
input_source	object	List of inputs used in this task will be taken from this source.
sample_ms	integer
ai_assistant	object	AI assistant details.
review	object	Review details.
status	object	Status of this task.
name	string	Add a title for this task to quickly recognise it in a list of tasks.
ai_assist_params	object
visibility	object	The visibility field represents whether this message is privately/publicly visible. To be visible to the public the App that contains it AND the User that contains the App must also be publicly visibl
app_id	string	The app the task belongs to.
user_id	string	The user the task belongs to.
label_order_id	string	The label order the task belongs to.
concepts	array	Ignore Task.concept_ids field if Task.TaskConcept are supplied.
delete_previous_annotations	boolean
metrics	object	Tasks metrics are filled in upon user-request.
priority	object
metadata	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clarifai/refs/heads/main/json-schema/apiTask.json",
  "title": "apiTask",
  "description": "Task is the work that needs to be done for labeling the inputs in an app.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique ID for the task."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the task was created.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "Most recent time when the task was updated.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
    },
    "type": {
      "$ref": "#/definitions/apiTaskTaskType",
      "description": "Task type."
    },
    "description": {
      "type": "string",
      "description": "Description of the task."
    },
    "worker": {
      "$ref": "#/definitions/apiTaskWorker",
      "description": "Worker details."
    },
    "concept_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of concept ids used in the work of this task.\nDEPRECATED: Use task.concepts instead."
    },
    "input_source": {
      "$ref": "#/definitions/apiTaskInputSource",
      "description": "List of inputs used in this task will be taken from this source."
    },
    "sample_ms": {
      "type": "integer",
      "format": "int64",
      "title": "For model predictions on video: Sample delay for video predicting (1 frame per N milliseconds)"
    },
    "ai_assistant": {
      "$ref": "#/definitions/apiTaskAIAssistant",
      "description": "AI assistant details."
    },
    "review": {
      "$ref": "#/definitions/apiTaskReview",
      "description": "Review details."
    },
    "status": {
      "$ref": "#/definitions/apistatusStatus",
      "description": "Status of this task."
    },
    "name": {
      "type": "string",
      "description": "Add a title for this task to quickly recognise it in a list of tasks."
    },
    "ai_assist_params": {
      "$ref": "#/definitions/apiAiAssistParameters"
    },
    "visibility": {
      "$ref": "#/definitions/clarifaiapiVisibility",
      "description": "The visibility field represents whether this message is privately/publicly visible.\nTo be visible to the public the App that contains it AND the User that contains the App must\nalso be publicly visible."
    },
    "app_id": {
      "type": "string",
      "description": "The app the task belongs to."
    },
    "user_id": {
      "type": "string",
      "description": "The user the task belongs to."
    },
    "label_order_id": {
      "type": "string",
      "description": "The label order the task belongs to."
    },
    "concepts": {
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "#/definitions/apiTaskConcept"
      },
      "description": "Ignore Task.concept_ids field if Task.TaskConcept are supplied."
    },
    "delete_previous_annotations": {
      "type": "boolean",
      "title": "Specify whether existing Annotations within the same app that are generated by other auto annotation tasks\nwith the specified Concept from the selected Model or Workflow should deleted before executing the Task"
    },
    "metrics": {
      "$ref": "#/definitions/apiTaskMetrics",
      "description": "Tasks metrics are filled in upon user-request."
    },
    "priority": {
      "$ref": "#/definitions/TaskTaskPriority",
      "title": "Priority of the task"
    },
    "metadata": {
      "type": "object",
      "title": "To handle arbitrary json metadata you can use a struct field:\nhttps://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto"
    }
  }
}