Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty>

Enclosing interface:

CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

@Stability(Stable)
public static final class CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty>

A builder for CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty	build()	Builds the configured instance.
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder	contentTemplate(String contentTemplate)	Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getContentTemplate()
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder	featureHeaders(List<String> featureHeaders)	Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getFeatureHeaders()
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder	featuresAttribute(String featuresAttribute)	Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getFeaturesAttribute()
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder	featureTypes(List<String> featureTypes)	Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getFeatureTypes()
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder	labelAttribute(String labelAttribute)	Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getLabelAttribute()
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder	labelHeaders(List<String> labelHeaders)	Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getLabelHeaders()
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder	labelIndex(Number labelIndex)	Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getLabelIndex()
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder	maxPayloadInMb(Number maxPayloadInMb)	Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getMaxPayloadInMb()
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder	maxRecordCount(Number maxRecordCount)	Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getMaxRecordCount()
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder	probabilityAttribute(String probabilityAttribute)	Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getProbabilityAttribute()
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder	probabilityIndex(Number probabilityIndex)	Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getProbabilityIndex()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

contentTemplate

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder contentTemplate(String contentTemplate)

Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getContentTemplate()

Parameters:

contentTemplate - 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.

Returns:

this

featureHeaders

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder featureHeaders(List<String> featureHeaders)

Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getFeatureHeaders()

Parameters:

featureHeaders - 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.

Returns:

this

featuresAttribute

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder featuresAttribute(String featuresAttribute)

Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getFeaturesAttribute()

Parameters:

featuresAttribute - 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]}' .

Returns:

this

featureTypes

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder featureTypes(List<String> featureTypes)

Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getFeatureTypes()

Parameters:

featureTypes - 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.

Returns:

this

labelAttribute

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder labelAttribute(String labelAttribute)

Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getLabelAttribute()

Parameters:

labelAttribute - 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"]

Returns:

this

labelHeaders

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder labelHeaders(List<String> labelHeaders)

Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getLabelHeaders()

Parameters:

labelHeaders - 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.

Returns:

this

labelIndex

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder labelIndex(Number labelIndex)

Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getLabelIndex()

Parameters:

labelIndex - 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'] .

Returns:

this

maxPayloadInMb

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder maxPayloadInMb(Number maxPayloadInMb)

Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getMaxPayloadInMb()

Parameters:

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

Returns:

this

maxRecordCount

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder maxRecordCount(Number maxRecordCount)

Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getMaxRecordCount()

Parameters:

maxRecordCount - 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.

Returns:

this

probabilityAttribute

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder probabilityAttribute(String probabilityAttribute)

Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getProbabilityAttribute()

Parameters:

probabilityAttribute - 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' .

Returns:

this

probabilityIndex

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder probabilityIndex(Number probabilityIndex)

Sets the value of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.getProbabilityIndex()

Parameters:

probabilityIndex - 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] .

Returns:

this

build

@Stability(Stable)
public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty>

Returns:

a new instance of CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty

Throws:

NullPointerException - if any required attribute was not provided