Save synonyms

1
2
3
4
5
6
7
8
9
10
# Batch synonyms, with replica forwarding and atomic replacement of existing synonyms
index.save_synonyms([{
  objectID: 'synonymID1',
  type: 'synonym',
  synonyms: ['car', 'vehicle', 'auto']
}, {
  objectID: 'synonymID2',
  type: 'synonym',
  synonyms: ['street', 'st']
}], { forwardToReplicas: true, replaceExistingSynonyms: true })

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Batch synonyms, with replica forwarding and atomic replacement of existing synonyms
const synonyms = [{
  objectID: 'synonymID1',
  type: 'synonym',
  synonyms: ['car', 'vehicle', 'auto']
}, {
  objectID: 'synonymID2',
  type: 'synonym',
  synonyms: ['street', 'st']
}];

index.saveSynonyms(synonyms, {
  forwardToReplicas: true,
  replaceExistingSynonyms: true
}).then(() => {
  // done
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Batch synonyms, with replica forwarding and atomic replacement of existing synonyms
index.save_synonyms(
    [
        {
            'objectID': 'synonymID1',
            'type': 'synonym',
            'synonyms': ['car', 'vehicle', 'auto']
        },
        {
            'objectID': 'synonymID2',
            'type': 'synonym',
            'synonyms': ['street', 'st']
        }
    ],
    {
        'forwardToReplicas': True,
        'replaceExistingSynonyms': True
    }
)

1
2
3
4
5
6
7
8
9
10
let synonyms: [Synonym] = [
  .multiWay(objectID: "synonymID1", synonyms: ["car", "vehicle", "auto"]),
  .multiWay(objectID: "synonymID2", synonyms: ["street", "st"])
]

index.saveSynonyms(synonyms, forwardToReplicas: true, replaceExistingSynonyms: false) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
10
11
val synonyms = listOf(
    Synonym.MultiWay(
        objectID = ObjectID("myID1"),
        synonyms = listOf("car", "vehicle", "auto")
    ),
    Synonym.MultiWay(
        objectID = ObjectID("myID2"),
        synonyms = listOf("street", "st")
    )
)
index.saveSynonyms(synonyms, forwardToReplicas = true, clearExistingSynonyms = true)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
List<Synonym> synonyms = new List<Synonym>
{
    new Synonym
    {
      ObjectID = "synonymID1",
      Type = "synonym",
      Synonyms = new List<string> { "car", "vehicle", "auto" }
    },
    new Synonym
    {
      ObjectID = "synonymID2",
      Type = "synonym",
      Synonyms = new List<string> { "street", "st" }
    }
};

index.SaveSynonyms(synonyms, forwardToreplicas: true, replaceExistingSynonyms: true);

// Asynchronous
await index.SaveSynonymsAsync(synonyms, forwardToreplicas: true, replaceExistingSynonyms: true);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Batch synonyms, with replica forwarding
// and atomic replacement of existing synonyms

boolean forwardToReplicas = true;
boolean replaceExistingSynonyms = true;

List<Synonym> synonyms = Arrays.asList(
    new Synonym()
      .setObjectID("synonymID1")
      .setSynonyms(Arrays.asList("car", "vehicle", "auto")),
    new Synonym()
      .setObjectID("synonymID2")
      .setSynonyms(Arrays.asList("street", "st")));

index.saveSynonyms(synonyms, forwardToReplicas, replaceExistingSynonyms);

// Asynchronous
index.saveSynonymsAsync(synonyms, forwardToReplicas, replaceExistingSynonyms);

1
2
3
4
5
6
7
8
9
10
11
opts := []interface{}{
	opt.ForwardToReplicas(true),
	opt.ReplaceExistingSynonyms(true),
}

synonyms := []search.Synonym{
	search.NewRegularSynonym("synonymID1", "car", "vehicle", "auto"),
	search.NewRegularSynonym("synonymID2", "street", "st"),
}

res, err := index.SaveSynonyms(synonyms, opts...)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Batch synonyms, with replica forwarding
// and atomic replacement of existing synonyms
client.execute {
  save synonyms Seq(
    Synonym(
      "synonymID1",
      Seq("car", "vehicle", "auto")
    ),
    Synonym(
      "synonymID2",
      Seq("street", "st")
    )
  ) inIndex "index_name" and forwardToReplicas and replaceExistingSynonyms
}

1
2
3
4
5
6
7
# Add synonyms to "indexName" from a newline delimited JSON file (see https://github.com/ndjson/ndjson-spec)
algolia synonym import indexName --file synonyms.ndjson

# Add synonyms to "indexName" from the command line
echo ' { "objectID": "synonymID1", "type": "synonym", "synonyms": [ "iphone", "apple phone"] }\n \
{ "objectID": "synonymID2", "type": "synonym", "synonyms": [ "street", "st"] }\n' | \
algolia synonym import indexName --file -

1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl -X POST \
    -H "X-Algolia-API-Key: ${API_KEY}" \
    -H "X-Algolia-Application-Id: ${APPLICATION_ID}" \
    --data-binary '[{
      "objectID": "synonymID1",
      "type": "synonym",
      "synonyms": ["iphone", "ephone", "aphone", "yphone", "apple phone"]
    },{
      "objectID": "synonymID2",
      "type": "onewaysynonym",
      "input": "iphone",
      "synonyms": ["ephone", "aphone", "yphone", "apple phone"]
  }] ' \
  "https://${APPLICATION_ID}.algolia.net/1/indexes/{indexName}/synonyms/batch"