Interface AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointBuilder
- Enclosing interface:
AWS2S3VectorsEndpointBuilderFactory
public static interface AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the AWS S3 Vectors component.
-
Method Summary
Modifier and TypeMethodDescriptionAmazon AWS Access Key.advanced()The data type of the vector.distanceMetric(String distanceMetric) The distance metric to use for similarity search.The operation to perform.operation(org.apache.camel.component.aws2.s3vectors.AWS2S3VectorsOperations operation) The operation to perform.overrideEndpoint(boolean overrideEndpoint) Set the need for overriding the endpoint.overrideEndpoint(String overrideEndpoint) Set the need for overriding the endpoint.profileCredentialsName(String profileCredentialsName) If using a profile credentials provider, this parameter will set the profile name.To define a proxy host when instantiating the S3 Vectors client.To define a proxy port when instantiating the S3 Vectors client.To define a proxy port when instantiating the S3 Vectors client.proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the S3 Vectors client.proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the S3 Vectors client.The region in which S3 Vectors client needs to work.Amazon AWS Secret Key.sessionToken(String sessionToken) Amazon AWS Session Token used when the user needs to assume an IAM role.similarityThreshold(Float similarityThreshold) The minimum similarity threshold for results.similarityThreshold(String similarityThreshold) The minimum similarity threshold for results.The number of top similar vectors to return in a query.The number of top similar vectors to return in a query.trustAllCertificates(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.trustAllCertificates(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint.uriEndpointOverride(String uriEndpointOverride) Set the overriding uri endpoint.useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider) Set whether the S3 Vectors client should expect to load credentials through a default credentials provider.useDefaultCredentialsProvider(String useDefaultCredentialsProvider) Set whether the S3 Vectors client should expect to load credentials through a default credentials provider.useProfileCredentialsProvider(boolean useProfileCredentialsProvider) Set whether the S3 Vectors client should expect to load credentials through a profile credentials provider.useProfileCredentialsProvider(String useProfileCredentialsProvider) Set whether the S3 Vectors client should expect to load credentials through a profile credentials provider.useSessionCredentials(boolean useSessionCredentials) Set whether the S3 Vectors client should expect to use Session Credentials.useSessionCredentials(String useSessionCredentials) Set whether the S3 Vectors client should expect to use Session Credentials.vectorDimensions(Integer vectorDimensions) The dimensions of the vector embeddings (default: 1536, which is the dimension for OpenAI text-embedding-3-small).vectorDimensions(String vectorDimensions) The dimensions of the vector embeddings (default: 1536, which is the dimension for OpenAI text-embedding-3-small).vectorIndexName(String vectorIndexName) The name of the vector index.Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUriMethods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
-
dataType
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder dataType(String dataType) The data type of the vector. Options: float32, float16. The option is a:java.lang.Stringtype. Default: float32 Group: common- Parameters:
dataType- the value to set- Returns:
- the dsl builder
-
distanceMetric
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder distanceMetric(String distanceMetric) The distance metric to use for similarity search. Options: cosine, euclidean, dot-product. The option is a:java.lang.Stringtype. Default: cosine Group: common- Parameters:
distanceMetric- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder 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:booleantype. Default: false Group: common- Parameters:
overrideEndpoint- the value to set- Returns:
- the dsl builder
-
overrideEndpoint
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder overrideEndpoint(String overrideEndpoint) Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option will be converted to abooleantype. Default: false Group: common- Parameters:
overrideEndpoint- the value to set- Returns:
- the dsl builder
-
region
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder 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:java.lang.Stringtype. Group: common- Parameters:
region- the value to set- Returns:
- the dsl builder
-
similarityThreshold
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder similarityThreshold(Float similarityThreshold) The minimum similarity threshold for results. The option is a:java.lang.Floattype. Group: common- Parameters:
similarityThreshold- the value to set- Returns:
- the dsl builder
-
similarityThreshold
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder similarityThreshold(String similarityThreshold) The minimum similarity threshold for results. The option will be converted to ajava.lang.Floattype. Group: common- Parameters:
similarityThreshold- the value to set- Returns:
- the dsl builder
-
topK
The number of top similar vectors to return in a query. The option is a:java.lang.Integertype. Default: 10 Group: common- Parameters:
topK- the value to set- Returns:
- the dsl builder
-
topK
The number of top similar vectors to return in a query. The option will be converted to ajava.lang.Integertype. Default: 10 Group: common- Parameters:
topK- the value to set- Returns:
- the dsl builder
-
uriEndpointOverride
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder uriEndpointOverride(String uriEndpointOverride) Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a:java.lang.Stringtype. Group: common- Parameters:
uriEndpointOverride- the value to set- Returns:
- the dsl builder
-
vectorDimensions
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder 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:java.lang.Integertype. Default: 1536 Group: common- Parameters:
vectorDimensions- the value to set- Returns:
- the dsl builder
-
vectorDimensions
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder vectorDimensions(String vectorDimensions) The dimensions of the vector embeddings (default: 1536, which is the dimension for OpenAI text-embedding-3-small). The option will be converted to ajava.lang.Integertype. Default: 1536 Group: common- Parameters:
vectorDimensions- the value to set- Returns:
- the dsl builder
-
vectorIndexName
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder vectorIndexName(String vectorIndexName) The name of the vector index. The option is a:java.lang.Stringtype. Group: common- Parameters:
vectorIndexName- the value to set- Returns:
- the dsl builder
-
operation
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder operation(org.apache.camel.component.aws2.s3vectors.AWS2S3VectorsOperations operation) The operation to perform. The option is a:org.apache.camel.component.aws2.s3vectors.AWS2S3VectorsOperationstype. Group: producer- Parameters:
operation- the value to set- Returns:
- the dsl builder
-
operation
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder operation(String operation) The operation to perform. The option will be converted to aorg.apache.camel.component.aws2.s3vectors.AWS2S3VectorsOperationstype. Group: producer- Parameters:
operation- the value to set- Returns:
- the dsl builder
-
proxyHost
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder proxyHost(String proxyHost) To define a proxy host when instantiating the S3 Vectors client. The option is a:java.lang.Stringtype. Group: proxy- Parameters:
proxyHost- the value to set- Returns:
- the dsl builder
-
proxyPort
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder proxyPort(Integer proxyPort) To define a proxy port when instantiating the S3 Vectors client. The option is a:java.lang.Integertype. Group: proxy- Parameters:
proxyPort- the value to set- Returns:
- the dsl builder
-
proxyPort
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder proxyPort(String proxyPort) To define a proxy port when instantiating the S3 Vectors client. The option will be converted to ajava.lang.Integertype. Group: proxy- Parameters:
proxyPort- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol) To define a proxy protocol when instantiating the S3 Vectors client. The option is a:software.amazon.awssdk.core.Protocoltype. Default: HTTPS Group: proxy- Parameters:
proxyProtocol- the value to set- Returns:
- the dsl builder
-
proxyProtocol
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder proxyProtocol(String proxyProtocol) To define a proxy protocol when instantiating the S3 Vectors client. The option will be converted to asoftware.amazon.awssdk.core.Protocoltype. Default: HTTPS Group: proxy- Parameters:
proxyProtocol- the value to set- Returns:
- the dsl builder
-
accessKey
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder accessKey(String accessKey) Amazon AWS Access Key. The option is a:java.lang.Stringtype. Group: security- Parameters:
accessKey- the value to set- Returns:
- the dsl builder
-
profileCredentialsName
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder profileCredentialsName(String profileCredentialsName) If using a profile credentials provider, this parameter will set the profile name. The option is a:java.lang.Stringtype. Group: security- Parameters:
profileCredentialsName- the value to set- Returns:
- the dsl builder
-
secretKey
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder secretKey(String secretKey) Amazon AWS Secret Key. The option is a:java.lang.Stringtype. Group: security- Parameters:
secretKey- the value to set- Returns:
- the dsl builder
-
sessionToken
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder sessionToken(String sessionToken) Amazon AWS Session Token used when the user needs to assume an IAM role. The option is a:java.lang.Stringtype. Group: security- Parameters:
sessionToken- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder trustAllCertificates(boolean trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint. The option is a:booleantype. Default: false Group: security- Parameters:
trustAllCertificates- the value to set- Returns:
- the dsl builder
-
trustAllCertificates
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder trustAllCertificates(String trustAllCertificates) If we want to trust all certificates in case of overriding the endpoint. The option will be converted to abooleantype. Default: false Group: security- Parameters:
trustAllCertificates- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder useDefaultCredentialsProvider(boolean useDefaultCredentialsProvider) Set whether the S3 Vectors client should expect to load credentials through a default credentials provider. The option is a:booleantype. Default: false Group: security- Parameters:
useDefaultCredentialsProvider- the value to set- Returns:
- the dsl builder
-
useDefaultCredentialsProvider
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder useDefaultCredentialsProvider(String useDefaultCredentialsProvider) Set whether the S3 Vectors client should expect to load credentials through a default credentials provider. The option will be converted to abooleantype. Default: false Group: security- Parameters:
useDefaultCredentialsProvider- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder useProfileCredentialsProvider(boolean useProfileCredentialsProvider) Set whether the S3 Vectors client should expect to load credentials through a profile credentials provider. The option is a:booleantype. Default: false Group: security- Parameters:
useProfileCredentialsProvider- the value to set- Returns:
- the dsl builder
-
useProfileCredentialsProvider
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder useProfileCredentialsProvider(String useProfileCredentialsProvider) Set whether the S3 Vectors client should expect to load credentials through a profile credentials provider. The option will be converted to abooleantype. Default: false Group: security- Parameters:
useProfileCredentialsProvider- the value to set- Returns:
- the dsl builder
-
useSessionCredentials
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder 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:booleantype. Default: false Group: security- Parameters:
useSessionCredentials- the value to set- Returns:
- the dsl builder
-
useSessionCredentials
default AWS2S3VectorsEndpointBuilderFactory.AWS2S3VectorsEndpointProducerBuilder useSessionCredentials(String 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 will be converted to abooleantype. Default: false Group: security- Parameters:
useSessionCredentials- the value to set- Returns:
- the dsl builder
-