Package org.apache.camel.builder.component.dsl

Interface Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.aws2.s3vectors.AWS2S3VectorsComponent>
All Known Implementing Classes:
Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilderImpl
Enclosing interface:
Aws2S3VectorsComponentBuilderFactory
public static interface Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder extends ComponentBuilder<org.apache.camel.component.aws2.s3vectors.AWS2S3VectorsComponent>
Builder for the AWS S3 Vectors component.

  • Method Details

    • configuration

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder configuration(org.apache.camel.component.aws2.s3vectors.AWS2S3VectorsConfiguration configuration)
      The component configuration. The option is a: <code>org.apache.camel.component.aws2.s3vectors.AWS2S3VectorsConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • dataType

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder dataType(String dataType)
      The data type of the vector. Options: float32, float16. The option is a: <code>java.lang.String</code> type. Default: float32 Group: common
      Parameters:
      dataType - the value to set
      Returns:
      the dsl builder

    • distanceMetric

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder distanceMetric(String distanceMetric)
      The distance metric to use for similarity search. Options: cosine, euclidean, dot-product. The option is a: <code>java.lang.String</code> type. Default: cosine Group: common
      Parameters:
      distanceMetric - the value to set
      Returns:
      the dsl builder

    • overrideEndpoint

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder overrideEndpoint(boolean overrideEndpoint)
      Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      overrideEndpoint - the value to set
      Returns:
      the dsl builder

    • region

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder region(String region)
      The region in which S3 Vectors client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1). The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      region - the value to set
      Returns:
      the dsl builder

    • similarityThreshold

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder similarityThreshold(Float similarityThreshold)
      The minimum similarity threshold for results. The option is a: <code>java.lang.Float</code> type. Group: common
      Parameters:
      similarityThreshold - the value to set
      Returns:
      the dsl builder

    • topK

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder topK(Integer topK)
      The number of top similar vectors to return in a query. The option is a: <code>java.lang.Integer</code> type. Default: 10 Group: common
      Parameters:
      topK - the value to set
      Returns:
      the dsl builder

    • uriEndpointOverride

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder uriEndpointOverride(String uriEndpointOverride)
      Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      uriEndpointOverride - the value to set
      Returns:
      the dsl builder

    • vectorDimensions

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder vectorDimensions(Integer vectorDimensions)
      The dimensions of the vector embeddings (default: 1536, which is the dimension for OpenAI text-embedding-3-small). The option is a: <code>java.lang.Integer</code> type. Default: 1536 Group: common
      Parameters:
      vectorDimensions - the value to set
      Returns:
      the dsl builder

    • vectorIndexName

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder vectorIndexName(String vectorIndexName)
      The name of the vector index. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      vectorIndexName - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • consumerMetadataFilter

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder consumerMetadataFilter(String consumerMetadataFilter)
      Optional metadata filter for the consumer to filter vectors during polling. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      consumerMetadataFilter - the value to set
      Returns:
      the dsl builder

    • consumerQueryVector

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder consumerQueryVector(String consumerQueryVector)
      The query vector to use for the consumer to poll for similar vectors. Specified as comma-separated float values (e.g., 0.1,0.2,0.3). If not specified, the consumer will not poll. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      consumerQueryVector - the value to set
      Returns:
      the dsl builder

    • delay

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder delay(long delay)
      Milliseconds before the next poll for the consumer. The option is a: <code>long</code> type. Default: 500 Group: consumer
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • deleteAfterRead

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder deleteAfterRead(boolean deleteAfterRead)
      Delete vectors after they have been consumed. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      deleteAfterRead - the value to set
      Returns:
      the dsl builder

    • maxMessagesPerPoll

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder maxMessagesPerPoll(int maxMessagesPerPoll)
      The maximum number of messages to consume per poll for the consumer. The option is a: <code>int</code> type. Default: 10 Group: consumer
      Parameters:
      maxMessagesPerPoll - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      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. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • operation

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder operation(org.apache.camel.component.aws2.s3vectors.AWS2S3VectorsOperations operation)
      The operation to perform. The option is a: <code>org.apache.camel.component.aws2.s3vectors.AWS2S3VectorsOperations</code> type. Group: producer
      Parameters:
      operation - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      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. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • s3VectorsClient

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder s3VectorsClient(software.amazon.awssdk.services.s3vectors.S3VectorsClient s3VectorsClient)
      Reference to a software.amazon.awssdk.services.s3vectors.S3VectorsClient in the registry. The option is a: <code>software.amazon.awssdk.services.s3vectors.S3VectorsClient</code> type. Group: advanced
      Parameters:
      s3VectorsClient - the value to set
      Returns:
      the dsl builder

    • healthCheckConsumerEnabled

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder proxyHost(String proxyHost)
      To define a proxy host when instantiating the S3 Vectors client. The option is a: <code>java.lang.String</code> type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder proxyPort(Integer proxyPort)
      To define a proxy port when instantiating the S3 Vectors client. The option is a: <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • proxyProtocol

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
      To define a proxy protocol when instantiating the S3 Vectors client. The option is a: <code>software.amazon.awssdk.core.Protocol</code> type. Default: HTTPS Group: proxy
      Parameters:
      proxyProtocol - the value to set
      Returns:
      the dsl builder

    • accessKey

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder accessKey(String accessKey)
      Amazon AWS Access Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accessKey - the value to set
      Returns:
      the dsl builder

    • profileCredentialsName

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder profileCredentialsName(String profileCredentialsName)
      If using a profile credentials provider, this parameter will set the profile name. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      profileCredentialsName - the value to set
      Returns:
      the dsl builder

    • secretKey

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder secretKey(String secretKey)
      Amazon AWS Secret Key. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      secretKey - the value to set
      Returns:
      the dsl builder

    • sessionToken

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder sessionToken(String sessionToken)
      Amazon AWS Session Token used when the user needs to assume an IAM role. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sessionToken - the value to set
      Returns:
      the dsl builder

    • trustAllCertificates

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder trustAllCertificates(boolean trustAllCertificates)
      If we want to trust all certificates in case of overriding the endpoint. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      trustAllCertificates - the value to set
      Returns:
      the dsl builder

    • useDefaultCredentialsProvider

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider)
      Set whether the S3 Vectors client should expect to load credentials through a default credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useDefaultCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useProfileCredentialsProvider

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider)
      Set whether the S3 Vectors client should expect to load credentials through a profile credentials provider. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useProfileCredentialsProvider - the value to set
      Returns:
      the dsl builder

    • useSessionCredentials

      default Aws2S3VectorsComponentBuilderFactory.Aws2S3VectorsComponentBuilder useSessionCredentials(boolean useSessionCredentials)
      Set whether the S3 Vectors client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in S3 Vectors. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useSessionCredentials - the value to set
      Returns:
      the dsl builder