Job

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-job-schema.json",
  "title": "Job",
  "description": "Job details which contain input document details on which prediction need to run, features (which and all language services ) need to run and where to store results",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-aiservicelanguage-api-openapi.yml#/components/schemas/Job",
  "properties": {
    "compartmentId": {
      "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.",
      "type": "string"
    },
    "completedDocuments": {
      "description": "Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.",
      "type": "integer"
    },
    "createdBy": {
      "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job.",
      "type": "string"
    },
    "description": {
      "description": "A short description of the job.",
      "type": "string"
    },
    "displayName": {
      "description": "A user-friendly display name for the job.",
      "type": "string"
    },
    "failedDocuments": {
      "description": "Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.",
      "type": "integer"
    },
    "id": {
      "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job.",
      "type": "string"
    },
    "inputConfiguration": {
      "$ref": "#/$defs/InputConfiguration"
    },
    "inputLocation": {
      "$ref": "#/$defs/InputLocation"
    },
    "lifecycleDetails": {
      "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.",
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current state of the Job.",
      "enum": [
        "ACCEPTED",
        "IN_PROGRESS",
        "SUCCEEDED",
        "FAILED",
        "CANCELING",
        "CANCELED",
        "DELETING",
        "DELETED"
      ],
      "type": "string"
    },
    "modelMetadataDetails": {
      "description": "training model details\nFor this release only one model is allowed to be input here.\nOne of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API\n",
      "items": {
        "$ref": "#/$defs/ModelMetadataDetails"
      },
      "maxItems": 50,
      "minItems": 1,
      "type": "array"
    },
    "outputLocation": {
      "$ref": "#/$defs/ObjectPrefixOutputLocation"
    },
    "pendingDocuments": {
      "description": "Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.",
      "type": "integer"
    },
    "percentComplete": {
      "description": "How much progress the operation has made, vs the total amount of work that must be performed.",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "timeAccepted": {
      "description": "Job accepted time.",
      "format": "date-time",
      "type": "string"
    },
    "timeCompleted": {
      "description": "Job finished time.",
      "format": "date-time",
      "type": "string"
    },
    "timeStarted": {
      "description": "Job started time.",
      "format": "date-time",
      "type": "string"
    },
    "totalDocuments": {
      "description": "Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.",
      "type": "integer"
    },
    "ttlInDays": {
      "description": "Time to live duration in days for Job. Job will be available till max 90 days.",
      "type": "integer"
    },
    "warningsCount": {
      "description": "warnings count",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "compartmentId",
    "inputLocation",
    "modelMetadataDetails",
    "outputLocation"
  ],
  "type": "object",
  "$defs": {
    "ConfigurationDetails": {
      "description": "training model details\n",
      "properties": {
        "configurationMap": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "model configuration details\nFor PII : ConfigurationDetails will be PiiEntityMasking can be anyone of the following\nex.{ \"mode\" : \"MASK\",\"maskingCharacter\" : \"&\",\"leaveCharactersUnmasked\": 3,\"isUnmaskedFromEnd\" : true  }\n   { \"mode\" : \"MASK\",\"replaceWith\" : \"&\"  }\n   { \"mode\" : \"REPLACE\" }\nFor language translation :  { \"languageCodes\" : [\"cs\", \"ar\"]}\nLanguage code supported\n- Automatically detect language - auto\n- Arabic - ar\n- Brazilian Portuguese -  pt-BR\n- Czech - cs\n- Danish - da\n- Dutch - nl\n- English - en\n- Finnish - fi\n- French - fr\n- Canadian French - fr-CA\n- German - de\n- Italian - it\n- Japanese - ja\n- Korean - ko\n- Norwegian - no\n- Polish - pl\n- Romanian - ro\n- Simplified Chinese - zh-CN\n- Spanish - es\n- Swedish - sv\n- Traditional Chinese - zh-TW\n- Turkish - tr\n- Greek - el\n- Hebrew - he\n",
          "type": "object"
        }
      },
      "type": "object"
    },
    "DocumentsConfiguration": {
      "description": "Input documents configuration\n",
      "properties": {
        "config": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "meta data about documents\n For CSV valid JSON format is {\"CSV\" :{inputColumn: \"reviewDetails\", rowId: \"reviewId\", copyColumnsToOutput: [\"reviewId\" \"userId\"] , delimiter: \",\"}\nNote: In future if new file types added we will update here in documentation about input file meta data\n",
          "type": "object"
        }
      },
      "type": "object"
    },
    "InputConfiguration": {
      "description": "input documents configuration\nby default TXT files will be processed and this behaviour will not change in future after adding new types\n",
      "properties": {
        "configuration": {
          "additionalProperties": {
            "$ref": "#/$defs/DocumentsConfiguration"
          },
          "description": "meta data about documents\n For CSV valid JSON format is {\"CSV\" :{inputColumn: \"reviewDetails\", rowId: \"reviewId\", copyColumnsToOutput: [\"reviewId\" \"userId\"] , delimiter: \",\"}\nNote: In future if new file types added we will update here in documentation about input file meta data\n",
          "type": "object"
        },
        "documentTypes": {
          "description": "Type of documents supported\nfor this release only TXT,CSV  and one element is allowed here.\nfor future scope this is marked as list\n",
          "items": {
            "type": "string"
          },
          "minItems": 1,
          "type": "array"
        }
      },
      "type": "object"
    },
    "InputLocation": {
      "description": "document location and other meta data about documents\nFor TXT only ObjectStoragePrefixLocation supported\nFor CSV only ObjectStorageFileNameLocation is supported\nFor this release only one file is supported for ObjectStorageFileNameLocation i.e CSV file type\n",
      "properties": {
        "locationType": {
          "description": "locationType\n",
          "enum": [
            "OBJECT_STORAGE_PREFIX",
            "OBJECT_STORAGE_FILE_LIST"
          ],
          "type": "string"
        }
      },
      "required": [
        "locationType"
      ],
      "type": "object"
    },
    "ModelMetadataDetails": {
      "description": "training model details\nFor this release only one model is allowed to be input here.\nOne of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API\n",
      "properties": {
        "configuration": {
          "additionalProperties": {
            "$ref": "#/$defs/ConfigurationDetails"
          },
          "description": "model configuration details\nFor PII :  < ENTITY_TYPE , ConfigurationDetails>\nex.\"ORACLE\":{ \"mode\" : \"MASK\",\"maskingCharacter\" : \"&\",\"leaveCharactersUnmasked\": 3,\"isUnmaskedFromEnd\" : true  }\nFor language translation : { \"targetLanguageCodes\" : ConfigurationDetails}\n",
          "type": "object"
        },
        "endpointId": {
          "description": "Unique identifier endpoint OCID that should be used for inference",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "languageCode": {
          "description": "Language code supported\n- auto : Automatically detect language\n- ar : Arabic\n- pt-BR : Brazilian Portuguese\n- cs : Czech\n- da : Danish\n- nl : Dutch\n- en : English\n- fi : Finnish\n- fr : French\n- fr-CA : Canadian French\n- de : German\n- it : Italian\n- ja : Japanese\n- ko : Korean\n- no : Norwegian\n- pl : Polish\n- ro : Romanian\n- zh-CN : Simplified Chinese\n- es : Spanish\n- sv : Swedish\n- zh-TW : Traditional Chinese\n- tr : Turkish\n- el : Greek\n- he : Hebrew\n",
          "maxLength": 5,
          "type": "string"
        },
        "modelId": {
          "description": "Unique identifier model OCID that should be used for inference",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "modelType": {
          "description": "model type to used for inference allowed values are\n- PRE_TRAINED_NAMED_ENTITY_RECOGNITION\n- PRE_TRAINED_TEXT_CLASSIFICATION\n- PRE_TRAINED_SENTIMENT_ANALYSIS\n- PRE_TRAINED_KEYPHRASE_EXTRACTION\n- PRE_TRAINED_LANGUAGE_DETECTION\n- PRE_TRAINED_PII\n- PRE_TRAINED_TRANSLATION\n- TEXT_CLASSIFICATION\n- NAMED_ENTITY_RECOGNITION\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "type": "object"
    },
    "ObjectPrefixOutputLocation": {
      "description": "Object storage output location to write inference results",
      "properties": {
        "bucketName": {
          "description": "Object Storage bucket name.",
          "maxLength": 256,
          "minLength": 1,
          "type": "string"
        },
        "namespaceName": {
          "description": "Object Storage namespace name.",
          "maxLength": 1024,
          "minLength": 1,
          "type": "string"
        },
        "prefix": {
          "description": "The prefix (directory) in an Object Storage bucket.",
          "maxLength": 1024,
          "minLength": 0,
          "type": "string"
        }
      },
      "required": [
        "namespaceName",
        "bucketName"
      ],
      "type": "object"
    }
  }
}