Customization

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-customization-schema.json",
  "title": "Customization",
  "description": "Description of a Customization.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-aiservicespeech-api-openapi.yml#/components/schemas/Customization",
  "properties": {
    "alias": {
      "description": "Customization Details Alias",
      "maxLength": 255,
      "type": "string"
    },
    "compartmentId": {
      "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want to create the job.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`.\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace-1\": {\"bar-key-1\": \"value-1\", \"bar-key-2\": \"value-2\"}, \"foo-namespace-2\": {\"bar-key-1\": \"value-1\", \"bar-key-2\": \"value-2\"}}`.\n",
      "type": "object"
    },
    "description": {
      "description": "A short description of the job.",
      "type": "string"
    },
    "displayName": {
      "description": "A user-friendly display name for the job.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "entities": {
      "description": "array of referenced entities",
      "items": {
        "$ref": "#/$defs/CustomizationReferencedEntities"
      },
      "type": "array"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`.\n",
      "type": "object"
    },
    "id": {
      "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the job.",
      "type": "string"
    },
    "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": [
        "DELETING",
        "DELETED",
        "FAILED",
        "UPDATING",
        "ACTIVE",
        "CREATING"
      ],
      "type": "string"
    },
    "modelDetails": {
      "$ref": "#/$defs/CustomizationModelDetails"
    },
    "systemTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string, integer and boolean types are supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`.\n",
        "type": "object"
      },
      "description": "Usage of system tag keys. These predefined keys are scoped to namespaces.\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`.\n",
      "type": "object"
    },
    "timeCreated": {
      "description": "Customization Created time. An RFC3339 formatted datetime string.",
      "format": "date-time",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "timeUpdated": {
      "description": "Customization Updated time. An RFC3339 formatted datetime string.",
      "format": "date-time",
      "type": "string"
    },
    "trainingDataset": {
      "$ref": "#/$defs/CustomizationDatasetDetails"
    }
  },
  "required": [
    "id",
    "compartmentId",
    "modelDetails"
  ],
  "type": "object",
  "$defs": {
    "CustomizationDatasetDetails": {
      "description": "Customization Training Dataset",
      "properties": {
        "datasetType": {
          "description": "Possible data sets",
          "enum": [
            "OBJECT_STORAGE",
            "ENTITY_LIST"
          ],
          "maxLength": 25,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "datasetType"
      ],
      "type": "object"
    },
    "CustomizationModelDetails": {
      "description": "Details of the base ASR model to train a Customization for.",
      "properties": {
        "domain": {
          "default": "GENERIC",
          "description": "Domain of the ASR model",
          "enum": [
            "GENERIC",
            "MEDICAL"
          ],
          "type": "string"
        },
        "languageCode": {
          "description": "Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646].\n- en-US: English - United States\n- es-ES: Spanish - Spain\n- pt-BR: Portuguese - Brazil\n- en-GB: English - Great Britain\n- en-AU: English - Australia\n- en-IN: English - India\n- hi-IN: Hindi - India\n- fr-FR: French - France\n- de-DE: German - Germany\n- it-IT: Italian - Italy\n",
          "format": "x-obmcs-human-language",
          "type": "string"
        }
      }
    },
    "CustomizationReferencedEntities": {
      "description": "Entities referenced by top level customization.",
      "properties": {
        "alias": {
          "description": "Alias of default referenced Customization for given entityType",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "entityType": {
          "description": "Customization Entity Type",
          "maxLength": 25,
          "minLength": 1,
          "type": "string"
        },
        "id": {
          "description": "Customization Id of default referenced Customization for given entityType",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}