CollectionParams

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CollectionParams",
  "title": "CollectionParams",
  "type": "object",
  "properties": {
    "vectors": {
      "$ref": "#/components/schemas/VectorsConfig"
    },
    "shard_number": {
      "description": "Number of shards the collection has",
      "default": 1,
      "type": "integer",
      "format": "uint32",
      "minimum": 1
    },
    "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",
      "anyOf": [
        {
          "$ref": "#/components/schemas/ShardingMethod"
        },
        {
          "nullable": true
        }
      ]
    },
    "replication_factor": {
      "description": "Number of replicas for each shard",
      "default": 1,
      "type": "integer",
      "format": "uint32",
      "minimum": 1
    },
    "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": 1,
      "type": "integer",
      "format": "uint32",
      "minimum": 1
    },
    "read_fan_out_factor": {
      "description": "Defines how many additional replicas should be processing read request at the same time. Default value is Auto, which means that fan-out will be determined automatically based on the busyness of the local replica. Having more than 0 might be useful to smooth latency spikes of individual nodes.",
      "type": "integer",
      "format": "uint32",
      "minimum": 0,
      "nullable": true
    },
    "read_fan_out_delay_ms": {
      "description": "Define number of milliseconds to wait before attempting to read from another replica. This setting can help to reduce latency spikes in case of occasional slow replicas. Default is 0, which means delayed fan out request is disabled.",
      "type": "integer",
      "format": "uint64",
      "minimum": 0,
      "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": true,
      "type": "boolean"
    },
    "sparse_vectors": {
      "description": "Configuration of the sparse vector storage",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/SparseVectorParams"
      },
      "nullable": true
    }
  }
}