Export Synonyms

Required API Key: any key with the settings ACL

Method signature

$index->browseSynonyms()

index.browse_synonyms()

index.browse_synonyms(Hash opts = {
  # any requestOptions
})

index.browseSynonyms({
  // A `batch` callback function that's called
  // on every batch of synonyms with the
  // signature: (synonyms: Synonyms[]) => any
  batch: function
})

index.browseSynonyms({
  // A `batch` callback function that's called
  // on every batch of synonyms with the
  // signature: (synonyms: Synonyms[]) => any
  batch: function,
  // All the following parameters are optional
  // + any requestOptions
})

index.browse_synonyms()

index.browseSynonyms(
  query: SynonymQuery = .init(),
  requestOptions: RequestOptions? = nil,
  completion: Result<[SynonymSearchResponse]> -> Void
)

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

index.BrowseSynonyms()

index.browseSynonyms()

index.BrowseSynonyms()

AlgoliaSyncHelper(client).exportSynonyms(String indexName)

See code examples

We released a new version of the PHP API client in public beta. Read the beta documentation for more information.

We released a new version of the JavaScript API client in public beta. Read the beta documentation for more information.

We released a new version of the Java API client in public beta. Read the beta documentation for more information.

You’re currently reading the JavaScript API client v4 documentation. Check the migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You’re currently reading the Ruby API client v2 documentation. Check the migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

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.

You can import and export synonyms from the Algolia dashboard.

Examples

Read the Algolia CLI documentation for more information.

Copy

1
2
3
4
5
$iterator = $index->browseSynonyms();

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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

Parameter	Description
`indexName`	type: string only needed in go, scala, c# Index name.
`requestOptions`	type: key/value mapping default: No request options Optional A mapping of `requestOptions` to send along with the query.

Response

Returns a synonym iterator.

Did you find this page helpful?

Export Synonyms

About this method

Examples

Parameters

Response

On this page