Package co.elastic.clients.elasticsearch.inference

Class AzureAiStudioTaskSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.AzureAiStudioTaskSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class AzureAiStudioTaskSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final Float	doSample()	For a completion task, instruct the inference process to perform sampling.
final Integer	maxNewTokens()	For a completion task, provide a hint for the maximum number of output tokens to be generated.
static AzureAiStudioTaskSettings	of(Function<AzureAiStudioTaskSettings.Builder,ObjectBuilder<AzureAiStudioTaskSettings>> fn)
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	setupAzureAiStudioTaskSettingsDeserializer(ObjectDeserializer<AzureAiStudioTaskSettings.Builder> op)
final Float	temperature()	For a completion task, control the apparent creativity of generated completions with a sampling temperature.
final Float	topP()	For a completion task, make the model consider the results of the tokens with nucleus sampling probability.
String	toString()
final String	user()	For a text_embedding task, specify the user issuing the request.

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<AzureAiStudioTaskSettings> _DESERIALIZER

Json deserializer for AzureAiStudioTaskSettings

Method Details

of

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

doSample

@Nullable
public final Float doSample()

For a completion task, instruct the inference process to perform sampling. It has no effect unless temperature or top_p is specified.

API name: do_sample

maxNewTokens

@Nullable
public final Integer maxNewTokens()

For a completion task, provide a hint for the maximum number of output tokens to be generated.

API name: max_new_tokens

temperature

@Nullable
public final Float temperature()

For a completion task, control the apparent creativity of generated completions with a sampling temperature. It must be a number in the range of 0.0 to 2.0. It should not be used if top_p is specified.

API name: temperature

topP

@Nullable
public final Float topP()

For a completion task, make the model consider the results of the tokens with nucleus sampling probability. It is an alternative value to temperature and must be a number in the range of 0.0 to 2.0. It should not be used if temperature is specified.

API name: top_p

user

@Nullable
public final String user()

For a text_embedding task, specify the user issuing the request. This information can be used for abuse detection.

API name: user

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

setupAzureAiStudioTaskSettingsDeserializer

protected static void setupAzureAiStudioTaskSettingsDeserializer(ObjectDeserializer<AzureAiStudioTaskSettings.Builder> op)