Package co.elastic.clients.elasticsearch.inference

Class HuggingFaceServiceSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.HuggingFaceServiceSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class HuggingFaceServiceSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HuggingFaceServiceSettings.Builder	Builder for HuggingFaceServiceSettings.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<HuggingFaceServiceSettings>	_DESERIALIZER	Json deserializer for HuggingFaceServiceSettings

Method Summary

Modifier and Type	Method	Description
final String	apiKey()	Required - A valid access token for your HuggingFace account.
static HuggingFaceServiceSettings	of(Function<HuggingFaceServiceSettings.Builder,ObjectBuilder<HuggingFaceServiceSettings>> fn)
final RateLimitSetting	rateLimit()	This setting helps to minimize the number of rate limit errors returned from Hugging Face.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupHuggingFaceServiceSettingsDeserializer(ObjectDeserializer<HuggingFaceServiceSettings.Builder> op)
String	toString()
final String	url()	Required - The URL endpoint to use for the requests.

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<HuggingFaceServiceSettings> _DESERIALIZER

Json deserializer for HuggingFaceServiceSettings

Method Details

of

public static HuggingFaceServiceSettings of(Function<HuggingFaceServiceSettings.Builder,ObjectBuilder<HuggingFaceServiceSettings>> fn)

apiKey

public final String apiKey()

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

@Nullable
public final RateLimitSetting rateLimit()

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 String url()

Required - The URL endpoint to use for the requests.

API name: url

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupHuggingFaceServiceSettingsDeserializer

protected static void setupHuggingFaceServiceSettingsDeserializer(ObjectDeserializer<HuggingFaceServiceSettings.Builder> op)