Export Synonyms | JavaScript API Client V3 (Deprecated)

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

Required API Key: any key with the settings ACL

Method signature

index.exportSynonyms()

See code examples

About this method

Retrieve an index’s complete list of synonyms.

The list includes all synonyms - whether created on the dashboard or pushed by the API.

The method returns an iterator.

Examples

Copy

Copy
$iterator = $index->browseSynonyms();

foreach ($iterator as $synonym) {
    var_dump($synonym);
}

Copy
// Only on Sync
Index<Contact> index = client.initIndex("myIndex", Contact.class);
List<Synonym> synonyms = new ArrayList<>();

SynonymsIterable synonymsIterable = index.browseSynonyms();
synonymsIterable.forEach(synonyms::add);

Copy
it, err := index.BrowseSynonyms()
// error handling

for {
  synonym, err := it.Next()
  if err != nil {
    if err == io.EOF {
      // all synonyms have been browsed
    } else {
      // error handling
    }
    break
  }
  fmt.Println(synonym)
}

Parameters


            indexName

type: string

only needed in go, scala, c#

Index name.

Response

Returns a synonym iterator.

Did you find this page helpful?

Export Synonyms | JavaScript API Client V3 (Deprecated)

About this method

Examples

Parameters

Response

On this page