Struct aws_sdk_cloudsearch::types::AnalysisOptions

#[non_exhaustive]
pub struct AnalysisOptions {
    pub synonyms: Option<String>,
    pub stopwords: Option<String>,
    pub stemming_dictionary: Option<String>,
    pub japanese_tokenization_dictionary: Option<String>,
    pub algorithmic_stemming: Option<AlgorithmicStemming>,
}

Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

synonyms: Option<String>

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: Option<String>

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.

stemming_dictionary: Option<String>

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.

japanese_tokenization_dictionary: Option<String>

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.

algorithmic_stemming: Option<AlgorithmicStemming>

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

Implementations

impl AnalysisOptions

pub fn synonyms(&self) -> Option<&str>

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.

pub fn stopwords(&self) -> Option<&str>

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.

pub fn stemming_dictionary(&self) -> Option<&str>

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.

pub fn japanese_tokenization_dictionary(&self) -> Option<&str>

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.

pub fn algorithmic_stemming(&self) -> Option<&AlgorithmicStemming>

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

impl AnalysisOptions

pub fn builder() -> AnalysisOptionsBuilder

Creates a new builder-style object to manufacture AnalysisOptions.

Trait Implementations

impl Clone for AnalysisOptions

fn clone(&self) -> AnalysisOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AnalysisOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AnalysisOptions

fn eq(&self, other: &AnalysisOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AnalysisOptions