Struct aws_sdk_sagemakerruntime::operation::invoke_endpoint::builders::InvokeEndpointOutputBuilder

#[non_exhaustive]
pub struct InvokeEndpointOutputBuilder { /* private fields */ }

A builder for InvokeEndpointOutput.

Implementations

impl InvokeEndpointOutputBuilder

pub fn body(self, input: Blob) -> Self

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.

This field is required.

pub fn set_body(self, input: Option<Blob>) -> Self

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.

pub fn get_body(&self) -> &Option<Blob>

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.

pub fn content_type(self, input: impl Into<String>) -> Self

The MIME type of the inference returned from the model container.

pub fn set_content_type(self, input: Option<String>) -> Self

The MIME type of the inference returned from the model container.

pub fn get_content_type(&self) -> &Option<String>

The MIME type of the inference returned from the model container.

pub fn invoked_production_variant(self, input: impl Into<String>) -> Self

Identifies the production variant that was invoked.

pub fn set_invoked_production_variant(self, input: Option<String>) -> Self

Identifies the production variant that was invoked.

pub fn get_invoked_production_variant(&self) -> &Option<String>

Identifies the production variant that was invoked.

pub fn custom_attributes(self, input: impl Into<String>) -> Self

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.

pub fn set_custom_attributes(self, input: Option<String>) -> Self

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.

pub fn get_custom_attributes(&self) -> &Option<String>

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.

pub fn new_session_id(self, input: impl Into<String>) -> Self

If you created a stateful session with your request, the ID and expiration time that the model assigns to that session.

pub fn set_new_session_id(self, input: Option<String>) -> Self

If you created a stateful session with your request, the ID and expiration time that the model assigns to that session.

pub fn get_new_session_id(&self) -> &Option<String>

If you created a stateful session with your request, the ID and expiration time that the model assigns to that session.

pub fn closed_session_id(self, input: impl Into<String>) -> Self

If you closed a stateful session with your request, the ID of that session.

pub fn set_closed_session_id(self, input: Option<String>) -> Self

If you closed a stateful session with your request, the ID of that session.

pub fn get_closed_session_id(&self) -> &Option<String>

If you closed a stateful session with your request, the ID of that session.

pub fn build(self) -> InvokeEndpointOutput

Consumes the builder and constructs a InvokeEndpointOutput.

Trait Implementations

impl Clone for InvokeEndpointOutputBuilder

fn clone(&self) -> InvokeEndpointOutputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InvokeEndpointOutputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for InvokeEndpointOutputBuilder

fn default() -> InvokeEndpointOutputBuilder

Returns the “default value” for a type.

impl PartialEq for InvokeEndpointOutputBuilder

fn eq(&self, other: &InvokeEndpointOutputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for InvokeEndpointOutputBuilder