Api clients / Ruby / V1 / Methods

Copy Synonyms | Ruby API Client V1 (Deprecated)

Deprecated content
This documentation is for a deprecated version of Ruby API client . Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of Ruby API client for up-to-date information.
Required API Key: any key with the synonyms ACL
Method signature
client.copy_synonyms(String indexNameSrc, String indexNameDest)

About this method

Copy the synonyms of an index to another index on the same app.

Note that this removes all synonyms currently present in the destination index, and replaces them with the synonyms from the source.

Examples

Copy synonyms

1
$client->copySynonyms('indexNameSrc', 'indexNameDest');

Parameters

indexNameSrc
type: string
Required

Name of the source index to copy.

indexNameDest
type: string
Required

Name of the destination index.

Response

No response.

Did you find this page helpful?