Qdrant · Schema

QueryRequest

AIArtificial IntelligenceVector Databases

Properties

Name	Type	Description
shard_key	object
prefetch	object	Sub-requests to perform first. If present, the query will be performed on the results of the prefetch(es).
query	object	Query to perform. If missing without prefetches, returns points ordered by their IDs.
using	string	Define which vector name to use for querying. If missing, the default vector is used.
filter	object	Filter conditions - return only those points that satisfy the specified conditions.
params	object	Search params for when there is no prefetch
score_threshold	number	Return points with scores better than this threshold.
limit	integer	Max number of points to return. Default is 10.
offset	integer	Offset of the result. Skip this many points. Default is 0
with_vector	object	Options for specifying which vectors to include into the response. Default is false.
with_payload	object	Options for specifying which payload to include or not. Default is false.
lookup_from	object	The location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in th

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/QueryRequest",
  "title": "QueryRequest",
  "type": "object",
  "properties": {
    "shard_key": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/ShardKeySelector"
        },
        {
          "nullable": true
        }
      ]
    },
    "prefetch": {
      "description": "Sub-requests to perform first. If present, the query will be performed on the results of the prefetch(es).",
      "default": null,
      "anyOf": [
        {
          "$ref": "#/components/schemas/Prefetch"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Prefetch"
          }
        },
        {
          "nullable": true
        }
      ]
    },
    "query": {
      "description": "Query to perform. If missing without prefetches, returns points ordered by their IDs.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/QueryInterface"
        },
        {
          "nullable": true
        }
      ]
    },
    "using": {
      "description": "Define which vector name to use for querying. If missing, the default vector is used.",
      "type": "string",
      "nullable": true
    },
    "filter": {
      "description": "Filter conditions - return only those points that satisfy the specified conditions.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/Filter"
        },
        {
          "nullable": true
        }
      ]
    },
    "params": {
      "description": "Search params for when there is no prefetch",
      "anyOf": [
        {
          "$ref": "#/components/schemas/SearchParams"
        },
        {
          "nullable": true
        }
      ]
    },
    "score_threshold": {
      "description": "Return points with scores better than this threshold.",
      "type": "number",
      "format": "float",
      "nullable": true
    },
    "limit": {
      "description": "Max number of points to return. Default is 10.",
      "type": "integer",
      "format": "uint",
      "minimum": 1,
      "nullable": true
    },
    "offset": {
      "description": "Offset of the result. Skip this many points. Default is 0",
      "type": "integer",
      "format": "uint",
      "minimum": 0,
      "nullable": true
    },
    "with_vector": {
      "description": "Options for specifying which vectors to include into the response. Default is false.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/WithVector"
        },
        {
          "nullable": true
        }
      ]
    },
    "with_payload": {
      "description": "Options for specifying which payload to include or not. Default is false.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/WithPayloadInterface"
        },
        {
          "nullable": true
        }
      ]
    },
    "lookup_from": {
      "description": "The location to use for IDs lookup, if not specified - use the current collection and the 'using' vector Note: the other collection vectors should have the same vector size as the 'using' vector in the current collection",
      "default": null,
      "anyOf": [
        {
          "$ref": "#/components/schemas/LookupLocation"
        },
        {
          "nullable": true
        }
      ]
    }
  }
}