Skip to main content

qdrant

Query items within a Qdrant collection and filter the returned results.

This processor searches a collection in Qdrant, a vector database, using a query vector extracted through vector_mapping. You can narrow the results with a Qdrant filter, cap the number of returned points with limit, and control which payload fields are returned using payload_fields and payload_filter.

# Config fields, showing default values
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: ""
    payload_fields: []
    payload_filter: include
    limit: 10

Examples​

Query a local Qdrant collection with a vector taken from each message, returning up to five points.

processor:
  qdrant:
    grpc_host: localhost:6334
    collection_name: my_collection
    vector_mapping: 'root = this.vector'
    limit: 5

Fields​

grpc_host​

The gRPC host of the Qdrant server.

Type: string

api_token​

The Qdrant API token for authentication. Defaults to an empty string. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string
Default: ""

tls​

Configure Transport Layer Security (TLS) settings to secure network connections. This includes options for standard TLS as well as mutual TLS (mTLS) authentication.

Type: object

tls.enabled​

Whether custom TLS settings are enabled.

Type: bool
Default: false

tls.skip_cert_verify​

Whether to skip server side certificate verification.

Type: bool
Default: false

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.root_cas​

An optional root certificate authority to use. This is a string, representing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string
Default: ""

tls.root_cas_file​

An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.

Type: string
Default: ""

tls.client_certs[]​

A list of client certificates to use. For each certificate either the fields cert and key, or cert_file and key_file should be specified, but not both.

Type: array
Default: []

tls.client_certs[].cert​

A plain text certificate to use.

Type: string
Default: ""

tls.client_certs[].key​

A plain text certificate key to use. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string
Default: ""

tls.client_certs[].cert_file​

The path of a certificate to use.

Type: string
Default: ""

tls.client_certs[].key_file​

The path of a certificate key to use.

Type: string
Default: ""

tls.client_certs[].password​

A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete pbeWithMD5AndDES-CBC algorithm is not supported for the PKCS#8 format. Warning: Since it does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext. :::warning Secret This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info. :::

Type: string
Default: ""

collection_name​

The name of the Qdrant collection you want to query. This field supports interpolation functions.

Type: string

vector_mapping​

A mapping to extract search vectors from the returned document.

Type: string

filter​

Specify additional filtering to perform on returned results. Mappings must return a valid filter using the proto3-encoded form.

Type: string
Default: ""

payload_fields[]​

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

Type: array
Default: []

payload_filter​

Whether to include or exclude the fields specified in payload_fields from the returned results. Set to include to return only the listed fields, or exclude to return everything except them.

Type: string
Default: include

limit​

The maximum number of points to return from the collection.

Type: int
Default: 10