Interface CohereScoringModelConfig
- All Superinterfaces:
Prototype.Api
- All Known Implementing Classes:
CohereScoringModelConfig.BuilderBase.CohereScoringModelConfigImpl
Configuration for the Cohere embedding model,
CohereScoringModel
.- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
Fluent API builder forCohereScoringModelConfig
.static class
CohereScoringModelConfig.BuilderBase<BUILDER extends CohereScoringModelConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends CohereScoringModelConfig> Fluent API builder base forCohereScoringModelConfig
. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionapiKey()
The API key used to authenticate requests to the Cohere API.baseUrl()
The base URL for the Cohere API.builder()
Create a new fluent API builder to customize configuration.builder
(CohereScoringModelConfig instance) Create a new fluent API builder from an existing instance.static CohereScoringModelConfig
create()
Create a new instance with default values.static CohereScoringModelConfig
Create a new instance from configuration.A map containing custom headers.boolean
enabled()
If set tofalse
(default), Cohere model will not be available even if configured.Whether to log API requests.Whether to log API responses.The maximum number of retries for failed API requests.The model name to use.proxy()
Proxy to use.timeout()
The timeout setting for API requests.
-
Field Details
-
CONFIG_ROOT
Default configuration prefix.- See Also:
-
-
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
Create a new instance from configuration.- Parameters:
config
- used to configure the new instance- Returns:
- a new instance configured from configuration
-
create
Create a new instance with default values.- Returns:
- a new instance
-
maxRetries
The maximum number of retries for failed API requests.- Returns:
- an
Optional
containing the maximum number of retries
-
proxy
Proxy to use.- Returns:
- an
Optional
containing HTTP proxy to use
-
enabled
boolean enabled()If set tofalse
(default), Cohere model will not be available even if configured.- Returns:
- whether Cohere model is enabled, defaults to
false
-
baseUrl
The base URL for the Cohere API.- Returns:
- the base URL
-
apiKey
The API key used to authenticate requests to the Cohere API.- Returns:
- an
Optional
containing the API key
-
logRequests
Whether to log API requests.- Returns:
- an
Optional
containing true if requests should be logged, false otherwise
-
logResponses
Whether to log API responses.- Returns:
- an
Optional
containing true if responses should be logged, false otherwise
-
customHeaders
A map containing custom headers.- Returns:
- custom headers map
-
timeout
The timeout setting for API requests.- Returns:
- the timeout setting in
Duration.parse(java.lang.CharSequence)
format
-
modelName
The model name to use.- Returns:
- the model name
-