Query structured spec data via REST or MCP. Get exactly what your agent needs.
api.clarifia.com
/v2/datasets/{datasetId}/versions/{datasetVersionId}/exports
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| datasetId | path | required | string | Identify dataset by id. |
| datasetVersionId | path | required | string | Identify dataset version by id. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V2PutDatasetVersionExports2Request"
}
}
},
"required": true
}
PUT /v2/datasets/{datasetId}/versions/{datasetVersionId}/exports
/v2/models/{modelId}/versions/{versionId}/exports
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| modelId | path | required | string | |
| versionId | path | required | string | |
| userAppId.userId | query | optional | string | Note user_id 'me' is reserved - it is the alias for the id of authorized user |
| userAppId.appId | query | optional | string |
PUT /v2/models/{modelId}/versions/{versionId}/exports
/v2/uploads/{uploadId}/content_parts
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| uploadId | path | required | string | |
| userAppId.userId | query | optional | string | Note user_id 'me' is reserved - it is the alias for the id of authorized user |
| userAppId.appId | query | optional | string |
PUT /v2/uploads/{uploadId}/content_parts
/v2/users/{userAppId.userId}/apps/{userAppId.appId}/datasets/{datasetId}/versions/{datasetVersionId}/exports
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userAppId.userId | path | required | string | Note user_id 'me' is reserved - it is the alias for the id of authorized user |
| userAppId.appId | path | required | string | |
| datasetId | path | required | string | Identify dataset by id. |
| datasetVersionId | path | required | string | Identify dataset version by id. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V2PutDatasetVersionExportsRequest"
}
}
},
"required": true
}
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/datasets/{datasetId}/versions/{datasetVersionId}/exports
/v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/{versionId}/exports
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userAppId.userId | path | required | string | Note user_id 'me' is reserved - it is the alias for the id of authorized user |
| userAppId.appId | path | required | string | |
| modelId | path | required | string | |
| versionId | path | required | string |
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/models/{modelId}/versions/{versionId}/exports
/v2/users/{userAppId.userId}/apps/{userAppId.appId}/tasks/{taskId}/assignments
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userAppId.userId | path | required | string | Note user_id 'me' is reserved - it is the alias for the id of authorized user |
| userAppId.appId | path | required | string | |
| taskId | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V2PutTaskAssignmentsRequest"
}
}
},
"required": true
}
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/tasks/{taskId}/assignments
/v2/users/{userAppId.userId}/apps/{userAppId.appId}/uploads/{uploadId}/content_parts
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userAppId.userId | path | required | string | Note user_id 'me' is reserved - it is the alias for the id of authorized user |
| userAppId.appId | path | required | string | |
| uploadId | path | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V2PutUploadContentPartsRequest"
}
}
},
"required": true
}
PUT /v2/users/{userAppId.userId}/apps/{userAppId.appId}/uploads/{uploadId}/content_parts
BookmarkOriginBookmarkType
{
"enum": [
"unknown",
"model",
"workflow",
"dataset",
"module"
],
"type": "string",
"default": "unknown"
}
CloudRegionCloud
{
"enum": [
"UNKOWN_CLOUD",
"SELF_HOSTED",
"AWS",
"GCP",
"AZURE",
"LAMBDA"
],
"type": "string",
"default": "UNKOWN_CLOUD",
"description": " - SELF_HOSTED: Run on a user's own infrastructure. This has restrictions on who can access resources\nthat are being run by SELF_HOSTED runners. Only those who are part of the user/org where they\nexist can leverage them."
}
DeploymentSchedulingChoice
{
"enum": [
"UNKNOWN_SCHEDULING_CHOICE",
"FAIL",
"RANDOM",
"PRICE",
"PERFORMANCE",
"NETWORK",
"UTILIZATION",
"PREFER_SPOT",
"PREFER_ONDEMAND"
],
"type": "string",
"default": "UNKNOWN_SCHEDULING_CHOICE",
"description": "In some scenarios it may not be obvous how we should schedule a resource to underlying nodes\nwithin the nodepool(s) above. The SchedulerChoice allows us to specify how to decide which\nnodepool to use when there are multiple nodepools and how to decide which type of node\nwithin a nodepool if there are multiple types.\nIf here are multiple nondepools then a decision on which to use comes into play\nif it is not specified in the prediction request.\nEven with a single nodepool a choice may come up such as when a resource that needs scheduling\nhas not specified the accelerator types it supports and the nodepool has multiple types.\n\n - FAIL: fail if there is any ambiguity.\n - RANDOM: randomly pick amongst the nodepools/nodes to assign.\n - PRICE: choose the compute that is cheaper\n - PERFORMANCE: schedule to the fastest known iption.\n - NETWORK: optimize based on network latency.\n - UTILIZATION: send to the least used nodepool based on it's capacity.\n - PREFER_SPOT: choose spot instances over on-demand\n - PREFER_ONDEMAND: choose on-demand instances over spot."
}
MatrixUint64
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "string",
"format": "uint64"
},
"description": "Matrix data stored as an array.\nIn order to access matrix element at row i & column j, use data[i*n_cols+j]."
},
"nCols": {
"type": "string",
"title": "Number of columns",
"format": "uint64"
}
},
"description": "Store matrix of uint64s values.\nIt is recommended to store the matrix as a 1D array\nbecause it produces less bytes during serialization than a 2D array.\nThe matrix does store the number of columns, but it does not store the number of rows.\nThe number of rows can automatically be calculated as length(data)/n_cols."
}
ModelTypeFieldModelTypeFieldType
{
"enum": [
"INVALID_MODEL_TYPE_FIELD_TYPE",
"BOOLEAN",
"STRING",
"NUMBER",
"ARRAY_OF_CONCEPTS",
"ARRAY_OF_CONCEPTS_WITH_THRESHOLD",
"RANGE",
"ENUM",
"COLLABORATORS",
"JSON",
"ARRAY_OF_NUMBERS",
"WORKFLOW_EMBED_MODELS",
"ARRAY_OF_STRINGS",
"RECURSIVE_ENUM",
"PYTHON_CODE",
"DATASET_ID",
"DATASET_VERSION_ID",
"ARRAY_OF_MODEL_CONCEPTS",
"DATASET",
"DATASET_VERSION",
"ENCRYPTED_STRING",
"CHECKPOINT_MODEL"
],
"type": "string",
"default": "INVALID_MODEL_TYPE_FIELD_TYPE",
"description": "These are various types of fields that we have UIs for.\n\n - ARRAY_OF_CONCEPTS: For auto-completing to concepts in the app. This goes into an data.concepts field.\n - ARRAY_OF_CONCEPTS_WITH_THRESHOLD: For auto-completing to concepts in the app. This goes into an data.concepts field.\n - RANGE: A range for a float value.\n - ENUM: If ENUM is used then the \"enum_options\" field should also be filled in with the respective ID and description\nfor the different ENUM options.\n - COLLABORATORS: For listing collaborators of the app. The field is a string of the collaborator's user_id.\n - JSON: For arbitrary json object: \"{...}\"\n - ARRAY_OF_NUMBERS: Such as [1.0, 2.0, 3.5]\n - WORKFLOW_EMBED_MODELS: For selecting the embed_model_version_id for context based models.\n - ARRAY_OF_STRINGS: Such as ['a', 'b', 'cantaloupe']\n - RECURSIVE_ENUM: If RECURSIVE_ENUM is used then the \"enum_options\" field should also be filled in with the respective ID and\ndescription for the different RECURSIVE_ENUM options, as well as model_type_fields for each enum choice.\n - PYTHON_CODE: For blocks of code that need to be specified by the user for setup or execution during workflow runs.\n - DATASET_ID: For selecting a dataset id in model parameters. String in API request.\n - DATASET_VERSION_ID: For selecting a dataset version id. String.\n - ARRAY_OF_MODEL_CONCEPTS: For auto-completing to concepts in the model.\n - DATASET: For selecting a dataset\n - DATASET_VERSION: For selecting a dataset version\n - ENCRYPTED_STRING: To pass a string downstream, that is encrypted in the DB and API.\n - CHECKPOINT_MODEL: For selecting a model version of the same model type to resume training from."
}
ModuleVersionModuleNav
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "This is the left side title for this module and for browser tab title of the module.\nWe have this in the version so that users can change those settings\nwhen releasing a new version of their module."
},
"moduleSubNavs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModuleVersionModuleSubNav"
},
"description": "A list of subnav elements to put under the module title."
}
}
}
ModuleVersionModuleSubNav
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "This is the display title for a navbar element to link to a specific page.\nThe name for this subnav element to show in the sidebar."
},
"queryKey": {
"type": "string",
"title": "The query param name"
},
"queryValue": {
"type": "string",
"title": "The query param value"
}
}
}
NodepoolCapacityType
{
"enum": [
"UKNOWN_CAPACITY_TYPE",
"ONDEMAND_TYPE",
"SPOT_TYPE"
],
"type": "string",
"default": "UKNOWN_CAPACITY_TYPE",
"description": "Type of nodes that are ok for instances in this pool.\nIf both spot and on-demand are provided then the runner will be able to run on either\nwith a preference for spot until they are not available."
}
SearchMetric
{
"enum": [
"METRIC_NOT_SET",
"EUCLIDEAN_DISTANCE",
"COSINE_DISTANCE"
],
"type": "string",
"default": "METRIC_NOT_SET",
"description": "Metric used for search. Can be EUCLIDEAN_DISTANCE (default) or COSINE_DISTANCE.\nCurrently only brute force search supports non-eudlicean metrics."
}
SplitIntoDatasetsDatasetSplitMethod
{
"enum": [
"NOT_SET",
"RANDOM_PERCENTAGE_SPLIT"
],
"type": "string",
"title": "- RANDOM_PERCENTAGE_SPLIT: We will randomly split inputs into the datasets",
"default": "NOT_SET"
}
TaskInputSourceTaskInputSourceType
{
"enum": [
"INPUT_SOURCE_TYPE_NOT_SET",
"ALL_INPUTS",
"SAVED_SEARCH",
"DATASET"
],
"type": "string",
"default": "INPUT_SOURCE_TYPE_NOT_SET",
"description": " - ALL_INPUTS: Use all inputs in the app.\n - SAVED_SEARCH: Use the inputs from a saved search.\n - DATASET: Inputs from a dataset."
}
TaskReviewTaskReviewStrategy
{
"enum": [
"TASK_REVIEW_STRATEGY_NOT_SET",
"NONE",
"MANUAL",
"CONSENSUS"
],
"type": "string",
"default": "TASK_REVIEW_STRATEGY_NOT_SET",
"description": " - NONE: No review is needed.\n - MANUAL: Manual review strategy.\n - CONSENSUS: Consensus review strategy."
}
TaskTaskType
{
"enum": [
"TYPE_NOT_SET",
"CONCEPTS_CLASSIFICATION",
"BOUNDING_BOX_DETECTION",
"POLYGON_DETECTION"
],
"type": "string",
"default": "TYPE_NOT_SET",
"description": " - CONCEPTS_CLASSIFICATION: Concepts classification tasks annotate concepts for the overall image, frame of video or section of text.\n - BOUNDING_BOX_DETECTION: Bounding box detection tasks annotate rectangular bounding box regions around each concept in an image, frame of video or section of text.\n - POLYGON_DETECTION: Polygon detection tasks annotate free-form regions around concepts in an image, frame of video or section of text."
}
TaskWorkerPartitionedStrategyInfoTaskWorkerPartitionedStrategy
{
"enum": [
"PARTITIONED_WORKER_STRATEGY_NOT_SET",
"EVENLY",
"WEIGHTED"
],
"type": "string",
"default": "PARTITIONED_WORKER_STRATEGY_NOT_SET",
"description": " - EVENLY: Each worker will label (approximately) the same number of inputs.\n - WEIGHTED: Each worker will have an assigned weight.\nSee weights field for more details."
}
TaskWorkerTaskWorkerStrategy
{
"enum": [
"WORKER_STRATEGY_NOT_SET",
"PARTITIONED",
"FULL"
],
"type": "string",
"default": "WORKER_STRATEGY_NOT_SET",
"description": " - PARTITIONED: The inputs will be partitioned in several partitions.\nEach worker will label one or more input partitions.\n - FULL: Each worker will label all inputs from input source."
}
V2CancelBulkOperationsRequest
{
"type": "object",
"title": "Cancel a list of bulk operation ids",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "List of bulk operation ids to be cancelled"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2CancelInputsAddJob2Request
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
V2CancelInputsAddJobRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2CancelInputsExtractionJobsRequest
{
"type": "object",
"title": "Cancel a list of extraction job ids",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "List of extraction job ids to be cancelled"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2DeleteAnnotationFiltersRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"annotationFilterIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specify which filters to delete."
}
},
"description": "Request to delete several annotation filters by list of ids."
}
V2DeleteAnnotations3Request
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Delete annotations with IDs"
},
"inputIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "Delete annotations for these Input IDs\nNote that 'ids' are optional but if the are provided the number and order in\n'ids' and 'input_ids' should match\nIf you do not specifiy 'ids' all the annotations for 'input_ids' are deleted\nHowever you need to specify at least one value for 'input_ids'\ni.e. this API does not support deleting all annotations"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to delete several things by the list of ids."
}
V2DeleteBulkOperationsRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "List of bulk operation ids to be deleted"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to delete the terminated bulk operations by ID\nOnly operations in terminated state can be deleted."
}
V2DeleteCollaboratorsRequest
{
"type": "object",
"title": "DeleteCollaboratorsRequest",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"userEmails": {
"type": "array",
"items": {
"type": "string"
}
},
"collaboratorIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
V2DeleteCollectorsRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"deleteAll": {
"type": "boolean"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to delete several things by the list of ids."
}
V2DeleteConceptRelationsRequest
{
"type": "object",
"title": "DELETE concept relations",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The concept relationship ids to delete."
},
"userAppId": {
"type": "object",
"title": "The user_id and app_id information.",
"description": "The user_id and app_id information."
}
}
}
V2DeleteDatasetInputs2Request
{
"type": "object",
"properties": {
"inputIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specify which inputs to delete from dataset."
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to delete several dataset inputs by list of ids."
}
V2DeleteDatasetInputsRequest
{
"type": "object",
"properties": {
"inputIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specify which inputs to delete from dataset."
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to delete several dataset inputs by list of ids."
}
V2DeleteDatasetVersions2Request
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"datasetVersionIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Request to delete several dataset versions by list of ids."
}
V2DeleteDatasetVersionsRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"datasetVersionIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Request to delete several dataset versions by list of ids."
}
V2DeleteDatasetsRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"datasetIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Request to delete several datasets by list of ids."
}
V2DeleteInputsRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to delete several things by the list of ids."
}
V2DeleteInstalledModuleVersionsRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to delete several installed module versions by the list of ids."
}
V2DeleteLabelOrdersRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to delete a list of label orders."
}
V2DeleteModuleVersionsRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to delete several module versions by the list of ids."
}
V2DeleteRunnersRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"type": "object",
"properties": {
"appId": {
"type": "string"
}
},
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to delete several things by the list of ids."
}
V2DeleteTasksRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to delete a list of tasks."
}
V2DeleteUploadsRequest
{
"type": "object",
"title": "Stops or deletes multipart upload",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2DeleteWorkflowVersions2Request
{
"type": "object",
"title": "DeleteWorkflowVersionsRequest",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"workflowVersionIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "Delete the versions identified by these ids"
}
}
}
V2DeleteWorkflowVersionsRequest
{
"type": "object",
"title": "DeleteWorkflowVersionsRequest",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"workflowVersionIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "Delete the versions identified by these ids"
}
}
}
V2GenerateModelOutputs2Response
{
"type": "object",
"title": "Stream result of apiMultiOutputResponse",
"properties": {
"error": {
"$ref": "#/components/schemas/googlerpcStatus"
},
"result": {
"$ref": "#/components/schemas/apiMultiOutputResponse"
}
}
}
V2GenerateModelOutputsResponse
{
"type": "object",
"title": "Stream result of apiMultiOutputResponse",
"properties": {
"error": {
"$ref": "#/components/schemas/googlerpcStatus"
},
"result": {
"$ref": "#/components/schemas/apiMultiOutputResponse"
}
}
}
V2PatchAnnotationFiltersRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now, only 'overwrite' action is supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"annotationFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAnnotationFilter"
},
"description": "List of annotation filters that are requested to be updated."
}
},
"description": "Request to patch several annotation filters."
}
V2PatchAnnotationsRequest
{
"type": "object",
"title": "PatchAnnotationsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"annotations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
}
},
"deleteIfEmptyData": {
"type": "boolean",
"description": "If the request is a \"remove\" action and the annotation is left with empty data,\nthen setting delete_if_empty_data to true will delete the annotation,\nif possible (for example, will not delete an input-level annotation)."
}
}
}
V2PatchAnnotationsSearchesRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched Search objects\nFor now only action 'overwrite' is supported"
},
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"title": "The searches to be patched"
},
"userAppId": {
"type": "object",
"title": "The user_id and app_id to query from.",
"description": "The user_id and app_id to query from."
}
}
}
V2PatchAnnotationsStatusRequest
{
"type": "object",
"title": "PatchAnnotationsStatusRequest",
"properties": {
"action": {
"type": "string",
"title": "'overwrite' is supported"
},
"userIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "Filter by user IDs"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"statusCode": {
"$ref": "#/components/schemas/statusStatusCode"
},
"statusCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/statusStatusCode"
},
"title": "Filter by Status codes"
}
}
}
V2PatchAppRequest
{
"type": "object",
"title": "PatchAppRequest",
"properties": {
"app": {
"$ref": "#/components/schemas/apiApp"
},
"action": {
"type": "string",
"description": "The action to perform on the patched App object except App.Metadata\nSupported values: 'overwrite' and 'remove'.\n\nNote that 'remove' can only be used to remove the app image by setting\n'image.url' in the request to the current value returned for the app."
},
"reindex": {
"type": "boolean",
"description": "If set, the app will be automatically reindexed upon change of its base workflow."
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"metadataAction": {
"$ref": "#/components/schemas/apiPatchAction"
}
}
}
V2PatchAppsIdsRequest
{
"type": "object",
"title": "PatchAppsIdsRequest",
"properties": {
"ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiIdUpdateSource"
},
"title": "Array containing 1 entry"
},
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nOnly 'overwrite' is supported"
},
"userAppId": {
"type": "object",
"properties": {
"appId": {
"type": "string"
}
},
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PatchAppsRequest
{
"type": "object",
"title": "PatchAppsRequest",
"properties": {
"apps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiApp"
}
},
"action": {
"type": "string",
"description": "The action to perform on the patched App objects except App.Metadata\nSupported values: 'overwrite' and 'remove'.\n\nNote that 'remove' can only be used to remove the app image by setting\n'image.url' in the request to the current value returned for that app."
},
"reindex": {
"type": "boolean",
"description": "If set, the app will be automatically reindexed upon change of its base workflow."
},
"userAppId": {
"type": "object",
"properties": {
"appId": {
"type": "string"
}
},
"description": "Common message to identify the app in a url endpoint."
},
"metadataAction": {
"$ref": "#/components/schemas/apiPatchAction"
}
}
}
V2PatchCollaboratorsRequest
{
"type": "object",
"title": "PatchCollaboratorsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now only action 'overwrite' is supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"collaborators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollaborator"
}
}
}
}
V2PatchCollectorsRequest
{
"type": "object",
"title": "PatchCollectorsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nOnly 'overwrite' is supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"collectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollector"
}
}
}
}
V2PatchConceptLanguages2Request
{
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action to perform with the objects in the PATCH."
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"conceptLanguages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptLanguage"
}
}
},
"description": "PATCH multiple concept languages for the given concept."
}
V2PatchConceptLanguagesRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action to perform with the objects in the PATCH."
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"conceptLanguages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptLanguage"
}
}
},
"description": "PATCH multiple concept languages for the given concept."
}
V2PatchConceptsRequest
{
"type": "object",
"title": "PatchConceptsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now ony action 'overwrite' is supported"
},
"concepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
},
"description": "The concepts to patch."
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PatchDatasetVersions2Request
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now, only 'overwrite' action is supported"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"datasetVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersion"
},
"description": "List of dataset versions that are requested to be updated."
}
},
"description": "Request to patch several dataset versions."
}
V2PatchDatasetVersionsRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now, only 'overwrite' action is supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"datasetVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersion"
},
"description": "List of dataset versions that are requested to be updated."
}
},
"description": "Request to patch several dataset versions."
}
V2PatchDatasetsRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action to perform on the patched objects\nSupported values: 'overwrite', 'merge', and 'remove'.\n\nNote that 'remove' can only be used to remove the dataset image by setting\n'image.url' in the request to the current value returned for that dataset."
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDataset"
},
"description": "List of datasets that are requested to be updated."
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to patch several datasets."
}
V2PatchInputsRequest
{
"type": "object",
"title": "PatchInputsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
},
"title": "List of inputs to patch.\nInputs are identified by id field.\nFor each input, the following fields are patchable:\n* data"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PatchKeysRequest
{
"type": "object",
"title": "PatchKeysRequest",
"properties": {
"keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiKey"
}
},
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now only action 'overwrite' is supported"
},
"userAppId": {
"type": "object",
"properties": {
"appId": {
"type": "string"
}
},
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PatchLabelOrdersRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"labelOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiLabelOrder"
}
}
},
"description": "Request to patch a list of label orders."
}
V2PatchModelCheckConsents2Request
{
"type": "object",
"title": "PatchModelCheckConsentsRequest",
"properties": {
"action": {
"type": "string",
"title": "overwrite supported"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"checkConsents": {
"type": "array",
"items": {
"type": "string"
},
"title": "the consents"
}
}
}
V2PatchModelCheckConsentsRequest
{
"type": "object",
"title": "PatchModelCheckConsentsRequest",
"properties": {
"action": {
"type": "string",
"title": "overwrite supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"checkConsents": {
"type": "array",
"items": {
"type": "string"
},
"title": "the consents"
}
}
}
V2PatchModelIdsRequest
{
"type": "object",
"title": "PatchModelIdsRequest",
"properties": {
"ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiIdUpdateSource"
},
"title": "Array containing 1 entry"
},
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nOnly 'overwrite' is supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PatchModelLanguages2Request
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "Only overwrite supported"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
V2PatchModelLanguagesRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "Only overwrite supported"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PatchModelToolkits2Request
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "overwrite supported"
},
"toolkits": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
V2PatchModelToolkitsRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "overwrite supported"
},
"toolkits": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PatchModelUseCases2Request
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "overwrite supported"
},
"usecases": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
V2PatchModelUseCasesRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "overwrite supported"
},
"usecases": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PatchModelVersionsRequest
{
"type": "object",
"title": "PatchModelVersionsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"modelVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersion"
}
}
}
}
V2PatchModelsRequest
{
"type": "object",
"title": "PatchModelsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported",
"description": "Note that 'remove' can be used to remove the model image by setting\n'image.url' in the request to the current value returned for that model.\nThis cannot be used in a request that is patching other fields as well."
},
"models": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModel"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PatchModuleVersionsRequest
{
"type": "object",
"title": "PatchModuleVersionsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now only action 'merge' is supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"moduleVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModuleVersion"
},
"title": "This allows you to modify the module version details.\n########## Supported fields ##########\n- description\n- id\n- metadata.fields\n- module_nav.module_sub_navs[].query_key\n- module_nav.module_sub_navs[].query_value\n- module_nav.module_sub_navs[].title\n- module_nav.title\n- notes\n- visibility.gettable"
}
}
}
V2PatchModulesRequest
{
"type": "object",
"title": "PatchModulesRequest",
"properties": {
"action": {
"type": "string",
"description": "The action to perform on the patched objects\nSupported values: 'overwrite' and 'remove'.\n\nNote that 'remove' can only be used to remove the module image by setting\n'image.url' in the request to the current value returned for that module."
},
"modules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModule"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PatchSearchesRequest
{
"type": "object",
"title": "PatchSearchesRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched Search objects\nFor now only action 'overwrite' is supported"
},
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"title": "The searches to be patched"
},
"userAppId": {
"type": "object",
"title": "The user_id and app_id to query from.",
"description": "The user_id and app_id to query from."
}
}
}
V2PatchTasksRequest
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTask"
}
},
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to patch a list of tasks."
}
V2PatchWorkflowIdsRequest
{
"type": "object",
"title": "PatchWorkflowIdsRequest",
"properties": {
"ids": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiIdUpdateSource"
},
"title": "Array containing 1 entry"
},
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nOnly 'overwrite' is supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PatchWorkflowVersions2Request
{
"type": "object",
"title": "PatchWorkflowVersionsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"workflowVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowVersion"
},
"description": "Patch these versions."
}
}
}
V2PatchWorkflowVersionsRequest
{
"type": "object",
"title": "PatchWorkflowVersionsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"workflowVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowVersion"
},
"description": "Patch these versions."
}
}
}
V2PatchWorkflowsRequest
{
"type": "object",
"title": "PatchWorkflowsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported",
"description": "Note that 'remove' can be used to remove the workflow image by setting\n'image.url' in the request to the current value returned for that workflow.\nThis cannot be used in a request that is patching other fields as well."
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflow"
}
}
}
}
V2PostAnnotationFiltersRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"annotationFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAnnotationFilter"
},
"description": "List of annotation filters that are requested to be added."
}
},
"description": "Request to add one or more annotation filters."
}
V2PostAnnotationSearchMetricsRequest
{
"type": "object",
"title": "PostAnnotationSearchMetricsRequest",
"properties": {
"id": {
"type": "string",
"title": "A unique customer facing id to identify this eval request"
},
"data": {
"$ref": "#/components/schemas/apiData"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"groundTruth": {
"$ref": "#/components/schemas/apiSearch"
},
"searchToEval": {
"$ref": "#/components/schemas/apiSearch"
},
"evaluationType": {
"$ref": "#/components/schemas/apiEvaluationType"
}
}
}
V2PostAnnotationsRequest
{
"type": "object",
"title": "PostAnnotationsRequest",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"annotations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
}
}
}
}
V2PostAnnotationsSearchesRequest
{
"type": "object",
"title": "Execute a new annotation search and optionally save it\nannotation search over annotations using rank and filter proto",
"properties": {
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"title": "The searched to be executed or saved"
},
"userAppId": {
"type": "object",
"title": "The user_id and app_id to query from.",
"description": "The user_id and app_id to query from."
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
}
}
}
V2PostAppDuplicationsRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"title": "The user and application ID of the source application to duplicate.",
"description": "The user and application ID of the source application to duplicate."
},
"appDuplications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAppDuplication"
}
}
},
"description": "Request to start app duplication jobs."
}
V2PostAppsRequest
{
"type": "object",
"title": "PostAppsRequest",
"properties": {
"apps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiApp"
}
},
"userAppId": {
"type": "object",
"properties": {
"appId": {
"type": "string"
}
},
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PostAppsSearchesRequest
{
"type": "object",
"properties": {
"appQuery": {
"$ref": "#/components/schemas/apiAppQuery"
},
"userAppId": {
"type": "object",
"properties": {
"appId": {
"type": "string"
}
},
"description": "Common message to identify the app in a url endpoint."
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
}
},
"description": "Search over the available applications."
}
V2PostBulkOperationsRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"bulkOperations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiBulkOperation"
},
"description": "List of bulk operation(s) to be performed e.g bulk update metadata or tags or labels etc."
}
},
"description": "Request to perform bulk operations on a list of inputs based on input source."
}
V2PostCollaboratorsRequest
{
"type": "object",
"title": "PostCollaboratorsRequest",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"collaborators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollaborator"
}
}
}
}
V2PostCollectorsRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"collectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollector"
}
}
},
"description": "Request to create Collectors."
}
V2PostConceptLanguages2Request
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"conceptLanguages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptLanguage"
}
}
},
"description": "POST multiple concept languages for the given concept."
}
V2PostConceptLanguagesRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"conceptLanguages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptLanguage"
}
}
},
"description": "POST multiple concept languages for the given concept."
}
V2PostConceptMappingJobsRequest
{
"type": "object",
"title": "Start concept mapping jobs",
"properties": {
"userAppId": {
"type": "object",
"title": "The user_id and app_id information.",
"description": "The user_id and app_id information."
},
"conceptMappingJobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptMappingJob"
},
"title": "The concept mapping jobs that are being started"
}
}
}
V2PostConceptRelationsRequest
{
"type": "object",
"title": "POST new concept relations",
"properties": {
"userAppId": {
"type": "object",
"title": "The user_id and app_id information.",
"description": "The user_id and app_id information."
},
"conceptRelations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptRelation"
},
"description": "The relationships you're going to add."
}
}
}
V2PostConceptsRequest
{
"type": "object",
"title": "PostConceptsRequest",
"properties": {
"concepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
},
"description": "The concepts to add."
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PostConceptsSearchesRequest
{
"type": "object",
"title": "PostConceptsSearchesRequest",
"properties": {
"extraInfo": {
"$ref": "#/components/schemas/apiConceptExtraInfoRequest"
},
"userAppId": {
"type": "object",
"title": "Ids present in the url of the request.",
"description": "Ids present in the url of the request."
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
},
"conceptQuery": {
"$ref": "#/components/schemas/apiConceptQuery"
}
}
}
V2PostDatasetInputs2Request
{
"type": "object",
"properties": {
"search": {
"$ref": "#/components/schemas/apiSearch"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"datasetInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetInput"
},
"description": "List of inputs that are requested to be added to this dataset.\nIdentify each input by id field. All other inputs fields are ignored."
}
},
"description": "Request to add one or more datasets."
}
V2PostDatasetInputsRequest
{
"type": "object",
"properties": {
"search": {
"$ref": "#/components/schemas/apiSearch"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"datasetInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetInput"
},
"description": "List of inputs that are requested to be added to this dataset.\nIdentify each input by id field. All other inputs fields are ignored."
}
},
"description": "Request to add one or more datasets."
}
V2PostDatasetVersions2Request
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"datasetVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersion"
},
"description": "List of dataset versions that are requested to be added."
}
},
"description": "Request to add one or more dataset versions."
}
V2PostDatasetVersionsRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"datasetVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersion"
},
"description": "List of dataset versions that are requested to be added."
}
},
"description": "Request to add one or more dataset versions."
}
V2PostDatasetsRequest
{
"type": "object",
"properties": {
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDataset"
},
"description": "List of datasets that are requested to be added."
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to add one or more datasets."
}
V2PostEvaluationsRequest
{
"type": "object",
"title": "Evaluate this model vesion",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"evalMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiEvalMetrics"
},
"description": "eval_info, id, model, and ground_truth_dataset will be used when creating the evaluation\nIf no dataset is provided, all app data that is annotated with concepts from the model will be used."
}
}
}
V2PostInputsDataSourcesRequest
{
"type": "object",
"properties": {
"appPat": {
"type": "string",
"title": "Personal Access Token to the application to which inputs are added"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"callBackUrl": {
"type": "string",
"description": "If call back url is set, we will send a Post request to this endpoint with job status."
},
"dataSources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInputsDataSource"
}
}
},
"description": "Initiates retrieval of inputs from cloud storage from a user provided data source.\nWill create and return an inputs-add-job for tracking progress.\nArchives will be extracted and their contents will be processed as inputs.\n\nThe cloud URL will be treated as a filter prefix. For example s3:/bucket/images_folder/abc will process\nfiles in the images_folder beginning with abc or in a subfolder beginning with abc.\nFor example:\nbucket/images_folder/abcImage.png\nbucket/images_folder/abc-1/Data.zip\n\nIf given URL is for a private bucket or file, then credentials should be provided to access the bucket.\nCredentials should include rights to list the objects in the bucket, except when pointed directly at a file archive,\nin which case it only requires rights to access that particular file."
}
V2PostInputsRequest
{
"type": "object",
"title": "PostInputsRequest",
"properties": {
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
},
"title": "List of inputs to post.\nFor each input, the following fields are used:\n* id\n* data\n* dataset_ids"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"inputsAddJobId": {
"type": "string",
"description": "Collect statistics about created inputs in job with given ID.\n* If job ID is empty, then job is not created.\n* If job ID is non-empty and doesn't already exist, then a new job will be created with given ID.\n* If job ID does already exist, then new inputs statistics are merged with previous inputs statistics."
},
"inputIdConflictResolution": {
"$ref": "#/components/schemas/apiInputIDConflictResolution"
}
}
}
V2PostInputsSearchesRequest
{
"type": "object",
"title": "Execute a new input search and optionally save it",
"properties": {
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"title": "The searched to be executed or saved"
},
"onlyCount": {
"type": "boolean",
"description": "If only_count is set, then the response will not contain hits,\nbut hit_counts instead."
},
"userAppId": {
"type": "object",
"title": "The user_id and app_id to query from.",
"description": "The user_id and app_id to query from."
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
}
}
}
V2PostInputsUploadsRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"inputsUploads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInputsUpload"
}
}
},
"description": "Start uploading a file archive containing inputs.\nWill create and return an inputs-add-job for tracking progress.\n\nAssociated inputs-add-job contains an upload id which should be completed through `PutUploadContentParts` endpoint.\nCompleting the upload will automatically begin unpacking the archive and uploading the contents as inputs."
}
V2PostInstalledModuleVersionsKeyRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "PostInstalledModuleVersionsKeyRequest to associate a key of the caller's to the installed module\nversion."
}
V2PostInstalledModuleVersionsRequest
{
"type": "object",
"title": "PostInstalledModuleVersionsRequest to install a module version into the app in the URL",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"installedModuleVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInstalledModuleVersion"
},
"description": "This allows you to create one or more module by posting it to the API."
}
}
}
V2PostKeysRequest
{
"type": "object",
"title": "PostKeysRequest",
"properties": {
"keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiKey"
}
},
"userAppId": {
"type": "object",
"properties": {
"appId": {
"type": "string"
}
},
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PostKnowledgeGraphsRequest
{
"type": "object",
"title": "POST new knowledge graphs",
"properties": {
"userAppId": {
"type": "object",
"title": "The user_id and app_id information.",
"description": "The user_id and app_id information."
},
"knowledgeGraphs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiKnowledgeGraph"
}
}
}
}
V2PostLabelOrdersRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"labelOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiLabelOrder"
}
}
},
"description": "Request to create label orders."
}
V2PostModelOutputs2Request
{
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/apiModel"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"runnerSelector": {
"$ref": "#/components/schemas/apiRunnerSelector"
}
},
"description": "//////////////////////////////////////////////////\nModel prediction related stuff needs inputs and produces outputs.\n//////////////////////////////////////////////////\nModel prediction."
}
V2PostModelOutputs3Request
{
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/apiModel"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"versionId": {
"type": "string"
},
"runnerSelector": {
"$ref": "#/components/schemas/apiRunnerSelector"
}
},
"description": "//////////////////////////////////////////////////\nModel prediction related stuff needs inputs and produces outputs.\n//////////////////////////////////////////////////\nModel prediction."
}
V2PostModelOutputs4Request
{
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/apiModel"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"versionId": {
"type": "string"
},
"runnerSelector": {
"$ref": "#/components/schemas/apiRunnerSelector"
}
},
"description": "//////////////////////////////////////////////////\nModel prediction related stuff needs inputs and produces outputs.\n//////////////////////////////////////////////////\nModel prediction."
}
V2PostModelOutputs5Request
{
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/apiModel"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
}
},
"modelId": {
"type": "string"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"versionId": {
"type": "string"
},
"runnerSelector": {
"type": "object",
"title": "Allow filtering of prediction requests down to specific Nodepools, Deploymetns or Runners",
"properties": {
"runner": {
"$ref": "#/components/schemas/apiRunner"
},
"nodepool": {
"$ref": "#/components/schemas/apiNodepool"
},
"deployment": {
"type": "object",
"title": "Optionally a partcular deployment within the nodepool.",
"properties": {
"model": {
"$ref": "#/components/schemas/apiModel"
},
"workflow": {
"$ref": "#/components/schemas/apiWorkflow"
},
"nodepools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiNodepool"
},
"title": "You can configure different autoscaling per nodepool(s).\nThese nodepools have to be also owned by the same user_id/org as this deployment.\nIf there is more than one nodepool we use the model's ComputeInfo to match\nwith what the nodepool provides to decide which one can handle it combined with the\nNodepoolRank below. Note: even within a single nodepool if it is heterogeneous then\nwe need a way to rank scheduling choices when we don't know how to decide (like a model\nsupports"
},
"autoscaleConfig": {
"$ref": "#/components/schemas/apiAutoscaleConfig"
},
"schedulingChoice": {
"$ref": "#/components/schemas/DeploymentSchedulingChoice"
}
},
"description": "In future as we support matching runners based on just labels:\n RunnerLabels runner_labels = 3; // FUTURE"
}
}
}
},
"description": "//////////////////////////////////////////////////\nModel prediction related stuff needs inputs and produces outputs.\n//////////////////////////////////////////////////\nModel prediction."
}
V2PostModelOutputsRequest
{
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/apiModel"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"runnerSelector": {
"$ref": "#/components/schemas/apiRunnerSelector"
}
},
"description": "//////////////////////////////////////////////////\nModel prediction related stuff needs inputs and produces outputs.\n//////////////////////////////////////////////////\nModel prediction."
}
V2PostModelVersionEvaluations2Request
{
"type": "object",
"title": "Evaluate this model vesion",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"evalMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiEvalMetrics"
},
"title": "EvalInfo and ID will be used when creating the evaluation"
}
}
}
V2PostModelVersionEvaluationsRequest
{
"type": "object",
"title": "Evaluate this model vesion",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"evalMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiEvalMetrics"
},
"title": "EvalInfo and ID will be used when creating the evaluation"
}
}
}
V2PostModelVersionMetrics2Request
{
"type": "object",
"properties": {
"evalInfo": {
"$ref": "#/components/schemas/apiEvalInfo"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"testSearch": {
"$ref": "#/components/schemas/apiSearch"
}
},
"description": "Evaluate this model version."
}
V2PostModelVersionMetricsRequest
{
"type": "object",
"properties": {
"evalInfo": {
"$ref": "#/components/schemas/apiEvalInfo"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"testSearch": {
"$ref": "#/components/schemas/apiSearch"
}
},
"description": "Evaluate this model version."
}
V2PostModelVersions2Request
{
"type": "object",
"properties": {
"evalInfo": {
"$ref": "#/components/schemas/apiEvalInfo"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"description": {
"type": "string",
"title": "Description about this training run"
},
"modelVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersion"
}
}
},
"description": "Create (train) a new model version."
}
V2PostModelVersionsPublish2Request
{
"type": "object",
"title": "PostModelVersionsPublishRequest",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"publications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersionPublishRequest"
}
}
}
}
V2PostModelVersionsPublishRequest
{
"type": "object",
"title": "PostModelVersionsPublishRequest",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"publications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersionPublishRequest"
}
}
}
}
V2PostModelVersionsRequest
{
"type": "object",
"properties": {
"evalInfo": {
"$ref": "#/components/schemas/apiEvalInfo"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"description": {
"type": "string",
"title": "Description about this training run"
},
"modelVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersion"
}
}
},
"description": "Create (train) a new model version."
}
V2PostModelVersionsTrainingTimeEstimate2Request
{
"type": "object",
"title": "Get the estimated training time for a model version",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"modelVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersion"
}
},
"estimatedInputCount": {
"type": "string",
"format": "uint64"
}
}
}
V2PostModelVersionsTrainingTimeEstimateRequest
{
"type": "object",
"title": "Get the estimated training time for a model version",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"modelVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersion"
}
},
"estimatedInputCount": {
"type": "string",
"format": "uint64"
}
}
}
V2PostModelVersionsUnPublish2Request
{
"type": "object",
"title": "PostModelVersionsUnPublishRequest",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"publications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersionUnpublishRequest"
}
}
}
}
V2PostModelVersionsUnPublishRequest
{
"type": "object",
"title": "PostModelVersionsUnPublishRequest",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"publications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersionUnpublishRequest"
}
}
}
}
V2PostModelVersionsUploadResponse
{
"type": "object",
"title": "Stream result of apiPostModelVersionsUploadResponse",
"properties": {
"error": {
"$ref": "#/components/schemas/googlerpcStatus"
},
"result": {
"$ref": "#/components/schemas/apiPostModelVersionsUploadResponse"
}
}
}
V2PostModelsRequest
{
"type": "object",
"title": "PostModelsRequest",
"properties": {
"model": {
"$ref": "#/components/schemas/apiModel"
},
"models": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModel"
},
"description": "This allows you to create one or more model by posting it to the API."
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PostModelsSearchesRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"title": "Ids present in the url of the request.",
"description": "Ids present in the url of the request."
},
"modelQuery": {
"$ref": "#/components/schemas/apiModelQuery"
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
}
},
"description": "Search over the available models."
}
V2PostModuleVersionsRequest
{
"type": "object",
"title": "PostModuleVersionsRequest",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"moduleVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModuleVersion"
},
"description": "This allows you to create one or more module by posting it to the API."
}
}
}
V2PostModulesRequest
{
"type": "object",
"title": "PostModulesRequest",
"properties": {
"modules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModule"
},
"description": "This allows you to create one or more module by posting it to the API."
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PostRunnerItemOutputsRequest
{
"type": "object",
"title": "PostRunnerItemOutputsRequest",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"userAppId": {
"type": "object",
"properties": {
"appId": {
"type": "string"
}
},
"description": "Common message to identify the app in a url endpoint."
},
"runnerItemOutputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiRunnerItemOutput"
},
"description": "This allows you to create one or more runner by posting it to the API."
}
}
}
V2PostRunnersRequest
{
"type": "object",
"title": "PostRunnersRequest",
"properties": {
"runners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiRunner"
},
"description": "This allows you to create one or more runner by posting it to the API."
},
"userAppId": {
"type": "object",
"properties": {
"appId": {
"type": "string"
}
},
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PostSearchesById2Request
{
"type": "object",
"title": "PostSearchesByIDRequest performs returns results of a saved search given its ID",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
}
}
}
V2PostSearchesByIdRequest
{
"type": "object",
"title": "PostSearchesByIDRequest performs returns results of a saved search given its ID",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
}
}
}
V2PostSearchesRequest
{
"type": "object",
"title": "PostSearchesRequest",
"properties": {
"query": {
"$ref": "#/components/schemas/apiQuery"
},
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"title": "The searched to be executed or saved\nEventually the request level fields will be deprecated in favor of this object"
},
"userAppId": {
"type": "object",
"title": "The user_id and app_id to query from.",
"description": "The user_id and app_id to query from."
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
}
}
}
V2PostStatValuesAggregateRequest
{
"type": "object",
"title": "PostStatValuesAggregateRequest",
"properties": {
"userAppId": {
"type": "object",
"title": "Ids present in the url of the request.",
"description": "Ids present in the url of the request."
},
"statValueAggregateQueries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiStatValueAggregateQuery"
},
"description": "Query to retrieve aggregate values."
}
}
}
V2PostStatValuesRequest
{
"type": "object",
"title": "PostStatValuesRequest",
"properties": {
"userAppId": {
"type": "object",
"title": "The user and app information for the request.",
"description": "The user and app information for the request."
},
"statValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiStatValue"
},
"description": "The stats to post, can post more than one at a time."
}
}
}
V2PostTasksRequest
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTask"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to create Tasks."
}
V2PostTrendingMetricsViewRequest
{
"type": "object",
"title": "PostTrendingMetricsViewRequest",
"properties": {
"userAppId": {
"type": "object",
"title": "The user_id and app_id information.",
"description": "The user_id and app_id information."
}
}
}
V2PostUploadsRequest
{
"type": "object",
"title": "Start a multipart upload",
"properties": {
"uploads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiUpload"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PostValidatePasswordRequest
{
"type": "object",
"title": "PostValidatePasswordRequest",
"properties": {
"password": {
"$ref": "#/components/schemas/apiPassword"
},
"userAppId": {
"type": "object",
"properties": {
"appId": {
"type": "string"
}
},
"description": "Common message to identify the app in a url endpoint."
}
}
}
V2PostWorkflowResults2Request
{
"type": "object",
"title": "PostWorkflowResultsRequest",
"properties": {
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"versionId": {
"type": "string",
"title": "Workflow version ID to retrieve\nIf no ID is specified, latest workflow version is used"
},
"outputConfig": {
"$ref": "#/components/schemas/apiOutputConfig"
},
"workflowState": {
"$ref": "#/components/schemas/apiWorkflowState"
},
"favorClarifaiWorkflows": {
"type": "boolean",
"title": "Use this flag to look into clarifai published workflows first for a Workflow ID"
}
}
}
V2PostWorkflowResults3Request
{
"type": "object",
"title": "PostWorkflowResultsRequest",
"properties": {
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"versionId": {
"type": "string",
"title": "Workflow version ID to retrieve\nIf no ID is specified, latest workflow version is used"
},
"outputConfig": {
"$ref": "#/components/schemas/apiOutputConfig"
},
"workflowState": {
"$ref": "#/components/schemas/apiWorkflowState"
},
"favorClarifaiWorkflows": {
"type": "boolean",
"title": "Use this flag to look into clarifai published workflows first for a Workflow ID"
}
}
}
V2PostWorkflowResultsRequest
{
"type": "object",
"title": "PostWorkflowResultsRequest",
"properties": {
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
}
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"outputConfig": {
"$ref": "#/components/schemas/apiOutputConfig"
},
"workflowState": {
"$ref": "#/components/schemas/apiWorkflowState"
},
"favorClarifaiWorkflows": {
"type": "boolean",
"title": "Use this flag to look into clarifai published workflows first for a Workflow ID"
}
}
}
V2PostWorkflowResultsSimilarity2Request
{
"type": "object",
"title": "PostWorkflowResultsSimilarityRequest",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"versionId": {
"type": "string",
"title": "Workflow version ID to retrieve\nIf no ID is specified, latest workflow version is used"
},
"poolInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
},
"title": "Each pool input is compared against ever probe input"
},
"probeInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
},
"title": "Each probe is compared against every pool input"
},
"modelVersionId": {
"type": "string",
"title": "The specific model version whose outputs we are comparing"
},
"favorClarifaiWorkflows": {
"type": "boolean",
"title": "Use this flag to look into clarifai published workflows first for a Workflow ID"
}
}
}
V2PostWorkflowResultsSimilarity3Request
{
"type": "object",
"title": "PostWorkflowResultsSimilarityRequest",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"versionId": {
"type": "string",
"title": "Workflow version ID to retrieve\nIf no ID is specified, latest workflow version is used"
},
"poolInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
},
"title": "Each pool input is compared against ever probe input"
},
"probeInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
},
"title": "Each probe is compared against every pool input"
},
"modelVersionId": {
"type": "string",
"title": "The specific model version whose outputs we are comparing"
},
"favorClarifaiWorkflows": {
"type": "boolean",
"title": "Use this flag to look into clarifai published workflows first for a Workflow ID"
}
}
}
V2PostWorkflowResultsSimilarityRequest
{
"type": "object",
"title": "PostWorkflowResultsSimilarityRequest",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"poolInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
},
"title": "Each pool input is compared against ever probe input"
},
"probeInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
},
"title": "Each probe is compared against every pool input"
},
"modelVersionId": {
"type": "string",
"title": "The specific model version whose outputs we are comparing"
},
"favorClarifaiWorkflows": {
"type": "boolean",
"title": "Use this flag to look into clarifai published workflows first for a Workflow ID"
}
}
}
V2PostWorkflowVersionsPublish2Request
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"publications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowVersionPublishRequest"
}
}
}
}
V2PostWorkflowVersionsPublishRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"publications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowVersionPublishRequest"
}
}
}
}
V2PostWorkflowVersionsUnPublish2Request
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"publications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowVersionUnPublishRequest"
}
}
}
}
V2PostWorkflowVersionsUnPublishRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"publications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowVersionUnPublishRequest"
}
}
}
}
V2PostWorkflowsRequest
{
"type": "object",
"title": "PostWorkflowsRequest",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflow"
}
}
}
}
V2PutDatasetVersionExports2Request
{
"type": "object",
"properties": {
"exports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersionExport"
},
"description": "exports is the list of requested dataset version exports.\nOnly setting the 'format' field of the export is supported."
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to create exports of a dataset version."
}
V2PutDatasetVersionExportsRequest
{
"type": "object",
"properties": {
"exports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersionExport"
},
"description": "exports is the list of requested dataset version exports.\nOnly setting the 'format' field of the export is supported."
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
}
},
"description": "Request to create exports of a dataset version."
}
V2PutTaskAssignmentsRequest
{
"type": "object",
"title": "PutTaskAssignmentsRequest",
"properties": {
"action": {
"$ref": "#/components/schemas/apiPutTaskAssignmentsRequestAction"
},
"inputId": {
"type": "string",
"title": "Deprecated: use action and action_config instead.\nSupported for backwards compatibility: setting this field is equivalent with\n* action = LABEL_SUBMIT\n* label_submit_config = [{\"task_assignments\": {\"input\": {\"id\": <input-id>}}}]"
},
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"labelSubmitConfig": {
"$ref": "#/components/schemas/apiLabelSubmitConfig"
},
"reviewApproveConfig": {
"$ref": "#/components/schemas/apiReviewApproveConfig"
},
"reviewRequestChangesConfig": {
"$ref": "#/components/schemas/apiReviewRequestChangesConfig"
}
}
}
V2PutUploadContentPartsRequest
{
"type": "object",
"properties": {
"userAppId": {
"type": "object",
"description": "Common message to identify the app in a url endpoint."
},
"contentParts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiUploadContentPart"
}
}
},
"description": "Upload a part of a multipart upload.\nBehaviour on completion depends on the endpoint that was used to initiate the upload."
}
VisibilityGettable
{
"enum": [
"UNKNOWN_VISIBILITY",
"PRIVATE",
"ORG",
"PUBLIC"
],
"type": "string",
"default": "UNKNOWN_VISIBILITY",
"description": "Gettable defined the level of access for GET operations for this resource.\n\n - UNKNOWN_VISIBILITY: Default value not allowed.\n - PRIVATE: PRIVATE requires collaborator or team permissions in order to GET this resource.\n - ORG: ORG requires you to be in the same org in order to GET this resource, but don't have to be a\nteammate or collaborator.\n - PUBLIC: PUBLIC opens up GET access to the resource to any user on the platform even if they are not\na teammate or collaborator."
}
apiAPIPostModelOutputsCollectorSource
{
"type": "object",
"properties": {
"modelId": {
"type": "string",
"description": "The Model ID of the model we want to collect from."
},
"modelAppId": {
"type": "string",
"description": "The App ID of the model we want to collect from."
},
"modelUserId": {
"type": "string",
"description": "To define the model that we should collect from we need to specify the following 4 IDs:\nThe User ID of the model we want to collect from.\nThis is User B in the example."
},
"callerUserId": {
"type": "string",
"description": "This is a private field that defaults to the app owner for public users.\nIf this is left blank then this collector will collect from ALL users calling the given model."
},
"modelVersionId": {
"type": "string",
"description": "The Version ID of the model we want to collect from."
},
"postInputsKeyId": {
"type": "string",
"description": "This key is used to POST /inputs into your app by the collector. It can be an API key or a\nPAT. This needs the permissions that are needed for POST /inputs for the app_id this\nCollector is defined in."
}
},
"description": "This is configuration for using the inputs send for model prediction in our API as\nas the source for data."
}
apiAWSCreds
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"token": {
"type": "string"
},
"region": {
"type": "string"
},
"secret": {
"type": "string"
}
},
"description": "AWS S3 storage credentials."
}
apiAddConcepts
{
"type": "object",
"properties": {
"concepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
}
}
}
}
apiAddMetadata
{
"type": "object",
"properties": {
"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"
}
}
}
apiAddToDataset
{
"type": "object",
"properties": {
"datasetId": {
"type": "string"
}
}
}
apiAiAssistParameters
{
"type": "object",
"title": "AiAssistParameters",
"properties": {
"maxThreshold": {
"type": "number",
"format": "float"
},
"minThreshold": {
"type": "number",
"title": "Min and max threshold values for approving annotations by default based on prediction score",
"format": "float"
},
"conceptRelationIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "ids of concept relations. Used in AI assist workflow"
}
}
}
apiAnd
{
"type": "object",
"properties": {
"input": {
"$ref": "#/components/schemas/apiInput"
},
"negate": {
"type": "boolean",
"title": "If True then this will flip the meaning of this part of the\nquery. This allow for queries such as dog AND ! metadata=={\"blah\":\"value\"}"
},
"output": {
"$ref": "#/components/schemas/apiOutput"
},
"annotation": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
}
},
"description": "This is the common building block of a query which is a sequence of And messages ANDed together.\nNote that some fields are used too RANK results (affect the scores) and some are used to FILTER\nresults (unordered subset of your app's contents). In general, FILTER operations are more\nefficient queries at scale and when combined with RANK operations can speed up search performance\nas you effectively operate on a smaller sub-set of your entire app."
}
apiAnnotationFilter
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "The ID for the annotation filter"
},
"appId": {
"type": "string",
"description": "The app the annotation filter belongs to."
},
"search": {
"$ref": "#/components/schemas/apiSearch"
},
"userId": {
"type": "string",
"description": "The user the annotation filter belongs to."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the annotation filter was created.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the annotation filter was modified.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
}
},
"description": "AnnotationFilter is used to create a new dataset version.\nFor now, the filter is simply a wrapper over a Search.\nIn the future, we may add extra fields to customize the filtering."
}
apiAnnotationFilterConfig
{
"type": "object",
"properties": {
"annotationFilter": {
"$ref": "#/components/schemas/apiAnnotationFilter"
},
"ignoreEmptyInputs": {
"type": "boolean",
"description": "If true, empty inputs are not included in the dataset version.\nIf false, empty inputs are included in the dataset version.\nWe define an empty input as an input without any annotations after annotation filter is applied."
}
}
}
apiAnnotationSearchMetrics
{
"type": "object",
"title": "AnnotationSearchMetrics",
"properties": {
"data": {
"$ref": "#/components/schemas/apiData"
},
"metrics": {
"$ref": "#/components/schemas/apiEvalMetrics"
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"groundTruth": {
"$ref": "#/components/schemas/apiSearch"
},
"searchToEval": {
"$ref": "#/components/schemas/apiSearch"
},
"activeConceptCount": {
"type": "integer",
"title": "active_concept_count is the number of concepts for this evaluation",
"format": "int64"
}
}
}
apiApp
{
"type": "object",
"title": "Application with tasks and datasets",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"image": {
"$ref": "#/components/schemas/apiImage"
},
"notes": {
"type": "string",
"description": "Notes for the application\nThis field should be used for in-depth notes and supports up to 64Kbs."
},
"userId": {
"type": "string",
"title": "why is user_id present here when this message type is used in PostApps but completely ignored there? PostApp already\nspecifies the userid in path but doesn't even actually use neither of userids, it instead used the id from auth context.\nThis creates a lot of ambiguity, should always have different message types for Post/Get endpoints so that the minimum interface for each op can be described"
},
"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"
},
"sampleMs": {
"type": "integer",
"title": "Default value for model predictions on video: Sample delay for video predicting (1 frame per N milliseconds)",
"format": "int64"
},
"createdAt": {
"type": "string",
"title": "When the app was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
},
"extraInfo": {
"$ref": "#/components/schemas/apiAppExtraInfo"
},
"isStarred": {
"type": "boolean",
"title": "Is starred by the requesting user (only showed on get/list requests)\nPlease use PostAppStars/DeleteAppStars endpoints to star/unstar an app"
},
"starCount": {
"type": "integer",
"title": "How many users have starred the app (only showed on get/list requests)\nComputed value, not editable",
"format": "int32"
},
"dataTierId": {
"type": "string",
"description": "data tier id this app is using."
},
"isTemplate": {
"type": "boolean",
"description": "An app marked as a template can be duplicated by any user that can see it,\nincluding all visible resources within it."
},
"modifiedAt": {
"type": "string",
"title": "When the app was last modified",
"format": "date-time"
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"description": {
"type": "string",
"description": "short description about the app."
},
"defaultLanguage": {
"type": "string"
},
"defaultWorkflow": {
"$ref": "#/components/schemas/apiWorkflow"
},
"defaultWorkflowId": {
"type": "string",
"title": "Default workflow id deprecated in favor of default_workflow"
},
"legalConsentStatus": {
"type": "integer",
"title": "if user accept legal consent for face recognition",
"format": "int64"
}
}
}
apiAppCopyProgress
{
"type": "object",
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "integer",
"format": "int32"
}
}
}
apiAppDuplication
{
"type": "object",
"title": "AppDuplication",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier of an app duplication job."
},
"filter": {
"$ref": "#/components/schemas/apiAppDuplicationFilters"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"newAppId": {
"type": "string",
"description": "The ID to use when creating a new application.\nYou cannot set this field when copying into an existing app, i.e., when existing_app_is is set.\n\nIf not provided, then it will be generated automatically.\n\nDeprecated: Use destination_app.id with a new ID instead."
},
"progress": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAppCopyProgress"
},
"title": "Copy progress for each resource type requested by the filter. Possible fields:\n - inputs\n - concepts\n - annotations\n - models\n - workflows\n - installed_module_versions"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "The time when the app duplication job was created."
},
"newAppName": {
"type": "string",
"description": "The name to use when creating a new application.\nYou cannot set this field when copying into an existing app, i.e., when existing_app_is is set.\n\nIf not provided, then the ID of the new application is also used as the name.\n\nDeprecated: Application names are deprecated, use application IDs instead."
},
"existingAppId": {
"type": "string",
"description": "The ID of an existing app you want to copy data into.\n\nIf not provided, then we will create a new application as the destination instead.\nThe various new_app_* fields can be used to set fields of this new application.\n\nDeprecated: Use destination_app.id with an existing ID instead."
},
"destinationApp": {
"$ref": "#/components/schemas/apiApp"
},
"lastModifiedAt": {
"type": "string",
"format": "date-time",
"description": "The last time when the app duplication job status was updated."
}
}
}
apiAppDuplicationFilters
{
"type": "object",
"title": "AppDuplicationFilters",
"properties": {
"copyInputs": {
"type": "boolean",
"description": "Copy inputs. Requires that copy_concepts is also set.\nNote that this will still copy input-level annotations even if copy_annotations is not set."
},
"copyModels": {
"type": "boolean",
"description": "Copy models. Requires that copy_concepts is also set."
},
"copyConcepts": {
"type": "boolean",
"description": "Copy concepts."
},
"copyWorkflows": {
"type": "boolean",
"description": "Copy workflows. Requires that copy_models and copy_concepts are also set."
},
"copyAnnotations": {
"type": "boolean",
"description": "Copy annotations. Requires that copy_inputs and copy_concepts are also set."
},
"copyInstalledModuleVersions": {
"type": "boolean",
"description": "Copy installed module versions."
}
}
}
apiAppExtraInfo
{
"type": "object",
"properties": {
"searchRevisionMarker": {
"type": "string",
"title": "Revision marker for this application.\nThe value of the revision changes when\n* inputs are added, updated or deleted\n* annotations are added, updated or deleted\n* inputs are added to or removed from datasets\nFor example, this value can be used to detect if client side caches related to searching should be invalidated.\nField not filled in for list endpoints, use GetApp"
}
}
}
apiAppQuery
{
"type": "object",
"title": "App query",
"properties": {
"name": {
"type": "string",
"description": "Query by application name. This supports wildcard queries like \"gen*\" to match \"general\" as an example."
}
}
}
apiAudio
{
"type": "object",
"title": "Audio asset struct",
"properties": {
"url": {
"type": "string",
"description": "This is a URL to a publicly accessible image file. The platform will download this file server\nside and then process."
},
"base64": {
"type": "string",
"format": "byte",
"description": "The base64 field is using image file bytes directly in the request.\nNOTE: if you're sending a json request, then this MUST be base64 encoded before sending (hence\nthe name here).\nWhen using our grpc clients, you DO NOT need to base64 encode\nit yourself since the clients know how to do this for you automatically and will avoid the\nbase64 encoding if they send a binary request."
},
"hosted": {
"$ref": "#/components/schemas/apiHostedURL"
},
"audioInfo": {
"$ref": "#/components/schemas/apiAudioInfo"
},
"allowDuplicateUrl": {
"type": "boolean",
"description": "If True then you will be allowed to have multiple urls."
}
}
}
apiAudioInfo
{
"type": "object",
"properties": {
"bitRate": {
"type": "integer",
"title": "audio track bit rate",
"format": "int32"
},
"sampleRate": {
"type": "integer",
"title": "sample rate",
"format": "int32"
},
"audioFormat": {
"type": "string",
"title": "audio format"
},
"durationSeconds": {
"type": "number",
"title": "audio track duration in seconds",
"format": "float"
}
}
}
apiAutoscaleConfig
{
"type": "object",
"properties": {
"maxReplicas": {
"type": "integer",
"format": "int64",
"description": "The maximium number of replicas to scale up the runner to."
},
"minReplicas": {
"type": "integer",
"format": "int64",
"description": "The minimum number of replicas for the runner to have.\nDefaults to 0 which means autoscaling can scale down to zero.\nIf you want a replica always up then set to >= 1."
},
"enablePacking": {
"type": "boolean",
"description": "Depending on your plan you may be able to enable packing of resources into a single node\nfor more compute and cost efficiency."
},
"scaleUpDelaySeconds": {
"type": "integer",
"format": "int64",
"description": "The time to wait between scaling up replicas without burst traffic."
},
"scaleDownDelaySeconds": {
"type": "integer",
"format": "int64",
"description": "The time to wait before scaling down after the last request."
},
"trafficHistorySeconds": {
"type": "integer",
"format": "int64",
"description": "The number of seconds of traffic history to consider when autoscaling."
}
},
"description": "It might be better to do this as runner autoscaling so that resources\nof a model are very simply what that model needs at minimum.\nNote that resources for things like modes inside runners are not\nrelated to how many replicas of those runners are needed to handle traffic."
}
apiAzureBlobCreds
{
"type": "object",
"properties": {
"accountKey": {
"type": "string"
},
"accountName": {
"type": "string"
}
},
"description": "Azure Blob storage credentials."
}
apiBinaryMetrics
{
"type": "object",
"title": "BinaryMetrics",
"properties": {
"f1": {
"type": "number",
"format": "float"
},
"iou": {
"type": "number",
"format": "float"
},
"numNeg": {
"type": "integer",
"format": "int64"
},
"numPos": {
"type": "integer",
"format": "int64"
},
"numTot": {
"type": "integer",
"format": "int64"
},
"rocAuc": {
"type": "number",
"format": "float"
},
"areaMax": {
"type": "number",
"format": "double"
},
"areaMin": {
"type": "number",
"format": "double"
},
"concept": {
"$ref": "#/components/schemas/apiConcept"
},
"areaName": {
"type": "string"
},
"rocCurve": {
"$ref": "#/components/schemas/apiROC"
},
"avgPrecision": {
"type": "number",
"format": "float"
},
"precisionRecallCurve": {
"$ref": "#/components/schemas/apiPrecisionRecallCurve"
}
}
}
apiBookmarkOrigin
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "original resource id"
},
"appId": {
"type": "string",
"title": "original resource app id"
},
"userId": {
"type": "string",
"title": "original resource user id"
},
"resourceType": {
"$ref": "#/components/schemas/BookmarkOriginBookmarkType"
}
}
}
apiBoundingBox
{
"type": "object",
"properties": {
"topRow": {
"type": "number",
"title": "The top left of the bounding box normalized to the data dimension to be within [0-1.0]",
"format": "float"
},
"leftCol": {
"type": "number",
"title": "The left column of the bounding box normalized to the data dimension to be within [0-1.0]",
"format": "float"
},
"rightCol": {
"type": "number",
"title": "The right col of the bounding box normalized to the data dimension to be within [0-1.0]",
"format": "float"
},
"bottomRow": {
"type": "number",
"title": "The bottom row of the bounding box normalized to the data dimension to be within [0-1.0]",
"format": "float"
}
},
"description": "Rectangular bounding box for a region."
}
apiBuildInfo
{
"type": "object",
"properties": {
"dockerImageTag": {
"type": "string",
"title": "Docker image tag"
},
"dockerImageName": {
"type": "string",
"title": "Docker image name"
},
"dockerImageDigest": {
"type": "string",
"title": "Docker image digest"
}
}
}
apiBulkOperation
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "id of the Bulk Operation task"
},
"appId": {
"type": "string",
"title": "Application ID that this Operation was created from"
},
"search": {
"$ref": "#/components/schemas/apiSearch"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"dataset": {
"$ref": "#/components/schemas/apiDataset"
},
"inputIds": {
"$ref": "#/components/schemas/apiInputIDs"
},
"progress": {
"$ref": "#/components/schemas/apiProgress"
},
"createdAt": {
"type": "string",
"title": "When the operation was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
},
"createdBy": {
"type": "string",
"title": "User id that created this operation"
},
"operation": {
"$ref": "#/components/schemas/apiOperation"
},
"lastModifiedAt": {
"type": "string",
"title": "Last time the status got updated",
"format": "date-time"
}
}
}
apiCancelBulkOperationRequest
{
"type": "object",
"title": "Cancel a list of bulk operation ids",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "List of bulk operation ids to be cancelled"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiCancelInputsExtractionJobsRequest
{
"type": "object",
"title": "Cancel a list of extraction job ids",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "List of extraction job ids to be cancelled"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiCloudRegion
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"cloud": {
"$ref": "#/components/schemas/CloudRegionCloud"
},
"region": {
"type": "string",
"description": "The region. The naming here depends on the cloud choice above and will be validated\nagainst which clouds+regions that Clarifai currently supports."
}
},
"description": "We define a cloud region here to be used in Nodepools and by the cloud agent.\nThere will be one cloud agent per CloudRegion.\nThis allows us to define CloudRegions that are VPCs within one physical cloud and have that\nmanaged by one cloud agent which can list all nodepools for that VPC to deploy them and\norchestrate work within them."
}
apiCluster
{
"type": "object",
"title": "Cluster data",
"properties": {
"id": {
"type": "string"
},
"hits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiHit"
},
"title": "Representative hits for cluster (for now we only return 1)"
},
"count": {
"type": "integer",
"title": "Number of annotations tied to the cluster in the app",
"format": "int64"
},
"score": {
"type": "number",
"format": "float",
"description": "The score assigned to this cluster.\nFor List Clusters endpoint, this represents percentage of inputs in the app assigned to this cluster."
},
"projection": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
}
}
}
apiCollaboration
{
"type": "object",
"properties": {
"app": {
"$ref": "#/components/schemas/apiApp"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"title": "the low-level scope users are shared with for this collaboration"
},
"appOwner": {
"$ref": "#/components/schemas/apiUser"
},
"createdAt": {
"type": "string",
"title": "when is the collaboration created",
"format": "date-time"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
},
"title": "the endpoint-level scopes users are shared with for this collaboration"
}
},
"description": "collaboration includes an app you're invited to work on."
}
apiCollaborator
{
"type": "object",
"title": "Collaborator - invited user, who shares an access to an application",
"properties": {
"id": {
"type": "string",
"title": "id of this collaborator"
},
"app": {
"$ref": "#/components/schemas/apiApp"
},
"user": {
"$ref": "#/components/schemas/apiUser"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"title": "the permission this collaborator"
},
"createdAt": {
"type": "string",
"title": "When the app was shared with. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
},
"deletedAt": {
"type": "string",
"format": "date-time",
"description": "When the collaborator was removed from app."
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
}
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the collaborator was updated."
}
}
}
apiCollector
{
"type": "object",
"title": "Collector is a data pathway from a CollectorSource to an app to collect data automatically.\nFor example, a CollectorSource",
"properties": {
"id": {
"type": "string",
"description": "Unique ID for the collector."
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"createdAt": {
"type": "string",
"title": "When the collector is created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
},
"description": {
"type": "string",
"description": "Human readable description for the collector."
},
"collectOutputs": {
"type": "boolean",
"description": "Whether to collect outputs or not. Default is false. If selected, outputs from the\noriginal model predict call will be posted as annotations along with the input with success status."
},
"collectorSource": {
"$ref": "#/components/schemas/apiCollectorSource"
},
"preQueueWorkflowId": {
"type": "string",
"description": "This is a workflow to run inline in model predict calls. It should ONLY have very fast and\nlight-weight models in it as it will effect the speed of the predictions being made.\nThis workflow's purpose is to filter down the inputs to queue for the collector to process.\nThe input to this workflow is going to be the OUTPUT of the model, not the input to the model\nsince we want to encourage having fast workflows that can also take advantage of the model\noutputs to make deciions (for example: thresholding based on concepts). If the workflow\noutput has any field that is non-empty then the input will be queued for the collector\nto process with the post_queue_workflow_id.\n\nAs a simpler alternative, pre_queue_random_sample can be set to just use random sampling instead."
},
"postQueueWorkflowId": {
"type": "string",
"description": "A workflow to run to after the collector is processing the queued input. This workflow\nuses the original input to the model as input to the workflow so that you can run additional\nmodels as well on that input to decide whether to queue the model or not. If the workflow\noutput has any field that is non-empty then it will be passed on to POST /inputs to\nthe destination app."
},
"preQueueRandomSample": {
"type": "number",
"format": "float",
"description": "Instead of needing to create a new workflow for pre_queue_workflow_id, if just random sampling\nof the model inputs is required, then pre_queue_random_sample can be set to a value from (0-1]\nto denote the fraction of inputs to collect."
}
}
}
apiCollectorSource
{
"type": "object",
"properties": {
"apiPostModelOutputsCollectorSource": {
"$ref": "#/components/schemas/apiAPIPostModelOutputsCollectorSource"
}
},
"description": "Configuration for the source to collect data from.\nOnly one of the fields can be present at a time.\n\nThe ID of the source in case we want to implment /collectors/{collector_id}/sources\n string id = 1;"
}
apiColor
{
"type": "object",
"title": "Color data",
"properties": {
"w3c": {
"$ref": "#/components/schemas/apiW3C"
},
"value": {
"type": "number",
"format": "float"
},
"rawHex": {
"type": "string"
}
}
}
apiComputeInfo
{
"type": "object",
"properties": {
"numCpus": {
"type": "integer",
"format": "int64",
"description": "Number of CPUs."
},
"cpuMemory": {
"type": "string",
"description": "Amount of CPU memory to use as a minimum."
},
"acceleratorType": {
"type": "array",
"items": {
"type": "string"
},
"description": "Or should it be removed completely and use the nodepool accelerator type itself.\nThese are the supported accelerators that the model can run on."
},
"numAccelerators": {
"type": "integer",
"format": "int64",
"description": "Number of accelerators (typically GPUs, TPUs, etc. not CPUs) for this resource."
},
"acceleratorMemory": {
"type": "string",
"description": "Amount of accelerator/GPU memory to use as a minimum.\nThis is defined per accelerator.\nThis follows the format used by kubernetes like 1Ki, 2Mi, 3Gi, 4Ti.\n\nThe supported accelerators that the resource can run on. If the resource requires a specific\n accelerator type then it will only be scheduled on nodes that have that type of accelerator.\n If there is no hard requirements beyond the number of accelerators and their memory then this\n field can be left empty.\n This setting will cause an error if num_accelerators == 0"
}
},
"description": "These are the resource needs of a given API object such as a model.\nThis is what they require as a minimum to run and will be used upon scheduling\nas the request and limit for the k8s pod. If we want to separate limits and requests in the\nfuture we can allow setting a limits ComputeInfo and a requests ComputeInfo."
}
apiConcept
{
"type": "object",
"title": "Concept or tag",
"properties": {
"id": {
"type": "string",
"description": "The concept's unique id."
},
"name": {
"type": "string",
"description": "The name of the concept in the given language."
},
"appId": {
"type": "string",
"description": "The application id that this concept is within. This can be ignored by most users."
},
"value": {
"type": "number",
"format": "float",
"description": "Used to indicate presence (1.0) or not (0.0) of this concept when making a request.\nThis is also the prediction probability when returning predictions from our API.\nFor convenience we use the default of 1.0 when making requests so the concept you provide is\nis treated as a positive (1.0) and not a negative (which would be value == 0.0)."
},
"userId": {
"type": "string",
"description": "The user the concept belongs to."
},
"vocabId": {
"type": "string",
"description": "The vocabulary that this concept belongs to. This is useful if you have different unique sets\nof concepts that you can separate out based on this field. For example \"age_appearance\" vs\n\"gender_appearance\" in a list of concept returned from the demographics model."
},
"language": {
"type": "string",
"description": "The language in which the concept name is in. This is *ONLY* used in the response and setting\nit in a request is ignored since the default language of your app is used when creating\nor patching a Concept. To set other languages for your concept use the ConceptLanguage object\nand its corresponding endpoints."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the concept was created. The format is https://www.ietf.org/rfc/rfc3339.txt .\nExample: \"2006-01-02T15:04:05.999999Z\". This field is used only in a response."
},
"extraInfo": {
"$ref": "#/components/schemas/apiConceptExtraInfo"
},
"definition": {
"type": "string",
"description": "The definition for the concept. Similar to name. This can be ignored by most users."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"keypointInfo": {
"$ref": "#/components/schemas/apiKeypointInfo"
}
}
}
apiConceptCount
{
"type": "object",
"title": "ConceptCount",
"properties": {
"id": {
"type": "string",
"description": "The concept's unique id."
},
"name": {
"type": "string",
"description": "The name of the concept."
},
"conceptTypeCount": {
"$ref": "#/components/schemas/apiConceptTypeCount"
},
"detailConceptCount": {
"$ref": "#/components/schemas/apiDetailConceptCount"
}
}
}
apiConceptExtraInfo
{
"type": "object",
"properties": {
"isRankable": {
"type": "boolean",
"description": "Whether this concept is rankable based on ConceptExtraInfoRequest configuration."
}
},
"description": "ConceptExtraInfo represents extra information related to a concept that is context-dependent.\nIt is only set when requested in ConceptExtraInfoRequest."
}
apiConceptExtraInfoRequest
{
"type": "object",
"properties": {
"rankableModel": {
"$ref": "#/components/schemas/apiModel"
}
}
}
apiConceptLanguage
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "This is the language code for the language such as \"en\"."
},
"name": {
"type": "string",
"description": "The type of the outside source."
},
"definition": {
"type": "string",
"description": "The ID that is referenced in the source."
}
},
"description": "This represents a link to an outside source for the given concept.\nThe values from here are sticked into Concept message into the name and definition fields when\nreturning from the API in your default language. The \"id\" field here becomes the \"language\"\nfield of the Concept message which is a little weird."
}
apiConceptMappingJob
{
"type": "object",
"title": "ConceptMappingJob",
"properties": {
"conceptIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "The ids of the concepts being mapped"
},
"knowledgeGraphId": {
"type": "string",
"title": "The id of the knowledge graph being used for this concept mapping job"
}
}
}
apiConceptQuery
{
"type": "object",
"title": "ConceptQuery",
"properties": {
"name": {
"type": "string",
"description": "The name of the concept to search."
},
"language": {
"type": "string",
"description": "The language of the concept name in a search. Defaults to English."
},
"useCases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowModelUseCase"
},
"description": "The concepts must belong to workflow models with specified use cases.\nMultiple values are joined using an OR condition."
},
"workflowId": {
"type": "string",
"description": "The id of workflow. If no id is provided, then application base workflow is used."
}
}
}
apiConceptRelation
{
"type": "object",
"title": "This represents a relation (i.e. edge) between the subject concept and the object concept",
"properties": {
"id": {
"type": "string",
"title": "ID of the concept relation"
},
"predicate": {
"type": "string",
"description": "The predicate (i.e. edge) linking the subject and the object\nBoth subject_concept and object_concept are concepts.\nThe predicate is the type of relationship.\nThat predicate acts on the subject.\n\nThere are three current types of predicates:\n1) \"hyponym\"\n2) \"hypernym\"\n3) \"synonym\"\n\n1) For example, 'hyponym' is a type of predicate which represents 'is_a_kind_of' relation so\nthe following relationship:\n'honey' (subject), 'hyponym' (predicate), 'food' (object)\nCan more easily be read as:\n'honey' 'is a kind of' 'food'\n\n\n2) The 'hypernym' relation is the opposite of 'hyponym' and when you add one of the\nrelationships the opposite will automatically appear for you in queries.\n\nThe 'hypernym' can be read as 'is a parent of' so:\n'food' (subject), 'hypernym' (predicate), 'honey' (object)\nCan more easily be read as:\n'food' is a parent of 'honey'\n\n3) The 'synonym' relation defines two concepts that essential mean the same thing. This\nis more like a \"is\" relationship. So for example a 'synonym' relationship could be:\n\"puppy\" is \"pup\"\nThe reverse is also true once the former is added so:\n\"pup\" is \"puppy\"\nwill appear in queries as well."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"objectConcept": {
"$ref": "#/components/schemas/apiConcept"
},
"subjectConcept": {
"$ref": "#/components/schemas/apiConcept"
},
"knowledgeGraphId": {
"type": "string",
"description": "The knowledge graph id that this edge belongs to. If using the app's global knowledge graph\nand not a specific one then this should be the empty string \"\"."
}
}
}
apiConceptTypeCount
{
"type": "object",
"title": "ConceptTypeCount",
"properties": {
"negative": {
"type": "integer",
"format": "int64",
"description": "The number of inputs that have a concept with a value of 0.0 (indicating absence of the\nconcept in an input)."
},
"positive": {
"type": "integer",
"format": "int64",
"description": "The number of inputs that have a concept with a value of 1.0 (indicating presence of the\nconcept in an input)."
}
}
}
apiConfusionMatrix
{
"type": "object",
"title": "ConfusionMatrix",
"properties": {
"matrix": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConfusionMatrixEntry"
}
},
"conceptIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "These concept_ids are ordered by the strength of the diagonal in the ConfusionMatrix."
}
}
}
apiConfusionMatrixEntry
{
"type": "object",
"title": "ConfusionMatrixEntry",
"properties": {
"value": {
"type": "number",
"format": "float"
},
"actual": {
"type": "string"
},
"predicted": {
"type": "string"
},
"actualConcept": {
"$ref": "#/components/schemas/apiConcept"
},
"predictedConcept": {
"$ref": "#/components/schemas/apiConcept"
}
}
}
apiCooccurrenceMatrix
{
"type": "object",
"title": "CooccurrenceMatrix",
"properties": {
"matrix": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCooccurrenceMatrixEntry"
}
},
"conceptIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "These concept_ids are ordered by the strength of the diagonal in the ConfusionMatrix."
}
}
}
apiCooccurrenceMatrixEntry
{
"type": "object",
"title": "NOTE: this is inefficient, should just have the order of the rows/cols",
"properties": {
"col": {
"type": "string",
"title": "concept_id for the col"
},
"row": {
"type": "string",
"title": "concept_id for the row"
},
"count": {
"type": "integer",
"format": "int64"
}
}
}
apiData
{
"type": "object",
"title": "Data",
"properties": {
"geo": {
"$ref": "#/components/schemas/apiGeo"
},
"hits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiHit"
},
"title": "Holds score, rank, and user, app, input IDs and search hit data"
},
"text": {
"$ref": "#/components/schemas/apiText"
},
"audio": {
"$ref": "#/components/schemas/apiAudio"
},
"image": {
"$ref": "#/components/schemas/apiImage"
},
"video": {
"$ref": "#/components/schemas/apiVideo"
},
"colors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiColor"
},
"description": "The dominant colors within an image."
},
"frames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiFrame"
},
"description": "For temporal content like video."
},
"tracks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTrack"
},
"description": "Track information."
},
"regions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiRegion"
},
"description": "For recursing into localized regions of an input."
},
"clusters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCluster"
},
"description": "Clustering centroids for inputs."
},
"concepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
},
"description": "A list of concepts."
},
"heatmaps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiImage"
},
"title": "Heatmap as 2d image"
},
"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"
},
"embeddings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiEmbedding"
},
"description": "Embedding vectors representing each input."
},
"timeSegments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTimeSegment"
},
"description": "Time segments information."
}
}
}
apiDataSourceCredentials
{
"type": "object",
"properties": {
"s3Creds": {
"$ref": "#/components/schemas/apiAWSCreds"
},
"gcpCreds": {
"type": "string",
"format": "byte",
"description": "GCP Cloud Storage uses service account key data(creds.json) as Byte array for authentication."
},
"azureBlobCreds": {
"$ref": "#/components/schemas/apiAzureBlobCreds"
}
}
}
apiDataSourceURL
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Supported providers are AWS S3, Azure blob, GCP cloud storage."
},
"credentials": {
"$ref": "#/components/schemas/apiDataSourceCredentials"
}
}
}
apiDataType
{
"enum": [
"UNDEFINED",
"STRING",
"UINT8",
"INT32",
"INT64",
"FP32"
],
"type": "string",
"title": "- UNDEFINED: Default value, should not be used",
"default": "UNDEFINED"
}
apiDataset
{
"type": "object",
"title": "Dataset",
"properties": {
"id": {
"type": "string",
"title": "The ID for the dataset"
},
"appId": {
"type": "string",
"description": "The app the dataset belongs to."
},
"image": {
"$ref": "#/components/schemas/apiImage"
},
"notes": {
"type": "string",
"description": "Notes for the dataset\nThis field should be used for in-depth notes and supports up to 64Kbs."
},
"userId": {
"type": "string",
"description": "The user the dataset belongs to."
},
"version": {
"$ref": "#/components/schemas/apiDatasetVersion"
},
"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"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the dataset was created.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"isStarred": {
"type": "boolean",
"description": "Whether the dataset is starred by the requesting user."
},
"starCount": {
"type": "integer",
"format": "int32",
"description": "Number of users that starred this dataset."
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the dataset was modified.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"description": {
"type": "string",
"title": "Description of the dataset"
},
"bookmarkOrigin": {
"$ref": "#/components/schemas/apiBookmarkOrigin"
},
"defaultProcessingInfo": {
"$ref": "#/components/schemas/apiDatasetVersionProcessingInfo"
},
"defaultAnnotationFilter": {
"$ref": "#/components/schemas/apiAnnotationFilter"
}
}
}
apiDatasetInput
{
"type": "object",
"title": "DatasetInput",
"properties": {
"input": {
"$ref": "#/components/schemas/apiInput"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the input was added to the dataset.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
}
}
}
apiDatasetSplit
{
"type": "object",
"properties": {
"dataset": {
"$ref": "#/components/schemas/apiDataset"
},
"percentage": {
"type": "integer",
"title": "For RANDOM_PERCENTAGE_SPLIT.\nValues from (0,100]",
"format": "int64"
}
}
}
apiDatasetVersion
{
"type": "object",
"title": "DatasetVersion",
"properties": {
"id": {
"type": "string",
"title": "The ID for the dataset version"
},
"appId": {
"type": "string",
"description": "The app the dataset version belongs to."
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"userId": {
"type": "string",
"description": "The user the dataset version belongs to."
},
"metrics": {
"type": "object",
"title": "Dataset version metrics",
"additionalProperties": {
"$ref": "#/components/schemas/apiDatasetVersionMetrics"
}
},
"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"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the dataset version was created.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"datasetId": {
"type": "string",
"description": "The dataset the dataset version belongs to."
},
"exportInfo": {
"$ref": "#/components/schemas/apiDatasetVersionExportInfo"
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the dataset version was modified.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"description": {
"type": "string",
"title": "Description of the dataset version"
},
"processingInfo": {
"$ref": "#/components/schemas/apiDatasetVersionProcessingInfo"
},
"modelPredictConfig": {
"$ref": "#/components/schemas/apiModelPredictConfig"
},
"embedModelVersionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The embedding models to return embeddings for. If empty, no embeddings are returned."
},
"annotationFilterConfig": {
"$ref": "#/components/schemas/apiAnnotationFilterConfig"
}
}
}
apiDatasetVersionExport
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url is the URL from where the dataset version export can be downloaded."
},
"size": {
"type": "string",
"format": "uint64",
"description": "size is the size of the dataset version export in number of bytes."
},
"format": {
"$ref": "#/components/schemas/apiDatasetVersionExportFormat"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"includeEmbeddings": {
"type": "boolean",
"description": "whether to include embeddings in the export or not."
}
},
"description": "DatasetVersionExport contains metadata for a single dataset version export."
}
apiDatasetVersionExportFormat
{
"enum": [
"DATASET_VERSION_EXPORT_FORMAT_NOT_SET",
"CLARIFAI_DATA_PROTOBUF",
"CLARIFAI_DATA_JSON",
"COCO"
],
"type": "string",
"default": "DATASET_VERSION_EXPORT_FORMAT_NOT_SET",
"description": " - CLARIFAI_DATA_PROTOBUF: CLARIFAI_DATA_PROTOBUF is the proprietary Clarifai API Data format. It\nis a ZIP-archive containing batches of serialized InputBatch protobuf messages.\n\nNote that only the \"id\" and \"data\" fields of exported inputs are set.\n - CLARIFAI_DATA_JSON: CLARIFAI_DATA_JSON is the proprietary Clarifai API Data format in JSON. It\nis a ZIP-archive containing batches of serialized InputBatch JSON messages.\n\nNote that only the \"id\" and \"data\" fields of exported inputs are set.\n - COCO: COCO is the data format used by Common Objects in Context. It is a\nZIP-archive containing JSON files with the dataset version annotations.\nSee https://cocodataset.org/#format-data."
}
apiDatasetVersionExportInfo
{
"type": "object",
"properties": {
"coco": {
"$ref": "#/components/schemas/apiDatasetVersionExport"
},
"clarifaiDataJson": {
"$ref": "#/components/schemas/apiDatasetVersionExport"
},
"clarifaiDataProtobuf": {
"$ref": "#/components/schemas/apiDatasetVersionExport"
}
},
"description": "DatasetVersionExportInfo contains information about all exports of a dataset version.\n\nIf the dataset version has not been exported in a format, then the DatasetVersionExport\nfield for that format is empty instead of having a \"not exported\" status."
}
apiDatasetVersionMetrics
{
"type": "object",
"properties": {
"masksCount": {
"type": "string",
"title": "Number of masks",
"format": "uint64"
},
"framesCount": {
"type": "string",
"title": "Number of frames",
"format": "uint64"
},
"inputsCount": {
"type": "string",
"title": "Number of inputs",
"format": "uint64"
},
"pointsCount": {
"type": "string",
"title": "Number of points",
"format": "uint64"
},
"regionsCount": {
"type": "string",
"title": "Number of regions",
"format": "uint64"
},
"polygonsCount": {
"type": "string",
"title": "Number of polygons",
"format": "uint64"
},
"embeddingsCount": {
"type": "string",
"title": "Number of embeddings",
"format": "uint64"
},
"frameInputsCount": {
"type": "string",
"title": "Number of inputs that have frames attached",
"format": "uint64"
},
"regionFramesCount": {
"type": "string",
"title": "Number of frames that have regions attached",
"format": "uint64"
},
"regionInputsCount": {
"type": "string",
"format": "uint64",
"description": "Number of inputs that have regions attached\nNote that this is not a recursive count: if an input contains frames that contains regions, then the region_frames_count is increased, but region_inputs_count is not increased."
},
"boundingBoxesCount": {
"type": "string",
"title": "Number of bounding boxes",
"format": "uint64"
},
"inputsWithGeoCount": {
"type": "string",
"title": "Number of inputs that have geo information",
"format": "uint64"
},
"regionLocationMatrix": {
"$ref": "#/components/schemas/MatrixUint64"
},
"unlabeledInputsCount": {
"type": "string",
"format": "uint64",
"description": "Number of unlabeled inputs\nAn input is considered unlabeled if it there are no annotations with positive labels for that input."
},
"positiveFrameTagsCount": {
"type": "string",
"title": "Number of positive tags added at frame-level",
"format": "uint64"
},
"positiveInputTagsCount": {
"type": "string",
"title": "Number of positive tags added at input-level",
"format": "uint64"
},
"inputsWithMetadataCount": {
"type": "string",
"title": "Number of inputs that have metadata",
"format": "uint64"
},
"positiveRegionTagsCount": {
"type": "string",
"title": "Number of positive tags added at region-level",
"format": "uint64"
}
}
}
apiDatasetVersionMetricsGroup
{
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/apiDatasetVersionMetricsGroupType"
},
"value": {},
"metrics": {
"$ref": "#/components/schemas/apiDatasetVersionMetrics"
},
"parentPath": {
"type": "string"
}
}
}
apiDatasetVersionMetricsGroupType
{
"enum": [
"DATASET_VERSION_METRICS_GROUP_TYPE_NOT_SET",
"INPUT_TYPE",
"CONCEPT_ID",
"CONCEPTS_COUNT",
"BOUNDING_BOXES_COUNT",
"POLYGONS_COUNT",
"POINTS_COUNT",
"MASKS_COUNT",
"PIXELS_COUNT",
"ASPECT_RATIO"
],
"type": "string",
"default": "DATASET_VERSION_METRICS_GROUP_TYPE_NOT_SET",
"description": " - INPUT_TYPE: Group data examples by input type.\nExamples: images, videos, text, audio.\n - CONCEPT_ID: Group data examples by concept ID.\nExamples: inputs with cat concept, inputs with dog concept.\n - CONCEPTS_COUNT: Group data examples by concepts count.\nExamples: inputs with 20 concepts, inputs with 21 concepts.\n - BOUNDING_BOXES_COUNT: Group data examples by bounding boxes count.\nExamples: inputs with 20 bounding boxes, inputs with 21 bounding boxes.\n - POLYGONS_COUNT: Group data examples by polygons count.\nExamples: inputs with 20 polygons, inputs with 21 polygons.\n - POINTS_COUNT: Group data examples by points count.\nExamples: inputs with 20 points, inputs with 21 points.\n - MASKS_COUNT: Group data examples by masks count.\nExamples: inputs with 20 masks, inputs with 21 masks.\n - PIXELS_COUNT: Group data examples by pixels count.\nIn order to reduce the number of groups, we use bins.\nExamples for bin size = 400: inputs with [200000, 200400) pixels, inputs with [200400, 200800) pixels.\n - ASPECT_RATIO: Group data examples by aspect ratio.\nIn order to reduce the number of groups, we use bins.\nExamples for bin size = 0.1: inputs with [0.5, 0.6) aspect ratio, inputs with [0.6, 0.7) aspect ratio."
}
apiDatasetVersionProcessingInfo
{
"type": "object",
"properties": {
"frameInterpolationInfo": {
"$ref": "#/components/schemas/apiFrameInterpolationInfo"
}
},
"description": "DatasetVersionProcessingInfo contains information about processing applied\nto a dataset version."
}
apiDeleteAnnotationFiltersRequest
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"annotationFilterIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specify which filters to delete."
}
},
"description": "Request to delete several annotation filters by list of ids."
}
apiDeleteAnnotationsRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Delete annotations with IDs"
},
"inputIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "Delete annotations for these Input IDs\nNote that 'ids' are optional but if the are provided the number and order in\n'ids' and 'input_ids' should match\nIf you do not specifiy 'ids' all the annotations for 'input_ids' are deleted\nHowever you need to specify at least one value for 'input_ids'\ni.e. this API does not support deleting all annotations"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to delete several things by the list of ids."
}
apiDeleteBulkOperationRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "List of bulk operation ids to be deleted"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to delete the terminated bulk operations by ID\nOnly operations in terminated state can be deleted."
}
apiDeleteCollectorsRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"deleteAll": {
"type": "boolean"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to delete several things by the list of ids."
}
apiDeleteConcepts
{
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"type": "string"
}
},
"concepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
}
}
}
}
apiDeleteDatasetsRequest
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"datasetIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Request to delete several datasets by list of ids."
}
apiDeleteFromDataset
{
"type": "object",
"properties": {
"datasetId": {
"type": "string"
}
}
}
apiDeleteGeo
{
"type": "object"
}
apiDeleteInputsRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to delete several things by the list of ids."
}
apiDeleteLabelOrdersRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to delete a list of label orders."
}
apiDeleteMetadata
{
"type": "object",
"properties": {
"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"
}
}
}
apiDeleteModelsRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"deleteAll": {
"type": "boolean"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to delete several things by the list of ids."
}
apiDeleteTasksRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to delete a list of tasks."
}
apiDeleteUploadsRequest
{
"type": "object",
"title": "Stops or deletes multipart upload",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiDeleteWorkflowsRequest
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
},
"deleteAll": {
"type": "boolean"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to delete several things by the list of ids."
}
apiDeployment
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "An id for this configured deployment."
},
"model": {
"$ref": "#/components/schemas/apiModel"
},
"userId": {
"type": "string",
"description": "The user who owns the deployment. These live in the user/org account."
},
"workflow": {
"$ref": "#/components/schemas/apiWorkflow"
},
"nodepools": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiNodepool"
},
"title": "You can configure different autoscaling per nodepool(s).\nThese nodepools have to be also owned by the same user_id/org as this deployment.\nIf there is more than one nodepool we use the model's ComputeInfo to match\nwith what the nodepool provides to decide which one can handle it combined with the\nNodepoolRank below. Note: even within a single nodepool if it is heterogeneous then\nwe need a way to rank scheduling choices when we don't know how to decide (like a model\nsupports"
},
"autoscaleConfig": {
"$ref": "#/components/schemas/apiAutoscaleConfig"
},
"schedulingChoice": {
"$ref": "#/components/schemas/DeploymentSchedulingChoice"
}
},
"description": "A deployment allows you to configure how runners for a particular type of resource will\nscale up and down. These are unique per user_id, nodepool and model so for differnet nodepools\nyou can scale differently."
}
apiDetailConceptCount
{
"type": "object",
"title": "DetailConceptCount",
"properties": {
"errors": {
"$ref": "#/components/schemas/apiConceptTypeCount"
},
"processed": {
"$ref": "#/components/schemas/apiConceptTypeCount"
},
"toProcess": {
"$ref": "#/components/schemas/apiConceptTypeCount"
},
"processing": {
"$ref": "#/components/schemas/apiConceptTypeCount"
}
}
}
apiEmailAddress
{
"type": "object",
"title": "EmailAddress",
"properties": {
"email": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"verified": {
"type": "boolean"
}
}
}
apiEmbedding
{
"type": "object",
"title": "Embedding",
"properties": {
"vector": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"numDimensions": {
"type": "integer",
"format": "int64"
}
}
}
apiEndpointDeps
{
"type": "object",
"title": "EndpointDeps",
"properties": {
"endpoint": {
"type": "string",
"title": "The fully qualified endpoint to"
},
"dependingScopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Other scopes that are required."
}
}
}
apiEvalInfo
{
"type": "object",
"properties": {
"params": {
"type": "object",
"description": "To control the evaluation process.\nAllow a list of parameters."
}
}
}
apiEvalMetrics
{
"type": "object",
"title": "EvalMetrics",
"properties": {
"id": {
"type": "string",
"title": "Id of this evaluation"
},
"appId": {
"type": "string",
"title": "app id that owns this evaluation"
},
"model": {
"$ref": "#/components/schemas/apiModel"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"userId": {
"type": "string",
"title": "user id that owns this evaluation"
},
"summary": {
"$ref": "#/components/schemas/apiMetricsSummary"
},
"testSet": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiEvalTestSetEntry"
}
},
"evalInfo": {
"$ref": "#/components/schemas/apiEvalInfo"
},
"labelCounts": {
"$ref": "#/components/schemas/apiLabelDistribution"
},
"binaryMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiBinaryMetrics"
}
},
"metricsByArea": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiBinaryMetrics"
}
},
"metricsByClass": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiBinaryMetrics"
}
},
"trackerMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTrackerMetrics"
}
},
"confusionMatrix": {
"$ref": "#/components/schemas/apiConfusionMatrix"
},
"extendedMetrics": {
"$ref": "#/components/schemas/apiExtendedMetrics"
},
"cooccurrenceMatrix": {
"$ref": "#/components/schemas/apiCooccurrenceMatrix"
},
"groundTruthDataset": {
"$ref": "#/components/schemas/apiDataset"
},
"predictionsDataset": {
"$ref": "#/components/schemas/apiDataset"
}
}
}
apiEvalTestSetEntry
{
"type": "object",
"title": "EvalTestSetEntry",
"properties": {
"input": {
"$ref": "#/components/schemas/apiInput"
},
"annotation": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
},
"predictedConcepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
}
},
"groundTruthConcepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
},
"title": "All the ground truth concepts will be show on the top level"
}
}
}
apiEvaluationType
{
"enum": [
"Undefined",
"Classification",
"Detection",
"Segmentation",
"Clustering",
"Tracker",
"Generation"
],
"type": "string",
"title": "- Classification: default",
"default": "Undefined"
}
apiExtendedMetrics
{
"type": "object",
"properties": {
"userMetrics": {
"type": "object"
}
}
}
apiFieldsValue
{
"type": "object",
"title": "FieldsValue",
"properties": {
"testSet": {
"type": "boolean"
},
"labelCounts": {
"type": "boolean"
},
"binaryMetrics": {
"type": "boolean"
},
"metricsByArea": {
"type": "boolean"
},
"metricsByClass": {
"type": "boolean"
},
"confusionMatrix": {
"type": "boolean"
},
"cooccurrenceMatrix": {
"type": "boolean"
}
}
}
apiFilter
{
"type": "object",
"title": "Filter",
"properties": {
"input": {
"$ref": "#/components/schemas/apiInput"
},
"negate": {
"type": "boolean",
"title": "If True then this will flip the meaning of this part of the\nquery. This allow for queries such as dog AND ! metadata=={\"blah\":\"value\"}"
},
"annotation": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
},
"lastUpdatedTimeRange": {
"$ref": "#/components/schemas/apiTimeRange"
}
}
}
apiFrame
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "An ID for the frame."
},
"data": {
"$ref": "#/components/schemas/apiData"
},
"frameInfo": {
"$ref": "#/components/schemas/apiFrameInfo"
}
},
"description": "A Frame of time-series Data such as a Video."
}
apiFrameInfo
{
"type": "object",
"properties": {
"time": {
"type": "integer",
"format": "int64",
"description": "time in the video in milliseconds. This is independent of the sampling rates used during\nprocessing."
},
"index": {
"type": "integer",
"title": "Deprecated. Use Time instead.\nThe index of the frame, informational and optional.\nDepends on the sampling rate used during processing\nMay be 0 for interpolated frames that are generated for brief time (training) or if new frame is manually added",
"format": "int64"
}
},
"description": "The information of the location of the Frame."
}
apiFrameInterpolationInfo
{
"type": "object",
"properties": {
"sampleMs": {
"type": "integer",
"format": "int64",
"description": "sample_ms is the sampling rate at which frame annotations are interpolated.\nIf sample_ms is zero, then the dataset default_processing_info value is used.\nIf the dataset default is zero or not set, then the input frame prediction\nsampling rate is used."
}
},
"description": "FrameInterpolationInfo contains information about frame annotations\ninterpolated from other video annotations, such as image object-detection\nregions generated from video object-tracking regions."
}
apiFullTag
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "Id value for referencing. Ex. \"en\""
},
"name": {
"type": "string",
"title": "Display name of the tag. Ex. \"English\""
}
}
}
apiGeo
{
"type": "object",
"title": "Geo",
"properties": {
"geoBox": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiGeoBoxedPoint"
},
"title": "NOTE: inconsistency: should have been geo_boxed_points"
},
"geoLimit": {
"$ref": "#/components/schemas/apiGeoLimit"
},
"geoPoint": {
"$ref": "#/components/schemas/apiGeoPoint"
}
}
}
apiGeoBoxedPoint
{
"type": "object",
"title": "GeoBoxedPoint",
"properties": {
"geoPoint": {
"$ref": "#/components/schemas/apiGeoPoint"
}
}
}
apiGeoLimit
{
"type": "object",
"title": "GeoLimit",
"properties": {
"type": {
"type": "string"
},
"value": {
"type": "number",
"format": "float"
}
}
}
apiGeoPoint
{
"type": "object",
"title": "GeoPoint",
"properties": {
"latitude": {
"type": "number",
"format": "float"
},
"longitude": {
"type": "number",
"format": "float"
}
}
}
apiGetResourceCountsResponse
{
"type": "object",
"title": "ResourceCountResponse",
"properties": {
"inputs": {
"type": "string",
"format": "int64"
},
"models": {
"type": "string",
"format": "int64"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modules": {
"type": "string",
"format": "int64"
},
"datasets": {
"type": "string",
"format": "int64"
},
"workflows": {
"type": "string",
"format": "int64"
}
}
}
apiGetVideoManifestResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"manifestUrl": {
"type": "string",
"title": "MPEG-dash manifest as data-URI, base64-encoded\nCan be empty if status is FAILED\nCan be fallback manifest if status is MIXED_STATUS"
}
}
}
apiHit
{
"type": "object",
"title": "Hit",
"properties": {
"appId": {
"type": "string",
"description": "The cfid of the app the asset came from."
},
"input": {
"$ref": "#/components/schemas/apiInput"
},
"score": {
"type": "number",
"format": "float",
"description": "This is the score for the ranked Hit results of the search query. This score is a number\nbetween 0.0 and 1.0 as it represents a confidence in the search Hit. For example, if you search\nfor \"car\" and get a close matching Hit, the score should be close to 1.0. If you get a score\nof close to 0.0 that means it's very disimilar to your query, in this case NOT a \"car\". There\nis a special intermediate score of 0.5 that means that the Hit is not really correlated with\nyour search query (ie. not similar or dissimlar to the query) which is a common occurrence\nwhen using negate queries.\nNote: some queries that are just filtering down your app of inputs may just return a score of\n1.0 for all Hits."
},
"userId": {
"type": "string",
"description": "The customer-facing id of the user who owns the app the asset came from."
},
"annotation": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
}
}
}
apiHitCount
{
"type": "object",
"properties": {
"estimatedTotal": {
"type": "string",
"format": "uint64",
"description": "The estimated total number of hits for the search query, not just the current page."
}
}
}
apiHostedURL
{
"type": "object",
"title": "HostedURL",
"properties": {
"sizes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The sizes field lists which images of the different sizes are hosted in our storage. The URL\nof each hosted image can be obtained by joining the prefix, one of the sizes and suffix."
},
"prefix": {
"type": "string",
"description": "Prefix of the URL of every hosted image."
},
"suffix": {
"type": "string",
"description": "Suffix of an image stored in different sizes."
},
"crossorigin": {
"type": "string",
"title": "The crossorigin property of html media tag\nFor Secure Data Hosting this needs to be set to 'use-credentials'"
}
}
}
apiIdUpdateSource
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "old id"
},
"newId": {
"type": "string",
"title": "new id"
}
}
}
apiImage
{
"type": "object",
"title": "Image",
"properties": {
"url": {
"type": "string",
"description": "This is a URL to a publicly accessible image file. The platform will download this file server\nside and then process."
},
"base64": {
"type": "string",
"format": "byte",
"description": "The base64 field is using image file bytes directly in the request.\nNOTE: if you're sending a json request, then this MUST be base64 encoded before sending (hence\nthe name here).\nWhen using our grpc clients, you DO NOT need to base64 encode\nit yourself since the clients know how to do this for you automatically and will avoid the\nbase64 encoding if they send a binary request."
},
"hosted": {
"$ref": "#/components/schemas/apiHostedURL"
},
"imageInfo": {
"$ref": "#/components/schemas/apiImageInfo"
},
"allowDuplicateUrl": {
"type": "boolean"
}
}
}
apiImageInfo
{
"type": "object",
"properties": {
"width": {
"type": "integer",
"title": "width",
"format": "int32"
},
"format": {
"type": "string",
"title": "image format"
},
"height": {
"type": "integer",
"title": "height",
"format": "int32"
},
"colorMode": {
"type": "string",
"title": "image color mode"
}
}
}
apiImportInfo
{
"type": "object",
"properties": {
"params": {
"type": "object",
"description": "Used to configure model imports from third-party toolkits."
}
}
}
apiInput
{
"type": "object",
"title": "Input",
"properties": {
"id": {
"type": "string",
"title": "The ID for the input"
},
"data": {
"$ref": "#/components/schemas/apiData"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"createdAt": {
"type": "string",
"title": "When the input was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
},
"datasetIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of dataset IDs that this input is part of\nCurrently, this field is ONLY used to\n* search inputs part of dataset(s), e.g. in `PostSearches`, `PostInputsSearches` and `PostAnnotationsSearches` endpoints, and\n* to add inputs to dataset(s) in `PostInputs` endpoint.\nNote that this field is ignored for other endpoints, e.g. `GetInput`, `ListInputs` and `PatchInputs`."
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the input was modified."
}
}
}
apiInputCount
{
"type": "object",
"properties": {
"errors": {
"type": "integer",
"format": "int64"
},
"processed": {
"type": "integer",
"format": "int64"
},
"reindexed": {
"type": "integer",
"format": "int64"
},
"toProcess": {
"type": "integer",
"format": "int64"
},
"toReindex": {
"type": "integer",
"format": "int64"
},
"processing": {
"type": "integer",
"format": "int64"
},
"reindexing": {
"type": "integer",
"format": "int64"
},
"reindexErrors": {
"type": "integer",
"format": "int64"
}
},
"description": "NOTE: inconsistency: this is weird mix of plural and singular words."
}
apiInputIDConflictResolution
{
"enum": [
"INPUT_ID_CONFLICT_RESOLUTION_NOT_SET",
"SKIP",
"SUFFIX"
],
"type": "string",
"default": "INPUT_ID_CONFLICT_RESOLUTION_NOT_SET",
"description": " - INPUT_ID_CONFLICT_RESOLUTION_NOT_SET: Defaults to SKIP\n - SKIP: Mark duplicate inputs as error and skip processing them.\n - SUFFIX: Add a suffix to inputs with conflicting IDs. Attempts numeric suffixes \"-1\" to \"-9\" and then a randomized suffix. Identical ID's in the same request are still treated as errors."
}
apiInputIDs
{
"type": "object",
"properties": {
"inputIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
apiInputInfo
{
"type": "object",
"title": "InputInfo",
"properties": {
"params": {
"type": "object",
"description": "To control the inputs to the given model we allow a list of parameters\ndefined for each ModelType as a Struct (JSON object) here. During training or inference, the\nsettings contained within are sent to the training processor to alter the training process."
},
"fieldsMap": {
"type": "object",
"description": "Map from the api.Data field names to the underlying model graph's inputs. When using a\nPretrainedModelConfig the values in this map need to match the Triton config.pbtxt input names."
},
"baseEmbedModel": {
"$ref": "#/components/schemas/apiModel"
}
}
}
apiInputsAddJob
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "id of the job"
},
"appPat": {
"type": "string",
"title": "Personal Access Token to the application to which inputs are added"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"uploads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiUpload"
},
"title": "Archive uploads"
},
"progress": {
"$ref": "#/components/schemas/apiInputsAddJobProgress"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the job was created.\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 time when the job was updated.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"callBackUrl": {
"type": "string",
"description": "If call back url is set, we will send a Post request to this endpoint with job status."
},
"extractionJobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInputsExtractionJob"
},
"title": "Sub-jobs that extract inputs from the cloud and/or archives"
}
}
}
apiInputsAddJobProgress
{
"type": "object",
"properties": {
"failedCount": {
"type": "string",
"format": "uint64"
},
"pendingCount": {
"type": "string",
"format": "uint64"
},
"successCount": {
"type": "string",
"format": "uint64"
},
"inProgressCount": {
"type": "string",
"format": "uint64"
}
}
}
apiInputsDataSource
{
"type": "object",
"properties": {
"url": {
"$ref": "#/components/schemas/apiDataSourceURL"
},
"inputTemplate": {
"$ref": "#/components/schemas/apiInput"
},
"inputsAddJobId": {
"type": "string",
"description": "Collect statistics about created inputs in job with given ID.\nOn Post call:\n* If job ID is empty, then job is automatically created with random ID.\n* If job ID is non-empty, then a new job will be created with given ID."
},
"inputIdConflictResolution": {
"$ref": "#/components/schemas/apiInputIDConflictResolution"
}
}
}
apiInputsExtractionJob
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID of extraction job"
},
"url": {
"type": "string",
"title": "Url of archive or bucket"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"progress": {
"$ref": "#/components/schemas/apiInputsExtractionJobProgress"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the extraction job was started.\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 time when the extraction job was updated.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"inputTemplate": {
"$ref": "#/components/schemas/apiInput"
},
"inputIdConflictResolution": {
"$ref": "#/components/schemas/apiInputIDConflictResolution"
}
}
}
apiInputsExtractionJobProgress
{
"type": "object",
"properties": {
"textInputsCount": {
"type": "string",
"format": "uint64"
},
"audioInputsCount": {
"type": "string",
"format": "uint64"
},
"imageInputsCount": {
"type": "string",
"format": "uint64"
},
"videoInputsCount": {
"type": "string",
"format": "uint64"
},
"failedArchivesCount": {
"type": "string",
"format": "uint64"
},
"pendingArchivesCount": {
"type": "string",
"format": "uint64"
},
"completedArchivesCount": {
"type": "string",
"format": "uint64"
},
"inProgressArchivesCount": {
"type": "string",
"format": "uint64"
}
}
}
apiInputsUpload
{
"type": "object",
"properties": {
"appPat": {
"type": "string",
"title": "Personal Access Token to the application to which inputs are added"
},
"upload": {
"$ref": "#/components/schemas/apiUpload"
},
"inputTemplate": {
"$ref": "#/components/schemas/apiInput"
},
"inputsAddJobId": {
"type": "string",
"description": "Collect statistics about created inputs in job with given ID.\n* If job ID is empty, then job is automatically created with random ID.\n* If job ID is non-empty, then a new job will be created with given ID."
},
"inputIdConflictResolution": {
"$ref": "#/components/schemas/apiInputIDConflictResolution"
}
}
}
apiInstalledModuleVersion
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique id for this install. This will be used in the browser url."
},
"appId": {
"type": "string",
"description": "The app_id the ModuleVersion is installed into (not necessary where the ModuleVersion was\ncreated). This doesn't have to be provided in requests to install, but will be returned in\nresponses."
},
"keyId": {
"type": "string",
"description": "The key ID to use for making requests to the API for this module.\nThis key is associated to this installed module version by PostInstalledModuleVersionsKey\nrequest. The key is associated with the CALLER not the App Owner where this module is installed\nnor the author of the module. This allows the module to act on behalf of the caller at all\ntimes so we get proper permissions the caller has (such as if they are stranger, teammate or\ncollaborator). This key should be a personal access token to enable modules to work across apps\nand have necessary abilities beyond what app-specific keys offer."
},
"userId": {
"type": "string",
"description": "The user that the app belongs to where the ModuleVersion is installed into (not necessary where\nthe ModuleVersion was created). This doesn't have to be provided in requests to install, but\nwill be returned in responses."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the install was created."
},
"deployUrl": {
"type": "string",
"description": "The URL of where this app module version is deployed.\nIf you provide this deploy_url when creating the install then it will\nbe treated as a pre-deployed module. You can only use a pre-deployed module\nin when installing to an app_id that you own as the creator of the module.\nIf you want to install someone elses module or to rely on Clarifai deploying\nyour module for you, leave deploy_url empty when creating the install.\nIf it is left empty, then deployment will occur when this module version is\ninstalled into an app using the git_commit_url of the ModuleVersion."
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the install was last modified."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"moduleVersion": {
"$ref": "#/components/schemas/apiModuleVersion"
}
}
}
apiKey
{
"type": "object",
"title": "Key",
"properties": {
"id": {
"type": "string",
"description": "The id of this key, it is used for authorization."
},
"apps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiApp"
},
"description": "The apps that this key give you access to, it is empty if this key is personal_access_token\nAPI key can only give you access to a single app."
},
"type": {
"type": "string",
"title": "The type of key, it can be api_key or personal_access_token, the default value is api_key"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"title": "The low-level scopes this key has"
},
"createdAt": {
"type": "string",
"title": "When the key was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
},
"title": "The endpoint-level scopes this key has"
},
"expiresAt": {
"type": "string",
"title": "When does the key expires, the key won't expire if this is empty",
"format": "date-time"
},
"description": {
"type": "string",
"title": "The description"
},
"authorizedIdpIds": {
"type": "array",
"items": {
"type": "string"
},
"title": "list of idp ids at which key is currently authorized"
}
}
}
apiKeypointEdge
{
"type": "object",
"properties": {
"k1": {
"type": "integer",
"format": "int64"
},
"k2": {
"type": "integer",
"format": "int64"
}
}
}
apiKeypointInfo
{
"type": "object",
"properties": {
"skeleton": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiKeypointEdge"
},
"description": "Defines the connections between keypoint_names. Each value represents the index in keypoint_names."
},
"keypointNames": {
"type": "array",
"items": {
"type": "string"
},
"title": "Names of the keypoints"
}
}
}
apiKnowledgeGraph
{
"type": "object",
"title": "A Knowledge Graph is a logical subsets of edges in the overall Concept Graph",
"properties": {
"id": {
"type": "string",
"title": "ID of the knowledge graph"
},
"name": {
"type": "string",
"title": "Name of the knowledge graph"
},
"description": {
"type": "string",
"title": "Human readable description of the knowledge graph"
},
"examplesAppId": {
"type": "string",
"title": "The app that contains the images that correspond to the concepts in the knowledge graph"
},
"sampledExamplesAppId": {
"type": "string",
"title": "The app that contains the sample images that we want to show the customer for the concepts in the knowledge graph"
}
}
}
apiLOPQEvalResult
{
"type": "object",
"title": "LOPQEvalResult",
"properties": {
"k": {
"type": "integer",
"format": "int32",
"description": "Rank k for which all metrics are reported."
},
"lopqNdcg": {
"type": "number",
"title": "Normalized Discounted Cumulative Gain (NDCG) @ k with a ground truth inferred from annotations\nand/or prediction for this evaluation LOPQ model.\nNDCG uses individual relevance scores of each returned image to evaluate the usefulness, or\ngain, of a document based on its position in the result list. The premise of DCG is that\nhighly relevant documents appearing lower in a search result list should be penalized as the\ngraded relevance value is reduced logarithmically proportional to the position of the result.\nSee: https://en.wikipedia.org/wiki/Information_retrieval#Discounted_cumulative_gain",
"format": "float",
"description": "To compute the relevance score between two images we consider two cases:\n1) Only one label for each image\nAn image is relevant to an image query iff they are labeled the same (score 1), and\nnot relevant otherwise (score 0)\n2) Multiple labels for each image\nHere an image relevancy with respect to a single image query is measured by f-beta score\nassuming the query image list of labels as ground truth and comparing them with that of\nthe search result. These labels can come from image annotations or if substitute_annotation_misses\nis set, predictions of base classifier where any prediction with prob < prob_threshold are\ndiscarded. To quantify the relevancy score of a single search result we opt to compute precision\nand recall @ k for simplicity, and combine them with f-beta score to obtain a single number."
},
"bruteForceNdcg": {
"type": "number",
"format": "float",
"description": "Brute force NDCG which gives a baseline to compare to and is a measure of how good\nthe embeddings are."
},
"recallVsBruteForce": {
"type": "number",
"format": "float",
"description": "Recall @ k assuming the brute force search is the ground truth."
},
"kendallTauVsBruteForce": {
"type": "number",
"format": "float",
"description": "Kendall's tau correlation @ k assuming the brute force search is the ground truth."
},
"mostFrequentCodePercent": {
"type": "number",
"format": "float",
"description": "The percentage of the most frequent code in the indexed part of evaluation data."
}
}
}
apiLabelCount
{
"type": "object",
"title": "LabelCount",
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"concept": {
"$ref": "#/components/schemas/apiConcept"
},
"conceptName": {
"type": "string"
}
}
}
apiLabelDistribution
{
"type": "object",
"title": "LabelDistribution",
"properties": {
"positiveLabelCounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiLabelCount"
}
}
}
}
apiLabelOrder
{
"type": "object",
"title": "LabelOrder",
"properties": {
"id": {
"type": "string",
"title": "id of the order"
},
"name": {
"type": "string",
"title": "name of the order"
},
"task": {
"$ref": "#/components/schemas/apiTask"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the label order was created.\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 time when the label order was updated.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"autoRelease": {
"type": "boolean",
"description": "if set to true, automatically release the labels once passed clarifai review."
},
"allowEmptyTag": {
"type": "boolean",
"description": "allow input without any tag."
},
"desiredFulfillTime": {
"type": "string",
"title": "User desired estimation when the task should be done",
"format": "date-time"
},
"estimateFulfillTime": {
"type": "string",
"format": "date-time",
"description": "Clarifai estimation when the task should be done ."
}
}
}
apiLabelSubmitConfig
{
"type": "object",
"properties": {
"taskAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTaskAssignment"
}
}
}
}
apiLayerShape
{
"type": "object",
"properties": {
"dims": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"title": "Supported dimensions\nExample: [-1,4] is a 2-dimensional array with the first dimension of variablesize, but second dimension with a static size: [[1,2,3,4],[4,5,6,7],...]"
},
"maxDims": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Max dimension size, applicable to layers that can have flexible sizes."
},
"dataType": {
"$ref": "#/components/schemas/apiDataType"
},
"description": {
"type": "string",
"title": "Description about the dimensions"
}
}
}
apiListOpenSourceLicensesResponse
{
"type": "object",
"title": "ListOpenSourceLicensesResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"licenses": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
apiMask
{
"type": "object",
"properties": {
"image": {
"$ref": "#/components/schemas/apiImage"
}
},
"description": "Segmentation mask."
}
apiMetricsSummary
{
"type": "object",
"title": "MetricsSummary",
"properties": {
"lopqMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiLOPQEvalResult"
}
},
"top1Accuracy": {
"type": "number",
"format": "float"
},
"top5Accuracy": {
"type": "number",
"format": "float"
},
"macroAvgRecall": {
"type": "number",
"format": "float"
},
"macroAvgRocAuc": {
"type": "number",
"format": "float"
},
"macroStdRocAuc": {
"type": "number",
"format": "float"
},
"macroAvgF1Score": {
"type": "number",
"format": "float"
},
"macroStdF1Score": {
"type": "number",
"format": "float"
},
"macroAvgPrecision": {
"type": "number",
"format": "float"
},
"meanAvgPrecisionIou50": {
"type": "number",
"format": "float"
},
"meanAvgPrecisionIouRange": {
"type": "number",
"format": "float"
}
}
}
apiModel
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The model's ID. Must be unique within a particular app and URL-friendly."
},
"name": {
"type": "string",
"description": "DEPRECATED: Please use the model id to name the model."
},
"task": {
"type": "string",
"title": "The task the model was trained to do"
},
"appId": {
"type": "string",
"description": "The app the model belongs to."
},
"image": {
"$ref": "#/components/schemas/apiImage"
},
"notes": {
"type": "string",
"description": "Notes for the model\nThis field should be used for in-depth notes and supports up to 64Kbs."
},
"userId": {
"type": "string",
"description": "The user id that the model belongs to."
},
"presets": {
"type": "object"
},
"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"
},
"toolkits": {
"type": "array",
"items": {
"type": "string"
},
"title": "Tags from toolkits category"
},
"useCases": {
"type": "array",
"items": {
"type": "string"
},
"title": "Tags from use_cases category"
},
"createdAt": {
"type": "string",
"title": "When the model was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\n the following from the API:\n \"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
},
"isStarred": {
"type": "boolean",
"title": "Is starred by the requesting user (only showed on get/list requests)\nPlease use PostModelStars/DeleteModelStars endpoints to star/unstar a model"
},
"languages": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags from languages category."
},
"starCount": {
"type": "integer",
"title": "How many users have starred the model (only showed on get/list requests)\nComputed value, not editable",
"format": "int32"
},
"modifiedAt": {
"type": "string",
"title": "When was the most recent model version created at",
"format": "date-time"
},
"outputInfo": {
"$ref": "#/components/schemas/apiOutputInfo"
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"description": {
"type": "string",
"title": "Short description about this model"
},
"displayName": {
"type": "string",
"description": "DEPRECATED: Please use the model id to name the model."
},
"modelTypeId": {
"type": "string",
"description": "The ModelType.Id that is used for this model. This is used for all versions and you cannot\nchange model_type_id between versions of the same model."
},
"modelVersion": {
"$ref": "#/components/schemas/apiModelVersion"
},
"checkConsents": {
"type": "array",
"items": {
"type": "string"
}
},
"languagesFull": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiFullTag"
},
"description": "Tags from languages category with names, only used in responses."
},
"bookmarkOrigin": {
"$ref": "#/components/schemas/apiBookmarkOrigin"
},
"defaultEvalInfo": {
"$ref": "#/components/schemas/apiEvalInfo"
},
"workflowRecommended": {
"type": "boolean",
"title": "Whether it's recommended that this model is used within a workflow"
}
},
"description": "This is the Model object which represents a created model in the platform.\nEach model has a particular type denoted by the model_type_id.\nWhen creating a Model with PostModels the following happens:\n - if the ModelType is trainable, then a new ModelVersion is created that is\n - UNTRAINED status by default\n - TRAINED status if a ModelVersion was included with PretrainedModelConfig in PostModels\n - if the ModelType is not trainable, then a new ModelVersion is created with TRAINED status.\nTo modify config settings like OutputInfo for the Model you an use PatchModels. This will\nalso create a new ModelVersion, potentially UNTRAINED following the same rules as above.\nThe fields that are patchable include Model.name, Model.display_name and Model.output_info\n(except the Model.output_info.type and Model.output_info.type_ext)."
}
apiModelLayerInfo
{
"type": "object",
"properties": {
"shapes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiLayerShape"
},
"description": "Description of the expected shape. Can support multiple support layer shapes."
},
"description": {
"type": "string",
"title": "Brief description about the layer if needed"
},
"dataFieldName": {
"type": "string",
"title": "The api.Data field this layer will be parsed into"
},
"requiresLabelFilename": {
"type": "boolean",
"title": "Whether this layer should have a label_filename specified and provided"
}
}
}
apiModelPredictConfig
{
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/apiModel"
}
}
}
apiModelQuery
{
"type": "object",
"title": "ModelQuery",
"properties": {
"name": {
"type": "string",
"description": "The name ofthe field. This supports wilcard queries like \"gen*\" to match \"general\" as an example."
},
"modelTypeId": {
"type": "string",
"description": "Filter models by the specific model_type_id. See ListModelTypes for the list of ModelType.Id's\nsupported."
}
}
}
apiModelReference
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "Id of the reference"
},
"url": {
"type": "string",
"title": "address of resource"
},
"name": {
"type": "string",
"title": "name of link"
},
"modelId": {
"type": "string",
"description": "The id of the model this Model reference is tied to."
},
"metadata": {
"type": "object",
"title": "To handle arbitrary json metadata:\nhttps://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto"
}
},
"description": "A link to a html/markdown/text file that stores reference material tied to a model."
}
apiModelType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for this model type."
},
"title": {
"type": "string",
"description": "A display title for this model."
},
"creatable": {
"type": "boolean",
"description": "Is this model creatable. We have some pre-trained model types that users cannot create yet in\nmodel mode."
},
"trainable": {
"type": "boolean",
"description": "Is this model trainable in our platform."
},
"description": {
"type": "string",
"description": "Description of this model type."
},
"inputFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of input fields that this model expects as inputs.\nUsed to validate that request input data has the expected fields."
},
"internalOnly": {
"type": "boolean",
"description": "Is this model type only for internal users at this time."
},
"outputFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of output fields that this model accepts."
},
"evaluationType": {
"$ref": "#/components/schemas/apiEvaluationType"
},
"modelTypeFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelTypeField"
},
"description": "The remaining fields are definitions of the configurable fields that exist."
},
"expectedInputLayers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelLayerInfo"
},
"description": "Expected input layers of an uploaded model."
},
"expectedOutputLayers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelLayerInfo"
},
"title": "Expected output layers of an uploaded model"
},
"requiresSequentialFrames": {
"type": "boolean",
"description": "For sequence models we need to know when processing that they require temporal time frames\nin sequential order. This will be true for model types like trackers as an example."
}
},
"description": "ModelType is a definition of a set of models that generally have the same input and output fields.\nThis is used to understand more about the possible models in our platform."
}
apiModelTypeEnumOption
{
"type": "object",
"title": "ModelTypeEnumOption",
"properties": {
"id": {
"type": "string",
"description": "The unique value of the enum option."
},
"aliases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelTypeEnumOptionAlias"
},
"title": "List of other ID values that are equivalent with this ID.\nThis allows the user to choose this option by multiple IDs.\nExample: if enum is \"Phone Number Prefix\", you could add an option that is selectable by two values:\n1. ID: \"Estonia\"\n2. Alias: 37"
},
"description": {
"type": "string",
"description": "Optional description for this enum option."
},
"recommended": {
"type": "boolean",
"description": "Whether this is the recommended enum option. Set to `true` when there\nare multiple options, and one is shown to be better than the others."
},
"internalOnly": {
"type": "boolean",
"description": "If this enum option should be internal only."
},
"modelTypeFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelTypeField"
},
"description": "These are additional fields that are specific to this enum choice. This allows\nus to use enums to control configuration settings as well."
}
}
}
apiModelTypeEnumOptionAlias
{
"type": "object",
"properties": {
"idInt": {
"type": "string",
"format": "int64",
"description": "Integer alias for id."
},
"wildcardString": {
"type": "string",
"description": "String that can contain wild cards and the regex needs to match."
}
}
}
apiModelTypeField
{
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The path where the value of the field will be stored in the model version object.\nExample:\n\"output_info.data\" would be the Data message in the OutputInfo message.\n\"output_info.output_config.language\" is in the OutputConfig message within OutputInfo\n\"input_info.params\" is in the params struct within InputInfo.\n\"output_info.params\" is in the params struct within OutputInfo.\n\"train_info.params\" is in the params struct within TrainInfo.\nand so on."
},
"required": {
"type": "boolean",
"description": "If this field is a required field. If True then during validation you won't be able to create\na model of this type with providing a value for this field. When False, the ModelType's\ndefault_value will be used for this field."
},
"fieldType": {
"$ref": "#/components/schemas/ModelTypeFieldModelTypeFieldType"
},
"description": {
"type": "string",
"description": "Description for this field."
},
"placeholder": {
"type": "string",
"description": "Placeholder text for the UI element."
},
"defaultValue": {
"description": "A default value. We use the Value field because we want to have structured data (just like\ngoogle.protobuf.Struct but this is just a single value)."
},
"internalOnly": {
"type": "boolean",
"description": "If this field should appear for internal users only."
},
"modelTypeRangeInfo": {
"$ref": "#/components/schemas/apiModelTypeRangeInfo"
},
"modelTypeEnumOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelTypeEnumOption"
},
"description": "List of options of the ENUM type and potentially additional fields they bring with them."
}
},
"description": "ModelTypeField stores a field value of a configurable type."
}
apiModelTypeRangeInfo
{
"type": "object",
"title": "ModelTypeRangeInfo",
"properties": {
"max": {
"type": "number",
"format": "float",
"description": "The end of the range as a float."
},
"min": {
"type": "number",
"format": "float",
"description": "The start of the range as a float."
},
"step": {
"type": "number",
"format": "float",
"description": "An optional step size for the range. If provided then only values at that step size will be\nrounded to. For example if step is 0.02 then 0.0245 will round to 0.02."
}
}
}
apiModelVersion
{
"type": "object",
"title": "ModelVersion",
"properties": {
"id": {
"type": "string"
},
"appId": {
"type": "string",
"description": "The app the model version belongs to."
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"userId": {
"type": "string",
"description": "The user the model version belongs to."
},
"license": {
"type": "string"
},
"metrics": {
"$ref": "#/components/schemas/apiEvalMetrics"
},
"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"
},
"trainLog": {
"type": "string",
"title": "Contains the training logs if available"
},
"buildInfo": {
"$ref": "#/components/schemas/apiBuildInfo"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the version was created."
},
"inputInfo": {
"$ref": "#/components/schemas/apiInputInfo"
},
"trainInfo": {
"$ref": "#/components/schemas/apiTrainInfo"
},
"importInfo": {
"$ref": "#/components/schemas/apiImportInfo"
},
"modifiedAt": {
"type": "string",
"title": "When this model version was last modified",
"format": "date-time"
},
"outputInfo": {
"$ref": "#/components/schemas/apiOutputInfo"
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"completedAt": {
"type": "string",
"format": "date-time",
"description": "When training of this version was completed."
},
"description": {
"type": "string",
"title": "Description about this version"
},
"totalInputCount": {
"type": "integer",
"title": "number of inputs in the model version",
"format": "int64"
},
"activeConceptCount": {
"type": "integer",
"format": "int64"
},
"inferenceComputeInfo": {
"$ref": "#/components/schemas/apiComputeInfo"
},
"pretrainedModelConfig": {
"$ref": "#/components/schemas/apiPretrainedModelConfig"
}
}
}
apiModelVersionExport
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "url is the URL from where the model version export can be downloaded."
},
"size": {
"type": "string",
"title": "size of model file",
"format": "int64"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
},
"description": "ModelVersionExport contains metadata for a single Model version export."
}
apiModelVersionInputExample
{
"type": "object",
"title": "ModelVersionInputExample",
"properties": {
"id": {
"type": "string",
"title": "user unique id"
},
"data": {
"$ref": "#/components/schemas/apiData"
},
"name": {
"type": "string",
"title": "name of link for display"
},
"modelId": {
"type": "string",
"title": "external id of model"
},
"description": {
"type": "string",
"title": "description of link contents"
},
"modelVersionId": {
"type": "string",
"title": "external id of model version"
}
}
}
apiModelVersionPublishRequest
{
"type": "object",
"title": "ModelVersionPublishRequest",
"properties": {
"versionId": {
"type": "string"
}
}
}
apiModelVersionUnpublishRequest
{
"type": "object",
"title": "ModelVersionUnpublishRequest",
"properties": {
"versionId": {
"type": "string"
}
}
}
apiModule
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for this app module."
},
"appId": {
"type": "string",
"description": "The app_id this module was created in."
},
"image": {
"$ref": "#/components/schemas/apiImage"
},
"userId": {
"type": "string",
"description": "The creator of the app module."
},
"metadata": {
"type": "object",
"description": "To handle arbitrary json metadata you can use a struct field:\nhttps://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto\nThis is an optional arg."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the app module was created."
},
"isStarred": {
"type": "boolean",
"title": "Is starred by the requesting user (only showed on get/list requests)\nPlease use PostModuleStars/DeleteModuleStars endpoints to star/unstar a module"
},
"starCount": {
"type": "integer",
"title": "How many users have starred the module (only showed on get/list requests)\nComputed value, not editable",
"format": "int32"
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the app module was last modified."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"description": {
"type": "string",
"description": "A short description for this app module to be used in grids of modules."
},
"moduleVersion": {
"$ref": "#/components/schemas/apiModuleVersion"
},
"bookmarkOrigin": {
"$ref": "#/components/schemas/apiBookmarkOrigin"
}
},
"description": "An app module that a user created in our app module marketplace."
}
apiModuleVersion
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A name for this version like 1_0, 1_1_0, etc."
},
"appId": {
"type": "string",
"description": "The app_id this module version belongs to."
},
"notes": {
"type": "string",
"description": "A markdown formatted string to detailed description of the app module.\nThis is within each version so that it can be change version to version."
},
"userId": {
"type": "string",
"description": "The user_id this module version belongs to."
},
"approved": {
"type": "boolean",
"description": "A boolean to mark if Clarifai has approved this app version.\nThis cannot be set in the request to True."
},
"metadata": {
"type": "object",
"description": "To handle arbitrary json metadata you can use a struct field:\nhttps://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto\nThis is an optional arg."
},
"moduleId": {
"type": "string",
"description": "The module this version belongs to."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the app module version was created."
},
"moduleNav": {
"$ref": "#/components/schemas/ModuleVersionModuleNav"
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the app module version was last modified."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"description": {
"type": "string",
"description": "A short description for this version."
},
"gitCommitUrl": {
"type": "string",
"title": "The code repo of the streamlit app.\nIf you are still developing your Module you should create a ModuleVersion\nwith an empty git_commit_url and then create an InstalledModuleVersion\nwith a pre-deployed deploy_url (such as localhost or streamlit cloud).\nOnce you are ready to create a production, create a new ModuleVersion with\nthe ready git url to a specific commit that you would like to be reviewed by the\nClarifai team for approval within our community. You cannot publish a ModuleVersion\nis reviewed and approved. Please only provide the git_commit_url when you're\nready for a review. This url needs to include a specific commit, for example:\nhttps://github.com/user/repo/commit/767ff9c08ba3429c8e7b8825da148555"
}
},
"description": "A specific version of an app module that is available for assigning to apps."
}
apiMultiAnnotationFilterResponse
{
"type": "object",
"title": "MultiAnnotationFilterResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"annotationFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAnnotationFilter"
}
}
}
}
apiMultiAnnotationResponse
{
"type": "object",
"title": "MultiAnnotationResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"annotations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
}
}
}
}
apiMultiAnnotationSearchMetricsResponse
{
"type": "object",
"title": "MultiAnnotationSearchMetricsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"annotationSearchMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAnnotationSearchMetrics"
}
}
}
}
apiMultiAppDuplicationsResponse
{
"type": "object",
"title": "MultiAppDuplicationsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"appDuplications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAppDuplication"
}
}
}
}
apiMultiAppResponse
{
"type": "object",
"title": "MultiAppResponse",
"properties": {
"apps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiApp"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiMultiBulkOperationsResponse
{
"type": "object",
"title": "MultiBulkOperationsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"bulkOperation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiBulkOperation"
}
}
}
}
apiMultiCollaborationsResponse
{
"type": "object",
"title": "MultiCollaborationsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"collaborations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollaboration"
}
}
}
}
apiMultiCollaboratorsResponse
{
"type": "object",
"title": "MultiCollaboratorsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"appOwner": {
"$ref": "#/components/schemas/apiUser"
},
"collaborators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollaborator"
}
}
}
}
apiMultiCollectorResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"collectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollector"
}
}
},
"description": "Response with multiple Collectors."
}
apiMultiConceptCountResponse
{
"type": "object",
"title": "MultiConceptCountResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"conceptCounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptCount"
},
"description": "The returned concept counts."
}
}
}
apiMultiConceptLanguageResponse
{
"type": "object",
"title": "MultiConceptLanguageResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"conceptLanguages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptLanguage"
}
}
}
}
apiMultiConceptMappingJobResponse
{
"type": "object",
"title": "MultiConceptMappingJobResponse",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ids of the concept mapping jobs underway."
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiMultiConceptRelationResponse
{
"type": "object",
"title": "MultiConceptRelationResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"conceptRelations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptRelation"
},
"description": "The returned concept relations."
}
}
}
apiMultiConceptResponse
{
"type": "object",
"title": "MultiConceptResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"concepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
},
"description": "The returned concepts."
}
}
}
apiMultiDatasetInputResponse
{
"type": "object",
"title": "MultiDatasetInputResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"bulkOperation": {
"$ref": "#/components/schemas/apiBulkOperation"
},
"datasetInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetInput"
}
}
}
}
apiMultiDatasetResponse
{
"type": "object",
"title": "MultiDatasetResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDataset"
}
}
}
}
apiMultiDatasetVersionExportResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"exports": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersionExport"
}
}
}
}
apiMultiDatasetVersionMetricsGroupResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"datasetVersionMetricsGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersionMetricsGroup"
}
}
}
}
apiMultiDatasetVersionResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"datasetVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDatasetVersion"
}
}
}
}
apiMultiEvalMetricsResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"evalMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiEvalMetrics"
}
}
}
}
apiMultiInputAnnotationResponse
{
"type": "object",
"title": "MultiInputAnnotationResponse",
"properties": {
"hits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiHit"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiMultiInputResponse
{
"type": "object",
"title": "MultiInputResponse",
"properties": {
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"inputsAddJob": {
"$ref": "#/components/schemas/apiInputsAddJob"
}
}
}
apiMultiInputsAddJobResponse
{
"type": "object",
"title": "MultiInputsAddJobResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"inputsAddJobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInputsAddJob"
}
}
}
}
apiMultiInputsExtractionJobResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"inputsExtractionJobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInputsExtractionJob"
}
}
}
}
apiMultiInstalledModuleVersionResponse
{
"type": "object",
"title": "MultiInstalledModuleVersionResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"installedModuleVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInstalledModuleVersion"
}
}
}
}
apiMultiKeyResponse
{
"type": "object",
"title": "MultiKeyResponse",
"properties": {
"keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiKey"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiMultiKnowledgeGraphResponse
{
"type": "object",
"title": "MultiKnowledgeGraphResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"knowledgeGraphs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiKnowledgeGraph"
},
"description": "The returned knowledge graphs."
}
}
}
apiMultiLabelOrderResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"labelOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiLabelOrder"
}
}
},
"description": "Response with multiple label order."
}
apiMultiModelCheckConsentResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"checkConsents": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
apiMultiModelLanguageResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
apiMultiModelReferenceResponse
{
"type": "object",
"title": "MultiModelReferenceResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modelReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelReference"
}
}
}
}
apiMultiModelResponse
{
"type": "object",
"title": "MultiModelResponse",
"properties": {
"models": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModel"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiMultiModelToolkitResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"toolkits": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
apiMultiModelTypeResponse
{
"type": "object",
"title": "MultiModelTypeResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modelTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelType"
},
"description": "List of ModelType objects."
},
"modelImporters": {
"$ref": "#/components/schemas/apiModelTypeField"
},
"tritonCondaEnvsInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTritonCondaEnvInfo"
},
"title": "Triton model envs that can be used for model upload"
}
}
}
apiMultiModelUseCaseResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"usecases": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
apiMultiModelVersionInputExampleResponse
{
"type": "object",
"title": "MultiModelVersionInputExampleResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modelVersionInputExamples": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersionInputExample"
},
"title": "model input example messages"
}
}
}
apiMultiModelVersionResponse
{
"type": "object",
"title": "MultiModelVersionResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modelVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelVersion"
}
}
}
}
apiMultiModuleResponse
{
"type": "object",
"title": "MultiModuleResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"modules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModule"
}
}
}
}
apiMultiModuleVersionResponse
{
"type": "object",
"title": "MultiModuleVersionResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"moduleVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModuleVersion"
}
}
}
}
apiMultiOutputResponse
{
"type": "object",
"title": "MultiOutputResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiOutput"
},
"description": "For each input processed during model prediction we create one output."
}
}
}
apiMultiRunnerItemOutputResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"runnerItemOutputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiRunnerItemOutput"
}
}
}
}
apiMultiRunnerItemResponse
{
"type": "object",
"title": "MultiRunnerItemResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"runnerItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiRunnerItem"
}
}
}
}
apiMultiRunnerResponse
{
"type": "object",
"title": "MultiRunnerResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"runners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiRunner"
}
}
}
}
apiMultiScopeDepsResponse
{
"type": "object",
"title": "MultiScopeDepsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"scopeDeps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiScopeDeps"
},
"description": "scopes is a list of low-level scopes and their dependencies."
},
"endpointDeps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiEndpointDeps"
},
"title": "endpoint_scopes is a listof all the publicly available endponts which can be\nused as scopes as well. A call to each of those endpoint depends on a subset\nof the above \"scopes\""
}
}
}
apiMultiScopeResponse
{
"type": "object",
"title": "MultiScopeResponse",
"properties": {
"app": {
"$ref": "#/components/schemas/apiApp"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "This is a list of the scopes that your key has."
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
},
"description": "This is a list of endpoint permissions that your key has."
},
"userFeatureFlags": {
"type": "string"
}
}
}
apiMultiScopeRootResponse
{
"type": "object",
"title": "MultiScopeRootResponse",
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "This is a list of the scopes that your key has."
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
},
"description": "This is a list of endpoint permissions that your key has."
},
"userFeatureFlags": {
"type": "string"
}
}
}
apiMultiScopeUserResponse
{
"type": "object",
"title": "MultiScopeUserResponse",
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "This is a list of the scopes that your key has."
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"endpoints": {
"type": "array",
"items": {
"type": "string"
},
"description": "This is a list of endpoint permissions that your key has."
},
"userFeatureFlags": {
"type": "string"
}
}
}
apiMultiSearchResponse
{
"type": "object",
"title": "MultiSearchResponse",
"properties": {
"id": {
"type": "string",
"title": "A unique id which uniquely identifies a search"
},
"hits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiHit"
},
"description": "The list of search result Hits."
},
"query": {
"$ref": "#/components/schemas/apiQuery"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"description": "The original Searches provided in the request."
},
"hitCounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiHitCount"
},
"description": "The counts of hits for each search, in the same order as searches.\nOnly returned if the request set only_count."
}
}
}
apiMultiStatValueAggregateResponse
{
"type": "object",
"title": "MultiStatValueAggregateResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"statValueAggregateResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiStatValueAggregateResult"
},
"description": "The aggregate results for each query passedin."
}
}
}
apiMultiStatValueResponse
{
"type": "object",
"title": "MultiStatValueResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"statValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiStatValue"
},
"description": "The returned stats values."
}
}
}
apiMultiStatusCodeResponse
{
"type": "object",
"title": "MultiStatusCodeResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
}
apiMultiTaskAssignmentResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"taskAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTaskAssignment"
}
}
}
}
apiMultiTaskResponse
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTask"
}
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
},
"description": "Response with multiple Tasks."
}
apiMultiTrainingTimeEstimateResponse
{
"type": "object",
"title": "Estimated training time in seconds",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"trainingTimeEstimates": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
apiMultiTrendingMetricsViewResponse
{
"type": "object",
"title": "MultiTrendingMetricsViewResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTrendingMetric"
}
}
}
}
apiMultiUploadResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"uploads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiUpload"
}
}
}
}
apiMultiWorkerResponse
{
"type": "object",
"title": "MultiWorkerResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"workers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorker"
}
}
}
}
apiMultiWorkflowResponse
{
"type": "object",
"title": "MultiWorkflowResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflow"
}
}
}
}
apiMultiWorkflowVersionResponse
{
"type": "object",
"title": "MultiWorkflowVersionResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"workflowVersions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowVersion"
}
}
}
}
apiNodeInput
{
"type": "object",
"properties": {
"nodeId": {
"type": "string",
"description": "The id to a connected WorkflowNode which will be used as an input for current WorkflowNode."
}
},
"description": "NodeInput represents inputs to a node of the graph."
}
apiNodepool
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The user defined ID of the nodepool."
},
"userId": {
"type": "string",
"description": "The user/org that this nodepool belongs to."
},
"cloudRegion": {
"$ref": "#/components/schemas/apiCloudRegion"
},
"maxInstances": {
"type": "integer",
"format": "int64",
"description": "An upper limit on the number of instances in this nodepool. This allows the nodepool to scale\nup to this amount."
},
"minInstances": {
"type": "integer",
"format": "int64",
"description": "Minimum number of instances in this nodepool. This allows the nodeool to scale down to this\namount. A nodepool needs a minimum of 1 instance."
},
"capacityTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NodepoolCapacityType"
}
},
"instanceTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "////////////////////////////////////\nThe instance types that will be available in this pool of nodes.\nClarifai offers multiple different choices that combine cpu cores, memory and accelerator.\n\n////////////////////////////////////"
}
},
"description": "A nodepool is a set of nodes dedicated for a given user's compute needs.\nThis compute will typically be consumed by runners and in the future other objects\nlike UI modules may be assigned to node pools."
}
apiOperation
{
"type": "object",
"properties": {
"deleteGeo": {
"$ref": "#/components/schemas/apiDeleteGeo"
},
"addConcepts": {
"$ref": "#/components/schemas/apiAddConcepts"
},
"addMetadata": {
"$ref": "#/components/schemas/apiAddMetadata"
},
"addToDataset": {
"$ref": "#/components/schemas/apiAddToDataset"
},
"overwriteGeo": {
"$ref": "#/components/schemas/apiOverwriteGeo"
},
"deleteConcepts": {
"$ref": "#/components/schemas/apiDeleteConcepts"
},
"deleteMetadata": {
"$ref": "#/components/schemas/apiDeleteMetadata"
},
"deleteFromDataset": {
"$ref": "#/components/schemas/apiDeleteFromDataset"
},
"splitIntoDatasets": {
"$ref": "#/components/schemas/apiSplitIntoDatasets"
}
}
}
apiOutput
{
"type": "object",
"title": "Output",
"properties": {
"id": {
"type": "string",
"title": "One of these outputs per Input"
},
"data": {
"$ref": "#/components/schemas/apiData"
},
"input": {
"$ref": "#/components/schemas/apiInput"
},
"model": {
"$ref": "#/components/schemas/apiModel"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"createdAt": {
"type": "string",
"title": "When the object was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
}
}
}
apiOutputConfig
{
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "For concept model predictions: Overrides the default_language for the app in a predict call."
},
"minValue": {
"type": "number",
"format": "float",
"description": "For concept model predictions: Minimum value of concept's probability score in result.\nDefaults to 0.0 which means we won't do any thresholding as all probabilities will\nlikely be > 0.0."
},
"sampleMs": {
"type": "integer",
"title": "For model predictions on video: Sample delay for video predicting (1 frame per N milliseconds)",
"format": "int64"
},
"hyperParams": {
"type": "object",
"title": "For custom model training: Hyperparameters for custom training"
},
"maxConcepts": {
"type": "integer",
"format": "int64",
"description": "For concept model predictions: Maximum number of concepts in result. Defaults to 0 which under\nthe hood will return default of 20. We do a server side default in order to control this\nfeature in the future."
},
"modelMetadata": {
"type": "object",
"description": "For custom model training: This is any additional metadata as a JSON object that we want\nwant to persist in the model's output config. This is a useful quick way to set fields for\nintroducing fields for new model types so we don't have to add a new proto field and DB field\neach time. Please refer to the documentation or model implementation internally for more\ndetails on what fields are supported for which models.\nTODO(zeiler): remove this field after Portal is updated."
},
"selectConcepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
},
"title": "For concept model predictions: Select concepts in result by name or by id"
},
"existingModelId": {
"type": "string",
"description": "DEPRECATED: For custom models, this is the base model to use for image embeddings.\nDefault is general model."
},
"hyperParameters": {
"type": "string",
"description": "DEPRECATED: Hyper-parameters for custom training.\nUse new hyper_params field instead."
},
"trainingTimeout": {
"type": "integer",
"title": "For custom concept model training: Training timeout of the model (in seconds)",
"format": "int64"
},
"embedModelVersionId": {
"type": "string",
"description": "For custom model training: this is the base model version to use for image embeddings.\nThis has to be one of the embed models in the app workflow.\n\nUse input_info.base_embed_model instead."
},
"conceptsMutuallyExclusive": {
"type": "boolean",
"description": "For custom concept model training: whether the concept predictions must sum to 1."
},
"failOnMissingPositiveExamples": {
"type": "boolean",
"title": "For custom model training: Use this flag to fail on missing positive examples\nBy default we fill in the missing with random examples"
}
},
"description": "OutputConfig is a collection of parameters controlling either inference or training settings for\nthe given Model. This message will be deprecated over time in favor or infer_params and\ntrain_params in OutputInfo which are cleaner and more extensible for many ModelTypes."
}
apiOutputInfo
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/apiData"
},
"params": {
"type": "object",
"description": "For predicting with the various ModelType's we accept a Struct (JSON object) worth of args\nthat the ModelTypeField defines. During inference, the settings contained within are sent\nto the model predictor to alter predictions from this Model."
},
"message": {
"type": "string",
"description": "For returning where to look for the Output info if not returning it."
},
"fieldsMap": {
"type": "object",
"description": "Map from the api.Data field names to the underlying model graph's outputs. When using a\nPretrainedModelConfig the values in this map need to match the Triton config.pbtxt output names."
},
"paramsSpecs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModelTypeField"
}
},
"outputConfig": {
"$ref": "#/components/schemas/apiOutputConfig"
}
},
"description": "OutputInfo defines some of the settings for each model version that PatchModels can effect. These\nparameters control some of the training or inference operations that this model can do.\nAs the number of parameters continued to grow when we launched more ModelTypes we decided to move\nto using the OutputInfo.params field which is a Struct (or JSON object if you're using\nour JSON REST APIs). This allows each ModelType to define the set of fields, their default values\nand description of each field so that we can display those in Portal and make the creation of\nModel's very extensible. The OutputConfig object will eventually go away in favor of\ninfer_params struct."
}
apiOverwriteGeo
{
"type": "object",
"properties": {
"geo": {
"$ref": "#/components/schemas/apiGeo"
}
}
}
apiPagination
{
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int64",
"description": "(optional URL parameter) The page number. Pagination is used to split the results into chunks. Defaults to 1."
},
"perPage": {
"type": "integer",
"format": "int64",
"description": "(optional URL parameter) The number of results that will be contained in each page. Defaults to 128."
}
},
"description": "Split the results into pages."
}
apiPassword
{
"type": "object",
"title": "Password",
"properties": {
"plaintext": {
"type": "string",
"title": "unencrypted password string"
}
}
}
apiPasswordViolations
{
"type": "object",
"title": "PasswordViolations",
"properties": {
"excludeEmail": {
"type": "boolean",
"title": "when first part of user's email (exact string or after removing special characters) is used in the new password"
},
"excludeNames": {
"type": "boolean",
"title": "when either user's first, middle or last name is used in the new password"
},
"maximumLength": {
"type": "boolean",
"title": "when new password length is longer than maximum length set"
},
"minimumLength": {
"type": "boolean",
"title": "when new password length is shorter than minimum length set"
},
"numericNeeded": {
"type": "boolean",
"title": "there is no numerics in the new password when there should be at least one"
},
"passwordReuse": {
"type": "boolean",
"title": "when one of the N most recent old password is reused, N is specified by password_reuse_epoch in db.password_policies"
},
"noCommonVocabs": {
"type": "boolean",
"title": "when there are common vocabs from the common vocab list used"
},
"lowerCaseNeeded": {
"type": "boolean",
"title": "there is no lower case letter in the new password when there should be at least one"
},
"upperCaseNeeded": {
"type": "boolean",
"title": "there is no upper case letter in the new password when there should be at least one"
},
"noOverlapWithOld": {
"type": "boolean",
"title": "when the current password is contained in the new password or vice versa"
},
"passwordLifespan": {
"type": "boolean",
"title": "when password has to be changed becauase it's too old"
},
"noSimplePasswords": {
"type": "boolean",
"title": "when there are simple password patterns used, such as 12345678 or aaaaaaa1"
},
"noConfusingLetters": {
"type": "boolean",
"title": "when there are confusing letters in the new password, such as o (first character of 'omega') vs 0 (zero)"
},
"nonAlphanumericNeeded": {
"type": "boolean",
"title": "there is no special character in the new password when there should be at least one"
}
}
}
apiPatchAction
{
"type": "object",
"title": "PatchAction",
"properties": {
"op": {
"type": "string",
"title": "The operation to perform on the patched metadata given a path\nFor now only operations 'overwrite', 'delete, and 'merge' is supported"
},
"path": {
"type": "string",
"description": "Path for the change. For example 'tag[1].data' is a valid path in above example.\nDefault path is root level i.e. ''."
},
"mergeConflictResolution": {
"type": "string",
"title": "If the action is 'merge' and there is a conflict, how to resolve it.\nThe options are\n'overwrite_by_id', 'remove_by_id', 'merge_by_id','overwrite', 'append' and 'do_nothing'\nNote that for conflict resolutions '*_by_id' to work on a list, the list should contain\nobjects with an 'id' field which will be used to uniquely identify each field. For example\nPatching existing json\n{\n \"tag\": [\n {\n \"id\": \"1\",\n \"data\": 1\n },\n {\n \"id\": \"2\",\n \"data\": 2\n }\n ]\n}\nwith op 'merge' and merge_conflict_resolution 'overwrite_by_id'\n{\n \"tag\": [\n {\n \"id\": \"2\",\n \"data\": 3\n }\n ]\n}\nwould produce\n{\n \"tag\": [\n {\n \"id\": \"1\",\n \"data\": 1\n },\n {\n \"id\": \"2\",\n \"data\": 3\n }\n ]\n}\nwhile with merge_conflict_resolution 'remove_by_id' it would produce\n{\n \"tag\": [\n {\n \"id\": \"1\",\n \"data\": 1\n }\n ]\n}",
"description": "Option 'append' will simply create a list on conflicts. For example in above example\nthe final result would be\n{\n \"tag\": [\n {\n \"id\": \"1\",\n \"data\": 1\n },\n {\n \"id\": \"2\",\n \"data\": [2, 3]\n }\n ]\n}"
}
}
}
apiPatchAnnotationFiltersRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now, only 'overwrite' action is supported"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"annotationFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAnnotationFilter"
},
"description": "List of annotation filters that are requested to be updated."
}
},
"description": "Request to patch several annotation filters."
}
apiPatchAnnotationsRequest
{
"type": "object",
"title": "PatchAnnotationsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"annotations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
}
},
"deleteIfEmptyData": {
"type": "boolean",
"description": "If the request is a \"remove\" action and the annotation is left with empty data,\nthen setting delete_if_empty_data to true will delete the annotation,\nif possible (for example, will not delete an input-level annotation)."
}
}
}
apiPatchAnnotationsSearchesRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched Search objects\nFor now only action 'overwrite' is supported"
},
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"title": "The searches to be patched"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiPatchAnnotationsStatusResponse
{
"type": "object",
"title": "PatchAnnotationsStatusResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"userIds": {
"type": "array",
"items": {
"type": "string"
}
},
"updatedCount": {
"type": "integer",
"format": "int64"
}
}
}
apiPatchCollectorsRequest
{
"type": "object",
"title": "PatchCollectorsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nOnly 'overwrite' is supported"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"collectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollector"
}
}
}
}
apiPatchConceptsRequest
{
"type": "object",
"title": "PatchConceptsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now ony action 'overwrite' is supported"
},
"concepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
},
"description": "The concepts to patch."
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiPatchDatasetsRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action to perform on the patched objects\nSupported values: 'overwrite', 'merge', and 'remove'.\n\nNote that 'remove' can only be used to remove the dataset image by setting\n'image.url' in the request to the current value returned for that dataset."
},
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDataset"
},
"description": "List of datasets that are requested to be updated."
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to patch several datasets."
}
apiPatchInputsRequest
{
"type": "object",
"title": "PatchInputsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
},
"title": "List of inputs to patch.\nInputs are identified by id field.\nFor each input, the following fields are patchable:\n* data"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiPatchInputsSearchesRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched Search objects\nFor now only action 'overwrite' is supported"
},
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"title": "The searches to be patched"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiPatchLabelOrdersRequest
{
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"labelOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiLabelOrder"
}
}
},
"description": "Request to patch a list of label orders."
}
apiPatchModelsRequest
{
"type": "object",
"title": "PatchModelsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported",
"description": "Note that 'remove' can be used to remove the model image by setting\n'image.url' in the request to the current value returned for that model.\nThis cannot be used in a request that is patching other fields as well."
},
"models": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModel"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiPatchSearchesRequest
{
"type": "object",
"title": "PatchSearchesRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched Search objects\nFor now only action 'overwrite' is supported"
},
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"title": "The searches to be patched"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiPatchTasksRequest
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTask"
}
},
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to patch a list of tasks."
}
apiPatchWorkflowsRequest
{
"type": "object",
"title": "PatchWorkflowsRequest",
"properties": {
"action": {
"type": "string",
"title": "The action to perform on the patched objects\nFor now actions 'merge', 'overwrite', and 'remove' are supported",
"description": "Note that 'remove' can be used to remove the workflow image by setting\n'image.url' in the request to the current value returned for that workflow.\nThis cannot be used in a request that is patching other fields as well."
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflow"
}
}
}
}
apiPoint
{
"type": "object",
"title": "Point",
"properties": {
"z": {
"type": "number",
"format": "float",
"description": "Depth if applicable for the point."
},
"col": {
"type": "number",
"format": "float",
"description": "The column location of the point. This has a [0.0-1.0] range with 0.0 being left col and 1.0\nbeing the right col."
},
"row": {
"type": "number",
"format": "float",
"description": "The row location of the point. This has a [0.0-1.0] range with 0.0 being top row and 1.0\nbeing the bottom row."
},
"visibility": {
"$ref": "#/components/schemas/apiPointVisibility"
}
}
}
apiPointVisibility
{
"enum": [
"NOT_SET",
"VISIBLE",
"NOT_VISIBLE",
"NOT_PRESENT"
],
"type": "string",
"title": "Whether this point is visible or occluded",
"default": "NOT_SET",
"description": "- NOT_SET: Visibility of the point is not set\n - VISIBLE: Point is visible\n - NOT_VISIBLE: Point is occluded\n - NOT_PRESENT: Point is not in the image"
}
apiPolygon
{
"type": "object",
"title": "Polygon",
"properties": {
"points": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiPoint"
},
"description": "A list of points connected together to form the polygon."
}
}
}
apiPostAnnotationFiltersRequest
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"annotationFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAnnotationFilter"
},
"description": "List of annotation filters that are requested to be added."
}
},
"description": "Request to add one or more annotation filters."
}
apiPostAnnotationSearchMetricsRequest
{
"type": "object",
"title": "PostAnnotationSearchMetricsRequest",
"properties": {
"id": {
"type": "string",
"title": "A unique customer facing id to identify this eval request"
},
"data": {
"$ref": "#/components/schemas/apiData"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"groundTruth": {
"$ref": "#/components/schemas/apiSearch"
},
"searchToEval": {
"$ref": "#/components/schemas/apiSearch"
},
"evaluationType": {
"$ref": "#/components/schemas/apiEvaluationType"
}
}
}
apiPostAnnotationsRequest
{
"type": "object",
"title": "PostAnnotationsRequest",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"annotations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
}
}
}
}
apiPostAnnotationsSearchesRequest
{
"type": "object",
"title": "Execute a new annotation search and optionally save it\nannotation search over annotations using rank and filter proto",
"properties": {
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"title": "The searched to be executed or saved"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
}
}
}
apiPostBulkOperationsRequest
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"bulkOperations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiBulkOperation"
},
"description": "List of bulk operation(s) to be performed e.g bulk update metadata or tags or labels etc."
}
},
"description": "Request to perform bulk operations on a list of inputs based on input source."
}
apiPostCollectorsRequest
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"collectors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiCollector"
}
}
},
"description": "Request to create Collectors."
}
apiPostConceptMappingJobsRequest
{
"type": "object",
"title": "Start concept mapping jobs",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"conceptMappingJobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConceptMappingJob"
},
"title": "The concept mapping jobs that are being started"
}
}
}
apiPostConceptsRequest
{
"type": "object",
"title": "PostConceptsRequest",
"properties": {
"concepts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiConcept"
},
"description": "The concepts to add."
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiPostConceptsSearchesRequest
{
"type": "object",
"title": "PostConceptsSearchesRequest",
"properties": {
"extraInfo": {
"$ref": "#/components/schemas/apiConceptExtraInfoRequest"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
},
"conceptQuery": {
"$ref": "#/components/schemas/apiConceptQuery"
}
}
}
apiPostDatasetsRequest
{
"type": "object",
"properties": {
"datasets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiDataset"
},
"description": "List of datasets that are requested to be added."
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to add one or more datasets."
}
apiPostEvaluationsRequest
{
"type": "object",
"title": "Evaluate this model vesion",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"evalMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiEvalMetrics"
},
"description": "eval_info, id, model, and ground_truth_dataset will be used when creating the evaluation\nIf no dataset is provided, all app data that is annotated with concepts from the model will be used."
}
}
}
apiPostInputsDataSourcesRequest
{
"type": "object",
"properties": {
"appPat": {
"type": "string",
"title": "Personal Access Token to the application to which inputs are added"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"callBackUrl": {
"type": "string",
"description": "If call back url is set, we will send a Post request to this endpoint with job status."
},
"dataSources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInputsDataSource"
}
}
},
"description": "Initiates retrieval of inputs from cloud storage from a user provided data source.\nWill create and return an inputs-add-job for tracking progress.\nArchives will be extracted and their contents will be processed as inputs.\n\nThe cloud URL will be treated as a filter prefix. For example s3:/bucket/images_folder/abc will process\nfiles in the images_folder beginning with abc or in a subfolder beginning with abc.\nFor example:\nbucket/images_folder/abcImage.png\nbucket/images_folder/abc-1/Data.zip\n\nIf given URL is for a private bucket or file, then credentials should be provided to access the bucket.\nCredentials should include rights to list the objects in the bucket, except when pointed directly at a file archive,\nin which case it only requires rights to access that particular file."
}
apiPostInputsRequest
{
"type": "object",
"title": "PostInputsRequest",
"properties": {
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
},
"title": "List of inputs to post.\nFor each input, the following fields are used:\n* id\n* data\n* dataset_ids"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"inputsAddJobId": {
"type": "string",
"description": "Collect statistics about created inputs in job with given ID.\n* If job ID is empty, then job is not created.\n* If job ID is non-empty and doesn't already exist, then a new job will be created with given ID.\n* If job ID does already exist, then new inputs statistics are merged with previous inputs statistics."
},
"inputIdConflictResolution": {
"$ref": "#/components/schemas/apiInputIDConflictResolution"
}
}
}
apiPostInputsSearchesRequest
{
"type": "object",
"title": "Execute a new input search and optionally save it",
"properties": {
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"title": "The searched to be executed or saved"
},
"onlyCount": {
"type": "boolean",
"description": "If only_count is set, then the response will not contain hits,\nbut hit_counts instead."
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
}
}
}
apiPostInputsUploadsRequest
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"inputsUploads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInputsUpload"
}
}
},
"description": "Start uploading a file archive containing inputs.\nWill create and return an inputs-add-job for tracking progress.\n\nAssociated inputs-add-job contains an upload id which should be completed through `PutUploadContentParts` endpoint.\nCompleting the upload will automatically begin unpacking the archive and uploading the contents as inputs."
}
apiPostKnowledgeGraphsRequest
{
"type": "object",
"title": "POST new knowledge graphs",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"knowledgeGraphs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiKnowledgeGraph"
}
}
}
}
apiPostLabelOrdersRequest
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"labelOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiLabelOrder"
}
}
},
"description": "Request to create label orders."
}
apiPostModelOutputsRequest
{
"type": "object",
"properties": {
"model": {
"$ref": "#/components/schemas/apiModel"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiInput"
}
},
"modelId": {
"type": "string"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"versionId": {
"type": "string"
},
"runnerSelector": {
"$ref": "#/components/schemas/apiRunnerSelector"
}
},
"description": "//////////////////////////////////////////////////\nModel prediction related stuff needs inputs and produces outputs.\n//////////////////////////////////////////////////\nModel prediction."
}
apiPostModelVersionsUploadConfig
{
"type": "object",
"properties": {
"modelId": {
"type": "string",
"title": "model to create version of"
},
"totalSize": {
"type": "string",
"title": "number of bytes in the model files to be uploaded",
"format": "uint64"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"modelVersion": {
"$ref": "#/components/schemas/apiModelVersion"
}
}
}
apiPostModelVersionsUploadRequest
{
"type": "object",
"properties": {
"contentPart": {
"$ref": "#/components/schemas/apiUploadContentPart"
},
"uploadConfig": {
"$ref": "#/components/schemas/apiPostModelVersionsUploadConfig"
}
}
}
apiPostModelVersionsUploadResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"bytesRemaining": {
"type": "string",
"format": "uint64"
},
"modelVersionId": {
"type": "string",
"title": "ID of the model version being uploaded"
}
}
}
apiPostModelsRequest
{
"type": "object",
"title": "PostModelsRequest",
"properties": {
"model": {
"$ref": "#/components/schemas/apiModel"
},
"models": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiModel"
},
"description": "This allows you to create one or more model by posting it to the API."
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiPostModelsSearchesRequest
{
"type": "object",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"modelQuery": {
"$ref": "#/components/schemas/apiModelQuery"
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
}
},
"description": "Search over the available models."
}
apiPostSearchesRequest
{
"type": "object",
"title": "PostSearchesRequest",
"properties": {
"query": {
"$ref": "#/components/schemas/apiQuery"
},
"searches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiSearch"
},
"title": "The searched to be executed or saved\nEventually the request level fields will be deprecated in favor of this object"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"pagination": {
"$ref": "#/components/schemas/apiPagination"
}
}
}
apiPostStatValuesAggregateRequest
{
"type": "object",
"title": "PostStatValuesAggregateRequest",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"statValueAggregateQueries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiStatValueAggregateQuery"
},
"description": "Query to retrieve aggregate values."
}
}
}
apiPostStatValuesRequest
{
"type": "object",
"title": "PostStatValuesRequest",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"statValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiStatValue"
},
"description": "The stats to post, can post more than one at a time."
}
}
}
apiPostTasksRequest
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTask"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
},
"description": "Request to create Tasks."
}
apiPostUploadsRequest
{
"type": "object",
"title": "Start a multipart upload",
"properties": {
"uploads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiUpload"
}
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiPostValidatePasswordRequest
{
"type": "object",
"title": "PostValidatePasswordRequest",
"properties": {
"password": {
"$ref": "#/components/schemas/apiPassword"
},
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
}
}
}
apiPostWorkflowResultsResponse
{
"type": "object",
"title": "PostWorkflowResultsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowResult"
},
"description": "The resulting predictions of all models in the workflow."
},
"workflow": {
"$ref": "#/components/schemas/apiWorkflow"
},
"workflowState": {
"$ref": "#/components/schemas/apiWorkflowState"
}
}
}
apiPostWorkflowResultsSimilarityResponse
{
"type": "object",
"title": "PostWorkflowResultsSimilarityResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowResultsSimilarity"
}
}
}
}
apiPostWorkflowsRequest
{
"type": "object",
"title": "PostWorkflowsRequest",
"properties": {
"userAppId": {
"$ref": "#/components/schemas/apiUserAppIDSet"
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflow"
}
}
}
}
apiPrecisionRecallCurve
{
"type": "object",
"title": "PrecisionRecallCurve",
"properties": {
"recall": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"precision": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"thresholds": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
}
}
}
apiPretrainedModelConfig
{
"type": "object",
"title": "PretrainedModelConfig",
"properties": {
"modelZipUrl": {
"type": "string",
"title": "Url to a zipped up model in triton format with the following files and folders at the root:\n config.pbtxt\n version 1 folder that contains model files (onnx graph, torch script, python BE model, and etc.)",
"description": "Whether to overwrite the model for the existing internal id"
},
"inputFieldsMap": {
"type": "object",
"description": "This is the internal id of the pretrained model.\nMap from the api.Data field names to the Triton config.pbtxt input."
},
"outputFieldsMap": {
"type": "object",
"description": "Map from the api.Data field names to the Triton config.pbtxt output."
}
}
}
apiProcessingInfo
{
"type": "object",
"title": "Processing info tells the runner how to process a RunnerItem",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"runnerMethodType": {
"$ref": "#/components/schemas/apiRunnerMethodType"
}
}
}
apiProgress
{
"type": "object",
"properties": {
"processed": {
"type": "integer",
"format": "int64"
},
"lastProcessedId": {
"type": "string"
}
}
}
apiPutTaskAssignmentsRequestAction
{
"enum": [
"PUT_TASK_ASSIGNMENTS_REQUEST_ACTION_NOT_SET",
"LABEL_START",
"LABEL_SUBMIT",
"REVIEW_START",
"REVIEW_APPROVE",
"REVIEW_REQUEST_CHANGES"
],
"type": "string",
"title": "- LABEL_START: Create a list of task assignments for labeler => 10 inputs are assigned to the labeler.\nThis is a fully sync action.\nIf task assignments already exist, then return existing task assignments.\n - LABEL_SUBMIT: Submit task assignments => mark task assignment work as completed.\nThis is a partially sync action.\nSync: task assignments are updated as follows:\n* when review_strategy is NONE, then task assignment status is updated to SUCCESS.\n* when review strategy is CONSENSUS, then task assignment status is updated to AWAITING_CONSENSUS_REVIEW.\n* when review strategy is MANUAL, then task assignment status is updated to AWAITING_REVIEW.\nIf task assignments are already submitted, then no update is performed on them.\nAsync: annotations added for the same input as the task assignment are updated as follows:\n* when review_strategy is NONE, then annotation status is updated to SUCCESS.\n* when review strategy is CONSENSUS, then annotation status is updated to SUCCESS (if it reaches consensus) or AWAITING_REVIEW (if it does not reach consensus).\n* when review strategy is MANUAL, then annotation status is updated to AWAITING_REVIEW.\n - REVIEW_START: Return a list of task assignments for reviewer to review => 10 inputs are assigned to the reviewer.\nThis is a fully sync action.\nNOT idempotent:\n In the current implementation, we don't actually store the reviewer in the task assignment,\n as the task assignment still stays assigned to the labeler.\n Therefore, multiple calls to this endpoint may result in different set of task assignments to review.\n For now, this action is practically not idempotent.\n In the future, we could however store the reviewer in the task assignment and\n return existing task assignments already assigned to the reviewer => this will make this action idempotent.\n - REVIEW_APPROVE: Approve task assignments.\nThere are two types of configurations:\n* Batch approve: approve a list of task assignment IDs;\n* Bulk approve: approve all task assignments from a list of workers.\nThis is a partially sync action.\nSync: task assignments are updated to SUCCESS\nAsync: annotations added for the same input as the task assignment are updated to SUCCESS\n - REVIEW_REQUEST_CHANGES: Request changes for task assignments.\nThere are two types of configurations:\n* Batch request changes: request changes for a list of task assignment IDs;\n* Bulk request changes: request changes for all task assignments from a list of workers.\nThis is a partially sync action.\nSync: task assignments are updated to PENDING\nAsync: annotations added for the same input as the task assignment are updated to PENDING",
"default": "PUT_TASK_ASSIGNMENTS_REQUEST_ACTION_NOT_SET"
}
apiQuery
{
"type": "object",
"properties": {
"ands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiAnd"
},
"description": "The query syntax is simply a list of And operatiosn that will be ANDed together to fetch\nresults which are returned to the user as Hit messages.\n\nDeprecated: Only used by the deprecated PostSearches endpoint. Use filters\nand ranks instead with PostInputsSearches or PostAnnotationsSearches."
},
"ranks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiRank"
},
"title": "rankings in this query\ne.g. visual search by a url"
},
"filters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiFilter"
},
"title": "filters in this query\ne.q. only fetch annotations that have certain metadata"
},
"language": {
"type": "string",
"description": "This allows the query to override any default language the app was setup in when doing Concept\nbased searches. This currently only affects public Models Output searches when those public\nModels have translations for their Concepts."
}
},
"description": "This is the search query used in /searches, model training requests, bulk data exports, etc."
}
apiROC
{
"type": "object",
"title": "ROC",
"properties": {
"fpr": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"tpr": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"thresholds": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"fprPerImage": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"fprPerObject": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
}
}
}
apiRank
{
"type": "object",
"title": "Rank",
"properties": {
"negate": {
"type": "boolean",
"title": "If True then this will flip the meaning of this part of the\nquery. This allow for queries such as !dog"
},
"annotation": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
}
}
}
apiRegion
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique id for the region."
},
"data": {
"$ref": "#/components/schemas/apiData"
},
"value": {
"type": "number",
"format": "float",
"description": "This is the confidence score of the overall Region."
},
"trackId": {
"type": "string",
"description": "For tracking algorithsm and annotations we tie regions together with this track id."
},
"regionInfo": {
"$ref": "#/components/schemas/apiRegionInfo"
}
},
"description": "A region within the data."
}
apiRegionInfo
{
"type": "object",
"properties": {
"mask": {
"$ref": "#/components/schemas/apiMask"
},
"span": {
"$ref": "#/components/schemas/apiSpan"
},
"point": {
"$ref": "#/components/schemas/apiPoint"
},
"token": {
"$ref": "#/components/schemas/apiToken"
},
"polygon": {
"$ref": "#/components/schemas/apiPolygon"
},
"boundingBox": {
"$ref": "#/components/schemas/apiBoundingBox"
},
"keypointLocations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiPoint"
},
"description": "The locations of detected keypoints, which are to be used in conjunction with the detected concept's skeleton to connect the keypoint locations.\nThese will be in the same order as the respective keypoint_names inside the concept."
}
},
"description": "The information of the location of the Region."
}
apiReviewApproveConfig
{
"type": "object",
"properties": {
"workers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorker"
}
},
"taskAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTaskAssignment"
}
}
}
}
apiReviewRequestChangesConfig
{
"type": "object",
"properties": {
"workers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorker"
}
},
"taskAssignments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiTaskAssignment"
}
}
}
}
apiRunner
{
"type": "object",
"title": "A worker for compute within a nodepool of instances.\nThis asks the API for work",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for this app module.\nThis is a UUID since runners can be automatically orchestrated."
},
"model": {
"$ref": "#/components/schemas/apiModel"
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Labels to match in order to find work."
},
"userId": {
"type": "string",
"description": "The owner of the runner. Runners belong to a user/org account."
},
"metadata": {
"type": "object",
"description": "To handle arbitrary json metadata you can use a struct field:\nhttps://github.com/google/protobuf/blob/master/src/google/protobuf/struct.proto\nThis is an optional arg."
},
"nodepool": {
"$ref": "#/components/schemas/apiNodepool"
},
"workflow": {
"$ref": "#/components/schemas/apiWorkflow"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the app module was created."
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the app module was last modified."
},
"computeInfo": {
"$ref": "#/components/schemas/apiComputeInfo"
},
"description": {
"type": "string",
"description": "A short description for this app module to be used in grids of modules."
}
}
}
apiRunnerItem
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A UUID hash for this work item."
},
"description": {
"type": "string",
"description": "A description of the work to be done in case needed for UIs."
},
"processingInfo": {
"$ref": "#/components/schemas/apiProcessingInfo"
},
"postModelOutputsRequest": {
"$ref": "#/components/schemas/apiPostModelOutputsRequest"
}
},
"description": "This is a piece of work for a runner to process."
}
apiRunnerItemOutput
{
"type": "object",
"properties": {
"multiOutputResponse": {
"$ref": "#/components/schemas/apiMultiOutputResponse"
}
}
}
apiRunnerMethodType
{
"enum": [
"UNKNOWN",
"UNARY_UNARY",
"UNARY_STREAMING",
"STREAMING_UNARY",
"STREAMING_STREAMING"
],
"type": "string",
"title": "- UNARY_UNARY: single request, single response. predict() in code\n - UNARY_STREAMING: single request, streamed response. generate() in code\n - STREAMING_UNARY: stream of requests, single response.\n - STREAMING_STREAMING: stream of requests, stream of responses. stream() in code",
"default": "UNKNOWN"
}
apiRunnerSelector
{
"type": "object",
"properties": {
"runner": {
"$ref": "#/components/schemas/apiRunner"
},
"nodepool": {
"$ref": "#/components/schemas/apiNodepool"
},
"deployment": {
"$ref": "#/components/schemas/apiDeployment"
}
},
"description": "////////////////////////////////////////\nDon't need RunnerSelector if we're opening up endpoints for deployments.\n////////////////////////////////////////\nThe RunnerSelector is an optional field we can provide during runtime\nof model/workflow predictions to specify which particular runner we want to process the work.\nThis can optionally be used to select a particular nodepool and then within that nodepool\na particular runner."
}
apiScopeDeps
{
"type": "object",
"title": "ScopeDeps",
"properties": {
"scope": {
"type": "string",
"title": "The scope"
},
"dependingScopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Other scopes that are required."
}
}
}
apiSearch
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Customer facing, external ID for search to be saved. Provided by the user, e.g. \"saved-search-1.\nIt is unique per application."
},
"asOf": {
"type": "string",
"format": "date-time",
"description": "\"As of\" timestamp, indicating a time in the past as of which we want to\nretrieve the annotations satisfying the query."
},
"name": {
"type": "string",
"description": "Human readable display name of the saved search."
},
"save": {
"type": "boolean",
"title": "If true, save this search, and exit without executing the search.\nIf false execute the query"
},
"query": {
"$ref": "#/components/schemas/apiQuery"
},
"metric": {
"$ref": "#/components/schemas/SearchMetric"
},
"gitHash": {
"type": "string",
"description": "Git hash of the code that ran the filter."
},
"minValue": {
"type": "number",
"format": "float",
"description": "Minimum value of confidence threshold score in result.\nDefaults to 0.0 which means we won't do any thresholding as all probabilities will\nlikely be > 0.0."
},
"algorithm": {
"type": "string",
"title": "The search algorithm to be used.\nOptions are are 'nearest_neighbor', 'brute_force', and 'avg_concept_brute_force'\nThe last two perform a brute force search visual search instead of a more scalable distributed\nnearest neighbor search and should be used by advanced users only.\nIf not specified we default to nearest neighbor"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the saved search was created."
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the saved search was updated."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"applicationId": {
"type": "string",
"description": "Application that owns this saved search."
}
},
"description": "This is the new Search object used in saved searches."
}
apiSingleAnnotationFilterResponse
{
"type": "object",
"title": "SingleAnnotationFilterResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"annotationFilter": {
"$ref": "#/components/schemas/apiAnnotationFilter"
}
}
}
apiSingleAnnotationResponse
{
"type": "object",
"title": "SingleAnnotationResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"annotation": {
"$ref": "#/components/schemas/clarifaiapiAnnotation"
}
}
}
apiSingleAppDuplicationResponse
{
"type": "object",
"title": "SingleAppDuplicationResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"appDuplication": {
"$ref": "#/components/schemas/apiAppDuplication"
}
}
}
apiSingleAppResponse
{
"type": "object",
"title": "SingleAppResponse",
"properties": {
"app": {
"$ref": "#/components/schemas/apiApp"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
}
}
apiSingleBulkOperationsResponse
{
"type": "object",
"title": "SingleBulkOperationsResponse",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"bulkOperation": {
"$ref": "#/components/schemas/apiBulkOperation"
}
}
}
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."
}
}
}
apiTaskStatusCountPerUser
{
"type": "object",
"title": "TaskStatusCountPerUser can represents count of human created annotations for a user for each valid status,\ncount of inputs (anchor annotation) for a user for each valid status",
"properties": {
"userId": {
"type": "string"
},
"pending": {
"type": "integer",
"format": "int64"
},
"success": {
"type": "integer",
"format": "int64"
},
"reviewDenied": {
"type": "integer",
"format": "int64"
},
"awaitingReview": {
"type": "integer",
"format": "int64"
},
"awaitingConsensusReview": {
"type": "integer",
"format": "int64"
}
}
}
apiTaskWorkMetrics
{
"type": "object",
"properties": {
"inputsCountEstimated": {
"type": "string",
"format": "uint64",
"description": "Estimated number of inputs that workers have worked on."
},
"inputsPercentEstimated": {
"type": "integer",
"format": "int64",
"description": "Estimated percent of inputs that workers have worked on.\nThis is a value between 0 and 100, where 0 = 0% and 100 = 100%."
}
}
}
apiTaskWorker
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiUser"
},
"description": "Users who will work on this task.\nWhen the 'worker.users' field is additionally requested, then all user\ninfo is filled for the workers. Otherwise, only the user 'id' is filled.\nDEPRECATED: Use workers.user instead."
},
"userIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Who will work on this task.\nDEPRECATED: Use workers.user.id instead."
},
"workers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorker"
},
"description": "Workers that will work on this task.\n\nFor Auto Annotation Tasks:\n the worker can be either a model or a workflow;\n currently only supports 1 worker.\nFor manual labeling Tasks:\n the workers can only be users;\n no limitation on number of workers."
},
"strategy": {
"$ref": "#/components/schemas/TaskWorkerTaskWorkerStrategy"
},
"partitionedStrategyInfo": {
"$ref": "#/components/schemas/apiTaskWorkerPartitionedStrategyInfo"
}
},
"description": "TaskWorker includes information about the workers that will work on this task."
}
apiTaskWorkerPartitionedStrategyInfo
{
"type": "object",
"title": "TaskWorkerPartitionedStrategyInfo",
"properties": {
"type": {
"$ref": "#/components/schemas/TaskWorkerPartitionedStrategyInfoTaskWorkerPartitionedStrategy"
},
"weights": {
"type": "object",
"description": "In case of weighted partitioning, map user ids to weights.\nEach labeler will be assigned work proportional to its own weight as compared to the sum of total weight.\n\nEXAMPLE:\nIf we have 3 workers, and weights = {1: 30, 2: 30, 3: 40},\nthen first worker will have assigned 30% of the work,\nsecond worker will have assigned 30% of the work,\nand third worker will have assigned 40% of the work.\nYou may use weights which add up to 100, but it's not necessary.\nFor example, weights {1: 30, 2: 30, 3: 40} are equivalent with {1: 3, 2: 3, 3: 4}\nbecause they represent the same percentages: {1: 30%, 2: 30%, 3: 40%}.\n\nNOTE:\nNote that no worker should be assigned a weight percentage greater than 1/workers_per_input.\nIt is mathematically impossible to partition the work in such a case.\nWhy? Say, we have 3 workers. And workers_per_input = 2, i.e. each input must be labeled by 2 workers.\nLet's assign weights {1: 51%, 2: 25%, 3: 24%}.\nNote that first worker has a weight percentage higher than 1/workers_per_input = 1/2 = 50%.\nIf we have 100 inputs, then a total of 100 * workers_per_input = 200 cumulative inputs will be labeled by these 3 workers.\nWorker 1 should label 102 cumulative inputs, while worker 2 and worker 3 will label 98 cumulative inputs together.\nNo matter how we assign the 98 cumulative inputs, the 2 workers will be able to label up to 98 actual inputs.\nThis means the remaining 2 inputs will be labeled only by worker 1. This contradicts the worker_per_input = 2 requirement."
},
"workersPerInput": {
"type": "integer",
"format": "int32",
"description": "How many workers will label each input."
}
}
}
apiText
{
"type": "object",
"title": "Text",
"properties": {
"raw": {
"type": "string",
"description": "This is a raw text string."
},
"url": {
"type": "string",
"title": "Url to a text file"
},
"hosted": {
"$ref": "#/components/schemas/apiHostedURL"
},
"textInfo": {
"$ref": "#/components/schemas/apiTextInfo"
},
"allowDuplicateUrl": {
"type": "boolean"
}
}
}
apiTextInfo
{
"type": "object",
"properties": {
"encoding": {
"type": "string",
"title": "text encoding"
},
"charCount": {
"type": "integer",
"title": "count of characters in text",
"format": "int32"
}
}
}
apiThresholdRange
{
"type": "object",
"properties": {
"lower": {
"type": "number",
"format": "float"
},
"upper": {
"type": "number",
"format": "float"
},
"isLowerInclusive": {
"type": "boolean",
"title": "The range used to filter over concept values.\ne.g. GREATER_THAN_OR_EQUAL_TO 0.7 -> is_lower_inclusive = true, lower = 0.7, is_upper_inclusive = true, upper = 1.0\ne.g. (0.3, 0.75] -> is_lower_inclusive = false, lower = 0.3, is_upper_inclusive = true, upper = 0.75"
},
"isUpperInclusive": {
"type": "boolean"
}
}
}
apiTimeInfo
{
"type": "object",
"title": "TimeInfo",
"properties": {
"endTime": {
"type": "number",
"format": "float",
"description": "Timestamp where track ends."
},
"beginTime": {
"type": "number",
"format": "float",
"description": "Timestamp where track begins."
},
"numFrames": {
"type": "integer",
"title": "Number of frames",
"format": "int64"
}
}
}
apiTimeRange
{
"type": "object",
"title": "TimeRange",
"properties": {
"endTime": {
"type": "string",
"format": "date-time",
"description": "End of the time range, optional, inclusive."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "Begin of the time range, optional, inclusive."
}
}
}
apiTimeSegment
{
"type": "object",
"title": "TimeSegment",
"properties": {
"id": {
"type": "string",
"description": "A unique id for the time segment."
},
"data": {
"$ref": "#/components/schemas/apiData"
},
"timeInfo": {
"$ref": "#/components/schemas/apiTimeInfo"
}
}
}
apiToken
{
"type": "object",
"properties": {
"charEnd": {
"type": "integer",
"format": "int64"
},
"rawText": {
"type": "string"
},
"charStart": {
"type": "integer",
"format": "int64"
}
}
}
apiTrack
{
"type": "object",
"title": "Track proto encodes information of a track over a number of frames",
"properties": {
"id": {
"type": "string",
"title": "track id"
},
"data": {
"$ref": "#/components/schemas/apiData"
},
"quality": {
"type": "number",
"format": "float"
},
"timeInfo": {
"$ref": "#/components/schemas/apiTimeInfo"
}
}
}
apiTrackerMetrics
{
"type": "object",
"title": "TrackerMetrics",
"properties": {
"aiid": {
"type": "string",
"title": "The concept that we are evaluating the tracker"
},
"motMota": {
"type": "number",
"title": "Multiple object tracking accuracy",
"format": "float"
},
"morseFrag": {
"type": "number",
"title": "MORSE fragmentation rate (a.k.a unique switch rate, only calculated in public sector)",
"format": "float"
},
"avgPrecision": {
"type": "number",
"title": "Average precision calculated from all processed frames",
"format": "float"
},
"motNumSwitches": {
"type": "integer",
"title": "Number of switches between tracks",
"format": "int32"
},
"uniqueSwitchRate": {
"type": "number",
"title": "Same as morse_frag but calculated using MOT mapping/metrics",
"format": "float"
}
}
}
apiTrainInfo
{
"type": "object",
"properties": {
"params": {
"type": "object",
"description": "To control the training process when PostModelVersions is used we allow a list of parameters\ndefined for each ModelType as a Struct (JSON object) here. During training, the settings\ncontained within are sent to the training processor to alter the training process."
},
"dataset": {
"$ref": "#/components/schemas/apiDataset"
},
"resumeFromModel": {
"$ref": "#/components/schemas/apiModel"
}
}
}
apiTrendingMetric
{
"type": "object",
"title": "TrendingMetric",
"properties": {
"appId": {
"type": "string"
},
"userId": {
"type": "string"
},
"objectId": {
"type": "string"
},
"viewCount": {
"type": "string",
"format": "uint64"
}
}
}
apiTritonCondaEnvInfo
{
"type": "object",
"properties": {
"condaPackUrl": {
"type": "string"
},
"condaYamlUrl": {
"type": "string"
}
}
}
apiUpload
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID of upload"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the upload was started.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "When the upload will expire and be deleted\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"contentUrl": {
"type": "string",
"title": "Url of uploaded content"
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "Most recent time when the upload was updated.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"contentName": {
"type": "string",
"title": "name of uploaded content (e.g. filename)"
},
"contentLength": {
"type": "string",
"title": "Total size of the upload content",
"format": "uint64"
}
}
}
apiUploadContentPart
{
"type": "object",
"properties": {
"data": {
"type": "string",
"format": "byte"
},
"partNumber": {
"type": "string",
"format": "int64"
},
"rangeStart": {
"type": "string",
"format": "uint64"
}
}
}
apiUser
{
"type": "object",
"title": "User",
"properties": {
"id": {
"type": "string"
},
"jobRole": {
"type": "string"
},
"billType": {
"type": "string"
},
"jobTitle": {
"type": "string"
},
"lastName": {
"type": "string"
},
"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"
},
"createdAt": {
"type": "string",
"title": "When the user was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
},
"firstName": {
"type": "string"
},
"intention": {
"type": "string",
"title": "This specifies user intent when registering on clarifai"
},
"isStarred": {
"type": "boolean",
"title": "Is starred by the requesting user (only showed on get/list requests)\nPlease use PostUserStars/DeleteUserStars endpoints to star/unstar an user"
},
"starCount": {
"type": "integer",
"title": "How many users have starred the user (only showed on get/list requests)\nComputed value, not editable",
"format": "int32"
},
"teamsCount": {
"type": "integer",
"format": "int64"
},
"userDetail": {
"$ref": "#/components/schemas/apiUserDetail"
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"companyName": {
"type": "string"
},
"primaryEmail": {
"type": "string"
},
"datePiiConsent": {
"type": "string",
"format": "date-time"
},
"dateTosConsent": {
"type": "string",
"format": "date-time"
},
"emailAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiEmailAddress"
}
},
"dateGdprConsent": {
"type": "string",
"format": "date-time"
},
"dateMarketingConsent": {
"type": "string",
"format": "date-time"
},
"twoFactorAuthEnabled": {
"type": "boolean"
}
}
}
apiUserAppIDSet
{
"type": "object",
"properties": {
"appId": {
"type": "string"
},
"userId": {
"type": "string",
"title": "Note user_id 'me' is reserved - it is the alias for the id of authorized user"
}
},
"description": "Common message to identify the app in a url endpoint."
}
apiUserDetail
{
"type": "object",
"properties": {
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"billType": {
"type": "string"
},
"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"
},
"teamsCount": {
"type": "integer",
"format": "int64"
},
"primaryEmail": {
"type": "string"
},
"datePiiConsent": {
"type": "string",
"format": "date-time"
},
"dateTosConsent": {
"type": "string",
"format": "date-time"
},
"emailAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiEmailAddress"
}
},
"dateGdprConsent": {
"type": "string",
"format": "date-time"
},
"dateMarketingConsent": {
"type": "string",
"format": "date-time"
},
"twoFactorAuthEnabled": {
"type": "boolean"
}
},
"description": "This message holds the confidential information from the User object that we don't want to expose\nto other users. It will be accessible only from /users/{user_id}/account and with the User scopes."
}
apiVideo
{
"type": "object",
"title": "Video",
"properties": {
"url": {
"type": "string",
"description": "This is a URL to a publicly accessible video file. The platform will download this file server\nside and then process."
},
"base64": {
"type": "string",
"format": "byte",
"description": "The base64 field is using video file bytes directly in the request.\nNOTE: if you're sending a json request, then this MUST be base64 encoded before sending (hence\nthe name here).\nWhen using our grpc clients, you DO NOT need to base64 encode\nit yourself since the clients know how to do this for you automatically and will avoid the\nbase64 encoding if they send a binary request."
},
"hosted": {
"$ref": "#/components/schemas/apiHostedURL"
},
"videoInfo": {
"$ref": "#/components/schemas/apiVideoInfo"
},
"thumbnailUrl": {
"type": "string",
"title": "URL of thumbnail image, which is currently frame at position of 1s. This field is currently\nused only in response.\nDeprecated in favour of thumbnail_hosted, which also contains alternate sizes of thumbnail"
},
"hostedThumbnail": {
"$ref": "#/components/schemas/apiHostedURL"
},
"allowDuplicateUrl": {
"type": "boolean"
}
}
}
apiVideoInfo
{
"type": "object",
"properties": {
"fps": {
"type": "number",
"format": "float",
"description": "Frames per second of the video."
},
"width": {
"type": "integer",
"title": "width",
"format": "int32"
},
"height": {
"type": "integer",
"title": "height",
"format": "int32"
},
"bitRate": {
"type": "integer",
"title": "video track bit rate",
"format": "int32"
},
"frameCount": {
"type": "integer",
"title": "video frame count",
"format": "int32"
},
"videoFormat": {
"type": "string",
"title": "video format"
},
"durationSeconds": {
"type": "number",
"title": "video duration in seconds",
"format": "float"
}
}
}
apiW3C
{
"type": "object",
"properties": {
"hex": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
apiWorker
{
"type": "object",
"properties": {
"user": {
"$ref": "#/components/schemas/apiUser"
},
"model": {
"$ref": "#/components/schemas/apiModel"
},
"workflow": {
"$ref": "#/components/schemas/apiWorkflow"
}
},
"description": "Worker is the author of an annotation."
}
apiWorkflow
{
"type": "object",
"title": "Workflow",
"properties": {
"id": {
"type": "string",
"description": "The workflows's unique id."
},
"appId": {
"type": "string",
"title": "The app the workflow belongs to"
},
"image": {
"$ref": "#/components/schemas/apiImage"
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowNode"
},
"description": "The list of nodes retrieved from latest workflow version.\nEach node can specify an input node that it connects to in order to define the graph."
},
"notes": {
"type": "string",
"description": "Notes for the workflow\nThis field should be used for in-depth notes and supports up to 64Kbs."
},
"userId": {
"type": "string",
"title": "The user the workflow belongs to"
},
"version": {
"$ref": "#/components/schemas/apiWorkflowVersion"
},
"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"
},
"useCases": {
"type": "array",
"items": {
"type": "string"
},
"title": "Tags from use_cases category"
},
"createdAt": {
"type": "string",
"title": "When the workflow was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
},
"isStarred": {
"type": "boolean",
"title": "Is starred by the requesting user (only showed on get/list requests)\nPlease use PostWorkflowStars/DeleteWorkflowStars endpoints to star/unstar a workflow"
},
"starCount": {
"type": "integer",
"title": "How many users have starred the workflow (only showed on get/list requests)\nComputed value, not editable",
"format": "int32"
},
"modifiedAt": {
"type": "string",
"title": "When the workflow was last modified",
"format": "date-time"
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"description": {
"type": "string",
"title": "Short description about this workflow"
},
"checkConsents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Tags for check consents"
},
"bookmarkOrigin": {
"$ref": "#/components/schemas/apiBookmarkOrigin"
}
}
}
apiWorkflowModelUseCase
{
"enum": [
"WORKFLOW_MODEL_USE_CASE_NOT_SET",
"CLASSIFICATION",
"DETECTION"
],
"type": "string",
"default": "WORKFLOW_MODEL_USE_CASE_NOT_SET",
"description": " - CLASSIFICATION: Classifier models without a detector parent (recursive check) in a workflow\nare used for classification.\n - DETECTION: Detector models in a workflow are used for detection.\nClassifier models that run after a detector model are also used for detection."
}
apiWorkflowNode
{
"type": "object",
"title": "WorkflowNode",
"properties": {
"id": {
"type": "string",
"description": "An identifier for this node in the graph. This is used when connecting NodeInputs\ntogether."
},
"model": {
"$ref": "#/components/schemas/apiModel"
},
"nodeInputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiNodeInput"
},
"description": "Each WorkflowNode can connect to multiple input nodes so that we can handle multi-model data\nand more complex workflow operations."
},
"suppressOutput": {
"type": "boolean",
"title": "suppress the output for workflow prediction"
},
"outputInfoOverride": {
"$ref": "#/components/schemas/apiOutputInfo"
}
}
}
apiWorkflowResult
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"$ref": "#/components/schemas/apiInput"
},
"model": {
"$ref": "#/components/schemas/apiModel"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiOutput"
},
"description": "For each model in the workflow we return an Output."
},
"createdAt": {
"type": "string",
"title": "When the object was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
},
"suppressOutput": {
"type": "boolean",
"description": "Indicate if the output of this model is suppressed."
}
},
"description": "WorkflowResult\nOne result per input in the workflow."
}
apiWorkflowResultsSimilarity
{
"type": "object",
"title": "WorkflowResultsSimilarity",
"properties": {
"probeInput": {
"$ref": "#/components/schemas/apiInput"
},
"poolResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiHit"
}
}
}
}
apiWorkflowState
{
"type": "object",
"title": "WorkflowState",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for the workflow state.\nTo start saving a state in a PostWorkflowResults request set this ID to \"init\"\nand it will return a newly generated unique state id that you can then pass in subsequent\nPostWorkflowResults calls. These state expire after 5 minutes between calls."
}
}
}
apiWorkflowVersion
{
"type": "object",
"title": "WorkflowVersion",
"properties": {
"id": {
"type": "string",
"description": "Id of this version."
},
"appId": {
"type": "string",
"description": "The app the workflow version belongs to."
},
"nodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiWorkflowNode"
},
"description": "The list of nodes that make up the workflow version. Each node can specify an input node\nthat it connects to in order to define the graph."
},
"userId": {
"type": "string",
"description": "The user the workflow version belongs to."
},
"license": {
"type": "string",
"title": "License associated to this workflow version"
},
"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"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "When the version was created.\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 time when the version was updated.\nThe format is https://www.ietf.org/rfc/rfc3339.txt.\nExample: \"2006-01-02T15:04:05.999999Z\"."
},
"visibility": {
"$ref": "#/components/schemas/clarifaiapiVisibility"
},
"workflowId": {
"type": "string",
"description": "Workflow id for this version."
},
"description": {
"type": "string",
"title": "Short description about this workflow version"
}
}
}
apiWorkflowVersionPublishRequest
{
"type": "object",
"properties": {
"versionId": {
"type": "string"
}
}
}
apiWorkflowVersionUnPublishRequest
{
"type": "object",
"properties": {
"versionId": {
"type": "string"
}
}
}
apistatusStatus
{
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/statusStatusCode"
},
"reqId": {
"type": "string",
"title": "A request ID may be present, to help monitoring and tracking requests"
},
"details": {
"type": "string",
"description": "More details of the given error.\nThese details may be exposed to non-technical users.\nFor technical details, try to use developer_notes field."
},
"stackTrace": {
"type": "array",
"items": {
"type": "string"
},
"description": "For some environment we may return a stack trace to help debug\nany issues."
},
"description": {
"type": "string",
"description": "A short description of the error."
},
"redirectInfo": {
"$ref": "#/components/schemas/statusRedirectInfo"
},
"timeRemaining": {
"type": "integer",
"title": "if status is pending, how much time is remaining (in seconds)",
"format": "int64"
},
"developerNotes": {
"type": "string",
"description": "Notes for developer.\nThese notes are rather technical details for developers how to interpret the status,\ne.g. why an error occurred and how to avoid getting the error."
},
"internalDetails": {
"type": "string",
"description": "Internal Annotation (do not set in production, for internal Clarifai use only)."
},
"percentCompleted": {
"type": "integer",
"title": "specifically for long running jobs",
"format": "int64"
}
}
}
clarifaiapiAnnotation
{
"type": "object",
"title": "Annotation of an asset with metadata",
"properties": {
"id": {
"type": "string",
"title": "The ID for the annotation"
},
"data": {
"$ref": "#/components/schemas/apiData"
},
"status": {
"$ref": "#/components/schemas/apistatusStatus"
},
"taskId": {
"type": "string",
"title": "The id of the task annotation belongs to"
},
"userId": {
"type": "string",
"title": "ID of the user this annotation is created by"
},
"inputId": {
"type": "string",
"title": "ID of the input this annotation is tied to"
},
"trusted": {
"type": "boolean",
"title": "Whether or not this annotation is trusted\nWill be deprecated"
},
"createdAt": {
"type": "string",
"title": "When the annotation was created. We follow the XXXX timestamp\nformat. We use https://www.ietf.org/rfc/rfc3339.txt format:\n\"2006-01-02T15:04:05.999999Z\" so you can expect results like\nthe following from the API:\n\"2017-04-11T21:50:50.223962Z\"",
"format": "date-time"
},
"inputLevel": {
"type": "boolean",
"description": "Is this the input level annotation."
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "When the annotation was modified."
},
"consensusInfo": {
"type": "object",
"title": "Consensus review related information, e.g.\n* annotation group\n* id of annotation parent, in case the annotation was split from another annotation"
},
"annotationInfo": {
"type": "object",
"title": "task_id is deprecated in annotation_info. Use task_id"
},
"modelVersionId": {
"type": "string",
"title": "ID of the model version this annotation is created by"
},
"workflowVersionId": {
"type": "string",
"title": "ID of the workflow version this annotation is created by"
},
"embedModelVersionId": {
"type": "string",
"description": "DEPRECATED."
}
}
}
clarifaiapiVisibility
{
"type": "object",
"properties": {
"gettable": {
"$ref": "#/components/schemas/VisibilityGettable"
}
},
"description": "Visibility represents how visible the given resource is to other users.\nWhen authenticating a request we can tell if a user is a collaborator or a teammate for the\nthe app that contains the resource and set their allowed visibility. We use that to restrict\nwhat they are allowed to see:\nIf AllowedVisibility is PRIVATE then we allow PRIVATE (10), ORG (30), PUBLIC (50)\nIf AllowedVisibility is ORG then we allow ORG (30), PUBLIC (50)\nIf AllowedVisibility is PUBLIC then we allow PUBLIC (50) only."
}
googlerpcStatus
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/protobufAny"
}
},
"message": {
"type": "string"
}
}
}
protobufAny
{
"type": "object",
"properties": {
"@type": {
"type": "string"
}
},
"additionalProperties": {}
}
protobufNullValue
{
"enum": [
"NULL_VALUE"
],
"type": "string",
"default": "NULL_VALUE",
"description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value."
}
statusBaseResponse
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/apistatusStatus"
}
},
"description": "Base message to return when there is a internal server error that\nis not caught elsewhere."
}
statusRedirectInfo
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "New location for the resource. Used to set response Location header."
},
"resourceType": {
"type": "string",
"title": "Resource type"
},
"newResourceId": {
"type": "string",
"title": "New resource id"
},
"oldResourceId": {
"type": "string",
"title": "Old resource id"
}
}
}
statusStatusCode
{
"enum": [
"ZERO",
"SUCCESS",
"MIXED_STATUS",
"FAILURE",
"TRY_AGAIN",
"NOT_IMPLEMENTED",
"MOVED",
"TEAPOT",
"CONN_ACCOUNT_ISSUES",
"CONN_TOKEN_INVALID",
"CONN_CREDENTIALS_INVALID",
"CONN_EXCEED_HOURLY_LIMIT",
"CONN_EXCEED_MONTHLY_LIMIT",
"CONN_THROTTLED",
"CONN_EXCEEDS_LIMITS",
"CONN_INSUFFICIENT_SCOPES",
"CONN_KEY_INVALID",
"CONN_KEY_NOT_FOUND",
"CONN_BAD_REQUEST_FORMAT",
"CONN_DOES_NOT_EXIST",
"CONN_INVALID_REQUEST",
"CONN_METHOD_NOT_ALLOWED",
"CONN_NO_GDPR_CONSENT",
"CONN_AUTH_METHOD_DISABLED",
"MODEL_TRAINED",
"MODEL_TRAINING",
"MODEL_UNTRAINED",
"MODEL_QUEUED_FOR_TRAINING",
"MODEL_UPLOADING",
"MODEL_UPLOADING_FAILED",
"MODEL_TRAINING_FAILED",
"MODEL_TRAINING_NO_DATA",
"MODEL_TRAINING_NO_POSITIVES",
"MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS",
"MODEL_TRAINING_TIMED_OUT",
"MODEL_TRAINING_WAITING_ERROR",
"MODEL_TRAINING_UNKNOWN_ERROR",
"MODEL_TRAINING_MSG_REDELIVER",
"MODEL_TRAINING_INSUFFICIENT_DATA",
"MODEL_TRAINING_INVALID_PARAMS",
"MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED",
"MODEL_MODIFY_SUCCESS",
"MODEL_MODIFY_PENDING",
"MODEL_MODIFY_FAILED",
"MODEL_DOES_NOT_EXIST",
"MODEL_PERMISSION_DENIED",
"MODEL_INVALID_ARGUMENT",
"MODEL_INVALID_REQUEST",
"MODEL_EVALUATED",
"MODEL_EVALUATING",
"MODEL_NOT_EVALUATED",
"MODEL_QUEUED_FOR_EVALUATION",
"MODEL_EVALUATION_TIMED_OUT",
"MODEL_EVALUATION_WAITING_ERROR",
"MODEL_EVALUATION_UNKNOWN_ERROR",
"MODEL_PREDICTION_FAILED",
"MODEL_EVALUATION_MSG_REDELIVER",
"MODEL_EVALUATION_NEED_LABELS",
"MODEL_EVALUATION_NEED_INPUTS",
"MODEL_EVALUATION_FAILED",
"MODEL_DEPLOYMENT_FAILED",
"MODEL_DEPLOYING",
"MODEL_QUEUED_FOR_DEPLOYMENT",
"MODEL_NOT_DEPLOYED",
"MODEL_REFERENCE_INVALID_ARGUMENT",
"MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT",
"MODEL_EXPORTED",
"MODEL_EXPORTING",
"MODEL_EXPORTING_FAILED",
"MODEL_EXPORT_PENDING",
"WORKFLOW_NO_MATCHING_INPUT",
"WORKFLOW_REQUIRE_TRAINED_MODEL",
"WORKFLOW_DUPLICATE",
"WORKFLOW_UNSUPPORTED_FORMAT",
"WORKFLOW_DOES_NOT_EXIST",
"WORKFLOW_PERMISSION_DENIED",
"WORKFLOW_INVALID_ARGUMENT",
"WORKFLOW_INVALID_RECIPE",
"WORKFLOW_INVALID_TEMPLATE",
"WORKFLOW_INVALID_GRAPH",
"WORKFLOW_INTERNAL_FAILURE",
"WORKFLOW_INVALID_REQUEST",
"WORKFLOW_MODIFY_SUCCESS",
"WORKFLOW_MODIFY_PENDING",
"WORKFLOW_MODIFY_FAILED",
"WORKFLOW_REINDEX_FAILED",
"CONCEPT_MODIFY_SUCCESS",
"CONCEPT_MODIFY_PENDING",
"CONCEPT_MODIFY_FAILED",
"ANNOTATION_SUCCESS",
"ANNOTATION_PENDING",
"ANNOTATION_FAILED",
"ANNOTATION_UNKNOWN_STATUS",
"ANNOTATION_INVALID_ARGUMENT",
"ANNOTATION_PERMISSION_DENIED",
"ANNOTATION_AWAITING_REVIEW",
"ANNOTATION_AWAITING_CONSENSUS_REVIEW",
"ANNOTATION_REVIEW_DENIED",
"ANNOTATION_MODIFY_SUCCESS",
"ANNOTATION_MODIFY_PENDING",
"ANNOTATION_MODIFY_FAILED",
"METADATA_INVALID_PATCH_ARGUMENTS",
"METADATA_PARSING_ISSUE",
"METADATA_MANIPULATION_ISSUE",
"TRAINER_JOB_STATE_NONE",
"TRAINER_JOB_STATE_QUEUED",
"TRAINER_JOB_STATE_RUNNING",
"TRAINER_JOB_STATE_COMPLETE",
"TRAINER_JOB_STATE_ERROR",
"DATA_DUMP_SUCCESS",
"DATA_DUMP_PENDING",
"DATA_DUMP_FAILED",
"DATA_DUMP_IN_PROGRESS",
"DATA_DUMP_NO_DATA",
"DATA_DUMP_UNEXPECTED_ERROR",
"DATA_DUMP_EXPORT_SUCCESS",
"DATA_DUMP_EXPORT_PENDING",
"DATA_DUMP_EXPORT_FAILED",
"DATA_DUMP_EXPORT_IN_PROGRESS",
"DATA_DUMP_EXPORT_UNEXPECTED_ERROR",
"APP_DUPLICATION_SUCCESS",
"APP_DUPLICATION_FAILED",
"APP_DUPLICATION_PENDING",
"APP_DUPLICATION_IN_PROGRESS",
"APP_DUPLICATION_INVALID_REQUEST",
"MODULE_DOES_NOT_EXIST",
"MODULE_PERMISSION_DENIED",
"MODULE_INVALID_ARGUMENT",
"MODULE_INVALID_REQUEST",
"BULK_OPERATION_SUCCESS",
"BULK_OPERATION_FAILED",
"BULK_OPERATION_PENDING",
"BULK_OPERATION_IN_PROGRESS",
"BULK_OPERATION_INVALID_REQUEST",
"BULK_OPERATION_CANCELLED",
"BULK_OPERATION_UNEXPECTED_ERROR",
"RUNNER_DOES_NOT_EXIST",
"RUNNER_PERMISSION_DENIED",
"RUNNER_INVALID_ARGUMENT",
"RUNNER_INVALID_REQUEST",
"RUNNER_NEEDS_RETRY",
"RUNNER_STREAM_START",
"RUNNER_STREAM_END",
"RUNNER_ITEM_CANCELLED",
"RUNNER_PROCESSING_FAILED",
"INPUT_DOWNLOAD_SUCCESS",
"INPUT_DOWNLOAD_PENDING",
"INPUT_DOWNLOAD_FAILED",
"INPUT_DOWNLOAD_IN_PROGRESS",
"INPUT_STATUS_UPDATE_FAILED",
"INPUT_DELETE_FAILED",
"INPUT_DUPLICATE",
"INPUT_UNSUPPORTED_FORMAT",
"INPUT_DOES_NOT_EXIST",
"INPUT_PERMISSION_DENIED",
"INPUT_INVALID_ARGUMENT",
"INPUT_OVER_LIMIT",
"INPUT_INVALID_URL",
"INPUT_MODIFY_SUCCESS",
"INPUT_MODIFY_PENDING",
"INPUT_MODIFY_FAILED",
"INPUT_STORAGE_HOST_FAILED",
"ALL_INPUT_INVALID_BYTES",
"INPUT_CLUSTER_SUCCESS",
"INPUT_CLUSTER_PENDING",
"INPUT_CLUSTER_FAILED",
"INPUT_CLUSTER_IN_PROGRESS",
"INPUT_REINDEX_SUCCESS",
"INPUT_REINDEX_PENDING",
"INPUT_REINDEX_FAILED",
"INPUT_REINDEX_IN_PROGRESS",
"INPUT_VIDEO_DOWNLOAD_SUCCESS",
"INPUT_VIDEO_DOWNLOAD_PENDING",
"INPUT_VIDEO_DOWNLOAD_FAILED",
"INPUT_VIDEO_DUPLICATE",
"INPUT_VIDEO_UNSUPPORTED_FORMAT",
"INPUT_VIDEO_DOES_NOT_EXIST",
"INPUT_VIDEO_PERMISSION_DENIED",
"INPUT_VIDEO_INVALID_ARGUMENT",
"INPUT_VIDEO_OVER_LIMIT",
"INPUT_VIDEO_INVALID_URL",
"INPUT_VIDEO_MODIFY_SUCCESS",
"INPUT_VIDEO_MODIFY_PENDING",
"INPUT_VIDEO_MODIFY_FAILED",
"INPUT_VIDEO_STORAGE_HOST_FAILED",
"ALL_INPUT_VIDEOS_INVALID_BYTES",
"INPUT_VIDEO_PROCESSING_SUCCESS",
"INPUT_VIDEO_PROCESSING_PENDING",
"INPUT_VIDEO_PROCESSING_FAILED",
"INPUT_VIDEO_STORAGE_INCONSISTENCY",
"INPUT_VIDEO_STORAGE_FAILURE",
"INPUT_VIDEO_URL_GENERATION_FAILURE",
"INPUT_CONNECTION_FAILED",
"REQUEST_DISABLED_FOR_MAINTENANCE",
"INPUT_WRITES_DISABLED_FOR_MAINTENANCE",
"INPUT_INVALID_REQUEST",
"PREDICT_INVALID_REQUEST",
"SEARCH_INVALID_REQUEST",
"CONCEPTS_INVALID_REQUEST",
"STATS_INVALID_REQUEST",
"DATABASE_DUPLICATE_KEY",
"DATABASE_STATEMENT_TIMEOUT",
"DATABASE_INVALID_ROWS_AFFECTED",
"DATABASE_DEADLOCK_DETECTED",
"DATABASE_FAIL_TASK",
"DATABASE_FAIL_TO_GET_CONNECTIONS",
"DATABASE_TOO_MANY_CLIENTS",
"DATABASE_CONSTRAINT_VIOLATED",
"DATABASE_CANCELED",
"ASYNC_WORKER_MULTI_ERRORS",
"RPC_REQUEST_QUEUE_FULL",
"RPC_SERVER_UNAVAILABLE",
"RPC_REQUEST_TIMEOUT",
"RPC_MAX_MESSAGE_SIZE_EXCEEDED",
"RPC_CANCELED",
"RPC_UNKNOWN_METHOD",
"REQUEST_CANCELED_BY_USER",
"CLUSTER_INTERNAL_FAILURE",
"EXTERNAL_CONNECTION_ERROR",
"QUERY_INVALID_SYNTAX",
"QUEUE_CONN_ERROR",
"QUEUE_CLOSE_REQUEST_TIMEOUT",
"QUEUE_CONN_CLOSED",
"QUEUE_PUBLISH_ACK_TIMEOUT",
"QUEUE_PUBLISH_ERROR",
"QUEUE_SUBSCRIPTION_TIMEOUT",
"QUEUE_SUBSCRIPTION_ERROR",
"QUEUE_MARSHALLING_FAILED",
"QUEUE_UNMARSHALLING_FAILED",
"QUEUE_MAX_MSG_REDELIVERY_EXCEEDED",
"QUEUE_ACK_FAILURE",
"SQS_OVERLIMIT",
"SQS_INVALID_RECEIPT_HANDLE",
"SQS_UNKNOWN",
"SEARCH_INTERNAL_FAILURE",
"SEARCH_PROJECTION_FAILURE",
"SEARCH_PREDICTION_FAILURE",
"SEARCH_BY_NOT_FULLY_INDEXED_INPUT",
"SAVED_SEARCH_MODIFY_FAILED",
"SEARCH_COUNTS_UNAVAILABLE",
"EVALUATION_QUEUED",
"EVALUATION_IN_PROGRESS",
"EVALUATION_SUCCESS",
"EVALUATION_FAILED_TO_RETRIEVE_DATA",
"EVALUATION_INVALID_ARGUMENT",
"EVALUATION_FAILED",
"EVALUATION_PENDING",
"EVALUATION_TIMED_OUT",
"EVALUATION_UNEXPECTED_ERROR",
"EVALUATION_MIXED",
"STRIPE_EVENT_ERROR",
"CACHE_MISS",
"REDIS_SCRIPT_EXITED_WITH_FAILURE",
"REDIS_STREAM_ERR",
"REDIS_NO_CONSUMERS",
"REDIS_STREAM_BACKOFF",
"SIGNUP_EVENT_ERROR",
"SIGNUP_FLAGGED",
"FILETYPE_UNSUPPORTED",
"APP_COUNT_INVALID_MESSAGE",
"APP_COUNT_UPDATE_INCREMENT_FAILED",
"APP_COUNT_REBUILD_FAILED",
"APP_COUNT_INTERNAL_FAILURE",
"MP_DOWNLOAD_ERROR",
"MP_RESOLVE_DNS_ERROR",
"MP_DOWNLOAD_MAX_SIZE_EXCEEDED_ERROR",
"MP_IMAGE_DECODE_ERROR",
"MP_INVALID_ARGUMENT",
"MP_IMAGE_PROCESSING_ERROR",
"DATATIER_CONN_ERROR",
"USER_CONSENT_FACE",
"WORKER_MISSING",
"WORKER_ACTIVE",
"WORKER_INACTIVE",
"COLLECTOR_MISSING",
"COLLECTOR_ACTIVE",
"COLLECTOR_INACTIVE",
"COLLECTOR_POST_INPUT_FAILED",
"SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST",
"TASK_IN_PROGRESS",
"TASK_DONE",
"TASK_WONT_DO",
"TASK_FAILED",
"TASK_IDLE",
"TASK_CONFLICT",
"TASK_NOT_IMPLEMENTED",
"TASK_MISSING",
"TASK_PERMISSION_DENIED",
"TASK_ASSIGNMENT_SUCCESS",
"TASK_ASSIGNMENT_PENDING",
"TASK_ASSIGNMENT_AWAITING_REVIEW",
"TASK_ASSIGNMENT_AWAITING_CONSENSUS_REVIEW",
"LABEL_ORDER_PENDING",
"LABEL_ORDER_IN_PROGRESS",
"LABEL_ORDER_SUCCESS",
"LABEL_ORDER_CANCELED",
"LICENSE_ACTIVE",
"LICENSE_DOES_NOT_EXIST",
"LICENSE_NEED_UPDATE",
"LICENSE_EXPIRED",
"LICENSE_REVOKED",
"LICENSE_DELETED",
"LICENSE_VOLUME_EXCEEDED",
"PASSWORD_VALIDATION_SUCCESS",
"PASSWORD_VALIDATION_FAILED",
"PASSWORDPOLICY_INVALID_ARGUMENT",
"FEATUREFLAG_CONFIG_NOT_FOUND",
"FEATUREFLAG_INVALID_ARGUMENT",
"FEATUREFLAG_BLOCKED",
"MAINTENANCE_SUCCESS",
"MAINTENANCE_FAILED",
"DATASET_VERSION_PENDING",
"DATASET_VERSION_IN_PROGRESS",
"DATASET_VERSION_READY",
"DATASET_VERSION_FAILURE",
"DATASET_VERSION_UNEXPECTED_ERROR",
"DATASET_VERSION_CONFLICT",
"DATASET_INPUT_SUCCESS",
"DATASET_INPUT_DUPLICATE",
"DATASET_VERSION_EXPORT_SUCCESS",
"DATASET_VERSION_EXPORT_PENDING",
"DATASET_VERSION_EXPORT_FAILED",
"DATASET_VERSION_EXPORT_IN_PROGRESS",
"DATASET_VERSION_EXPORT_UNEXPECTED_ERROR",
"JOB_QUEUED",
"JOB_RUNNING",
"JOB_COMPLETED",
"JOB_FAILED",
"JOB_CANCELLED",
"JOB_UNEXPECTED_ERROR",
"JOB_CONFLICT",
"AUTH_MISSING_IDP_ASSOC",
"LIST_OBJECTS_FAILED",
"ARCHIVE_EXTRACT_FAILED",
"UPLOAD_IN_PROGRESS",
"UPLOAD_DONE",
"UPLOAD_FAILED",
"UPLOAD_UNEXPECTED_ERROR",
"UPLOAD_EXPIRED",
"UPLOAD_CANCELED",
"UPLOAD_CONFLICT",
"BILLING_INVALID_INFO",
"INTERNAL_SERVER_ISSUE",
"INTERNAL_FETCHING_ISSUE",
"INTERNAL_DATABASE_ISSUE",
"INTERNAL_CONTEXT_CANCELED",
"INTERNAL_UNEXPECTED_TIMEOUT",
"INTERNAL_UNEXPECTED_V1",
"INTERNAL_UNEXPECTED_PANIC",
"INTERNAL_UNEXPECTED_SPIRE",
"INTERNAL_REDIS_UNAVAILABLE",
"INTERNAL_RESOURCE_EXHAUSTED",
"INTERNAL_REDIS_UNCATEGORIZED",
"INTERNAL_AWS_UNCATEGORIZED",
"INTERNAL_AZURE_UNCATEGORIZED",
"CONN_UNCATEGORIZED",
"MODEL_UNCATEGORIZED",
"INPUT_UNCATEGORIZED",
"ANNOTATION_UNCATEGORIZED",
"BILLING_UNCATEGORIZED",
"INTERNAL_UNCATEGORIZED",
"BAD_REQUEST",
"SERVER_ERROR"
],
"type": "string",
"title": "- ZERO: to be revised and greatly expanded\n - SUCCESS: Generic\n - MOVED: Resource moved. Respond with Http status 307 and add new Location header to response\n - TEAPOT: SUCCESS_WARNING_API_DEPRECATED = 10001;\nSUCCESS_WARNING_CLIENT_DEPRECATED = 10002;\n - CONN_ACCOUNT_ISSUES: Clarifai Connection Codes: 11xxx",
"default": "ZERO",
"description": "expired cc, still in trial, feature not supported in your tier\n - CONN_TOKEN_INVALID: invalid auth token used. Deprecated: we should return CONN_KEY_INVALID instead now in all cases.\n - CONN_CREDENTIALS_INVALID: invalid auth credentials\n - CONN_EXCEED_HOURLY_LIMIT: throttle hourly limit exceeded\n - CONN_EXCEED_MONTHLY_LIMIT: throttle monthly limit exceeded\n - CONN_THROTTLED: throttler and billing stuff\n - CONN_EXCEEDS_LIMITS: throttler and billing stuff\n - CONN_INSUFFICIENT_SCOPES: api key has insufficient permissions\n - CONN_KEY_INVALID: api key is invalid\n - CONN_KEY_NOT_FOUND: api key not found\n - CONN_BAD_REQUEST_FORMAT: multipart form parsing, broken json, etc\n - CONN_DOES_NOT_EXIST: when path is bad\n - CONN_INVALID_REQUEST: something wrong with a header\n - CONN_METHOD_NOT_ALLOWED: when a request method is not allowed\n - CONN_NO_GDPR_CONSENT: lack GDPR consent\n - CONN_AUTH_METHOD_DISABLED: authentication method is disabled\n - MODEL_TRAINED: Model/Custom Training related 20xxx\n\nCustom model has been already trained.\n - MODEL_TRAINING: Custom model is currently training.\n - MODEL_UNTRAINED: Custom model has not yet been trained.\n - MODEL_QUEUED_FOR_TRAINING: Custom model is currently in queue for training, waiting on assets to process first.\n - MODEL_TRAINING_FAILED: generic err msg for any type of model training err.\n - MODEL_TRAINING_NO_DATA: Custom model training had no data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_NO_POSITIVES: Custom model training had no positive examples. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_ONE_VS_N_SINGLE_CLASS: Custom model training was ONE_VS_N but with a single class. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_TIMED_OUT: Training took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_WAITING_ERROR: Training got error waiting on asset pipeline to finish. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_UNKNOWN_ERROR: Training threw an unknown exception.\n - MODEL_TRAINING_MSG_REDELIVER: Training message was redelivered. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INSUFFICIENT_DATA: Training got error due to insufficient labelled data. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_PARAMS: FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_TRAINING_INVALID_DATA_TOLERANCE_EXCEEDED: Training is stopped because too much data was dropped. FIXME(yang): deprecate this. Use the 21106 + errStatusMsg\n - MODEL_EVALUATION_TIMED_OUT: Evaluation took longer than hard coded timeouts. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_WAITING_ERROR: Evaluation got error waiting on asset pipeline to finish.FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_UNKNOWN_ERROR: EVALUATION THREW AN UNKNOWN EXCEPTION.\n - MODEL_EVALUATION_MSG_REDELIVER: Eval message was redelivered. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_LABELS: Don't have enough concepts labelled to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_NEED_INPUTS: Don't have enough inputs per concept to perform evaluation. FIXME(yang): deprecate this. Use the 21317 + errStatusMsg\n - MODEL_EVALUATION_FAILED: Generic err code for eval failure.\n - MODEL_DEPLOYMENT_FAILED: Used when inference coordinator failed to deploy spire and throws an error\n - MODEL_DEPLOYING: Used when calling the inference coordinator to deploy a spire\n - MODEL_QUEUED_FOR_DEPLOYMENT: Used when training is completed\n - MODEL_NOT_DEPLOYED: Used when model spire deployment is manually taken down or due to inactivity\n - MODEL_REFERENCE_INVALID_ARGUMENT: Used when a model reference field is not set properly\n - MODEL_EXAMPLE_INPUT_INVALID_ARGUMENT: Used when a model example input field is not set properly\n - MODEL_EXPORTED: Model Export status codes\n - WORKFLOW_NO_MATCHING_INPUT: specified model input not in workflow\n - WORKFLOW_REQUIRE_TRAINED_MODEL: specified model must be trained\n - WORKFLOW_INVALID_ARGUMENT: error in the request somewhere\n - WORKFLOW_INVALID_REQUEST: error in the request somewhere\n - CONCEPT_MODIFY_SUCCESS: Concept related 23xxx\n - ANNOTATION_SUCCESS: Annotation related 24xxx\n - METADATA_INVALID_PATCH_ARGUMENTS: Metadata related 249xx\n - TRAINER_JOB_STATE_NONE: Training service related 25xxx\n - DATA_DUMP_SUCCESS: Data Dump related 251xx\n - DATA_DUMP_NO_DATA: DEPRECATED: Not used anymore. Now for an empty data dump, DATA_DUMP_SUCCESS is returned. To detect an empty data dump, check if the inptus count is 0.\n - APP_DUPLICATION_SUCCESS: Duplicate related 252xx\n - MODULE_DOES_NOT_EXIST: Module related codes 253xx\n - BULK_OPERATION_SUCCESS: Bulk Operation related codes 254xx\n - RUNNER_DOES_NOT_EXIST: Runner related codes 256xx\n - INPUT_DOWNLOAD_SUCCESS: Input:Image related 30xxx\n - INPUT_DOWNLOAD_PENDING: when things are async, this is the default status.\n - INPUT_DOWNLOAD_FAILED: any type of error downloading and processing\n - INPUT_VIDEO_DOWNLOAD_SUCCESS: Input:Video related 31xxx -- Deprecated\n - INPUT_WRITES_DISABLED_FOR_MAINTENANCE: deprecate this one. Use REQUEST_DISABLED_FOR_MAINTENANCE\n - PREDICT_INVALID_REQUEST: API formatting issues 4000x\n - DATABASE_DUPLICATE_KEY: Other related 400xx\n - EXTERNAL_CONNECTION_ERROR: could not connect to external services\n - QUEUE_CONN_ERROR: Queue related errors 41xxx\n - SQS_OVERLIMIT: SQS related errors 411xx\n - SEARCH_INTERNAL_FAILURE: Search related errors 43xxxx\n - EVALUATION_QUEUED: Workflow evaluation err code\n - STRIPE_EVENT_ERROR: Stripe 44xxx\n - CACHE_MISS: Redis/Cache 45xxx\n - SIGNUP_EVENT_ERROR: Sift Science 46xxx\n - APP_COUNT_INVALID_MESSAGE: Application counts related errors 470xx\n - MP_DOWNLOAD_ERROR: Media processor related errors 471xx -- DEPRECATED\n - DATATIER_CONN_ERROR: DataTier related error 472xx\n - USER_CONSENT_FACE: User legal consent stauts related 50xxx\n - WORKER_MISSING: Workers 51xxx\n - COLLECTOR_MISSING: Collectors 52xxx\n - SSO_IDENTITY_PROVIDER_DOES_NOT_EXIST: SSO 53xxx\n - TASK_IN_PROGRESS: Tasks 54xxx\nThe task was created.\n - TASK_DONE: The task is completed.\n - TASK_WONT_DO: The task is marked as abandoned.\n - TASK_FAILED: An error occurred during add-task-annotations or add-auto-annotations pipeline.\n - TASK_IDLE: When an Auto Annotation task job has finished processing its last batch and is waiting for more dataset assets.\n - TASK_CONFLICT: The task operation is in conflict with the current state of the server.\n - TASK_NOT_IMPLEMENTED: Certain task-related scenarios are not implemented.\n - TASK_MISSING: Task was not found.\n - TASK_PERMISSION_DENIED: Not allowed to perform a task-related action.\n - LABEL_ORDER_PENDING: Label Order Related Status Code 55xxx\n - LICENSE_ACTIVE: License Related Status Code 600xx\n - LICENSE_DELETED: hidden state not reflected to users\n - PASSWORD_VALIDATION_SUCCESS: Password Related Status Code\n - FEATUREFLAG_CONFIG_NOT_FOUND: Feature flags status code\n - MAINTENANCE_SUCCESS: Maintenance status code\n - DATASET_VERSION_PENDING: Datasets 64xxx\nThe dataset version is pending to be processed.\n - DATASET_VERSION_IN_PROGRESS: The dataset version is currently being processed.\n - DATASET_VERSION_READY: The dataset version is ready to be used.\n - DATASET_VERSION_FAILURE: An error occurred during the dataset version processing.\n - DATASET_VERSION_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version processing.\n - DATASET_VERSION_CONFLICT: An alteration to dataset version would create a conflict\n - DATASET_INPUT_SUCCESS: The dataset input was successfully added.\n - DATASET_INPUT_DUPLICATE: The dataset input is a duplicate.\nDeprecated: Unused.\n - DATASET_VERSION_EXPORT_SUCCESS: The dataset version export is completed.\n - DATASET_VERSION_EXPORT_PENDING: The dataset version is pending to be exported.\n - DATASET_VERSION_EXPORT_FAILED: An error occurred during the dataset version export.\n - DATASET_VERSION_EXPORT_IN_PROGRESS: The dataset version is currently being exported.\n - DATASET_VERSION_EXPORT_UNEXPECTED_ERROR: An unexpected error occurred during the dataset version export.\n - JOB_QUEUED: Generic Job status codes\n - AUTH_MISSING_IDP_ASSOC: auth issues\n\nTODO: Knowledge graph related 80xxx\n - UPLOAD_IN_PROGRESS: Multipart uploading status codes\n - BILLING_INVALID_INFO: Billing related issues: 69xxx\n - INTERNAL_SERVER_ISSUE: Internal issues: 98xxx\n - CONN_UNCATEGORIZED: Uncategorized: 99xxx: move off as soon as known\n - BAD_REQUEST: Deprecated: migrate off to one of the internal issues\n - SERVER_ERROR: Deprecated: migrate off to one of the internal issues"
}