Class AnalysisOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AnalysisOptions.Builder,
AnalysisOptions>
Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AlgorithmicStemming
The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
.final String
The level of algorithmic stemming to perform:none
,minimal
,light
, orfull
.static AnalysisOptions.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton.static Class
<? extends AnalysisOptions.Builder> final String
A JSON object that contains a collection of string:value pairs that each map a term to its stem.final String
A JSON array of terms to ignore during indexing and searching.final String
synonyms()
A JSON object that defines synonym groups and aliases.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
synonyms
A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
- Returns:
- A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
-
stopwords
A JSON array of terms to ignore during indexing and searching. For example,
["a", "an", "the", "of"]
. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.- Returns:
- A JSON array of terms to ignore during indexing and searching. For example,
["a", "an", "the", "of"]
. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
-
stemmingDictionary
A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example,
{"term1": "stem1", "term2": "stem2", "term3": "stem3"}
. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.- Returns:
- A JSON object that contains a collection of string:value pairs that each map a term to its stem. For
example,
{"term1": "stem1", "term2": "stem2", "term3": "stem3"}
. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
-
japaneseTokenizationDictionary
A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
- Returns:
- A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
-
algorithmicStemming
The level of algorithmic stemming to perform:
none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer GuideIf the service returns an enum value that is not available in the current SDK version,
algorithmicStemming
will returnAlgorithmicStemming.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromalgorithmicStemmingAsString()
.- Returns:
- The level of algorithmic stemming to perform:
none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide - See Also:
-
algorithmicStemmingAsString
The level of algorithmic stemming to perform:
none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer GuideIf the service returns an enum value that is not available in the current SDK version,
algorithmicStemming
will returnAlgorithmicStemming.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromalgorithmicStemmingAsString()
.- Returns:
- The level of algorithmic stemming to perform:
none
,minimal
,light
, orfull
. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide - See Also:
-
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 interfaceToCopyableBuilder<AnalysisOptions.Builder,
AnalysisOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-