Package co.elastic.clients.elasticsearch.inference

Class ContextualAITaskSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.ContextualAITaskSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ContextualAITaskSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final String	instruction()	Instructions for the reranking model.
static ContextualAITaskSettings	of(Function<ContextualAITaskSettings.Builder,ObjectBuilder<ContextualAITaskSettings>> fn)
final Boolean	returnDocuments()	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	setupContextualAITaskSettingsDeserializer(ObjectDeserializer<ContextualAITaskSettings.Builder> op)
final Integer	topK()	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<ContextualAITaskSettings> _DESERIALIZER

Json deserializer for ContextualAITaskSettings

Method Details

of

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

instruction

@Nullable
public final String instruction()

Instructions for the reranking model. Refer to https://docs.contextual.ai/api-reference/rerank/rerank#body-instruction Only for the rerank task type.

API name: instruction

returnDocuments

@Nullable
public final Boolean returnDocuments()

Whether to return the source documents in the response. Only for the rerank task type.

API name: return_documents

topK

@Nullable
public final Integer topK()

The number of most relevant documents to return. If not specified, the reranking results of all documents will be returned. Only for the rerank task type.

API name: top_k

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

setupContextualAITaskSettingsDeserializer

protected static void setupContextualAITaskSettingsDeserializer(ObjectDeserializer<ContextualAITaskSettings.Builder> op)