Interface WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
WatsonxAiEndpointBuilderFactory
public static interface WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the IBM watsonx.ai component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()IBM Cloud API key for authentication.The watsonx.ai base URL (e.g., https://us-south.ml.cloud.ibm.com).Cloud Object Storage URL.deploymentId(String deploymentId) Deployed model ID (for deployment operations).Whether to detect HAP (Harmful, Abusive, Profane content).Whether to detect HAP (Harmful, Abusive, Profane content).detectionThreshold(Double detectionThreshold) Detection threshold (0.0 to 1.0).detectionThreshold(String detectionThreshold) Detection threshold (0.0 to 1.0).Whether to detect PII (Personal Identifiable Information).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.frequencyPenalty(String frequencyPenalty) Frequency penalty for chat.maxCompletionTokens(Integer maxCompletionTokens) Maximum completion tokens for chat.maxCompletionTokens(String maxCompletionTokens) Maximum completion tokens for chat.maxNewTokens(Integer maxNewTokens) Maximum new tokens to generate.maxNewTokens(String maxNewTokens) Maximum new tokens to generate.Foundation model ID (e.g., ibm/granite-13b-instruct-v2).The operation to perform.operation(org.apache.camel.component.ibm.watsonx.ai.WatsonxAiOperations operation) The operation to perform.presencePenalty(Double presencePenalty) Presence penalty for chat.presencePenalty(String presencePenalty) Presence penalty for chat.IBM Cloud project ID.repetitionPenalty(Double repetitionPenalty) Repetition penalty.repetitionPenalty(String repetitionPenalty) Repetition penalty.rerankTopN(Integer rerankTopN) Number of top results to return for reranking.rerankTopN(String 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.returnDocuments(String 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).temperature(String temperature) Temperature for randomness (0.0 to 2.0).Top K (top-k sampling).Top K (top-k sampling).Top P (nucleus sampling).Top P (nucleus sampling).truncateInputTokens(Integer truncateInputTokens) Maximum number of tokens accepted per input for embeddings.truncateInputTokens(String truncateInputTokens) Maximum number of tokens accepted per input for embeddings.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.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUriMethods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
-
baseUrl
The watsonx.ai base URL (e.g., https://us-south.ml.cloud.ibm.com). The option is a:java.lang.Stringtype. Required: true Group: common- Parameters:
baseUrl- the value to set- Returns:
- the dsl builder
-
projectId
IBM Cloud project ID. The option is a:java.lang.Stringtype. 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:java.lang.Stringtype. 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:java.lang.Stringtype. Group: common- Parameters:
wxUrl- the value to set- Returns:
- the dsl builder
-
cosUrl
Cloud Object Storage URL. The option is a:java.lang.Stringtype. Group: producer- Parameters:
cosUrl- the value to set- Returns:
- the dsl builder
-
deploymentId
Deployed model ID (for deployment operations). The option is a:java.lang.Stringtype. Group: producer- Parameters:
deploymentId- the value to set- Returns:
- the dsl builder
-
detectHap
Whether to detect HAP (Harmful, Abusive, Profane content). The option is a:java.lang.Booleantype. Default: false Group: producer- Parameters:
detectHap- the value to set- Returns:
- the dsl builder
-
detectHap
Whether to detect HAP (Harmful, Abusive, Profane content). The option will be converted to ajava.lang.Booleantype. Default: false Group: producer- Parameters:
detectHap- the value to set- Returns:
- the dsl builder
-
detectionThreshold
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder detectionThreshold(Double detectionThreshold) Detection threshold (0.0 to 1.0). The option is a:java.lang.Doubletype. Group: producer- Parameters:
detectionThreshold- the value to set- Returns:
- the dsl builder
-
detectionThreshold
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder detectionThreshold(String detectionThreshold) Detection threshold (0.0 to 1.0). The option will be converted to ajava.lang.Doubletype. Group: producer- Parameters:
detectionThreshold- the value to set- Returns:
- the dsl builder
-
detectPii
Whether to detect PII (Personal Identifiable Information). The option is a:java.lang.Booleantype. Default: false Group: producer- Parameters:
detectPii- the value to set- Returns:
- the dsl builder
-
detectPii
Whether to detect PII (Personal Identifiable Information). The option will be converted to ajava.lang.Booleantype. Default: false Group: producer- Parameters:
detectPii- the value to set- Returns:
- the dsl builder
-
documentBucket
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder documentBucket(String documentBucket) COS bucket for document storage. The option is a:java.lang.Stringtype. Group: producer- Parameters:
documentBucket- the value to set- Returns:
- the dsl builder
-
documentConnectionId
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder documentConnectionId(String documentConnectionId) COS connection ID for document storage. The option is a:java.lang.Stringtype. Group: producer- Parameters:
documentConnectionId- the value to set- Returns:
- the dsl builder
-
frequencyPenalty
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder frequencyPenalty(Double frequencyPenalty) Frequency penalty for chat. The option is a:java.lang.Doubletype. Group: producer- Parameters:
frequencyPenalty- the value to set- Returns:
- the dsl builder
-
frequencyPenalty
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder frequencyPenalty(String frequencyPenalty) Frequency penalty for chat. The option will be converted to ajava.lang.Doubletype. Group: producer- Parameters:
frequencyPenalty- the value to set- Returns:
- the dsl builder
-
maxCompletionTokens
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder maxCompletionTokens(Integer maxCompletionTokens) Maximum completion tokens for chat. The option is a:java.lang.Integertype. Group: producer- Parameters:
maxCompletionTokens- the value to set- Returns:
- the dsl builder
-
maxCompletionTokens
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder maxCompletionTokens(String maxCompletionTokens) Maximum completion tokens for chat. The option will be converted to ajava.lang.Integertype. Group: producer- Parameters:
maxCompletionTokens- the value to set- Returns:
- the dsl builder
-
maxNewTokens
Maximum new tokens to generate. The option is a:java.lang.Integertype. Group: producer- Parameters:
maxNewTokens- the value to set- Returns:
- the dsl builder
-
maxNewTokens
Maximum new tokens to generate. The option will be converted to ajava.lang.Integertype. 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:java.lang.Stringtype. Group: producer- Parameters:
modelId- the value to set- Returns:
- the dsl builder
-
operation
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder operation(org.apache.camel.component.ibm.watsonx.ai.WatsonxAiOperations operation) The operation to perform. The option is a:org.apache.camel.component.ibm.watsonx.ai.WatsonxAiOperationstype. Group: producer- Parameters:
operation- the value to set- Returns:
- the dsl builder
-
operation
The operation to perform. The option will be converted to aorg.apache.camel.component.ibm.watsonx.ai.WatsonxAiOperationstype. Group: producer- Parameters:
operation- the value to set- Returns:
- the dsl builder
-
presencePenalty
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder presencePenalty(Double presencePenalty) Presence penalty for chat. The option is a:java.lang.Doubletype. Group: producer- Parameters:
presencePenalty- the value to set- Returns:
- the dsl builder
-
presencePenalty
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder presencePenalty(String presencePenalty) Presence penalty for chat. The option will be converted to ajava.lang.Doubletype. Group: producer- Parameters:
presencePenalty- the value to set- Returns:
- the dsl builder
-
repetitionPenalty
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder repetitionPenalty(Double repetitionPenalty) Repetition penalty. The option is a:java.lang.Doubletype. Group: producer- Parameters:
repetitionPenalty- the value to set- Returns:
- the dsl builder
-
repetitionPenalty
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder repetitionPenalty(String repetitionPenalty) Repetition penalty. The option will be converted to ajava.lang.Doubletype. Group: producer- Parameters:
repetitionPenalty- the value to set- Returns:
- the dsl builder
-
rerankTopN
Number of top results to return for reranking. The option is a:java.lang.Integertype. Group: producer- Parameters:
rerankTopN- the value to set- Returns:
- the dsl builder
-
rerankTopN
Number of top results to return for reranking. The option will be converted to ajava.lang.Integertype. Group: producer- Parameters:
rerankTopN- the value to set- Returns:
- the dsl builder
-
resultBucket
COS bucket for result storage. The option is a:java.lang.Stringtype. Group: producer- Parameters:
resultBucket- the value to set- Returns:
- the dsl builder
-
resultConnectionId
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder resultConnectionId(String resultConnectionId) COS connection ID for result storage. The option is a:java.lang.Stringtype. Group: producer- Parameters:
resultConnectionId- the value to set- Returns:
- the dsl builder
-
returnDocuments
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder returnDocuments(Boolean returnDocuments) Whether to return documents in rerank response. The option is a:java.lang.Booleantype. Default: false Group: producer- Parameters:
returnDocuments- the value to set- Returns:
- the dsl builder
-
returnDocuments
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder returnDocuments(String returnDocuments) Whether to return documents in rerank response. The option will be converted to ajava.lang.Booleantype. Default: false Group: producer- Parameters:
returnDocuments- the value to set- Returns:
- the dsl builder
-
temperature
Temperature for randomness (0.0 to 2.0). The option is a:java.lang.Doubletype. Group: producer- Parameters:
temperature- the value to set- Returns:
- the dsl builder
-
temperature
Temperature for randomness (0.0 to 2.0). The option will be converted to ajava.lang.Doubletype. Group: producer- Parameters:
temperature- the value to set- Returns:
- the dsl builder
-
topK
Top K (top-k sampling). The option is a:java.lang.Integertype. Group: producer- Parameters:
topK- the value to set- Returns:
- the dsl builder
-
topK
Top K (top-k sampling). The option will be converted to ajava.lang.Integertype. Group: producer- Parameters:
topK- the value to set- Returns:
- the dsl builder
-
topP
Top P (nucleus sampling). The option is a:java.lang.Doubletype. Group: producer- Parameters:
topP- the value to set- Returns:
- the dsl builder
-
topP
Top P (nucleus sampling). The option will be converted to ajava.lang.Doubletype. Group: producer- Parameters:
topP- the value to set- Returns:
- the dsl builder
-
truncateInputTokens
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder truncateInputTokens(Integer truncateInputTokens) Maximum number of tokens accepted per input for embeddings. Truncates from the end if exceeded. The option is a:java.lang.Integertype. Group: producer- Parameters:
truncateInputTokens- the value to set- Returns:
- the dsl builder
-
truncateInputTokens
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder truncateInputTokens(String truncateInputTokens) Maximum number of tokens accepted per input for embeddings. Truncates from the end if exceeded. The option will be converted to ajava.lang.Integertype. Group: producer- Parameters:
truncateInputTokens- the value to set- Returns:
- the dsl builder
-
apiKey
IBM Cloud API key for authentication. The option is a:java.lang.Stringtype. Required: true Group: security- Parameters:
apiKey- the value to set- Returns:
- the dsl builder
-