Package software.amazon.awscdk.mixins.preview.services.sagemaker.mixins

Class CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.mixins.preview.services.sagemaker.mixins.CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Jsii$Proxy

All Implemented Interfaces:

CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

@Stability(Stable)
@Internal
public static final class CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

An implementation for CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.mixins.preview.services.sagemaker.mixins.CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder, CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getContentTemplate()	A template string used to format a JSON record into an acceptable model container input.
final List<String>	getFeatureHeaders()	The names of the features.
final String	getFeaturesAttribute()	Provides the JMESPath expression to extract the features from a model container input in JSON Lines format.
final List<String>	getFeatureTypes()	A list of data types of the features (optional).
final String	getLabelAttribute()	A JMESPath expression used to locate the list of label headers in the model container output.
final List<String>	getLabelHeaders()	For multiclass classification problems, the label headers are the names of the classes.
final Number	getLabelIndex()	A zero-based index used to extract a label header or list of label headers from model container output in CSV format.
final Number	getMaxPayloadInMb()	The maximum payload size (MB) allowed of a request from the explainer to the model container.
final Number	getMaxRecordCount()	The maximum number of records in a request that the model container can process when querying the model container for the predictions of a synthetic dataset .
final String	getProbabilityAttribute()	A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.
final Number	getProbabilityIndex()	A zero-based index used to extract a probability value (score) or list from model container output in CSV format.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder.

Method Details

getContentTemplate

public final String getContentTemplate()

Description copied from interface: CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

A template string used to format a JSON record into an acceptable model container input.

For example, a ContentTemplate string '{"myfeatures":$features}' will format a list of features [1,2,3] into the record string '{"myfeatures":[1,2,3]}' . Required only when the model container input is in JSON Lines format.

Specified by:

getContentTemplate in interface CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-contenttemplate

getFeatureHeaders

public final List<String> getFeatureHeaders()

Description copied from interface: CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

The names of the features.

If provided, these are included in the endpoint response payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint in the Developer Guide for more information.

Specified by:

getFeatureHeaders in interface CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-featureheaders

getFeaturesAttribute

public final String getFeaturesAttribute()

Description copied from interface: CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

Provides the JMESPath expression to extract the features from a model container input in JSON Lines format.

For example, if FeaturesAttribute is the JMESPath expression 'myfeatures' , it extracts a list of features [1,2,3] from request data '{"myfeatures":[1,2,3]}' .

Specified by:

getFeaturesAttribute in interface CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-featuresattribute

getFeatureTypes

public final List<String> getFeatureTypes()

Description copied from interface: CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

A list of data types of the features (optional).

Applicable only to NLP explainability. If provided, FeatureTypes must have at least one 'text' string (for example, ['text'] ). If FeatureTypes is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the response section under Invoke the endpoint in the Developer Guide for more information.

Specified by:

getFeatureTypes in interface CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-featuretypes

getLabelAttribute

public final String getLabelAttribute()

Description copied from interface: CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

A JMESPath expression used to locate the list of label headers in the model container output.

Example : If the model container output of a batch request is '{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}' , then set LabelAttribute to 'labels' to extract the list of label headers ["cat","dog","fish"]

Specified by:

getLabelAttribute in interface CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-labelattribute

getLabelHeaders

public final List<String> getLabelHeaders()

Description copied from interface: CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

For multiclass classification problems, the label headers are the names of the classes.

Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the InvokeEndpoint API. See the response section under Invoke the endpoint in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.

Specified by:

getLabelHeaders in interface CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-labelheaders

getLabelIndex

public final Number getLabelIndex()

Description copied from interface: CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

A zero-based index used to extract a label header or list of label headers from model container output in CSV format.

Example for a multiclass model: If the model container output consists of label headers followed by probabilities: '"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"' , set LabelIndex to 0 to select the label headers ['cat','dog','fish'] .

Specified by:

getLabelIndex in interface CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-labelindex

getMaxPayloadInMb

public final Number getMaxPayloadInMb()

Description copied from interface: CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

The maximum payload size (MB) allowed of a request from the explainer to the model container.

Defaults to 6 MB.

Specified by:

getMaxPayloadInMb in interface CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-maxpayloadinmb

getMaxRecordCount

public final Number getMaxRecordCount()

Description copied from interface: CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

The maximum number of records in a request that the model container can process when querying the model container for the predictions of a synthetic dataset . A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If MaxRecordCount is 1 , the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container's capacity at runtime.

Specified by:

getMaxRecordCount in interface CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-maxrecordcount

getProbabilityAttribute

public final String getProbabilityAttribute()

Description copied from interface: CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.

Example : If the model container output of a single request is '{"predicted_label":1,"probability":0.6}' , then set ProbabilityAttribute to 'probability' .

Specified by:

getProbabilityAttribute in interface CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-probabilityattribute

getProbabilityIndex

public final Number getProbabilityIndex()

Description copied from interface: CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

A zero-based index used to extract a probability value (score) or list from model container output in CSV format.

If this value is not provided, the entire model container output will be treated as a probability value (score) or list.

Example for a single class model: If the model container output consists of a string-formatted prediction label followed by its probability: '1,0.6' , set ProbabilityIndex to 1 to select the probability value 0.6 .

Example for a multiclass model: If the model container output consists of a string-formatted prediction label followed by its probability: '"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"' , set ProbabilityIndex to 1 to select the probability values [0.1,0.6,0.3] .

Specified by:

getProbabilityIndex in interface CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifyinferenceconfig.html#cfn-sagemaker-endpointconfig-clarifyinferenceconfig-probabilityindex

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object