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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public ClarifyTextConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ClarifyTextConfig.Builder,ClarifyTextConfig>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.