apiSingleCollectorResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"collector": {
"$ref": "#/components/schemas/apiCollector"
}
},
"description": "Response with a single Collector."
}
apiSingleConceptLanguageResponse
{
"type": "object",
"title": "SingleConceptLanguageResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"conceptLanguage": {
"$ref": "#/components/schemas/apiConceptLanguage"
}
}
}
apiSingleConceptResponse
{
"type": "object",
"title": "SingleConceptResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"concept": {
"$ref": "#/components/schemas/apiConcept"
}
}
}
apiSingleDatasetInputResponse
{
"type": "object",
"title": "SingleDatasetInputResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"datasetInput": {
"$ref": "#/components/schemas/apiDatasetInput"
}
}
}
apiSingleDatasetResponse
{
"type": "object",
"title": "SingleDatasetResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"dataset": {
"$ref": "#/components/schemas/apiDataset"
}
}
}
apiSingleDatasetVersionResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"datasetVersion": {
"$ref": "#/components/schemas/apiDatasetVersion"
}
}
}
apiSingleEvalMetricsResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"evalMetrics": {
"$ref": "#/components/schemas/apiEvalMetrics"
}
}
}
apiSingleInputCountResponse
{
"type": "object",
"title": "SingleInputCountResponse",
"properties": {
"counts": {
"$ref": "#/components/schemas/apiInputCount"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiSingleInputResponse
{
"type": "object",
"title": "SingleInputResponse",
"properties": {
"input": {
"$ref": "#/components/schemas/apiInput"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiSingleInputsAddJobResponse
{
"type": "object",
"title": "SingleInputsAddJobResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"inputsAddJob": {
"$ref": "#/components/schemas/apiInputsAddJob"
}
}
}
apiSingleInputsExtractionJobResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"inputsExtractionJob": {
"$ref": "#/components/schemas/apiInputsExtractionJob"
}
}
}
apiSingleInstalledModuleVersionResponse
{
"type": "object",
"title": "SingleInstalledModuleVersionResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"installedModuleVersion": {
"$ref": "#/components/schemas/apiInstalledModuleVersion"
}
}
}
apiSingleKeyResponse
{
"type": "object",
"title": "SingleKeyResponse",
"properties": {
"key": {
"$ref": "#/components/schemas/apiKey"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiSingleLabelOrderResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"labelOrder": {
"$ref": "#/components/schemas/apiLabelOrder"
}
},
"description": "Response with a label order."
}
apiSingleModelResponse
{
"type": "object",
"title": "SingleModelResponse",
"properties": {
"model": {
"$ref": "#/components/schemas/apiModel"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiSingleModelTypeResponse
{
"type": "object",
"title": "SingleModelTypeResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modelType": {
"$ref": "#/components/schemas/apiModelType"
}
}
}
apiSingleModelVersionExportResponse
{
"type": "object",
"title": "SingleModelVersionExportResponse",
"properties": {
"export": {
"$ref": "#/components/schemas/apiModelVersionExport"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiSingleModelVersionInputExampleResponse
{
"type": "object",
"title": "SingleModelVersionInputExampleResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modelVersionInputExample": {
"$ref": "#/components/schemas/apiModelVersionInputExample"
}
}
}
apiSingleModelVersionResponse
{
"type": "object",
"title": "SingleModelVersionResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modelVersion": {
"$ref": "#/components/schemas/apiModelVersion"
}
}
}
apiSingleModuleResponse
{
"type": "object",
"title": "SingleModuleResponse",
"properties": {
"module": {
"$ref": "#/components/schemas/apiModule"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiSingleModuleVersionResponse
{
"type": "object",
"title": "SingleModuleVersionResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"moduleVersion": {
"$ref": "#/components/schemas/apiModuleVersion"
}
}
}
apiSingleModuleVersionUsageCountResponse
{
"type": "object",
"title": "SingleModuleVersionUsageCountResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"usageCount": {
"type": "integer",
"format": "int64"
}
}
}
apiSinglePasswordValidationResponse
{
"type": "object",
"title": "SinglePasswordValidationResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"passwordViolations": {
"$ref": "#/components/schemas/apiPasswordViolations"
}
}
}
apiSingleRunnerResponse
{
"type": "object",
"title": "SingleRunnerResponse",
"properties": {
"runner": {
"$ref": "#/components/schemas/apiRunner"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiSingleSearchResponse
{
"type": "object",
"title": "SingleSearchResponse returns saved search in response to GetSearchRequest",
"properties": {
"search": {
"$ref": "#/components/schemas/apiSearch"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiSingleStatusCodeResponse
{
"type": "object",
"title": "SingleStatusCodeResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiSingleTaskCountResponse
{
"type": "object",
"title": "SingleTaskCountResponse represent counts of annotations or inputs(anchor annotations) for labelers in given task",
"properties": {
"appId": {
"type": "string"
},
"counts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTaskStatusCountPerUser"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"taskId": {
"type": "string"
}
}
}
apiSingleTaskResponse
{
"type": "object",
"properties": {
"task": {
"$ref": "#/components/schemas/apiTask"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
},
"description": "Response with a single Task."
}
apiSingleUploadResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"upload": {
"$ref": "#/components/schemas/apiUpload"
}
}
}
apiSingleUserResponse
{
"type": "object",
"title": "SingleUserResponse",
"properties": {
"user": {
"$ref": "#/components/schemas/apiUser"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiSingleWorkflowResponse
{
"type": "object",
"title": "SingleWorkflowResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"workflow": {
"$ref": "#/components/schemas/apiWorkflow"
}
}
}
apiSingleWorkflowVersionResponse
{
"type": "object",
"title": "SingleWorkflowVersionResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"workflowVersion": {
"$ref": "#/components/schemas/apiWorkflowVersion"
}
}
}
apiSpan
{
"type": "object",
"properties": {
"charEnd": {
"type": "integer",
"format": "int64"
},
"rawText": {
"type": "string"
},
"charStart": {
"type": "integer",
"format": "int64"
}
}
}
apiSplitIntoDatasets
{
"type": "object",
"properties": {
"method": {
"$ref": "#/components/schemas/SplitIntoDatasetsDatasetSplitMethod"
},
"datasetSplits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetSplit"
}
}
}
}
apiStatTimeAggType
{
"enum": [
"NO_TIME_AGG",
"YEAR",
"MONTH",
"WEEK",
"DAY",
"HOUR",
"MINUTE"
],
"type": "string",
"default": "NO_TIME_AGG"
}
apiStatValue
{
"type": "object",
"title": "StatValue",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of tags to attach to this stat. Each should contain one colon so that the first part will\nbe used as a tag group while the second being the tag itself. For example: [\"task_id:a\",\n\"worker_id:1\"]. These tag groups like \"task_id\" or \"worker_id\" are important for aggregating\nvalues in the StatValueAggregateQuery."
},
"time": {
"type": "string",
"format": "date-time",
"description": "The time of the event. Defaults to now()."
},
"value": {
"type": "number",
"format": "float",
"description": "A value for the metric you're recording."
}
}
}
apiStatValueAggType
{
"enum": [
"SUM",
"AVG"
],
"type": "string",
"default": "SUM"
}
apiStatValueAggregate
{
"type": "object",
"title": "StatValueAggregate",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags for this aggregated_value and count. This will be filled in if tag groups were used in\nthe query to group aggregations."
},
"time": {
"type": "string",
"format": "date-time",
"description": "The time of the aggregation. For example, if you aggregate over \"HOUR\" buckets then you can\nexpect each hour that has atleast one value (matching the rest of your query fields) will have\na StatValueAggregate with the time filled into that hour."
},
"count": {
"type": "string",
"format": "uint64",
"description": "The count of the stat values that were used in this aggregation."
},
"aggregateValue": {
"type": "number",
"title": "The value aggregated according to the stat_value_agg_type",
"format": "float"
}
}
}
apiStatValueAggregateQuery
{
"type": "object",
"title": "StatValueAggregateQuery",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "These tags are used to filter down the values before they are aggregated. For example,\nif you want to aggregate values for \"task_id:a\" you could specify that as a tag here."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "If provided the time range over which values will be <= this time. If not provided then all\nvalues will be used up until now()."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "If provided the time range over which values will be >= this time. If not provided then\nall values will be used back to start of time."
},
"tagGroups": {
"type": "array",
"items": {
"type": "string"
},
"title": "These are tag groups to aggregate over. So for example if you added stat values with tags\n\"task_id:a\" and others with \"task_id:b\", then added [\"task_id\"] to the task group, it the\naggregation would return StatValueAggregate values for each task_id. If you provide more than\none tag_group the response will return all rolled up combinations of them. For example\n[\"task_id\", \"something\"] where \"something:1\" and \"something:2\" were used as tags for some\nvalues then you'd get StatValueAggregate values back for:\ntask_id | something\na | 1\na | 2\nb | 1\nb | 1"
},
"statTimeAggType": {
"$ref": "#/components/schemas/apiStatTimeAggType"
},
"statValueAggType": {
"$ref": "#/components/schemas/apiStatValueAggType"
}
}
}
apiStatValueAggregateResult
{
"type": "object",
"title": "StatValueAggregateResult",
"properties": {
"statValueAggregates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiStatValueAggregate"
},
"description": "The list of repeated aggregate values and their counts."
},
"statValueAggregateQuery": {
"$ref": "#/components/schemas/apiStatValueAggregateQuery"
}
}
}
apiTask
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique ID for the task."
},
"name": {
"type": "string",
"description": "Add a title for this task to quickly recognise it in a list of tasks."
},
"type": {
"$ref": "#/components/schemas/TaskTaskType"
},
"appId": {
"type": "string",
"description": "The app the task belongs to."
},
"review": {
"$ref": "#/components/schemas/apiTaskReview"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"userId": {
"type": "string",
"description": "The user the task belongs to."
},
"worker": {
"$ref": "#/components/schemas/apiTaskWorker"
},
"metrics": {
"$ref": "#/components/schemas/apiTaskMetrics"
},
"concepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTaskConcept"
},
"description": "Ignore Task.concept_ids field if Task.TaskConcept are supplied."
},
"sampleMs": {
"type": "integer",
"title": "For model predictions on video: Sample delay for video predicting (1 frame per N milliseconds)",
"format": "int64"
},
"createdAt": {
"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\"."
},
"conceptIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of concept ids used in the work of this task.\nDEPRECATED: Use task.concepts instead."
},
"modifiedAt": {
"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\"."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"aiAssistant": {
"$ref": "#/components/schemas/apiTaskAIAssistant"
},
"description": {
"type": "string",
"description": "Description of the task."
},
"inputSource": {
"$ref": "#/components/schemas/apiTaskInputSource"
},
"labelOrderId": {
"type": "string",
"description": "The label order the task belongs to."
},
"aiAssistParams": {
"$ref": "#/components/schemas/apiAiAssistParameters"
},
"deletePreviousAnnotations": {
"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"
}
},
"description": "Task is the work that needs to be done for labeling the inputs in an app."
}
apiTaskAIAssistant
{
"type": "object",
"title": "TaskAIAssistant",
"properties": {
"workflowId": {
"type": "string",
"description": "The worker is helped by an AI assistant.\nThis field is the workflow id which is used to assist the worker with predictions.\nIf empty, then AI assistant is disabled."
}
}
}
apiTaskAssignment
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"$ref": "#/components/schemas/apiInput"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"worker": {
"$ref": "#/components/schemas/apiWorker"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Creation time.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "Most recent modification time.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
}
}
}
apiTaskConcept
{
"type": "object",
"properties": {
"concept": {
"$ref": "#/components/schemas/apiConcept"
},
"autoAnnotationConfig": {
"$ref": "#/components/schemas/apiTaskConceptAutoAnnotationConfig"
}
}
}
apiTaskConceptAutoAnnotationConfig
{
"type": "object",
"properties": {
"statusCode": {
"$ref": "#/components/schemas/statusStatusCode"
},
"thresholdRange": {
"$ref": "#/components/schemas/apiThresholdRange"
},
"annotationDataTypes": {
"type": "integer",
"format": "int64",
"description": "Filter annotations by their annotation data type.\nThis is a bit-mask field that holds multiple AnnotationDataType values that are combined in an OR fashion.\nExample: if annotation_data_types = 34, then we filter annotations that appear as a mask or a bounding box,\nbecause MASK = 32 and BOUNDING_BOX = 2."
}
}
}
apiTaskInputSource
{
"type": "object",
"title": "TaskInputSource",
"properties": {
"id": {
"type": "string",
"description": "If type is SAVED_SEARCH, then this is the saved search id."
},
"type": {
"$ref": "#/components/schemas/TaskInputSourceTaskInputSourceType"
}
}
}
apiTaskMetrics
{
"type": "object",
"properties": {
"work": {
"$ref": "#/components/schemas/apiTaskWorkMetrics"
}
}
}
apiTaskReview
{
"type": "object",
"title": "TaskReview",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiUser"
},
"description": "Users who will review this task.\nWhen the 'review.users' field is additionally requested, then all user\ninfo is filled for the reviewers. Otherwise, only the user 'id' is filled."
},
"userIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Who will review this task.\nDEPRECATED: Use users.id instead."
},
"strategy": {
"$ref": "#/components/schemas/TaskReviewTaskReviewStrategy"
},
"manualStrategyInfo": {
"$ref": "#/components/schemas/apiTaskReviewManualStrategyInfo"
},
"consensusStrategyInfo": {
"$ref": "#/components/schemas/apiTaskReviewConsensusStrategyInfo"
}
}
}
apiTaskReviewConsensusStrategyInfo
{
"type": "object",
"title": "TaskReviewConsensusStrategyInfo",
"properties": {
"approvalThreshold": {
"type": "integer",
"format": "int64",
"description": "The number of labelers that need to agree in order to automatically approve an annotation."
}
}
}
apiTaskReviewManualStrategyInfo
{
"type": "object",
"title": "TaskReviewManualStrategyInfo",
"properties": {
"samplePercentage": {
"type": "number",
"format": "float",
"description": "This field represents the percentage of inputs that will be reviewed by reviewers. It is a value between 0 and 1."
}
}
}