software.amazon.awssdk.services.sagemakerruntime.model

Interface InvokeEndpointResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<InvokeEndpointResponse.Builder,InvokeEndpointResponse>, SageMakerRuntimeResponse.Builder, SdkBuilder<InvokeEndpointResponse.Builder,InvokeEndpointResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

InvokeEndpointResponse

public static interface InvokeEndpointResponse.Builder
extends SageMakerRuntimeResponse.Builder, SdkPojo, CopyableBuilder<InvokeEndpointResponse.Builder,InvokeEndpointResponse>

Method Summary

Modifier and Type	Method and Description
InvokeEndpointResponse.Builder	body(SdkBytes body) Includes the inference provided by the model.
InvokeEndpointResponse.Builder	contentType(String contentType) The MIME type of the inference returned in the response body.
InvokeEndpointResponse.Builder	customAttributes(String customAttributes) Provides additional information in the response about the inference returned by a model hosted at an Amazon SageMaker endpoint.
InvokeEndpointResponse.Builder	invokedProductionVariant(String invokedProductionVariant) Identifies the production variant that was invoked.

Methods inherited from interface software.amazon.awssdk.services.sagemakerruntime.model.SageMakerRuntimeResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

body

InvokeEndpointResponse.Builder body(SdkBytes body)

Includes the inference provided by the model.

For information about the format of the response body, see Common Data Formats-Inference.

If the explainer is activated, the body includes the explanations provided by the model. For more information, see the Response section under Invoke the Endpoint in the Developer Guide.

Parameters:

body - Includes the inference provided by the model.

For information about the format of the response body, see Common Data Formats-Inference.

If the explainer is activated, the body includes the explanations provided by the model. For more information, see the Response section under Invoke the Endpoint in the Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentType

InvokeEndpointResponse.Builder contentType(String contentType)

The MIME type of the inference returned in the response body.

Parameters:

contentType - The MIME type of the inference returned in the response body.

Returns:

Returns a reference to this object so that method calls can be chained together.

invokedProductionVariant

InvokeEndpointResponse.Builder invokedProductionVariant(String invokedProductionVariant)

Identifies the production variant that was invoked.

Parameters:

invokedProductionVariant - Identifies the production variant that was invoked.

Returns:

Returns a reference to this object so that method calls can be chained together.

customAttributes

InvokeEndpointResponse.Builder customAttributes(String customAttributes)

Provides additional information in the response about the inference returned by 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 return an ID received in the CustomAttributes header of a request or other metadata that a service endpoint was programmed to produce. 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). If the customer wants the custom attribute returned, the model must set the custom attribute to be included on the way back.

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.

Parameters:

customAttributes - Provides additional information in the response about the inference returned by 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 return an ID received in the CustomAttributes header of a request or other metadata that a service endpoint was programmed to produce. 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). If the customer wants the custom attribute returned, the model must set the custom attribute to be included on the way back.

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:

Returns a reference to this object so that method calls can be chained together.