ClarifyTextConfig (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class ClarifyTextConfig

java.lang.Object
- com.amazonaws.services.sagemaker.model.ClarifyTextConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ClarifyTextConfig
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ClarifyTextConfig ()

Constructors
Constructor and Description
`ClarifyTextConfig ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`ClarifyTextConfig`	`clone ()`
`boolean`	`equals (Object obj)`
`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 or ISO 639-3 code of a supported language.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setGranularity (String granularity)` The unit of granularity for the analysis of text features.
`void`	`setLanguage (String language)` Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.
`String`	`toString ()` Returns a string representation of this object.
`ClarifyTextConfig`	`withGranularity (ClarifyTextGranularity granularity)` The unit of granularity for the analysis of text features.
`ClarifyTextConfig`	`withGranularity (String granularity)` The unit of granularity for the analysis of text features.
`ClarifyTextConfig`	`withLanguage (ClarifyTextLanguage language)` Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.
`ClarifyTextConfig`	`withLanguage (String language)` Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ClarifyTextConfig
```
public ClarifyTextConfig()
```
- Method Detail
  - setLanguage
```
public void setLanguage(String 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'.
    
    Parameters:
    
    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'.
    
    See Also:
    
    ClarifyTextLanguage
  - getLanguage
```
public String getLanguage()
```
    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'.
    
    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
  - withLanguage
```
public ClarifyTextConfig withLanguage(String 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'.
    
    Parameters:
    
    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'.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClarifyTextLanguage
  - withLanguage
```
public ClarifyTextConfig withLanguage(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'.
    
    Parameters:
    
    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'.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClarifyTextLanguage
  - setGranularity
```
public void setGranularity(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ClarifyTextGranularity
  - getGranularity
```
public 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.
    
    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
  - withGranularity
```
public ClarifyTextConfig withGranularity(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClarifyTextGranularity
  - withGranularity
```
public ClarifyTextConfig withGranularity(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClarifyTextGranularity
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ClarifyTextConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class ClarifyTextConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClarifyTextConfig

Method Detail

setLanguage

getLanguage

withLanguage

withLanguage

setGranularity

getGranularity

withGranularity

withGranularity

toString

equals

hashCode

clone

marshall