Api clients / Ruby / V1 / Methods

Copy Synonyms | Ruby API Client V1 (Deprecated)

This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.

Required API Key: any key with the synonyms ACL
Method signature
client.copy_synonyms(String indexNameSrc, String indexNameDest)

About this method# A

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# A

Copy synonyms#

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

Parameters# A

indexNameSrc #
type: string
Required

Name of the source index to copy.

indexNameDest #
type: string
Required

Name of the destination index.

Response# A

No response.

Did you find this page helpful?