Package co.elastic.clients.elasticsearch.inference

Class EmbeddingRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<EmbeddingRequest.Builder>

co.elastic.clients.elasticsearch.inference.EmbeddingRequest.Builder

All Implemented Interfaces:

WithJson<EmbeddingRequest.Builder>, ObjectBuilder<EmbeddingRequest>

Enclosing class:

EmbeddingRequest

public static class EmbeddingRequest.Builder
extends RequestBase.AbstractBuilder<EmbeddingRequest.Builder>
implements ObjectBuilder<EmbeddingRequest>

Builder for EmbeddingRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EmbeddingRequest	build()	Builds a EmbeddingRequest.
final EmbeddingRequest.Builder	embedding(RequestEmbedding value)	Required - Request body.
final EmbeddingRequest.Builder	embedding(Function<RequestEmbedding.Builder,ObjectBuilder<RequestEmbedding>> fn)	Required - Request body.
final EmbeddingRequest.Builder	inferenceId(String value)	Required - The inference Id
protected EmbeddingRequest.Builder	self()
final EmbeddingRequest.Builder	timeout(Time value)	Specifies the amount of time to wait for the inference request to complete.
final EmbeddingRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Specifies the amount of time to wait for the inference request to complete.
EmbeddingRequest.Builder	withJson(jakarta.json.stream.JsonParser parser, JsonpMapper mapper)	Sets additional properties values on this object by reading from a JSON input.

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

inferenceId

public final EmbeddingRequest.Builder inferenceId(String value)

Required - The inference Id

API name: inference_id

timeout

public final EmbeddingRequest.Builder timeout(@Nullable
 Time value)

Specifies the amount of time to wait for the inference request to complete.

API name: timeout

timeout

public final EmbeddingRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Specifies the amount of time to wait for the inference request to complete.

API name: timeout

embedding

public final EmbeddingRequest.Builder embedding(RequestEmbedding value)

Required - Request body.

embedding

public final EmbeddingRequest.Builder embedding(Function<RequestEmbedding.Builder,ObjectBuilder<RequestEmbedding>> fn)

Required - Request body.

withJson

public EmbeddingRequest.Builder withJson(jakarta.json.stream.JsonParser parser,
 JsonpMapper mapper)

Description copied from interface: WithJson

Sets additional properties values on this object by reading from a JSON input.

This is a "partial deserialization": properties that were already set keep their value if they're not present in the JSON input, and properties can also be set after having called this method, including overriding those read from the JSON input.

This low level variant of withJson gives full control on the json parser and object mapper. Most of the time using WithJson.withJson(Reader) and WithJson.withJson(InputStream) will be more convenient.

Specified by:

withJson in interface WithJson<EmbeddingRequest.Builder>

Overrides:

withJson in class WithJsonObjectBuilderBase<EmbeddingRequest.Builder>

Parameters:

parser - the JSONP parser

mapper - the JSONP mapper used to deserialize values and nested objects

Returns:

this object

self

protected EmbeddingRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<EmbeddingRequest.Builder>

build

public EmbeddingRequest build()

Builds a EmbeddingRequest.

Specified by:

build in interface ObjectBuilder<EmbeddingRequest>

Throws:

NullPointerException - if some of the required fields are null.