CreateCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateCollection",
  "title": "CreateCollection",
  "description": "Operation for creating new collection and (optionally) specify index params",
  "type": "object",
  "properties": {
    "vectors": {
      "$ref": "#/components/schemas/VectorsConfig"
    },
    "shard_number": {
      "description": "For auto sharding: Number of shards in collection. - Default is 1 for standalone, otherwise equal to the number of nodes - Minimum is 1\n\nFor custom sharding: Number of shards in collection per shard group. - Default is 1, meaning that each shard key will be mapped to a single shard - Minimum is 1",
      "default": null,
      "type": "integer",
      "format": "uint32",
      "minimum": 1,
      "nullable": true
    },
    "sharding_method": {
      "description": "Sharding method Default is Auto - points are distributed across all available shards Custom - points are distributed across shards according to shard key",
      "default": null,
      "anyOf": [
        {
          "$ref": "#/components/schemas/ShardingMethod"
        },
        {
          "nullable": true
        }
      ]
    },
    "replication_factor": {
      "description": "Number of shards replicas. Default is 1 Minimum is 1",
      "default": null,
      "type": "integer",
      "format": "uint32",
      "minimum": 1,
      "nullable": true
    },
    "write_consistency_factor": {
      "description": "Defines how many replicas should apply the operation for us to consider it successful. Increasing this number will make the collection more resilient to inconsistencies, but will also make it fail if not enough replicas are available. Does not have any performance impact.",
      "default": null,
      "type": "integer",
      "format": "uint32",
      "minimum": 1,
      "nullable": true
    },
    "on_disk_payload": {
      "description": "If true - point's payload will not be stored in memory. It will be read from the disk every time it is requested. This setting saves RAM by (slightly) increasing the response time. Note: those payload values that are involved in filtering and are indexed - remain in RAM.\n\nDefault: true",
      "default": null,
      "type": "boolean",
      "nullable": true
    },
    "hnsw_config": {
      "description": "Custom params for HNSW index. If none - values from service configuration file are used.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/HnswConfigDiff"
        },
        {
          "nullable": true
        }
      ]
    },
    "wal_config": {
      "description": "Custom params for WAL. If none - values from service configuration file are used.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/WalConfigDiff"
        },
        {
          "nullable": true
        }
      ]
    },
    "optimizers_config": {
      "description": "Custom params for Optimizers.  If none - values from service configuration file are used.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/OptimizersConfigDiff"
        },
        {
          "nullable": true
        }
      ]
    },
    "quantization_config": {
      "description": "Quantization parameters. If none - quantization is disabled.",
      "default": null,
      "anyOf": [
        {
          "$ref": "#/components/schemas/QuantizationConfig"
        },
        {
          "nullable": true
        }
      ]
    },
    "sparse_vectors": {
      "description": "Sparse vector data config.",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/SparseVectorParams"
      },
      "nullable": true
    },
    "strict_mode_config": {
      "description": "Strict-mode config.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/StrictModeConfig"
        },
        {
          "nullable": true
        }
      ]
    },
    "metadata": {
      "description": "Arbitrary JSON metadata for the collection This can be used to store application-specific information such as creation time, migration data, inference model info, etc.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/Payload"
        },
        {
          "nullable": true
        }
      ]
    }
  }
}