Package co.elastic.clients.elasticsearch.inference

Class OpenAITaskSettings

java.lang.Object

co.elastic.clients.elasticsearch.inference.OpenAITaskSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class OpenAITaskSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final JsonData	headers()	Specifies custom HTTP header parameters.
static OpenAITaskSettings	of(Function<OpenAITaskSettings.Builder,ObjectBuilder<OpenAITaskSettings>> 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	setupOpenAITaskSettingsDeserializer(ObjectDeserializer<OpenAITaskSettings.Builder> op)
String	toString()
final String	user()	For a completion or 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<OpenAITaskSettings> _DESERIALIZER

Json deserializer for OpenAITaskSettings

Method Details

of

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

user

@Nullable
public final String user()

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

API name: user

headers

@Nullable
public final JsonData headers()

Specifies custom HTTP header parameters. For example:

 "headers":{
   "Custom-Header": "Some-Value",
   "Another-Custom-Header": "Another-Value"
 }
 
 

API name: headers

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

setupOpenAITaskSettingsDeserializer

protected static void setupOpenAITaskSettingsDeserializer(ObjectDeserializer<OpenAITaskSettings.Builder> op)