VectorStoreFileBatch

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/azure-ai-foundry/json-schema/azure-ai-foundry-vector-store-file-batch-schema.json",
  "title": "VectorStoreFileBatch",
  "description": "A batch of files attached to a vector store.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/azure-ai-foundry-vector-stores-api-openapi.yml#/components/schemas/VectorStoreFileBatch",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The identifier, which can be referenced in API endpoints."
    },
    "object": {
      "type": "string",
      "description": "The object type, which is always `vector_store.file_batch`.",
      "enum": [
        "vector_store.files_batch"
      ],
      "x-ms-enum": {
        "modelAsString": false
      }
    },
    "created_at": {
      "type": "integer",
      "format": "unixtime",
      "description": "The Unix timestamp (in seconds) for when the vector store files batch was created.",
      "x-ms-client-name": "createdAt"
    },
    "vector_store_id": {
      "type": "string",
      "description": "The ID of the vector store that the file is attached to.",
      "x-ms-client-name": "vectorStoreId"
    },
    "status": {
      "$ref": "#/$defs/VectorStoreFileBatchStatus",
      "description": "The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`."
    },
    "file_counts": {
      "$ref": "#/$defs/VectorStoreFileCount",
      "description": "Files count grouped by status processed or being processed by this vector store.",
      "x-ms-client-name": "fileCounts"
    }
  },
  "required": [
    "id",
    "object",
    "created_at",
    "vector_store_id",
    "status",
    "file_counts"
  ],
  "$defs": {
    "VectorStoreFileBatchStatus": {
      "type": "string",
      "description": "The status of the vector store file batch.",
      "enum": [
        "in_progress",
        "completed",
        "cancelled",
        "failed"
      ],
      "x-ms-enum": {
        "name": "VectorStoreFileBatchStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "inProgress",
            "value": "in_progress",
            "description": "The vector store is still processing this file batch."
          },
          {
            "name": "completed",
            "value": "completed",
            "description": "the vector store file batch is ready for use."
          },
          {
            "name": "cancelled",
            "value": "cancelled",
            "description": "The vector store file batch was cancelled."
          },
          {
            "name": "failed",
            "value": "failed",
            "description": "The vector store file batch failed to process."
          }
        ]
      }
    },
    "VectorStoreFileCount": {
      "type": "object",
      "description": "Counts of files processed or being processed by this vector store grouped by status.",
      "properties": {
        "in_progress": {
          "type": "integer",
          "format": "int32",
          "description": "The number of files that are currently being processed.",
          "x-ms-client-name": "inProgress"
        },
        "completed": {
          "type": "integer",
          "format": "int32",
          "description": "The number of files that have been successfully processed."
        },
        "failed": {
          "type": "integer",
          "format": "int32",
          "description": "The number of files that have failed to process."
        },
        "cancelled": {
          "type": "integer",
          "format": "int32",
          "description": "The number of files that were cancelled."
        },
        "total": {
          "type": "integer",
          "format": "int32",
          "description": "The total number of files."
        }
      },
      "required": [
        "in_progress",
        "completed",
        "failed",
        "cancelled",
        "total"
      ]
    }
  }
}