public static interface InvokeEndpointRequest.Builder extends SageMakerRuntimeRequest.Builder, SdkPojo, CopyableBuilder<InvokeEndpointRequest.Builder,InvokeEndpointRequest>
| Modifier and Type | Method and Description |
|---|---|
InvokeEndpointRequest.Builder |
accept(String accept)
The desired MIME type of the inference response from the model container.
|
InvokeEndpointRequest.Builder |
body(SdkBytes body)
Provides input data, in the format specified in the
ContentType request header. |
InvokeEndpointRequest.Builder |
contentType(String contentType)
The MIME type of the input data in the request body.
|
InvokeEndpointRequest.Builder |
customAttributes(String customAttributes)
Provides additional information about a request for an inference submitted to a model hosted at an Amazon
SageMaker endpoint.
|
InvokeEndpointRequest.Builder |
enableExplanations(String enableExplanations)
An optional JMESPath expression used to override the
EnableExplanations parameter of the
ClarifyExplainerConfig API. |
InvokeEndpointRequest.Builder |
endpointName(String endpointName)
The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
|
InvokeEndpointRequest.Builder |
inferenceId(String inferenceId)
If you provide a value, it is added to the captured data when you enable data capture on the endpoint.
|
InvokeEndpointRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
InvokeEndpointRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
InvokeEndpointRequest.Builder |
targetContainerHostname(String targetContainerHostname)
If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter
specifies the host name of the container to invoke.
|
InvokeEndpointRequest.Builder |
targetModel(String targetModel)
The model to request for inference when invoking a multi-model endpoint.
|
InvokeEndpointRequest.Builder |
targetVariant(String targetVariant)
Specify the production variant to send the inference request to when invoking an endpoint that is running two
or more variants.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildInvokeEndpointRequest.Builder endpointName(String endpointName)
The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
endpointName - The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.InvokeEndpointRequest.Builder body(SdkBytes body)
Provides input data, in the format specified in the ContentType request header. Amazon SageMaker
passes all of the data in the body to the model.
For information about the format of the request body, see Common Data Formats-Inference.
body - Provides input data, in the format specified in the ContentType request header. Amazon
SageMaker passes all of the data in the body to the model.
For information about the format of the request body, see Common Data Formats-Inference.
InvokeEndpointRequest.Builder contentType(String contentType)
The MIME type of the input data in the request body.
contentType - The MIME type of the input data in the request body.InvokeEndpointRequest.Builder accept(String accept)
The desired MIME type of the inference response from the model container.
accept - The desired MIME type of the inference response from the model container.InvokeEndpointRequest.Builder customAttributes(String customAttributes)
Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).
The code in your model is responsible for setting or updating any custom attributes in the response. If your
code does not set this value in the response, an empty value is returned. For example, if a custom attribute
represents the trace ID, your model can prepend the custom attribute with Trace ID: in your
post-processing function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.
customAttributes - Provides additional information about a request for an inference submitted to a model hosted at an
Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could
use this value, for example, to provide an ID that you can use to track a request or to provide other
metadata that a service endpoint was programmed to process. The value must consist of no more than
1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value
Components of the Hypertext Transfer Protocol (HTTP/1.1).
The code in your model is responsible for setting or updating any custom attributes in the response.
If your code does not set this value in the response, an empty value is returned. For example, if a
custom attribute represents the trace ID, your model can prepend the custom attribute with
Trace ID: in your post-processing function.
This feature is currently supported in the Amazon Web Services SDKs but not in the Amazon SageMaker Python SDK.
InvokeEndpointRequest.Builder targetModel(String targetModel)
The model to request for inference when invoking a multi-model endpoint.
targetModel - The model to request for inference when invoking a multi-model endpoint.InvokeEndpointRequest.Builder targetVariant(String targetVariant)
Specify the production variant to send the inference request to when invoking an endpoint that is running two or more variants. Note that this parameter overrides the default behavior for the endpoint, which is to distribute the invocation traffic based on the variant weights.
For information about how to use variant targeting to perform a/b testing, see Test models in production
targetVariant - Specify the production variant to send the inference request to when invoking an endpoint that is
running two or more variants. Note that this parameter overrides the default behavior for the
endpoint, which is to distribute the invocation traffic based on the variant weights.
For information about how to use variant targeting to perform a/b testing, see Test models in production
InvokeEndpointRequest.Builder targetContainerHostname(String targetContainerHostname)
If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies the host name of the container to invoke.
targetContainerHostname - If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter
specifies the host name of the container to invoke.InvokeEndpointRequest.Builder inferenceId(String inferenceId)
If you provide a value, it is added to the captured data when you enable data capture on the endpoint. For information about data capture, see Capture Data.
inferenceId - If you provide a value, it is added to the captured data when you enable data capture on the endpoint.
For information about data capture, see Capture
Data.InvokeEndpointRequest.Builder enableExplanations(String enableExplanations)
An optional JMESPath expression used to override the EnableExplanations parameter of the
ClarifyExplainerConfig API. See the EnableExplanations section in the developer guide for more information.
enableExplanations - An optional JMESPath expression used to override the EnableExplanations parameter of the
ClarifyExplainerConfig API. See the EnableExplanations section in the developer guide for more information.InvokeEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderInvokeEndpointRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.