feature: Allow users to send custom attributes to the model endpoint (#2198)

Author: keerthanvasist

src/sagemaker/clarify.py

@@ -122,6 +122,7 @@ def __init__(
         accept_type=None,
         content_type=None,
         content_template=None,
+        custom_attributes=None,
     ):
         """Initializes a configuration of a model and the endpoint to be created for it.
 
@@ -141,6 +142,15 @@ def __init__(
                 "application/jsonlines". The template should have one and only one placeholder
                 $features which will be replaced by a features list for to form the model inference
                 input.
+            custom_attributes (str): 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 (
+                https://tools.ietf.org/html/rfc7230#section-3.2.6) of the Hypertext Transfer
+                Protocol (HTTP/1.1).
         """
         self.predictor_config = {
             "model_name": model_name,
@@ -169,6 +179,9 @@ def __init__(
                 )
             self.predictor_config["content_template"] = content_template
 
+        if custom_attributes is not None:
+            self.predictor_config["custom_attributes"] = custom_attributes
+
     def get_predictor_config(self):
         """Returns part of the predictor dictionary of the analysis config."""
         return copy.deepcopy(self.predictor_config)

tests/unit/test_clarify.py

@@ -91,19 +91,22 @@ def test_model_config():
     instance_count = 1
     accept_type = "text/csv"
     content_type = "application/jsonlines"
+    custom_attributes = "c000b4f9-df62-4c85-a0bf-7c525f9104a4"
     model_config = ModelConfig(
         model_name=model_name,
         instance_type=instance_type,
         instance_count=instance_count,
         accept_type=accept_type,
         content_type=content_type,
+        custom_attributes=custom_attributes,
     )
     expected_config = {
         "model_name": model_name,
         "instance_type": instance_type,
         "initial_instance_count": instance_count,
         "accept_type": accept_type,
         "content_type": content_type,
+        "custom_attributes": custom_attributes,
     }
     assert expected_config == model_config.get_predictor_config()