Package co.elastic.clients.elasticsearch.inference

Class OpenShiftAiTaskSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.OpenShiftAiTaskSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class OpenShiftAiTaskSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static OpenShiftAiTaskSettings	of(Function<OpenShiftAiTaskSettings.Builder,ObjectBuilder<OpenShiftAiTaskSettings>> fn)
OpenShiftAiTaskSettings.Builder	rebuild()
final Boolean	returnDocuments()	For a rerank task, whether to return the source documents in the response.
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	setupOpenShiftAiTaskSettingsDeserializer(ObjectDeserializer<OpenShiftAiTaskSettings.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<OpenShiftAiTaskSettings> _DESERIALIZER

Json deserializer for OpenShiftAiTaskSettings

Method Details

of

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

returnDocuments

@Nullable
public final Boolean returnDocuments()

For a rerank task, whether to return the source documents in the response.

API name: return_documents

topN

@Nullable
public final Integer topN()

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

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

rebuild

public OpenShiftAiTaskSettings.Builder rebuild()

Returns:

New OpenShiftAiTaskSettings.Builder initialized with field values of this instance

setupOpenShiftAiTaskSettingsDeserializer

protected static void setupOpenShiftAiTaskSettingsDeserializer(ObjectDeserializer<OpenShiftAiTaskSettings.Builder> op)