Struct InvokeEndpointWithResponseStreamOutput

#[non_exhaustive]
pub struct InvokeEndpointWithResponseStreamOutput {
    pub body: EventReceiver<ResponseStream, ResponseStreamError>,
    pub content_type: Option<String>,
    pub invoked_production_variant: Option<String>,
    pub custom_attributes: Option<String>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

body: EventReceiver<ResponseStream, ResponseStreamError>

A stream of payload parts. Each part contains a portion of the response for a streaming inference request.

content_type: Option<String>

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

invoked_production_variant: Option<String>

Identifies the production variant that was invoked.

custom_attributes: 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.

Implementations

impl InvokeEndpointWithResponseStreamOutput

pub fn body(&self) -> &EventReceiver<ResponseStream, ResponseStreamError>

A stream of payload parts. Each part contains a portion of the response for a streaming inference request.

pub fn content_type(&self) -> Option<&str>

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

pub fn invoked_production_variant(&self) -> Option<&str>

Identifies the production variant that was invoked.

pub fn custom_attributes(&self) -> Option<&str>

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.

impl InvokeEndpointWithResponseStreamOutput

pub fn builder() -> InvokeEndpointWithResponseStreamOutputBuilder

Creates a new builder-style object to manufacture InvokeEndpointWithResponseStreamOutput.

Trait Implementations

impl Debug for InvokeEndpointWithResponseStreamOutput

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

Formats the value using the given formatter.

impl RequestId for InvokeEndpointWithResponseStreamOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.