Qdrant · Schema

LocalShardTelemetry

AIArtificial IntelligenceVector Databases

Properties

Name	Type	Description
variant_name	string
status	object
total_optimized_points	integer	Total number of optimized points since the last start.
vectors_size_bytes	integer	An ESTIMATION of effective amount of bytes used for vectors Do NOT rely on this number unless you know what you are doing
payloads_size_bytes	integer	An estimation of the effective amount of bytes used for payloads Do NOT rely on this number unless you know what you are doing
num_points	integer	Sum of segment points This is an approximate number Do NOT rely on this number unless you know what you are doing
num_vectors	integer	Sum of number of vectors in all segments This is an approximate number Do NOT rely on this number unless you know what you are doing
num_vectors_by_name	object	Sum of number of vectors across all segments, grouped by their name. This is an approximate number. Do NOT rely on this number unless you know what you are doing
segments	array
optimizations	object
async_scorer	boolean
indexed_only_excluded_vectors	object
update_queue	object	Update queue status

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LocalShardTelemetry",
  "title": "LocalShardTelemetry",
  "type": "object",
  "required": [
    "total_optimized_points"
  ],
  "properties": {
    "variant_name": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ShardStatus"
        },
        {
          "nullable": true
        }
      ]
    },
    "total_optimized_points": {
      "description": "Total number of optimized points since the last start.",
      "type": "integer",
      "format": "uint",
      "minimum": 0
    },
    "vectors_size_bytes": {
      "description": "An ESTIMATION of effective amount of bytes used for vectors Do NOT rely on this number unless you know what you are doing",
      "type": "integer",
      "format": "uint",
      "minimum": 0,
      "nullable": true
    },
    "payloads_size_bytes": {
      "description": "An estimation of the effective amount of bytes used for payloads Do NOT rely on this number unless you know what you are doing",
      "type": "integer",
      "format": "uint",
      "minimum": 0,
      "nullable": true
    },
    "num_points": {
      "description": "Sum of segment points This is an approximate number Do NOT rely on this number unless you know what you are doing",
      "type": "integer",
      "format": "uint",
      "minimum": 0,
      "nullable": true
    },
    "num_vectors": {
      "description": "Sum of number of vectors in all segments This is an approximate number Do NOT rely on this number unless you know what you are doing",
      "type": "integer",
      "format": "uint",
      "minimum": 0,
      "nullable": true
    },
    "num_vectors_by_name": {
      "description": "Sum of number of vectors across all segments, grouped by their name. This is an approximate number. Do NOT rely on this number unless you know what you are doing",
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "uint",
        "minimum": 0
      },
      "nullable": true
    },
    "segments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SegmentTelemetry"
      },
      "nullable": true
    },
    "optimizations": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/OptimizerTelemetry"
        },
        {
          "nullable": true
        }
      ]
    },
    "async_scorer": {
      "type": "boolean",
      "nullable": true
    },
    "indexed_only_excluded_vectors": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "uint",
        "minimum": 0
      },
      "nullable": true
    },
    "update_queue": {
      "description": "Update queue status",
      "anyOf": [
        {
          "$ref": "#/components/schemas/ShardUpdateQueueInfo"
        },
        {
          "nullable": true
        }
      ]
    }
  }
}