API Reference / API Methods / Synonyms / Export Synonyms

Feb. 26, 2019

Export Synonyms

Required API Key: any key with the settings ACL

Method signature

$index->browseSynonyms()

index.export_synonyms

index.exportSynonyms()

index.browse_synonyms()

This method is not available in mobile API clients.

Synonyms need to be configured via
the Algolia Dashboard or with one of our backend API clients.

suspend fun Index.browseSynonyms(
    query: SynonymQuery = SynonymQuery(),
    requestOptions: RequestOptions? = null
): List<ResponseSearchSynonyms>

This method is not available in mobile API clients.

Synonyms need to be configured via
the Algolia Dashboard or with one of our backend API clients.

index.BrowseSynonyms()

index.browseSynonyms()

index.BrowseSynonyms()

AlgoliaSyncHelper(client).exportSynonyms(String indexName)

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

$iterator = $index->browseSynonyms();

foreach ($iterator as $synonym) {
    var_dump($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);

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.

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

iOS

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

iOS InstantSearch

Android InstantSearch

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Magento 1

Magento 2

WordPress

Shopify

Export Synonyms

About this method

Examples

Parameters

Response

Did you find this page helpful?

On this page