Class WatsonxGatewayEmbeddingModel.Builder

java.lang.Object
dev.langchain4j.model.watsonx.WatsonxGatewayEmbeddingModel.Builder
Enclosing class:
WatsonxGatewayEmbeddingModel
public static class WatsonxGatewayEmbeddingModel.Builder extends Object
Builder class for constructing WatsonxGatewayEmbeddingModel instances with configurable parameters.

  • Field Details

    • baseUrl

      protected URI baseUrl

    • version

      protected String version

    • apiKey

      protected String apiKey

    • logRequests

      protected Boolean logRequests

    • logResponses

      protected Boolean logResponses

    • timeout

      protected Duration timeout

    • authenticator

      protected com.ibm.watsonx.ai.core.auth.Authenticator authenticator

    • httpClient

      protected HttpClient httpClient

    • verifySsl

      protected boolean verifySsl

  • Method Details

    • modelName

      public WatsonxGatewayEmbeddingModel.Builder modelName(String modelName)
      Sets the gateway embedding model id, e.g. "text-embedding-3-small".
      Parameters:
      modelName - the model id
      Returns:
      this

    • dimensions

      public WatsonxGatewayEmbeddingModel.Builder dimensions(Integer dimensions)
      Sets the number of dimensions of the returned embeddings. Only the models that support it accept this value.
      Parameters:
      dimensions - the number of dimensions
      Returns:
      this

    • encodingFormat

      public WatsonxGatewayEmbeddingModel.Builder encodingFormat(com.ibm.watsonx.ai.gateway.embedding.ModelGatewayEmbeddingParameters.EncodingFormat encodingFormat)
      Sets the wire format of the returned embeddings. The SDK decodes ModelGatewayEmbeddingParameters.EncodingFormat.BASE64 for you, so both formats give the same vectors.
      Parameters:
      encodingFormat - the ModelGatewayEmbeddingParameters.EncodingFormat
      Returns:
      this

    • encodingFormat

      public WatsonxGatewayEmbeddingModel.Builder encodingFormat(String encodingFormat)
      Sets the wire format of the returned embeddings as a raw string, for the formats that ModelGatewayEmbeddingParameters.EncodingFormat does not cover yet.
      Parameters:
      encodingFormat - the encoding format
      Returns:
      this

    • user

      public WatsonxGatewayEmbeddingModel.Builder user(String user)
      Sets the identifier of the end user, used for abuse monitoring.
      Parameters:
      user - the user identifier
      Returns:
      this

    • listeners

      public WatsonxGatewayEmbeddingModel.Builder listeners(List<EmbeddingModelListener> listeners)
      Sets the EmbeddingModelListeners notified around every embedding request.
      Parameters:
      listeners - the listeners to register
      Returns:
      this

    • build

      public WatsonxGatewayEmbeddingModel build()

    • baseUrl

      public WatsonxGatewayEmbeddingModel.Builder baseUrl(com.ibm.watsonx.ai.CloudRegion baseUrl)
      Sets the IBM watsonx.ai endpoint from a predefined CloudRegion.
      Parameters:
      baseUrl - the IBM Cloud region whose ML endpoint will be used
      Returns:
      this

    • baseUrl

      public WatsonxGatewayEmbeddingModel.Builder baseUrl(String url)
      Sets the base URL of the IBM watsonx.ai API.
      Parameters:
      url - the base URL string, e.g. "https://us-south.ml.cloud.ibm.com"
      Returns:
      this

    • baseUrl

      public WatsonxGatewayEmbeddingModel.Builder baseUrl(URI url)
      Sets the base URL of the IBM watsonx.ai API as a URI.
      Parameters:
      url - the base URL URI
      Returns:
      this

    • version

      public WatsonxGatewayEmbeddingModel.Builder version(String version)
      Sets the watsonx.ai API version date, e.g. "2024-05-31".
      Parameters:
      version - the API version date string
      Returns:
      this

    • apiKey

      public WatsonxGatewayEmbeddingModel.Builder apiKey(String apiKey)
      Sets the IBM Cloud API key used to generate IAM access tokens for authentication.
      Parameters:
      apiKey - the IBM Cloud API key
      Returns:
      this

    • logRequests

      public WatsonxGatewayEmbeddingModel.Builder logRequests(Boolean logRequests)
      Enables debug logging of request bodies sent to the watsonx.ai API.
      Parameters:
      logRequests - true to enable request logging
      Returns:
      this

    • logResponses

      public WatsonxGatewayEmbeddingModel.Builder logResponses(Boolean logResponses)
      Enables debug logging of response bodies received from the watsonx.ai API.
      Parameters:
      logResponses - true to enable response logging
      Returns:
      this

    • timeout

      public WatsonxGatewayEmbeddingModel.Builder timeout(Duration timeout)
      Sets the HTTP request timeout. Defaults to 60 seconds.
      Parameters:
      timeout - the request timeout
      Returns:
      this

    • authenticator

      public WatsonxGatewayEmbeddingModel.Builder authenticator(com.ibm.watsonx.ai.core.auth.Authenticator authenticator)
      Sets a custom Authenticator for generating bearer tokens.
      Parameters:
      authenticator - the authenticator
      Returns:
      this

    • httpClient

      public WatsonxGatewayEmbeddingModel.Builder httpClient(HttpClient httpClient)
      Sets a custom HttpClient to use for all API calls.
      Parameters:
      httpClient - the HTTP client
      Returns:
      this

    • verifySsl

      public WatsonxGatewayEmbeddingModel.Builder verifySsl(boolean verifySsl)
      Controls whether SSL certificate verification is performed. Defaults to true.
      Parameters:
      verifySsl - false to disable SSL verification
      Returns:
      this