Package org.apache.camel.builder.endpoint.dsl

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 Type	Method	Description
default WatsonxAiEndpointBuilderFactory.AdvancedWatsonxAiEndpointBuilder	advanced()
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	apiKey(String apiKey)	IBM Cloud API key for authentication.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	baseUrl(String baseUrl)	The watsonx.ai base URL (e.g., https://us-south.ml.cloud.ibm.com).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	cosUrl(String cosUrl)	Cloud Object Storage URL.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	deploymentId(String deploymentId)	Deployed model ID (for deployment operations).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	detectHap(Boolean detectHap)	Whether to detect HAP (Harmful, Abusive, Profane content).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	detectHap(String detectHap)	Whether to detect HAP (Harmful, Abusive, Profane content).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	detectionThreshold(Double detectionThreshold)	Detection threshold (0.0 to 1.0).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	detectionThreshold(String detectionThreshold)	Detection threshold (0.0 to 1.0).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	detectPii(Boolean detectPii)	Whether to detect PII (Personal Identifiable Information).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	detectPii(String detectPii)	Whether to detect PII (Personal Identifiable Information).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	documentBucket(String documentBucket)	COS bucket for document storage.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	documentConnectionId(String documentConnectionId)	COS connection ID for document storage.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	frequencyPenalty(Double frequencyPenalty)	Frequency penalty for chat.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	frequencyPenalty(String frequencyPenalty)	Frequency penalty for chat.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	maxCompletionTokens(Integer maxCompletionTokens)	Maximum completion tokens for chat.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	maxCompletionTokens(String maxCompletionTokens)	Maximum completion tokens for chat.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	maxNewTokens(Integer maxNewTokens)	Maximum new tokens to generate.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	maxNewTokens(String maxNewTokens)	Maximum new tokens to generate.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	modelId(String modelId)	Foundation model ID (e.g., ibm/granite-13b-instruct-v2).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	operation(String operation)	The operation to perform.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	operation(org.apache.camel.component.ibm.watsonx.ai.WatsonxAiOperations operation)	The operation to perform.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	presencePenalty(Double presencePenalty)	Presence penalty for chat.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	presencePenalty(String presencePenalty)	Presence penalty for chat.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	projectId(String projectId)	IBM Cloud project ID.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	repetitionPenalty(Double repetitionPenalty)	Repetition penalty.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	repetitionPenalty(String repetitionPenalty)	Repetition penalty.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	rerankTopN(Integer rerankTopN)	Number of top results to return for reranking.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	rerankTopN(String rerankTopN)	Number of top results to return for reranking.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	resultBucket(String resultBucket)	COS bucket for result storage.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	resultConnectionId(String resultConnectionId)	COS connection ID for result storage.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	returnDocuments(Boolean returnDocuments)	Whether to return documents in rerank response.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	returnDocuments(String returnDocuments)	Whether to return documents in rerank response.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	spaceId(String spaceId)	IBM Cloud deployment space ID (alternative to projectId).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	temperature(Double temperature)	Temperature for randomness (0.0 to 2.0).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	temperature(String temperature)	Temperature for randomness (0.0 to 2.0).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	topK(Integer topK)	Top K (top-k sampling).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	topK(String topK)	Top K (top-k sampling).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	topP(Double topP)	Top P (nucleus sampling).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	topP(String topP)	Top P (nucleus sampling).
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	truncateInputTokens(Integer truncateInputTokens)	Maximum number of tokens accepted per input for embeddings.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	truncateInputTokens(String truncateInputTokens)	Maximum number of tokens accepted per input for embeddings.
default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder	wxUrl(String wxUrl)	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, getRawUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Details

advanced

default WatsonxAiEndpointBuilderFactory.AdvancedWatsonxAiEndpointBuilder advanced()

baseUrl

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder baseUrl(String baseUrl)

The watsonx.ai base URL (e.g., https://us-south.ml.cloud.ibm.com). The option is a: java.lang.String type. Required: true Group: common

Parameters:

baseUrl - the value to set

Returns:

the dsl builder

projectId

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder projectId(String projectId)

IBM Cloud project ID. The option is a: java.lang.String type. Group: common

Parameters:

projectId - the value to set

Returns:

the dsl builder

spaceId

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder spaceId(String spaceId)

IBM Cloud deployment space ID (alternative to projectId). The option is a: java.lang.String type. Group: common

Parameters:

spaceId - the value to set

Returns:

the dsl builder

wxUrl

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder wxUrl(String 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.String type. Group: common

Parameters:

wxUrl - the value to set

Returns:

the dsl builder

cosUrl

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder cosUrl(String cosUrl)

Cloud Object Storage URL. The option is a: java.lang.String type. Group: producer

Parameters:

cosUrl - the value to set

Returns:

the dsl builder

deploymentId

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder deploymentId(String deploymentId)

Deployed model ID (for deployment operations). The option is a: java.lang.String type. Group: producer

Parameters:

deploymentId - the value to set

Returns:

the dsl builder

detectHap

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder detectHap(Boolean detectHap)

Whether to detect HAP (Harmful, Abusive, Profane content). The option is a: java.lang.Boolean type. Default: false Group: producer

Parameters:

detectHap - the value to set

Returns:

the dsl builder

detectHap

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder detectHap(String detectHap)

Whether to detect HAP (Harmful, Abusive, Profane content). The option will be converted to a java.lang.Boolean type. 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.Double type. 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 a java.lang.Double type. Group: producer

Parameters:

detectionThreshold - the value to set

Returns:

the dsl builder

detectPii

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder detectPii(Boolean detectPii)

Whether to detect PII (Personal Identifiable Information). The option is a: java.lang.Boolean type. Default: false Group: producer

Parameters:

detectPii - the value to set

Returns:

the dsl builder

detectPii

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder detectPii(String detectPii)

Whether to detect PII (Personal Identifiable Information). The option will be converted to a java.lang.Boolean type. 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.String type. 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.String type. 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.Double type. 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 a java.lang.Double type. 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.Integer type. 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 a java.lang.Integer type. Group: producer

Parameters:

maxCompletionTokens - the value to set

Returns:

the dsl builder

maxNewTokens

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder maxNewTokens(Integer maxNewTokens)

Maximum new tokens to generate. The option is a: java.lang.Integer type. Group: producer

Parameters:

maxNewTokens - the value to set

Returns:

the dsl builder

maxNewTokens

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder maxNewTokens(String maxNewTokens)

Maximum new tokens to generate. The option will be converted to a java.lang.Integer type. Group: producer

Parameters:

maxNewTokens - the value to set

Returns:

the dsl builder

modelId

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder modelId(String modelId)

Foundation model ID (e.g., ibm/granite-13b-instruct-v2). The option is a: java.lang.String type. 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.WatsonxAiOperations type. Group: producer

Parameters:

operation - the value to set

Returns:

the dsl builder

operation

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder operation(String operation)

The operation to perform. The option will be converted to a org.apache.camel.component.ibm.watsonx.ai.WatsonxAiOperations type. 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.Double type. 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 a java.lang.Double type. 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.Double type. 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 a java.lang.Double type. Group: producer

Parameters:

repetitionPenalty - the value to set

Returns:

the dsl builder

rerankTopN

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder rerankTopN(Integer rerankTopN)

Number of top results to return for reranking. The option is a: java.lang.Integer type. Group: producer

Parameters:

rerankTopN - the value to set

Returns:

the dsl builder

rerankTopN

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder rerankTopN(String rerankTopN)

Number of top results to return for reranking. The option will be converted to a java.lang.Integer type. Group: producer

Parameters:

rerankTopN - the value to set

Returns:

the dsl builder

resultBucket

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder resultBucket(String resultBucket)

COS bucket for result storage. The option is a: java.lang.String type. 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.String type. 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.Boolean type. 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 a java.lang.Boolean type. Default: false Group: producer

Parameters:

returnDocuments - the value to set

Returns:

the dsl builder

temperature

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder temperature(Double temperature)

Temperature for randomness (0.0 to 2.0). The option is a: java.lang.Double type. Group: producer

Parameters:

temperature - the value to set

Returns:

the dsl builder

temperature

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder temperature(String temperature)

Temperature for randomness (0.0 to 2.0). The option will be converted to a java.lang.Double type. Group: producer

Parameters:

temperature - the value to set

Returns:

the dsl builder

topK

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder topK(Integer topK)

Top K (top-k sampling). The option is a: java.lang.Integer type. Group: producer

Parameters:

topK - the value to set

Returns:

the dsl builder

topK

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder topK(String topK)

Top K (top-k sampling). The option will be converted to a java.lang.Integer type. Group: producer

Parameters:

topK - the value to set

Returns:

the dsl builder

topP

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder topP(Double topP)

Top P (nucleus sampling). The option is a: java.lang.Double type. Group: producer

Parameters:

topP - the value to set

Returns:

the dsl builder

topP

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder topP(String topP)

Top P (nucleus sampling). The option will be converted to a java.lang.Double type. 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.Integer type. 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 a java.lang.Integer type. Group: producer

Parameters:

truncateInputTokens - the value to set

Returns:

the dsl builder

apiKey

default WatsonxAiEndpointBuilderFactory.WatsonxAiEndpointBuilder apiKey(String apiKey)

IBM Cloud API key for authentication. The option is a: java.lang.String type. Required: true Group: security

Parameters:

apiKey - the value to set

Returns:

the dsl builder