Package co.elastic.clients.elasticsearch.inference

Class AlibabaCloudTaskSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.AlibabaCloudTaskSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class AlibabaCloudTaskSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final String	inputType()	For a sparse_embedding or text_embedding task, specify the type of input passed to the model.
static AlibabaCloudTaskSettings	of(Function<AlibabaCloudTaskSettings.Builder,ObjectBuilder<AlibabaCloudTaskSettings>> fn)
final Boolean	returnToken()	For a sparse_embedding task, it affects whether the token name will be returned 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	setupAlibabaCloudTaskSettingsDeserializer(ObjectDeserializer<AlibabaCloudTaskSettings.Builder> op)
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<AlibabaCloudTaskSettings> _DESERIALIZER

Json deserializer for AlibabaCloudTaskSettings

Method Details

of

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

inputType

@Nullable
public final String inputType()

For a sparse_embedding or text_embedding task, specify the type of input passed to the model. Valid values are:

• ingest for storing document embeddings in a vector database.
• search for storing embeddings of search queries run against a vector database to find relevant documents.

API name: input_type

returnToken

@Nullable
public final Boolean returnToken()

For a sparse_embedding task, it affects whether the token name will be returned in the response. It defaults to false, which means only the token ID will be returned in the response.

API name: return_token

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

setupAlibabaCloudTaskSettingsDeserializer

protected static void setupAlibabaCloudTaskSettingsDeserializer(ObjectDeserializer<AlibabaCloudTaskSettings.Builder> op)