Camel Components

Qdrant

Since Camel 4.5

Only producer is supported

The Qdrant Component provides support for interacting with the Qdrant Vector Database.

URI format

qdrant:collection[?options]

Where collection represents a named set of points (vectors with a payload) defined in your database.

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level.

For example, a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre-configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

You can configure components using:

  • the Component DSL.

  • in a configuration file (application.properties, *.yaml files, etc).

  • directly in the Java code.

Configuring Endpoint Options

You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders.

Property placeholders provide a few benefits:

  • They help prevent using hardcoded urls, port numbers, sensitive information, and other settings.

  • They allow externalizing the configuration from the code.

  • They help the code to become more flexible and reusable.

The following two sections list all the options, firstly for the component followed by the endpoint.

Component Options

The Qdrant component supports the following options which are listed below.

Name Description Default Type

configuration (producer)

The configuration;.

QdrantConfiguration

host (producer)

The host to connect to.

localhost

String

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

maxResults (producer)

Max results for similarity search.

3

int

port (producer)

The port to connect to.

6334

int

timeout (producer)

Sets a default timeout for all requests.

Duration

autowiredEnabled (advanced)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

boolean

filter (advanced)

Autowired Filter for similarity search.

Filter

apiKey (security)

Sets the API key to use for authentication.

String

tls (security)

Whether the client uses Transport Layer Security (TLS) to secure communications.

false

boolean

Endpoint Options

The Qdrant endpoint is configured using URI syntax:

qdrant:collection

With the following path and query parameters:

Path Parameters

Name Description Default Type

collection (producer)

Required The collection Name.

String

Query Parameters

Name Description Default Type

host (producer)

The host to connect to.

localhost

String

maxResults (producer)

Max results for similarity search.

3

int

port (producer)

The port to connect to.

6334

int

timeout (producer)

Sets a default timeout for all requests.

Duration

lazyStartProducer (producer (advanced))

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

filter (advanced)

Autowired Filter for similarity search.

Filter

apiKey (security)

Sets the API key to use for authentication.

String

tls (security)

Whether the client uses Transport Layer Security (TLS) to secure communications.

false

boolean

Message Headers

The Qdrant component supports the following message header(s), which is/are listed below:

Name Description Default Type

CamelQdrantAction (producer)

Constant: ACTION

The action to be performed.

Enum values:

  • CREATE_COLLECTION

  • DELETE_COLLECTION

  • UPSERT

  • RETRIEVE

  • DELETE

  • COLLECTION_INFO

  • SIMILARITY_SEARCH

String

CamelQdrantPointsPayloadSelector (producer)

Constant: PAYLOAD_SELECTOR

Payload Selector.

Points$WithPayloadSelector

CamelQdrantOperationID (producer)

Constant: OPERATION_ID

Operation ID.

long

CamelQdrantOperationStatus (producer)

Constant: OPERATION_STATUS

Operation Status.

String

CamelQdrantOperationStatusValue (producer)

Constant: OPERATION_STATUS_VALUE

Operation Status Value.

int

CamelQdrantReadConsistency (producer)

Constant: READ_CONSISTENCY

Read Consistency.

Points$ReadConsistency

CamelQdrantWithPayload (producer)

Constant: INCLUDE_PAYLOAD

Include Payload.

true

boolean

CamelQdrantWithVectors (producer)

Constant: INCLUDE_VECTORS

Include Vectors.

false

boolean

CamelQdrantSize (producer)

Constant: SIZE

The number of elements.

int

CamelQdrantPointId (producer)

Constant: POINT_ID

The point id to use for operation.

int

CamelQdrantMaxResults (producer)

Constant: MAX_RESULTS

The maximum number of results to return from a similarity search.

int

Message Body

The message body at each side of the Qdrant component: Consumer is the body of the messages the consumer creates, Consumer reply the bodies a consumer that answers its caller can reply with, Producer input the bodies the producer can send or write, and Producer output the body after the producer.

Side Body Description

Producer input

pojo, list or null

By the action in the CamelQdrantAction header: a VectorParams for CREATE_COLLECTION, a PointStruct or a List of them for UPSERT, a PointId or a List of them for RETRIEVE, a PointsSelector, PointId, Filter or Condition for DELETE, and the query vector as a List of Float, a float array or a PointStruct for SIMILARITY_SEARCH. DELETE_COLLECTION and COLLECTION_INFO do not read the body. Another body fails, such as a number as the id (use PointIdFactory.id) or a List of Double. The qdrant:embeddings data type transformer builds the PointStruct from the output of langchain4j-embeddings.

Producer output

list, pojo or unchanged

By the action: a List of RetrievedPoint for RETRIEVE, a List of ScoredPoint for SIMILARITY_SEARCH and a CollectionInfo for COLLECTION_INFO. The other actions keep the body, UPSERT and DELETE with the operation id and status in headers.

The bodies are the ones with the default options. A side that is not listed is not known, and tooling does not guess it. The carriers are described in the Camel Catalog.

Examples

In YAML, a Groovy expression builds the request objects of the Qdrant client, such as VectorParams or PointStruct.

Collection Examples

In the route below, we use the Qdrant component to create a collection named myCollection with the given parameters:

Create Collection

  • Java

  • YAML

from("direct:in")
    .setHeader(QdrantHeaders.ACTION)
        .constant(QdrantAction.CREATE_COLLECTION)
    .setBody()
        .constant(
            Collections.VectorParams.newBuilder()
                .setSize(2)
                .setDistance(Collections.Distance.Cosine).build())
    .to("qdrant:myCollection");
- route:
    from:
      uri: direct:in
      steps:
        - setHeader:
            name: CamelQdrantAction
            expression:
              constant:
                expression: CREATE_COLLECTION
        - setBody:
            expression:
              groovy:
                expression: >-
                  io.qdrant.client.grpc.Collections.VectorParams.newBuilder()
                  .setSize(2)
                  .setDistance(io.qdrant.client.grpc.Collections.Distance.Cosine)
                  .build()
        - to:
            uri: qdrant:myCollection

Delete Collection

In the route below, we use the Qdrant component to delete a collection named myCollection:

  • Java

  • YAML

from("direct:in")
    .setHeader(QdrantHeaders.ACTION)
        .constant(QdrantAction.DELETE_COLLECTION)
    .to("qdrant:myCollection");
- route:
    from:
      uri: direct:in
      steps:
        - setHeader:
            name: CamelQdrantAction
            expression:
              constant:
                expression: DELETE_COLLECTION
        - to:
            uri: qdrant:myCollection

Collection Info

In the route below, we use the qdrant component to get information about the collection named myCollection:

  • Java

  • YAML

from("direct:in")
    .setHeader(QdrantHeaders.ACTION)
        .constant(QdrantAction.COLLECTION_INFO)
    .to("qdrant:myCollection")
    .process(this::process);
- route:
    from:
      uri: direct:in
      steps:
        - setHeader:
            name: CamelQdrantAction
            expression:
              constant:
                expression: COLLECTION_INFO
        - to:
            uri: qdrant:myCollection
        - log:
            message: "${body}"

If there is a collection, you will receive a reply of type Collections.CollectionInfo. If there is not, the exchange will contain an exception of type QdrantActionException with a cause of type StatusRuntimeException statusRuntimeException and status Status.NOT_FOUND.

Points Examples

Upsert

In the route below we use the qdrant component to perform insert + updates (upsert) on points in the collection named myCollection:

  • Java

  • YAML

from("direct:in")
    .setHeader(QdrantHeaders.ACTION)
        .constant(QdrantAction.UPSERT)
    .setBody()
        .constant(
            Points.PointStruct.newBuilder()
                .setId(id(8))
                .setVectors(VectorsFactory.vectors(List.of(3.5f, 4.5f)))
                .putAllPayload(Map.of(
                        "foo", value("hello"),
                        "bar", value(1)))
                .build())
    .to("qdrant:myCollection");
- route:
    from:
      uri: direct:in
      steps:
        - setHeader:
            name: CamelQdrantAction
            expression:
              constant:
                expression: UPSERT
        - setBody:
            expression:
              groovy:
                expression: >-
                  io.qdrant.client.grpc.Points.PointStruct.newBuilder()
                  .setId(io.qdrant.client.PointIdFactory.id(8))
                  .setVectors(io.qdrant.client.VectorsFactory.vectors([3.5f, 4.5f]))
                  .putAllPayload([foo: io.qdrant.client.ValueFactory.value('hello'),
                  bar: io.qdrant.client.ValueFactory.value(1)])
                  .build()
        - to:
            uri: qdrant:myCollection

Retrieve

In the route below, we use the Qdrant component to retrieve information of a single point by id from the collection named myCollection:

  • Java

  • YAML

from("direct:in")
    .setHeader(QdrantHeaders.ACTION)
        .constant(QdrantAction.RETRIEVE)
    .setBody()
        .constant(PointIdFactory.id(8))
    .to("qdrant:myCollection");
- route:
    from:
      uri: direct:in
      steps:
        - setHeader:
            name: CamelQdrantAction
            expression:
              constant:
                expression: RETRIEVE
        - setBody:
            expression:
              groovy:
                expression: "io.qdrant.client.PointIdFactory.id(8)"
        - to:
            uri: qdrant:myCollection

Delete

In the route below, we use the qdrant component to delete points from the collection named myCollection according to a criteria:

  • Java

  • YAML

from("direct:in")
    .setHeader(QdrantHeaders.ACTION)
        .constant(QdrantAction.DELETE)
    .setBody()
        .constant(ConditionFactory.matchKeyword("foo", "hello"))
    .to("qdrant:myCollection");
- route:
    from:
      uri: direct:in
      steps:
        - setHeader:
            name: CamelQdrantAction
            expression:
              constant:
                expression: DELETE
        - setBody:
            expression:
              groovy:
                expression: "io.qdrant.client.ConditionFactory.matchKeyword('foo', 'hello')"
        - to:
            uri: qdrant:myCollection