update_stemming_options ( $domain_name, $stems, $opt )

Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500KB.

Access

public

Parameters

Parameter

Type

Required

Description

$domain_name

string

Required

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. [Constraints: The value must be between 3 and 28 characters, and must match the following regular expression pattern: [a-z][a-z0-9-]+]

$stems

string

Required

Maps terms to their stems, serialized as a JSON document. The document has a single object with one property “stems” whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500KB. Example: { "stems": {"people": "person", "walking": "walk"} }

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Update and describe the stemming options.

// Instantiate the class
$search = new AmazonCloudSearch();

$domain_name = 'my-domain';
$stemming_options = '{"stems": {"people": "person", "walking": "walk"}}';

/*%**************************************************************%*/
// Create a new CloudSearch domain

echo '# Creating a new CloudSearch domain' . PHP_EOL;
$response = $search->create_domain($domain_name);

// Check for success...
if ($response->isOK())
{
	echo 'Kicked off the creation of the CloudSearch domain...' . PHP_EOL;
}
else
{
	print_r($response);
}

echo PHP_EOL;

/*%**************************************************************%*/
// Update stemming options

sleep(1);

echo "# Update the stemming options, \"${domain_name}\"" . PHP_EOL;
$response = $search->update_stemming_options($domain_name, $stemming_options);

// Check for success...
if ($response->isOK())
{
	echo 'Updated the stemming options...' . PHP_EOL;
}
else
{
	print_r($response);
}

echo PHP_EOL;

/*%**************************************************************%*/
// Describe stemming options

echo "# Describing the stemming options, \"${domain_name}\"" . PHP_EOL;
$response = $search->describe_stemming_options($domain_name);

print_r($response->body->Options()->map_string());

echo PHP_EOL;

/*%**************************************************************%*/
// Delete the CloudSearch domain

echo '# Deleting the CloudSearch domain...' . PHP_EOL;
$response = $search->delete_domain($domain_name);

// Check for success...
if ($response->isOK())
{
	echo 'CloudSearch domain was deleted successfully.' . PHP_EOL;
}
else
{
	print_r($response);
}

Source

Method defined in services/cloudsearch.class.php | Toggle source view (8 lines) | View on GitHub

public function update_stemming_options($domain_name, $stems, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['DomainName'] = $domain_name;
    $opt['Stems'] = $stems;
    
    return $this->authenticate('UpdateStemmingOptions', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback