Package co.elastic.clients.elasticsearch.inference

Class AmazonSageMakerServiceSettings

java.lang.Object
co.elastic.clients.elasticsearch.inference.AmazonSageMakerServiceSettings
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class AmazonSageMakerServiceSettings extends Object implements JsonpSerializable
See Also:

  • Field Details

  • Method Details

    • of

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

    • accessKey

      public final String accessKey()
      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 String endpointName()
      Required - The name of the SageMaker endpoint.

      API name: endpoint_name

    • api

      public final AmazonSageMakerApi api()
      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 String region()
      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 String secretKey()
      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

      @Nullable public final String targetModel()
      The model ID when calling a multi-model endpoint.

      API name: target_model

    • targetContainerHostname

      @Nullable public final String targetContainerHostname()
      The container to directly invoke when calling a multi-container endpoint.

      API name: target_container_hostname

    • inferenceComponentName

      @Nullable public final String inferenceComponentName()
      The inference component to directly invoke when calling a multi-component endpoint.

      API name: inference_component_name

    • batchSize

      @Nullable public final Integer batchSize()
      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

      @Nullable public final Integer dimensions()
      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

    • 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

    • setupAmazonSageMakerServiceSettingsDeserializer

      protected static void setupAmazonSageMakerServiceSettingsDeserializer(ObjectDeserializer<AmazonSageMakerServiceSettings.Builder> op)