Interface IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.ibm.watsonx.ai.WatsonxAiComponent>
- All Known Implementing Classes:
IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilderImpl
- Enclosing interface:
IbmWatsonxAiComponentBuilderFactory
public static interface IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder
extends ComponentBuilder<org.apache.camel.component.ibm.watsonx.ai.WatsonxAiComponent>
Builder for the IBM watsonx.ai component.
-
Method Summary
Modifier and TypeMethodDescriptionIBM Cloud API key for authentication.autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.The watsonx.ai base URL (e.g., https://us-south.ml.cloud.ibm.com).configuration(org.apache.camel.component.ibm.watsonx.ai.WatsonxAiConfiguration configuration) The component configuration.Cloud Object Storage URL.deploymentId(String deploymentId) Deployed model ID (for deployment operations).Whether to detect HAP (Harmful, Abusive, Profane content).detectionThreshold(Double detectionThreshold) Detection threshold (0.0 to 1.0).Whether to detect PII (Personal Identifiable Information).documentBucket(String documentBucket) COS bucket for document storage.documentConnectionId(String documentConnectionId) COS connection ID for document storage.frequencyPenalty(Double frequencyPenalty) Frequency penalty for chat.lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).logRequests(Boolean logRequests) Whether to log HTTP requests to the watsonx.ai API.logResponses(Boolean logResponses) Whether to log HTTP responses from the watsonx.ai API.maxCompletionTokens(Integer maxCompletionTokens) Maximum completion tokens for chat.maxNewTokens(Integer maxNewTokens) Maximum new tokens to generate.Foundation model ID (e.g., ibm/granite-13b-instruct-v2).operation(org.apache.camel.component.ibm.watsonx.ai.WatsonxAiOperations operation) The operation to perform.presencePenalty(Double presencePenalty) Presence penalty for chat.IBM Cloud project ID.repetitionPenalty(Double repetitionPenalty) Repetition penalty.rerankTopN(Integer rerankTopN) Number of top results to return for reranking.resultBucket(String resultBucket) COS bucket for result storage.resultConnectionId(String resultConnectionId) COS connection ID for result storage.returnDocuments(Boolean returnDocuments) Whether to return documents in rerank response.IBM Cloud deployment space ID (alternative to projectId).temperature(Double temperature) Temperature for randomness (0.0 to 2.0).Request timeout in milliseconds.Top K (top-k sampling).Top P (nucleus sampling).truncateInputTokens(Integer truncateInputTokens) Maximum number of tokens accepted per input for embeddings.Whether to verify SSL certificates.The watsonx.ai WX platform URL for tool operations (e.g., https://api.dataplatform.cloud.ibm.com/wx).Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
baseUrl
The watsonx.ai base URL (e.g., https://us-south.ml.cloud.ibm.com). The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
baseUrl- the value to set- Returns:
- the dsl builder
-
configuration
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder configuration(org.apache.camel.component.ibm.watsonx.ai.WatsonxAiConfiguration configuration) The component configuration. The option is a: <code>org.apache.camel.component.ibm.watsonx.ai.WatsonxAiConfiguration</code> type. Group: producer- Parameters:
configuration- the value to set- Returns:
- the dsl builder
-
projectId
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder projectId(String projectId) IBM Cloud project ID. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
projectId- the value to set- Returns:
- the dsl builder
-
spaceId
IBM Cloud deployment space ID (alternative to projectId). The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
spaceId- the value to set- Returns:
- the dsl builder
-
wxUrl
The watsonx.ai WX platform URL for tool operations (e.g., https://api.dataplatform.cloud.ibm.com/wx). The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
wxUrl- the value to set- Returns:
- the dsl builder
-
cosUrl
Cloud Object Storage URL. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
cosUrl- the value to set- Returns:
- the dsl builder
-
deploymentId
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder deploymentId(String deploymentId) Deployed model ID (for deployment operations). The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
deploymentId- the value to set- Returns:
- the dsl builder
-
detectHap
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder detectHap(Boolean detectHap) Whether to detect HAP (Harmful, Abusive, Profane content). The option is a: <code>java.lang.Boolean</code> type. Default: false Group: producer- Parameters:
detectHap- the value to set- Returns:
- the dsl builder
-
detectionThreshold
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder detectionThreshold(Double detectionThreshold) Detection threshold (0.0 to 1.0). The option is a: <code>java.lang.Double</code> type. Group: producer- Parameters:
detectionThreshold- the value to set- Returns:
- the dsl builder
-
detectPii
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder detectPii(Boolean detectPii) Whether to detect PII (Personal Identifiable Information). The option is a: <code>java.lang.Boolean</code> type. Default: false Group: producer- Parameters:
detectPii- the value to set- Returns:
- the dsl builder
-
documentBucket
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder documentBucket(String documentBucket) COS bucket for document storage. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
documentBucket- the value to set- Returns:
- the dsl builder
-
documentConnectionId
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder documentConnectionId(String documentConnectionId) COS connection ID for document storage. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
documentConnectionId- the value to set- Returns:
- the dsl builder
-
frequencyPenalty
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder frequencyPenalty(Double frequencyPenalty) Frequency penalty for chat. The option is a: <code>java.lang.Double</code> type. Group: producer- Parameters:
frequencyPenalty- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder 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
-
maxCompletionTokens
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder maxCompletionTokens(Integer maxCompletionTokens) Maximum completion tokens for chat. The option is a: <code>java.lang.Integer</code> type. Group: producer- Parameters:
maxCompletionTokens- the value to set- Returns:
- the dsl builder
-
maxNewTokens
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder maxNewTokens(Integer maxNewTokens) Maximum new tokens to generate. The option is a: <code>java.lang.Integer</code> type. Group: producer- Parameters:
maxNewTokens- the value to set- Returns:
- the dsl builder
-
modelId
Foundation model ID (e.g., ibm/granite-13b-instruct-v2). The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
modelId- the value to set- Returns:
- the dsl builder
-
operation
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder operation(org.apache.camel.component.ibm.watsonx.ai.WatsonxAiOperations operation) The operation to perform. The option is a: <code>org.apache.camel.component.ibm.watsonx.ai.WatsonxAiOperations</code> type. Group: producer- Parameters:
operation- the value to set- Returns:
- the dsl builder
-
presencePenalty
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder presencePenalty(Double presencePenalty) Presence penalty for chat. The option is a: <code>java.lang.Double</code> type. Group: producer- Parameters:
presencePenalty- the value to set- Returns:
- the dsl builder
-
repetitionPenalty
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder repetitionPenalty(Double repetitionPenalty) Repetition penalty. The option is a: <code>java.lang.Double</code> type. Group: producer- Parameters:
repetitionPenalty- the value to set- Returns:
- the dsl builder
-
rerankTopN
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder rerankTopN(Integer rerankTopN) Number of top results to return for reranking. The option is a: <code>java.lang.Integer</code> type. Group: producer- Parameters:
rerankTopN- the value to set- Returns:
- the dsl builder
-
resultBucket
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder resultBucket(String resultBucket) COS bucket for result storage. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
resultBucket- the value to set- Returns:
- the dsl builder
-
resultConnectionId
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder resultConnectionId(String resultConnectionId) COS connection ID for result storage. The option is a: <code>java.lang.String</code> type. Group: producer- Parameters:
resultConnectionId- the value to set- Returns:
- the dsl builder
-
returnDocuments
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder returnDocuments(Boolean returnDocuments) Whether to return documents in rerank response. The option is a: <code>java.lang.Boolean</code> type. Default: false Group: producer- Parameters:
returnDocuments- the value to set- Returns:
- the dsl builder
-
temperature
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder temperature(Double temperature) Temperature for randomness (0.0 to 2.0). The option is a: <code>java.lang.Double</code> type. Group: producer- Parameters:
temperature- the value to set- Returns:
- the dsl builder
-
topK
Top K (top-k sampling). The option is a: <code>java.lang.Integer</code> type. Group: producer- Parameters:
topK- the value to set- Returns:
- the dsl builder
-
topP
Top P (nucleus sampling). The option is a: <code>java.lang.Double</code> type. Group: producer- Parameters:
topP- the value to set- Returns:
- the dsl builder
-
truncateInputTokens
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder truncateInputTokens(Integer truncateInputTokens) Maximum number of tokens accepted per input for embeddings. Truncates from the end if exceeded. The option is a: <code>java.lang.Integer</code> type. Group: producer- Parameters:
truncateInputTokens- the value to set- Returns:
- the dsl builder
-
autowiredEnabled
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder 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
-
logRequests
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder logRequests(Boolean logRequests) Whether to log HTTP requests to the watsonx.ai API. The option is a: <code>java.lang.Boolean</code> type. Default: false Group: advanced- Parameters:
logRequests- the value to set- Returns:
- the dsl builder
-
logResponses
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder logResponses(Boolean logResponses) Whether to log HTTP responses from the watsonx.ai API. The option is a: <code>java.lang.Boolean</code> type. Default: false Group: advanced- Parameters:
logResponses- the value to set- Returns:
- the dsl builder
-
timeout
Request timeout in milliseconds. The option is a: <code>java.lang.Long</code> type. Group: advanced- Parameters:
timeout- the value to set- Returns:
- the dsl builder
-
verifySsl
default IbmWatsonxAiComponentBuilderFactory.IbmWatsonxAiComponentBuilder verifySsl(Boolean verifySsl) Whether to verify SSL certificates. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: advanced- Parameters:
verifySsl- the value to set- Returns:
- the dsl builder
-
apiKey
IBM Cloud API key for authentication. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
apiKey- the value to set- Returns:
- the dsl builder
-