Create an Amazon SageMaker inference endpoint
- PUT /_inference/{task_type}/{amazonsagemaker_inference_id}
Create an inference endpoint to perform an inference task with the amazon_sagemaker service.
Required authorization
- Cluster privileges manage_inference
Request body
-
chunking_settingsobject -
The chunking configuration object.
- Reference
-
max_chunk_sizenumber · default: 250 -
The maximum size of a chunk in words. This value cannot be higher than
300or lower than20(forsentencestrategy) or10(forwordstrategy). -
overlapnumber · default: 100 -
The number of overlapping words for chunks. It is applicable only to a
wordchunking strategy. This value cannot be higher than half themax_chunk_sizevalue. -
servicerequired -
The type of service supported for the specified task type. In this case,
amazon_sagemaker. -
Values:
amazon_sagemaker -
service_settingsobjectrequired -
Settings used to install the inference model. These settings are specific to the
amazon_sagemakerservice andservice_settings.apiyou specified. -
access_keystringrequired -
A valid AWS access key that has permissions to use Amazon SageMaker and access to models for invoking requests.
-
apirequired -
The API format to use when calling SageMaker. Elasticsearch will convert the POST _inference request to this data format when invoking the SageMaker endpoint.
-
Values:
openaielastic -
regionstringrequired -
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.
- External docs
-
secret_keystringrequired -
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. - External docs
-
target_container_hostnamestring -
The container to directly invoke when calling a multi-container endpoint.
- External docs
-
inference_component_namestring -
The inference component to directly invoke when calling a multi-component endpoint.
- External docs
-
task_settingsobject -
Settings to configure the inference task. These settings are specific to the task type and
service_settings.apiyou specified. -
custom_attributesstring -
The AWS custom attributes passed verbatim through to the model running in the SageMaker Endpoint. Values will be returned in the
X-elastic-sagemaker-custom-attributesheader. - External docs
-
enable_explanationsstring -
The optional JMESPath expression used to override the EnableExplanations provided during endpoint creation.
- External docs
-
session_idstring -
The stateful session identifier for a new or existing session. New sessions will be returned in the
X-elastic-sagemaker-new-session-idheader. Closed sessions will be returned in theX-elastic-sagemaker-closed-session-idheader. - External docs
-
target_variantstring -
Specifies the variant when running with multi-variant Endpoints.
- External docs
Response
-
chunking_settingsobject -
Chunking configuration object
-
max_chunk_sizenumber · default: 250 -
The maximum size of a chunk in words. This value cannot be higher than
300or lower than20(forsentencestrategy) or10(forwordstrategy). -
overlapnumber · default: 100 -
The number of overlapping words for chunks. It is applicable only to a
wordchunking strategy. This value cannot be higher than half themax_chunk_sizevalue.