{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-openai/json-schema/microsoft-azure-openai-file-list-schema.json",
  "title": "FileList",
  "description": "Represents a list of files.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-openai-files-api-openapi.yml#/components/schemas/FileList",
  "type": "object",
  "properties": {
    "object": {
      "$ref": "#/$defs/TypeDiscriminator"
    },
    "data": {
      "description": "The list of items.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/File"
      }
    }
  },
  "$defs": {
    "File": {
      "title": "File",
      "description": "A file is a document usable for training and validation. It can also be a service generated document with result details.",
      "required": [
        "filename",
        "purpose"
      ],
      "type": "object",
      "properties": {
        "object": {
          "$ref": "#/$defs/TypeDiscriminator"
        },
        "created_at": {
          "format": "unixtime",
          "description": "A timestamp when this job or item was created (in unix epochs).",
          "type": "integer",
          "readOnly": true
        },
        "id": {
          "description": "The identity of this item.",
          "type": "string",
          "readOnly": true
        },
        "status": {
          "$ref": "#/$defs/FileState"
        },
        "bytes": {
          "format": "int64",
          "description": "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\nwith JavaScript integers.",
          "type": "integer",
          "readOnly": true
        },
        "purpose": {
          "$ref": "#/$defs/Purpose"
        },
        "filename": {
          "description": "The name of the file.",
          "minLength": 1,
          "type": "string"
        },
        "status_details": {
          "description": "The error message with details in case processing of this file failed.",
          "type": "string",
          "readOnly": true
        }
      },
      "readOnly": true
    },
    "FileState": {
      "title": "FileState",
      "description": "The state of a file.",
      "enum": [
        "uploaded",
        "pending",
        "running",
        "processed",
        "error",
        "deleting",
        "deleted"
      ],
      "type": "string",
      "readOnly": true,
      "x-ms-enum": {
        "name": "FileState",
        "modelAsString": true,
        "values": [
          {
            "value": "uploaded",
            "description": "The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an inactive state."
          },
          {
            "value": "pending",
            "description": "The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state."
          },
          {
            "value": "running",
            "description": "The operation has started to be processed. It can be categorized as an active state."
          },
          {
            "value": "processed",
            "description": "The operation has successfully be processed and is ready for consumption. It can be categorized as a terminal state."
          },
          {
            "value": "error",
            "description": "The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state."
          },
          {
            "value": "deleting",
            "description": "The entity is ni the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility. It can be categorized as an active state."
          },
          {
            "value": "deleted",
            "description": "The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a terminal state."
          }
        ]
      }
    },
    "Purpose": {
      "title": "Purpose",
      "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.",
      "enum": [
        "fine-tune",
        "fine-tune-results",
        "assistants",
        "assistants_output",
        "batch",
        "batch_output"
      ],
      "type": "string",
      "readOnly": true,
      "x-ms-enum": {
        "name": "Purpose",
        "modelAsString": true,
        "values": [
          {
            "value": "fine-tune",
            "description": "This file contains training data for a fine tune job."
          },
          {
            "value": "fine-tune-results",
            "description": "This file contains the results of a fine tune job."
          },
          {
            "value": "assistants",
            "description": "This file contains data to be used in assistants."
          },
          {
            "value": "assistants_output",
            "description": "This file contains the results of an assistant."
          },
          {
            "value": "batch",
            "description": "This file contains the input data for a batch."
          },
          {
            "value": "batch_output",
            "description": "This file contains the results of a batch."
          }
        ]
      }
    },
    "TypeDiscriminator": {
      "title": "TypeDiscriminator",
      "description": "Defines the type of an object.",
      "enum": [
        "list",
        "fine_tuning.job",
        "file",
        "fine_tuning.job.event",
        "fine_tuning.job.checkpoint",
        "model",
        "batch",
        "upload",
        "upload.part"
      ],
      "type": "string",
      "readOnly": true,
      "x-ms-enum": {
        "name": "TypeDiscriminator",
        "modelAsString": true,
        "values": [
          {
            "value": "list",
            "description": "This object represents a list of other objects."
          },
          {
            "value": "fine_tuning.job",
            "description": "This object represents a fine tune job."
          },
          {
            "value": "file",
            "description": "This object represents a file."
          },
          {
            "value": "fine_tuning.job.event",
            "description": "This object represents an event of a fine tuning job."
          },
          {
            "value": "fine_tuning.job.checkpoint",
            "description": "This object represents a checkpoint of a fine tuning job."
          },
          {
            "value": "model",
            "description": "This object represents a model (can be a base model or fine tune job result)."
          },
          {
            "value": "batch",
            "description": "This object represents a batch."
          },
          {
            "value": "upload",
            "description": "This object represents a file upload."
          },
          {
            "value": "upload.part",
            "description": "This object represents part of a file upload."
          }
        ]
      }
    }
  }
}