Connect
Also in Cloud

qdrant

Query items within a Qdrant collection.

Introduced in version 4.54.0.

  • Common

  • Advanced

processor:
  label: ""
  qdrant:
    grpc_host: "" # No default (required)
    api_token: ""
    collection_name: "" # No default (required)
    vector_mapping: "" # No default (required)
    filter: "" # No default (optional)
    payload_fields: []
    payload_filter: include
    limit: 10
processor:
  label: ""
  qdrant:
    grpc_host: "" # No default (required)
    api_token: ""
    tls:
      enabled: false
      skip_cert_verify: false
      enable_renegotiation: false
      root_cas: ""
      root_cas_file: ""
      client_certs: []
    collection_name: "" # No default (required)
    vector_mapping: "" # No default (required)
    filter: "" # No default (optional)
    payload_fields: []
    payload_filter: include
    limit: 10

Fields

api_token

The Qdrant API token to use for authentication, which defaults to an empty string.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

collection_name

The name of the Qdrant collection you want to query.

This field supports interpolation functions.

Type: string

filter

Specify additional filtering to perform on returned results. Mappings must return a valid Qdrant filter using the proto3-encoded form. For examples, see the Qdrant documentation.

Type: string

# Examples:
filter: |

  root.must = [
  	{"has_id":{"has_id":[{"num": 8}, { "uuid":"1234-5678-90ab-cdef" }]}},
  	{"field":{"key": "city", "match": {"text": "London"}}},
  ]

# ---

filter: |

  root.must = [
  	{"field":{"key": "city", "match": {"text": "London"}}},
  ]
  root.must_not = [
  	{"field":{"color": "city", "match": {"text": "red"}}},
  ]

grpc_host

The gRPC host of the Qdrant server.

Type: string

# Examples:
grpc_host: localhost:6334

# ---

grpc_host: xyz-example.eu-central.aws.cloud.qdrant.io:6334

limit

The maximum number of points to return from the collection.

Type: int

Default: 10

payload_fields[]

The fields to include or exclude in returned results. Use this field in combination with payload_filter.

Type: array<string>

Default: []

payload_filter

Whether to include or exclude the fields specified in payload_fields from the returned results.

Type: string

Default: include

Option Summary

exclude

Exclude the payload fields specified in payload_fields.

include

Include the payload fields specified in payload_fields.

tls

Configure Transport Layer Security (TLS) settings to secure network connections. This includes options for standard TLS as well as mutual TLS (mTLS) authentication where both client and server authenticate each other using certificates. Key configuration options include enabled to enable TLS, client_certs for mTLS authentication, root_cas/root_cas_file for custom certificate authorities, and skip_cert_verify for development environments.

Type: object

tls.client_certs[]

A list of client certificates for mutual TLS (mTLS) authentication. Configure this field to enable mTLS, authenticating the client to the server with these certificates.

You must set tls.enabled: true for the client certificates to take effect.

Certificate pairing rules: For each certificate item, provide either:

  • Inline PEM data using both cert and key or

  • File paths using both cert_file and key_file.

Mixing inline and file-based values within the same item is not supported.

Type: array<object>

Default: []

# Examples:
client_certs:
  - cert: foo
    key: bar


# ---

client_certs:
  - cert_file: ./example.pem
    key_file: ./example.key

tls.client_certs[].cert

The plaintext certificate to use for TLS authentication. Must be paired with the corresponding private key in the key field when using inline PEM data for mTLS client certificates.

Type: string

Default: ""

tls.client_certs[].cert_file

The path to a file containing the certificate to use for TLS authentication. Must be paired with the corresponding private key file in the key_file field when using file-based configuration for mTLS client certificates.

Type: string

Default: ""

tls.client_certs[].key

Private key for mTLS client certificate as inline PEM data. Must correspond to the client certificate specified in the cert field. Use this field together with cert when providing certificate data inline rather than through files.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

tls.client_certs[].key_file

Path to private key file for mTLS client certificate in PEM format. Must correspond to the client certificate specified in the cert_file field. Use this field together with cert_file when loading certificate data from files.

Type: string

Default: ""

tls.client_certs[].password

The password to use for the private key (specified in the key or key_file fields), if it is password-protected. The PKCS#1 and PKCS#8 formats are supported. Supports environment variable interpolation for secure password management.

The pbeWithMD5AndDES-CBC algorithm is obsolete and not supported for the PKCS#8 format. This algorithm does not authenticate the ciphertext, making it vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

# Examples:
password: foo

# ---

password: ${KEY_PASSWORD}

tls.enable_renegotiation

Whether to allow the remote server to repeatedly request renegotiation. Enable this option if you’re seeing the error message local error: tls: no renegotiation.

Type: bool

Default: false

tls.enabled

Whether to enable TLS for secure connections. Set to true to enable TLS encryption. Required to be true for other TLS options (like client_certs, root_cas, etc.) to take effect.

Type: bool

Default: false

tls.root_cas

Specify a root certificate authority to use (optional). This is a string that represents a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Use either this field for inline certificate data or root_cas_file for file-based certificate loading.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

Default: ""

# Examples:
root_cas: |-
  -----BEGIN CERTIFICATE-----
  ...
  -----END CERTIFICATE-----

tls.root_cas_file

Specify the path to a root certificate authority file (optional). This is a file, often with a .pem extension, which contains a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Use either this field for file-based certificate loading or root_cas for inline certificate data.

Type: string

Default: ""

# Examples:
root_cas_file: ./root_cas.pem

tls.skip_cert_verify

Whether to skip server-side certificate verification. Set to true only for testing environments as this reduces security by disabling certificate validation. When using self-signed certificates or in development, this may be necessary, but should never be used in production. Consider using root_cas or root_cas_file to specify trusted certificates instead of disabling verification entirely.

Type: bool

Default: false

vector_mapping

A mapping that extracts the search vector from the input message. The processor uses this vector to query the collection.

Type: string

# Examples:
vector_mapping: root = [1.2, 0.5, 0.76]

# ---

vector_mapping: root = this.vector

# ---

vector_mapping: root = [[0.352,0.532,0.532,0.234],[0.352,0.532,0.532,0.234]]

# ---

vector_mapping: 'root = {"some_sparse": {"indices":[23,325,532],"values":[0.352,0.532,0.532]}}'

# ---

vector_mapping: 'root = {"some_multi": [[0.352,0.532,0.532,0.234],[0.352,0.532,0.532,0.234]]}'

# ---

vector_mapping: 'root = {"some_dense": [0.352,0.532,0.532,0.234]}'