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>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.contentTemplate(String contentTemplate) featureHeaders(List<String> featureHeaders) featuresAttribute(String featuresAttribute) featureTypes(List<String> featureTypes) labelAttribute(String labelAttribute) labelHeaders(List<String> labelHeaders) labelIndex(Number labelIndex) maxPayloadInMb(Number maxPayloadInMb) maxRecordCount(Number maxRecordCount) probabilityAttribute(String probabilityAttribute) probabilityIndex(Number probabilityIndex)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
contentTemplate
@Stability(Stable) public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder contentTemplate(String contentTemplate) - Parameters:
contentTemplate- A template string used to format a JSON record into an acceptable model container input. For example, aContentTemplatestring'{"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) - Parameters:
featureHeaders- The names of the features. If provided, these are included in the endpoint response payload to help readability of theInvokeEndpointoutput. 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) - Parameters:
featuresAttribute- Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, ifFeaturesAttributeis 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) - Parameters:
featureTypes- A list of data types of the features (optional). Applicable only to NLP explainability. If provided,FeatureTypesmust have at least one'text'string (for example,['text']). IfFeatureTypesis 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) - 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 setLabelAttributeto'labels'to extract the list of label headers["cat","dog","fish"]- Returns:
this
-
labelHeaders
@Stability(Stable) public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder labelHeaders(List<String> labelHeaders) - 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 theInvokeEndpointAPI. 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) - 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]"', setLabelIndexto0to select the label headers['cat','dog','fish'].- Returns:
this
-
maxPayloadInMb
@Stability(Stable) public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder maxPayloadInMb(Number maxPayloadInMb) - Parameters:
maxPayloadInMb- The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to6MB.- Returns:
this
-
maxRecordCount
@Stability(Stable) public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder maxRecordCount(Number maxRecordCount) - 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. IfMaxRecordCountis1, 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 ofCfnEndpointConfigPropsMixin.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 setProbabilityAttributeto'probability'.- Returns:
this
-
probabilityIndex
@Stability(Stable) public CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty.Builder probabilityIndex(Number probabilityIndex) - 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', setProbabilityIndexto1to select the probability value0.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]"', setProbabilityIndexto1to select the probability values[0.1,0.6,0.3].- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty>- Returns:
- a new instance of
CfnEndpointConfigPropsMixin.ClarifyInferenceConfigProperty - Throws:
NullPointerException- if any required attribute was not provided
-