Class: Aws::SageMakerRuntime::Types::InvokeEndpointOutput

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemakerruntime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:body, :custom_attributes]

Instance Attribute Summary collapse

Instance Attribute Details

#body ⇒ String

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.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/cdf-inference.html [2]: docs.aws.amazon.com/sagemaker/latest/dg/clarify-online-explainability-invoke-endpoint.html#clarify-online-explainability-response

Returns:

  • (String) 


366
367
368
369
370
371
372
373
374
375
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 366

class InvokeEndpointOutput < Struct.new(
  :body,
  :content_type,
  :invoked_production_variant,
  :custom_attributes,
  :new_session_id,
  :closed_session_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end

#closed_session_id ⇒ String

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

Returns:

  • (String) 


366
367
368
369
370
371
372
373
374
375
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 366

class InvokeEndpointOutput < Struct.new(
  :body,
  :content_type,
  :invoked_production_variant,
  :custom_attributes,
  :new_session_id,
  :closed_session_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end

#content_type ⇒ String

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

Returns:

  • (String) 


366
367
368
369
370
371
372
373
374
375
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 366

class InvokeEndpointOutput < Struct.new(
  :body,
  :content_type,
  :invoked_production_variant,
  :custom_attributes,
  :new_session_id,
  :closed_session_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end

#custom_attributes ⇒ 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][1

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.

[1]: tools.ietf.org/html/rfc7230#section-3.2.6

Returns:

  • (String) 


366
367
368
369
370
371
372
373
374
375
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 366

class InvokeEndpointOutput < Struct.new(
  :body,
  :content_type,
  :invoked_production_variant,
  :custom_attributes,
  :new_session_id,
  :closed_session_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end

#invoked_production_variant ⇒ String

Identifies the production variant that was invoked.

Returns:

  • (String) 


366
367
368
369
370
371
372
373
374
375
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 366

class InvokeEndpointOutput < Struct.new(
  :body,
  :content_type,
  :invoked_production_variant,
  :custom_attributes,
  :new_session_id,
  :closed_session_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end

#new_session_id ⇒ String

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

Returns:

  • (String) 


366
367
368
369
370
371
372
373
374
375
 
# File 'lib/aws-sdk-sagemakerruntime/types.rb', line 366

class InvokeEndpointOutput < Struct.new(
  :body,
  :content_type,
  :invoked_production_variant,
  :custom_attributes,
  :new_session_id,
  :closed_session_id)
  SENSITIVE = [:body, :custom_attributes]
  include Aws::Structure
end