Qdrant · Schema

SetPayload

This data structure is used in API interface and applied across multiple shards

AIArtificial IntelligenceVector Databases

Properties

Name Type Description
payload object
points array Assigns payload to each point in this list
filter object Assigns payload to each point that satisfy this filter condition
shard_key object
key string Assigns payload to each point that satisfy this path of property
View JSON Schema on GitHub

JSON Schema

qdrant-setpayload-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SetPayload",
  "title": "SetPayload",
  "description": "This data structure is used in API interface and applied across multiple shards",
  "type": "object",
  "required": [
    "payload"
  ],
  "properties": {
    "payload": {
      "$ref": "#/components/schemas/Payload"
    },
    "points": {
      "description": "Assigns payload to each point in this list",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ExtendedPointId"
      },
      "nullable": true
    },
    "filter": {
      "description": "Assigns payload to each point that satisfy this filter condition",
      "anyOf": [
        {
          "$ref": "#/components/schemas/Filter"
        },
        {
          "nullable": true
        }
      ]
    },
    "shard_key": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ShardKeySelector"
        },
        {
          "nullable": true
        }
      ]
    },
    "key": {
      "description": "Assigns payload to each point that satisfy this path of property",
      "type": "string",
      "nullable": true
    }
  }
}