Interface InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointBuilder
- Enclosing interface:
InfinispanRemoteEndpointBuilderFactory
public static interface InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint producers for the Infinispan component.
-
Method Summary
Modifier and TypeMethodDescriptionbasic()
cacheContainer
(String cacheContainer) Specifies the cache Container to connect.cacheContainer
(org.infinispan.client.hotrod.RemoteCacheManager cacheContainer) Specifies the cache Container to connect.cacheContainerConfiguration
(String cacheContainerConfiguration) The CacheContainer configuration.cacheContainerConfiguration
(org.infinispan.client.hotrod.configuration.Configuration cacheContainerConfiguration) The CacheContainer configuration.configurationProperties
(String configurationProperties) Implementation specific properties for the CacheManager.configurationProperties
(Map<String, String> configurationProperties) Implementation specific properties for the CacheManager.configurationUri
(String configurationUri) An implementation specific URI for the CacheManager.embeddingStoreDimension
(int embeddingStoreDimension) The dimension size used to store vector embeddings.embeddingStoreDimension
(String embeddingStoreDimension) The dimension size used to store vector embeddings.embeddingStoreDistance
(int embeddingStoreDistance) The distance to use for kNN search queries in relation to the configured vector similarity.embeddingStoreDistance
(String embeddingStoreDistance) The distance to use for kNN search queries in relation to the configured vector similarity.embeddingStoreEnabled
(boolean embeddingStoreEnabled) Whether to enable the embedding store.embeddingStoreEnabled
(String embeddingStoreEnabled) Whether to enable the embedding store.embeddingStoreRegisterSchema
(boolean embeddingStoreRegisterSchema) Whether to automatically register the proto schema for the types required by embedding store cache put and query operations.embeddingStoreRegisterSchema
(String embeddingStoreRegisterSchema) Whether to automatically register the proto schema for the types required by embedding store cache put and query operations.embeddingStoreTypeName
(String embeddingStoreTypeName) The name of the type used to store embeddings.embeddingStoreVectorSimilarity
(String embeddingStoreVectorSimilarity) The vector similarity algorithm used to store embeddings.embeddingStoreVectorSimilarity
(org.infinispan.api.annotations.indexing.option.VectorSimilarity embeddingStoreVectorSimilarity) The vector similarity algorithm used to store embeddings.A comma separated list of org.infinispan.client.hotrod.Flag to be applied by default on each cache invocation.lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).lazyStartProducer
(String lazyStartProducer) Whether the producer should be started lazy (on the first message).remappingFunction
(String remappingFunction) Set a specific remappingFunction to use in a compute operation.remappingFunction
(BiFunction remappingFunction) Set a specific remappingFunction to use in a compute operation.resultHeader
(String resultHeader) Store the operation result in a header instead of the message body.Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
basic
-
embeddingStoreDimension
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder embeddingStoreDimension(int embeddingStoreDimension) The dimension size used to store vector embeddings. This should be equal to the dimension size of the model used to create the vector embeddings. This option is mandatory if the embedding store is enabled. The option is a:int
type. Group: producer (advanced)- Parameters:
embeddingStoreDimension
- the value to set- Returns:
- the dsl builder
-
embeddingStoreDimension
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder embeddingStoreDimension(String embeddingStoreDimension) The dimension size used to store vector embeddings. This should be equal to the dimension size of the model used to create the vector embeddings. This option is mandatory if the embedding store is enabled. The option will be converted to aint
type. Group: producer (advanced)- Parameters:
embeddingStoreDimension
- the value to set- Returns:
- the dsl builder
-
embeddingStoreDistance
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder embeddingStoreDistance(int embeddingStoreDistance) The distance to use for kNN search queries in relation to the configured vector similarity. The option is a:int
type. Default: 3 Group: producer (advanced)- Parameters:
embeddingStoreDistance
- the value to set- Returns:
- the dsl builder
-
embeddingStoreDistance
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder embeddingStoreDistance(String embeddingStoreDistance) The distance to use for kNN search queries in relation to the configured vector similarity. The option will be converted to aint
type. Default: 3 Group: producer (advanced)- Parameters:
embeddingStoreDistance
- the value to set- Returns:
- the dsl builder
-
embeddingStoreEnabled
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder embeddingStoreEnabled(boolean embeddingStoreEnabled) Whether to enable the embedding store. When enabled, the embedding store will be configured automatically when Camel starts. Note that this feature requires camel-langchain4j-embeddings to be on the classpath. The option is a:boolean
type. Default: true Group: producer (advanced)- Parameters:
embeddingStoreEnabled
- the value to set- Returns:
- the dsl builder
-
embeddingStoreEnabled
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder embeddingStoreEnabled(String embeddingStoreEnabled) Whether to enable the embedding store. When enabled, the embedding store will be configured automatically when Camel starts. Note that this feature requires camel-langchain4j-embeddings to be on the classpath. The option will be converted to aboolean
type. Default: true Group: producer (advanced)- Parameters:
embeddingStoreEnabled
- the value to set- Returns:
- the dsl builder
-
embeddingStoreRegisterSchema
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder embeddingStoreRegisterSchema(boolean embeddingStoreRegisterSchema) Whether to automatically register the proto schema for the types required by embedding store cache put and query operations. The option is a:boolean
type. Default: true Group: producer (advanced)- Parameters:
embeddingStoreRegisterSchema
- the value to set- Returns:
- the dsl builder
-
embeddingStoreRegisterSchema
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder embeddingStoreRegisterSchema(String embeddingStoreRegisterSchema) Whether to automatically register the proto schema for the types required by embedding store cache put and query operations. The option will be converted to aboolean
type. Default: true Group: producer (advanced)- Parameters:
embeddingStoreRegisterSchema
- the value to set- Returns:
- the dsl builder
-
embeddingStoreTypeName
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder embeddingStoreTypeName(String embeddingStoreTypeName) The name of the type used to store embeddings. The default is 'InfinispanRemoteEmbedding' suffixed with the value of the embeddingStoreDimension option. E.g. CamelInfinispanRemoteEmbedding384. The option is a:java.lang.String
type. Group: producer (advanced)- Parameters:
embeddingStoreTypeName
- the value to set- Returns:
- the dsl builder
-
embeddingStoreVectorSimilarity
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder embeddingStoreVectorSimilarity(org.infinispan.api.annotations.indexing.option.VectorSimilarity embeddingStoreVectorSimilarity) The vector similarity algorithm used to store embeddings. The option is a:org.infinispan.api.annotations.indexing.option.VectorSimilarity
type. Default: COSINE Group: producer (advanced)- Parameters:
embeddingStoreVectorSimilarity
- the value to set- Returns:
- the dsl builder
-
embeddingStoreVectorSimilarity
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder embeddingStoreVectorSimilarity(String embeddingStoreVectorSimilarity) The vector similarity algorithm used to store embeddings. The option will be converted to aorg.infinispan.api.annotations.indexing.option.VectorSimilarity
type. Default: COSINE Group: producer (advanced)- Parameters:
embeddingStoreVectorSimilarity
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder 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:boolean
type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder lazyStartProducer(String 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 will be converted to aboolean
type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
cacheContainer
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder cacheContainer(org.infinispan.client.hotrod.RemoteCacheManager cacheContainer) Specifies the cache Container to connect. The option is a:org.infinispan.client.hotrod.RemoteCacheManager
type. Group: advanced- Parameters:
cacheContainer
- the value to set- Returns:
- the dsl builder
-
cacheContainer
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder cacheContainer(String cacheContainer) Specifies the cache Container to connect. The option will be converted to aorg.infinispan.client.hotrod.RemoteCacheManager
type. Group: advanced- Parameters:
cacheContainer
- the value to set- Returns:
- the dsl builder
-
cacheContainerConfiguration
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder cacheContainerConfiguration(org.infinispan.client.hotrod.configuration.Configuration cacheContainerConfiguration) The CacheContainer configuration. Used if the cacheContainer is not defined. The option is a:org.infinispan.client.hotrod.configuration.Configuration
type. Group: advanced- Parameters:
cacheContainerConfiguration
- the value to set- Returns:
- the dsl builder
-
cacheContainerConfiguration
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder cacheContainerConfiguration(String cacheContainerConfiguration) The CacheContainer configuration. Used if the cacheContainer is not defined. The option will be converted to aorg.infinispan.client.hotrod.configuration.Configuration
type. Group: advanced- Parameters:
cacheContainerConfiguration
- the value to set- Returns:
- the dsl builder
-
configurationProperties
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder configurationProperties(Map<String, String> configurationProperties) Implementation specific properties for the CacheManager. The option is a:java.util.Map<java.lang.String, java.lang.String>
type. Group: advanced- Parameters:
configurationProperties
- the value to set- Returns:
- the dsl builder
-
configurationProperties
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder configurationProperties(String configurationProperties) Implementation specific properties for the CacheManager. The option will be converted to ajava.util.Map<java.lang.String, java.lang.String>
type. Group: advanced- Parameters:
configurationProperties
- the value to set- Returns:
- the dsl builder
-
configurationUri
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder configurationUri(String configurationUri) An implementation specific URI for the CacheManager. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a:java.lang.String
type. Group: advanced- Parameters:
configurationUri
- the value to set- Returns:
- the dsl builder
-
flags
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder flags(String flags) A comma separated list of org.infinispan.client.hotrod.Flag to be applied by default on each cache invocation. The option is a:java.lang.String
type. Group: advanced- Parameters:
flags
- the value to set- Returns:
- the dsl builder
-
remappingFunction
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder remappingFunction(BiFunction remappingFunction) Set a specific remappingFunction to use in a compute operation. The option is a:java.util.function.BiFunction
type. Group: advanced- Parameters:
remappingFunction
- the value to set- Returns:
- the dsl builder
-
remappingFunction
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder remappingFunction(String remappingFunction) Set a specific remappingFunction to use in a compute operation. The option will be converted to ajava.util.function.BiFunction
type. Group: advanced- Parameters:
remappingFunction
- the value to set- Returns:
- the dsl builder
-
resultHeader
default InfinispanRemoteEndpointBuilderFactory.AdvancedInfinispanRemoteEndpointProducerBuilder resultHeader(String resultHeader) Store the operation result in a header instead of the message body. By default, resultHeader == null and the query result is stored in the message body, any existing content in the message body is discarded. If resultHeader is set, the value is used as the name of the header to store the query result and the original message body is preserved. This value can be overridden by an in message header named: CamelInfinispanOperationResultHeader. The option is a:java.lang.String
type. Group: advanced- Parameters:
resultHeader
- the value to set- Returns:
- the dsl builder
-