Class InvokeEndpointRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<InvokeEndpointRequest.Builder,
InvokeEndpointRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
accept()
The desired MIME type of the inference response from the model container.final SdkBytes
body()
Provides input data, in the format specified in theContentType
request header.builder()
final String
The MIME type of the input data in the request body.final String
Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint.final String
An optional JMESPath expression used to override theEnableExplanations
parameter of theClarifyExplainerConfig
API.final String
The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke.final String
If you provide a value, it is added to the captured data when you enable data capture on the endpoint.static Class
<? extends InvokeEndpointRequest.Builder> final String
If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies the host name of the container to invoke.final String
The model to request for inference when invoking a multi-model endpoint.final String
Specify the production variant to send the inference request to when invoking an endpoint that is running two or more variants.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
endpointName
The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
- Returns:
- The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.
-
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.
- Returns:
- 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.
-
contentType
The MIME type of the input data in the request body.
- Returns:
- The MIME type of the input data in the request body.
-
accept
The desired MIME type of the inference response from the model container.
- Returns:
- The desired MIME type of the inference response from the model container.
-
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.
- Returns:
- 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.
-
targetModel
The model to request for inference when invoking a multi-model endpoint.
- Returns:
- The model to request for inference when invoking a multi-model endpoint.
-
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
- Returns:
- 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
-
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.
- Returns:
- If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies the host name of the container to invoke.
-
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.
- Returns:
- 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.
-
enableExplanations
An optional JMESPath expression used to override the
EnableExplanations
parameter of theClarifyExplainerConfig
API. See the EnableExplanations section in the developer guide for more information.- Returns:
- An optional JMESPath expression used to override the
EnableExplanations
parameter of theClarifyExplainerConfig
API. See the EnableExplanations section in the developer guide for more information.
-
inferenceComponentName
If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke.
- Returns:
- If the endpoint hosts one or more inference components, this parameter specifies the name of inference component to invoke.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<InvokeEndpointRequest.Builder,
InvokeEndpointRequest> - Specified by:
toBuilder
in classSageMakerRuntimeRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-