Package software.amazon.awscdk.services.sagemaker

Interface CfnEndpointConfig.ClarifyTextConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointConfig.ClarifyTextConfigProperty.Jsii$Proxy

Enclosing class:

CfnEndpointConfig

@Stability(Stable)
public static interface CfnEndpointConfig.ClarifyTextConfigProperty
extends software.amazon.jsii.JsiiSerializable

A parameter used to configure the SageMaker Clarify explainer to treat text features as text so that explanations are provided for individual units of text.

Required only for natural language processing (NLP) explainability.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 ClarifyTextConfigProperty clarifyTextConfigProperty = ClarifyTextConfigProperty.builder()
         .granularity("granularity")
         .language("language")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-endpointconfig-clarifytextconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEndpointConfig.ClarifyTextConfigProperty.Builder	A builder for CfnEndpointConfig.ClarifyTextConfigProperty
static final class	CfnEndpointConfig.ClarifyTextConfigProperty.Jsii$Proxy	An implementation for CfnEndpointConfig.ClarifyTextConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnEndpointConfig.ClarifyTextConfigProperty.Builder	builder()
String	getGranularity()	The unit of granularity for the analysis of text features.
String	getLanguage()	Specifies the language of the text features in [ISO 639-1](https://docs.aws.amazon.com/ https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or ISO 639-3 code of a supported language.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGranularity

@Stability(Stable)
@NotNull
String getGranularity()

The unit of granularity for the analysis of text features.

For example, if the unit is 'token' , then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.

See Also:

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

getLanguage

@Stability(Stable)
@NotNull
String getLanguage()

Specifies the language of the text features in [ISO 639-1](https://docs.aws.amazon.com/ https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or ISO 639-3 code of a supported language.

For a mix of multiple languages, use code 'xx' .

See Also:

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

builder

@Stability(Stable)
static CfnEndpointConfig.ClarifyTextConfigProperty.Builder builder()

Returns:

a CfnEndpointConfig.ClarifyTextConfigProperty.Builder of CfnEndpointConfig.ClarifyTextConfigProperty