Package co.elastic.clients.elasticsearch.inference

Class HuggingFaceServiceSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.inference.HuggingFaceServiceSettings.Builder

All Implemented Interfaces:

WithJson<HuggingFaceServiceSettings.Builder>, ObjectBuilder<HuggingFaceServiceSettings>

Enclosing class:

HuggingFaceServiceSettings

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

Builder for HuggingFaceServiceSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final HuggingFaceServiceSettings.Builder	apiKey(String value)	Required - A valid access token for your HuggingFace account.
HuggingFaceServiceSettings	build()	Builds a HuggingFaceServiceSettings.
final HuggingFaceServiceSettings.Builder	rateLimit(RateLimitSetting value)	This setting helps to minimize the number of rate limit errors returned from Hugging Face.
final HuggingFaceServiceSettings.Builder	rateLimit(Function<RateLimitSetting.Builder,ObjectBuilder<RateLimitSetting>> fn)	This setting helps to minimize the number of rate limit errors returned from Hugging Face.
protected HuggingFaceServiceSettings.Builder	self()
final HuggingFaceServiceSettings.Builder	url(String value)	Required - The URL endpoint to use for the requests.

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 HuggingFaceServiceSettings.Builder apiKey(String value)

Required - A valid access token for your HuggingFace account. You can create or find your access tokens on the HuggingFace 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

rateLimit

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

This setting helps to minimize the number of rate limit errors returned from Hugging Face. By default, the hugging_face service sets the number of requests allowed per minute to 3000.

API name: rate_limit

rateLimit

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

This setting helps to minimize the number of rate limit errors returned from Hugging Face. By default, the hugging_face service sets the number of requests allowed per minute to 3000.

API name: rate_limit

url

public final HuggingFaceServiceSettings.Builder url(String value)

Required - The URL endpoint to use for the requests.

API name: url

self

protected HuggingFaceServiceSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<HuggingFaceServiceSettings.Builder>

build

public HuggingFaceServiceSettings build()

Builds a HuggingFaceServiceSettings.

Specified by:

build in interface ObjectBuilder<HuggingFaceServiceSettings>

Throws:

NullPointerException - if some of the required fields are null.