All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
CohereScoringModelConfig.BuilderBase.CohereScoringModelConfigImpl

public interface CohereScoringModelConfig extends Prototype.Api
Configuration for the Cohere embedding model, CohereScoringModel.
See Also:
  • Field Details

  • Method Details

    • builder

      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder
    • builder

      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance
    • create

      static CohereScoringModelConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration
    • create

      static CohereScoringModelConfig create()
      Create a new instance with default values.
      Returns:
      a new instance
    • maxRetries

      Optional<Integer> maxRetries()
      The maximum number of retries for failed API requests.
      Returns:
      an Optional containing the maximum number of retries
    • proxy

      Optional<Proxy> proxy()
      Proxy to use.
      Returns:
      an Optional containing HTTP proxy to use
    • enabled

      boolean enabled()
      If set to false (default), Cohere model will not be available even if configured.
      Returns:
      whether Cohere model is enabled, defaults to false
    • baseUrl

      Optional<String> baseUrl()
      The base URL for the Cohere API.
      Returns:
      the base URL
    • apiKey

      Optional<String> apiKey()
      The API key used to authenticate requests to the Cohere API.
      Returns:
      an Optional containing the API key
    • logRequests

      Optional<Boolean> logRequests()
      Whether to log API requests.
      Returns:
      an Optional containing true if requests should be logged, false otherwise
    • logResponses

      Optional<Boolean> logResponses()
      Whether to log API responses.
      Returns:
      an Optional containing true if responses should be logged, false otherwise
    • customHeaders

      Map<String,String> customHeaders()
      A map containing custom headers.
      Returns:
      custom headers map
    • timeout

      Optional<Duration> timeout()
      The timeout setting for API requests.
      Returns:
      the timeout setting in Duration.parse(java.lang.CharSequence) format
    • modelName

      Optional<String> modelName()
      The model name to use.
      Returns:
      the model name