Skip to main content

qdrant

Query items within a Qdrant collection.

# Common config fields, showing default values
pipeline:
  processors:
    - 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

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.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string
Default: ""

tls​

TLS(HTTPS) config to use when connecting

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.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

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 of object
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.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

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.

Because the obsolete pbeWithMD5AndDES-CBC algorithm does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string
Default: ""

collection_name​

The name of the collection in Qdrant.

This field supports interpolation functions.

Type: string

vector_mapping​

The mapping to extract the search vector from the document.

Type: string

filter​

Additional filtering to perform on the results. The mapping should return a valid filter (using the proto3 encoded form) in qdrant. See the ^Qdrant documentation for examples.

Type: string

payload_fields​

The fields to include or exclude in returned result based on the payload_filter.

Type: array of string
Default: []

payload_filter​

The way the fields in payload_fields are filtered in the result.

Type: string
Default: "include"

OptionSummary
excludeExclude the payload fields specified in payload_fields.
includeInclude the payload fields specified in payload_fields.

limit​

The maximum number of points to return.

Type: int
Default: 10