You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudSearch::Types::AnalysisOptions

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb

Overview

Note:

When making an API call, you may pass AnalysisOptions data as a hash:

{
  synonyms: "String",
  stopwords: "String",
  stemming_dictionary: "String",
  japanese_tokenization_dictionary: "String",
  algorithmic_stemming: "none", # accepts none, minimal, light, full
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#algorithmic_stemmingString

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

Returns:

  • (String)


102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 102

class AnalysisOptions < Struct.new(
  :synonyms,
  :stopwords,
  :stemming_dictionary,
  :japanese_tokenization_dictionary,
  :algorithmic_stemming)
  include Aws::Structure
end

#japanese_tokenization_dictionaryString

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:

  • (String)


102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 102

class AnalysisOptions < Struct.new(
  :synonyms,
  :stopwords,
  :stemming_dictionary,
  :japanese_tokenization_dictionary,
  :algorithmic_stemming)
  include Aws::Structure
end

#stemming_dictionaryString

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:

  • (String)


102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 102

class AnalysisOptions < Struct.new(
  :synonyms,
  :stopwords,
  :stemming_dictionary,
  :japanese_tokenization_dictionary,
  :algorithmic_stemming)
  include Aws::Structure
end

#stopwordsString

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:

  • (String)


102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 102

class AnalysisOptions < Struct.new(
  :synonyms,
  :stopwords,
  :stemming_dictionary,
  :japanese_tokenization_dictionary,
  :algorithmic_stemming)
  include Aws::Structure
end

#synonymsString

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:

  • (String)


102
103
104
105
106
107
108
109
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 102

class AnalysisOptions < Struct.new(
  :synonyms,
  :stopwords,
  :stemming_dictionary,
  :japanese_tokenization_dictionary,
  :algorithmic_stemming)
  include Aws::Structure
end