Package co.elastic.clients.elasticsearch.inference

Class AzureAiStudioTaskSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<AzureAiStudioTaskSettings.Builder>

co.elastic.clients.elasticsearch.inference.AzureAiStudioTaskSettings.Builder

All Implemented Interfaces:

WithJson<AzureAiStudioTaskSettings.Builder>, ObjectBuilder<AzureAiStudioTaskSettings>

Enclosing class:

AzureAiStudioTaskSettings

public static class AzureAiStudioTaskSettings.Builder
extends WithJsonObjectBuilderBase<AzureAiStudioTaskSettings.Builder>
implements ObjectBuilder<AzureAiStudioTaskSettings>

Builder for AzureAiStudioTaskSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AzureAiStudioTaskSettings	build()	Builds a AzureAiStudioTaskSettings.
final AzureAiStudioTaskSettings.Builder	doSample(Float value)	For a completion task, instruct the inference process to perform sampling.
final AzureAiStudioTaskSettings.Builder	maxNewTokens(Integer value)	For a completion task, provide a hint for the maximum number of output tokens to be generated.
final AzureAiStudioTaskSettings.Builder	returnDocuments(Boolean value)	For a rerank task, return doc text within the results.
protected AzureAiStudioTaskSettings.Builder	self()
final AzureAiStudioTaskSettings.Builder	temperature(Float value)	For a completion task, control the apparent creativity of generated completions with a sampling temperature.
final AzureAiStudioTaskSettings.Builder	topN(Integer value)	For a rerank task, the number of most relevant documents to return.
final AzureAiStudioTaskSettings.Builder	topP(Float value)	For a completion task, make the model consider the results of the tokens with nucleus sampling probability.
final AzureAiStudioTaskSettings.Builder	user(String value)	For a text_embedding task, specify the user issuing the request.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

doSample

public final AzureAiStudioTaskSettings.Builder doSample(@Nullable
 Float value)

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

public final AzureAiStudioTaskSettings.Builder maxNewTokens(@Nullable
 Integer value)

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

API name: max_new_tokens

temperature

public final AzureAiStudioTaskSettings.Builder temperature(@Nullable
 Float value)

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

public final AzureAiStudioTaskSettings.Builder topP(@Nullable
 Float value)

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

public final AzureAiStudioTaskSettings.Builder user(@Nullable
 String value)

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

API name: user

returnDocuments

public final AzureAiStudioTaskSettings.Builder returnDocuments(@Nullable
 Boolean value)

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

API name: return_documents

topN

public final AzureAiStudioTaskSettings.Builder topN(@Nullable
 Integer value)

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

API name: top_n

self

protected AzureAiStudioTaskSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<AzureAiStudioTaskSettings.Builder>

build

public AzureAiStudioTaskSettings build()

Builds a AzureAiStudioTaskSettings.

Specified by:

build in interface ObjectBuilder<AzureAiStudioTaskSettings>

Throws:

NullPointerException - if some of the required fields are null.