Package co.elastic.clients.elasticsearch.inference

Class HuggingFaceTaskSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.HuggingFaceTaskSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class HuggingFaceTaskSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static HuggingFaceTaskSettings	of(Function<HuggingFaceTaskSettings.Builder,ObjectBuilder<HuggingFaceTaskSettings>> fn)
final Boolean	returnDocuments()	For a rerank task, return doc text within the results.
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	setupHuggingFaceTaskSettingsDeserializer(ObjectDeserializer<HuggingFaceTaskSettings.Builder> op)
final Integer	topN()	For a rerank task, the number of most relevant documents to return.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<HuggingFaceTaskSettings> _DESERIALIZER

Json deserializer for HuggingFaceTaskSettings

Method Details

of

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

returnDocuments

@Nullable
public final Boolean returnDocuments()

For a rerank task, return doc text within the results.

API name: return_documents

topN

@Nullable
public final Integer topN()

For a rerank task, the number of most relevant documents to return. It defaults to the number of the documents.

API name: top_n

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

setupHuggingFaceTaskSettingsDeserializer

protected static void setupHuggingFaceTaskSettingsDeserializer(ObjectDeserializer<HuggingFaceTaskSettings.Builder> op)