algolia synonyms save

Add a synonym to an index.

Usage

algolia synonyms save <index> --id <id> --synonyms <synonyms> [flags]

Examples

Save one standard synonym with ID “1” and “foo” and “bar” synonyms to the “MOVIES” index:

algolia synonyms save MOVIES --id 1 --synonyms foo,bar

Flags

-c, --corrections

A list of corrections of the word (alt correction synonyms only)

-f, --forward-to-replicas

Whether to add the synoynm to replicas

-i, --id

Synonym ID to save

-n, --input

Word of phrases to appear in query strings (one-way synonyms only)

-l, --placeholder

Placeholder token to represent a synonym within records

-r, --replacements

Query words that will match the placeholder synonym token

-s, --synonyms

Synonyms to save

-t, --type

Synonym type to save (default to regular)

--wait

Wait for the operation to complete

-w, --word

A single word, used as the basis for the array of corrections (alt-correction synonyms only)

Output formatting flags

--allow-missing-template-keys

If true, ignore errors in templates due to missing fields or map keys. This only applies to golang and jsonpath output formats.

-o, --output

Output format. One of: (json, jsonl, ndjson, jsonpath, jsonpath-as-json, jsonpath-file).

--template

Template string or path to a template file to use when —output=jsonpath, —output=jsonpath-file.