Package software.amazon.awssdk.services.sagemaker.model

Class ClarifyTextConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ClarifyTextConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClarifyTextConfig.Builder,ClarifyTextConfig>

@Generated("software.amazon.awssdk:codegen")
public final class ClarifyTextConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClarifyTextConfig.Builder,ClarifyTextConfig>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClarifyTextConfig.Builder

Method Summary

Modifier and Type	Method	Description
static ClarifyTextConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
ClarifyTextGranularity	granularity()	The unit of granularity for the analysis of text features.
String	granularityAsString()	The unit of granularity for the analysis of text features.
int	hashCode()
ClarifyTextLanguage	language()	Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.
String	languageAsString()	Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ClarifyTextConfig.Builder>	serializableBuilderClass()
ClarifyTextConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

language

public final ClarifyTextLanguage language()

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

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

If the service returns an enum value that is not available in the current SDK version, language will return ClarifyTextLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageAsString().

Returns:

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

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

See Also:

ClarifyTextLanguage

languageAsString

public final String languageAsString()

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

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

If the service returns an enum value that is not available in the current SDK version, language will return ClarifyTextLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageAsString().

Returns:

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

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

See Also:

ClarifyTextLanguage

granularity

public final ClarifyTextGranularity granularity()

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.

If the service returns an enum value that is not available in the current SDK version, granularity will return ClarifyTextGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

Returns:

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:

ClarifyTextGranularity

granularityAsString

public final String granularityAsString()

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.

If the service returns an enum value that is not available in the current SDK version, granularity will return ClarifyTextGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from granularityAsString().

Returns:

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:

ClarifyTextGranularity

toBuilder

public ClarifyTextConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClarifyTextConfig.Builder,ClarifyTextConfig>

builder

public static ClarifyTextConfig.Builder builder()

serializableBuilderClass

public static Class<? extends ClarifyTextConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo