Package co.elastic.clients.elasticsearch.inference

Class AmazonSageMakerServiceSettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.inference.AmazonSageMakerServiceSettings.Builder

All Implemented Interfaces:

WithJson<AmazonSageMakerServiceSettings.Builder>, ObjectBuilder<AmazonSageMakerServiceSettings>

Enclosing class:

AmazonSageMakerServiceSettings

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

Builder for AmazonSageMakerServiceSettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AmazonSageMakerServiceSettings.Builder	accessKey(String value)	Required - A valid AWS access key that has permissions to use Amazon SageMaker and access to models for invoking requests.
final AmazonSageMakerServiceSettings.Builder	api(AmazonSageMakerApi value)	Required - The API format to use when calling SageMaker.
final AmazonSageMakerServiceSettings.Builder	batchSize(Integer value)	The maximum number of inputs in each batch.
AmazonSageMakerServiceSettings	build()	Builds a AmazonSageMakerServiceSettings.
final AmazonSageMakerServiceSettings.Builder	dimensions(Integer value)	The number of dimensions returned by the text embedding models.
final AmazonSageMakerServiceSettings.Builder	endpointName(String value)	Required - The name of the SageMaker endpoint.
final AmazonSageMakerServiceSettings.Builder	inferenceComponentName(String value)	The inference component to directly invoke when calling a multi-component endpoint.
final AmazonSageMakerServiceSettings.Builder	region(String value)	Required - The region that your endpoint or Amazon Resource Name (ARN) is deployed in.
final AmazonSageMakerServiceSettings.Builder	secretKey(String value)	Required - A valid AWS secret key that is paired with the access_key.
protected AmazonSageMakerServiceSettings.Builder	self()
final AmazonSageMakerServiceSettings.Builder	targetContainerHostname(String value)	The container to directly invoke when calling a multi-container endpoint.
final AmazonSageMakerServiceSettings.Builder	targetModel(String value)	The model ID when calling a multi-model endpoint.

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

accessKey

public final AmazonSageMakerServiceSettings.Builder accessKey(String value)

Required - A valid AWS access key that has permissions to use Amazon SageMaker and access to models for invoking requests.

API name: access_key

endpointName

public final AmazonSageMakerServiceSettings.Builder endpointName(String value)

Required - The name of the SageMaker endpoint.

API name: endpoint_name

api

public final AmazonSageMakerServiceSettings.Builder api(AmazonSageMakerApi value)

Required - The API format to use when calling SageMaker. Elasticsearch will convert the POST _inference request to this data format when invoking the SageMaker endpoint.

API name: api

region

public final AmazonSageMakerServiceSettings.Builder region(String value)

Required - The region that your endpoint or Amazon Resource Name (ARN) is deployed in. The list of available regions per model can be found in the Amazon SageMaker documentation.

API name: region

secretKey

public final AmazonSageMakerServiceSettings.Builder secretKey(String value)

Required - A valid AWS secret key that is paired with the access_key. For information about creating and managing access and secret keys, refer to the AWS documentation.

API name: secret_key

targetModel

public final AmazonSageMakerServiceSettings.Builder targetModel(@Nullable
 String value)

The model ID when calling a multi-model endpoint.

API name: target_model

targetContainerHostname

public final AmazonSageMakerServiceSettings.Builder targetContainerHostname(@Nullable
 String value)

The container to directly invoke when calling a multi-container endpoint.

API name: target_container_hostname

inferenceComponentName

public final AmazonSageMakerServiceSettings.Builder inferenceComponentName(@Nullable
 String value)

The inference component to directly invoke when calling a multi-component endpoint.

API name: inference_component_name

batchSize

public final AmazonSageMakerServiceSettings.Builder batchSize(@Nullable
 Integer value)

The maximum number of inputs in each batch. This value is used by inference ingestion pipelines when processing semantic values. It correlates to the number of times the SageMaker endpoint is invoked (one per batch of input).

API name: batch_size

dimensions

public final AmazonSageMakerServiceSettings.Builder dimensions(@Nullable
 Integer value)

The number of dimensions returned by the text embedding models. If this value is not provided, then it is guessed by making invoking the endpoint for the text_embedding task.

API name: dimensions

self

protected AmazonSageMakerServiceSettings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<AmazonSageMakerServiceSettings.Builder>

build

public AmazonSageMakerServiceSettings build()

Builds a AmazonSageMakerServiceSettings.

Specified by:

build in interface ObjectBuilder<AmazonSageMakerServiceSettings>

Throws:

NullPointerException - if some of the required fields are null.