Package co.elastic.clients.elasticsearch.inference

Class InferenceEndpoint

java.lang.Object

co.elastic.clients.elasticsearch.inference.InferenceEndpoint

All Implemented Interfaces:

JsonpSerializable

Direct Known Subclasses:

InferenceEndpointInfo, InferenceEndpointInfoAlibabaCloudAI, InferenceEndpointInfoAmazonBedrock, InferenceEndpointInfoAmazonSageMaker, InferenceEndpointInfoAnthropic, InferenceEndpointInfoAzureAIStudio, InferenceEndpointInfoAzureOpenAI, InferenceEndpointInfoCohere, InferenceEndpointInfoCustom, InferenceEndpointInfoDeepSeek, InferenceEndpointInfoElasticsearch, InferenceEndpointInfoELSER, InferenceEndpointInfoGoogleAIStudio, InferenceEndpointInfoGoogleVertexAI, InferenceEndpointInfoHuggingFace, InferenceEndpointInfoJinaAi, InferenceEndpointInfoMistral, InferenceEndpointInfoOpenAI, InferenceEndpointInfoVoyageAI, InferenceEndpointInfoWatsonx

@JsonpDeserializable
public class InferenceEndpoint
extends Object
implements JsonpSerializable

Configuration options when storing the inference endpoint

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InferenceEndpoint.AbstractBuilder<BuilderT extends InferenceEndpoint.AbstractBuilder<BuilderT>>
static class	InferenceEndpoint.Builder	Builder for InferenceEndpoint.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InferenceEndpoint(InferenceEndpoint.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
final InferenceChunkingSettings	chunkingSettings()	Chunking configuration object
static InferenceEndpoint	inferenceEndpointOf(Function<InferenceEndpoint.Builder,ObjectBuilder<InferenceEndpoint>> 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)
final String	service()	Required - The service type
final JsonData	serviceSettings()	Required - Settings specific to the service
protected static <BuilderT extends InferenceEndpoint.AbstractBuilder<BuilderT>> void	setupInferenceEndpointDeserializer(ObjectDeserializer<BuilderT> op)
final JsonData	taskSettings()	Task settings specific to the service and task type
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<InferenceEndpoint> _DESERIALIZER

Json deserializer for InferenceEndpoint

Constructor Details

InferenceEndpoint

protected InferenceEndpoint(InferenceEndpoint.AbstractBuilder<?> builder)

Method Details

inferenceEndpointOf

public static InferenceEndpoint inferenceEndpointOf(Function<InferenceEndpoint.Builder,ObjectBuilder<InferenceEndpoint>> fn)

chunkingSettings

@Nullable
public final InferenceChunkingSettings chunkingSettings()

Chunking configuration object

API name: chunking_settings

service

public final String service()

Required - The service type

API name: service

serviceSettings

public final JsonData serviceSettings()

Required - Settings specific to the service

API name: service_settings

taskSettings

@Nullable
public final JsonData taskSettings()

Task settings specific to the service and task type

API name: task_settings

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

setupInferenceEndpointDeserializer

protected static <BuilderT extends InferenceEndpoint.AbstractBuilder<BuilderT>>
void setupInferenceEndpointDeserializer(ObjectDeserializer<BuilderT> op)