Export synonyms

Retrieve an index’s complete list of synonyms.

Required ACL: settings

Examples

C#

var synonymsIterator = client.BrowseSynonyms();

foreach (var synonym in synonymsIterator)
{
    Console.WriteLine(synonym);
}

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)
}

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

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

index
  .browseSynonyms({
    batch: (batch) => console.log(batch),
  })
  .then(() => {
    // done
  });

index.browseSynonyms().forEach {
    println(it)
}

$iterator = $index->browseSynonyms();

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

# Print all synonyms in an index.
for synonym in index.browse_synonyms():
    print(synonym)

# Get synonyms by batch
synonyms = index.browse_synonyms
# With a block
index.browse_synonyms { |synonym| puts(synonym) }

val helper = AlgoliaSyncHelper(client)
helper.exportSynonyms("myIndex").map(println)

index.browseSynonyms { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Parameters

indexName · string

Scala only: index name

requestOptions · object

A mapping of request options to send along with the query.

Response

This method returns an iterator.