Package co.elastic.clients.elasticsearch.inference

Class CohereServiceSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<CohereServiceSettings.Builder>

co.elastic.clients.elasticsearch.inference.CohereServiceSettings.Builder

All Implemented Interfaces:

WithJson<CohereServiceSettings.Builder>, ObjectBuilder<CohereServiceSettings>

Enclosing class:

CohereServiceSettings

public static class CohereServiceSettings.Builder
extends WithJsonObjectBuilderBase<CohereServiceSettings.Builder>
implements ObjectBuilder<CohereServiceSettings>

Builder for CohereServiceSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final CohereServiceSettings.Builder	apiKey(String value)	Required - A valid API key for your Cohere account.
CohereServiceSettings	build()	Builds a CohereServiceSettings.
final CohereServiceSettings.Builder	embeddingType(CohereEmbeddingType value)	For a text_embedding task, the types of embeddings you want to get back.
final CohereServiceSettings.Builder	modelId(String value)	For a completion, rerank, or text_embedding task, the name of the model to use for the inference task.
final CohereServiceSettings.Builder	rateLimit(RateLimitSetting value)	This setting helps to minimize the number of rate limit errors returned from Cohere.
final CohereServiceSettings.Builder	rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)	This setting helps to minimize the number of rate limit errors returned from Cohere.
protected CohereServiceSettings.Builder	self()
final CohereServiceSettings.Builder	similarity(CohereSimilarityType value)	The similarity measure.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

apiKey

public final CohereServiceSettings.Builder apiKey(String value)

Required - A valid API key for your Cohere account. You can find or create your Cohere API keys on the Cohere API key settings page.

IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key. After creating the inference model, you cannot change the associated API key. If you want to use a different API key, delete the inference model and recreate it with the same name and the updated API key.

API name: api_key

embeddingType

public final CohereServiceSettings.Builder embeddingType(@Nullable
 CohereEmbeddingType value)

For a text_embedding task, the types of embeddings you want to get back. Use byte for signed int8 embeddings (this is a synonym of int8). Use float for the default float embeddings. Use int8 for signed int8 embeddings.

API name: embedding_type

modelId

public final CohereServiceSettings.Builder modelId(@Nullable
 String value)

For a completion, rerank, or text_embedding task, the name of the model to use for the inference task.

• For the available completion models, refer to the Cohere command docs.
• For the available rerank models, refer to the Cohere rerank docs.
• For the available text_embedding models, refer to Cohere embed docs.

The default value for a text embedding task is embed-english-v2.0.

API name: model_id

rateLimit

public final CohereServiceSettings.Builder rateLimit(@Nullable
 RateLimitSetting value)

This setting helps to minimize the number of rate limit errors returned from Cohere. By default, the cohere service sets the number of requests allowed per minute to 10000.

API name: rate_limit

rateLimit

public final CohereServiceSettings.Builder rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)

This setting helps to minimize the number of rate limit errors returned from Cohere. By default, the cohere service sets the number of requests allowed per minute to 10000.

API name: rate_limit

similarity

public final CohereServiceSettings.Builder similarity(@Nullable
 CohereSimilarityType value)

The similarity measure. If the embedding_type is float, the default value is dot_product. If the embedding_type is int8 or byte, the default value is cosine.

API name: similarity

self

protected CohereServiceSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<CohereServiceSettings.Builder>

build

public CohereServiceSettings build()

Builds a CohereServiceSettings.

Specified by:

build in interface ObjectBuilder<CohereServiceSettings>

Throws:

NullPointerException - if some of the required fields are null.