API Reference / API Methods / Synonyms / Save synonyms

Jan. 28, 2022

Save Synonyms

Required API Key: any key with the editSettings ACL

Method signature

$index->saveSynonyms(array synonyms)

$index->saveSynonyms(array synonyms), [
  // All the following parameters are optional
  'forwardToReplicas' => boolean,
  'replaceExistingSynonyms' => boolean
])

index.save_synonyms(
  Array synonyms,
  Hash opts = {
    Boolean forwardToReplicas: false,
    Boolean replaceExistingSynonyms: false
  }
)

index.saveSynonyms(array synonyms)

index.saveSynonyms(array synonyms, {
  // All the following parameters are optional
  forwardToReplicas: boolean,
  replaceExistingSynonyms: boolean
})

index.save_synonyms(list synonyms, {
    // All the following parameters are optional
    'forwardToReplicas': bool,
    'replaceExistingSynonyms': bool
})

index.saveSynonyms(
  _ synonyms: [Synonym],
  forwardToReplicas: Bool? = nil,
  replaceExistingSynonyms: Bool? = nil,
  requestOptions: RequestOptions? = nil,
  completion: Result<IndexRevision> -> Void
)

suspend fun Index.saveSynonyms(
    synonyms: List<Synonym>,
    forwardToReplicas: Boolean? = null,
    replaceExistingSynonyms: Boolean? = null,
    requestOptions: RequestOptions? = null
): RevisionIndex

index.SaveSynonyms(
  IEnumerable<Synonym> synonyms,

  // All the following parameters are optional
  forwardToReplicas: bool,
  replaceExistingSynonyms: bool
)

index.saveSyonyms(
  List<Synonym> synonyms,
  bool forwardToReplicas,
  bool replaceExistingSynonyms
)

index.SaveSynonyms([]Synonym synonyms)
index.SaveSynonyms([]Synonym synonyms, opt.ForwardToReplicas(bool forwardToReplicas))
index.SaveSynonyms([]Synonym synonyms, opt.ReplaceExistingSynonyms(bool replaceExistingSynonyms))

save.synonyms(List<Synonym> synonyms)
  .inIndex("index_name")
  .and(bool forwardToReplicas)
  .and(bool replaceExistingSynonyms)

See code examples

About this method # A

Create or update multiple synonyms.

This method enables you to create or update one or more synonyms in a single call.

You can also recreate your entire set of synonyms by using the replaceExistingSynonyms parameter.

Note that each synonym object counts as a single indexing operation.

Examples # A

Save synonyms#

Copy

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

$index->saveSynonyms(
  [
    [
      "objectID" => "a-unique-identifier",
      "type" => "synonym",
      "synonyms" => ["car", "vehicle", "auto"]
    ],
    [
      "objectID" => "another-unique-identifier",
      "type" => "synonym",
      "synonyms" => ["street", "st"]
    ]
  ], [
    'forwardToReplicas' => true,
    'replaceExistingSynonyms' => true
  ]
);

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: 'a-unique-identifier',
  type: 'synonym',
  synonyms: ['car', 'vehicle', 'auto']
}, {
  objectID: 'another-unique-identifier',
  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: 'a-unique-identifier',
  type: 'synonym',
  synonyms: ['car', 'vehicle', 'auto']
}, {
  objectID: 'another-unique-identifier',
  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': 'a-unique-identifier',
            'type': 'synonym',
            'synonyms': ['car', 'vehicle', 'auto']
        },
        {
            'objectID': 'another-unique-identifier',
            'type': 'synonym',
            'synonyms': ['street', 'st']
        }
    ],
    {
        'forwardToReplicas': True,
        'replaceExistingSynonyms': True
    }
)

1
2
3
4
5
6
7
8
9
10
let synonyms: [Synonym] = [
  .multiWay(objectID: "myID1", synonyms: ["car", "vehicle", "auto"]),
  .multiWay(objectID: "myID2", 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
12
13
14
15
16
17
18
19
20
List<Synonym> synonyms = new List<Synonym>
{
    new Synonym
    {
      ObjectID = "a-unique-identifier",
      Type = "synonym",
      Synonyms = new List<string> { "car", "vehicle", "auto" }
    },
    new Synonym
    {
      ObjectID = "another-unique-identifier",
      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("a-unique-identifier")
      .setSynonyms(Arrays.asList("car", "vehicle", "auto")),
    new Synonym()
      .setObjectID("another-unique-identifier")
      .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("a-unique-identifier", "car", "vehicle", "auto"),
	search.NewRegularSynonym("another-unique-identifier", "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(
      "a-unique-identifier",
      Seq("car", "vehicle", "auto")
    ),
    Synonym(
      "another-unique-identifier",
      Seq("street", "st")
    )
  ) inIndex "index_name" and forwardToReplicas and replaceExistingSynonyms
}

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)

Parameters # A


            synonyms

type: list

Required

Array of synonym.


            forwardToReplicas

type: boolean

default: false

optional

Sends synonyms to all replicas.

Without this parameter, or by setting it to false, the method will apply the change only to the specified index. If you want to forward your synonyms to replicas you will need to set this parameter to true.


            replaceExistingSynonyms

type: boolean

default: false

optional

Forces the engine to replace all synonyms, using an atomic save.

Normally, to replace all synonyms on an index, you would first clear the synonyms, using clearAllSynonyms, and then create a new list. However, between the clear and the add, your index will have no synonyms. This is where replaceExistingSynonyms comes into play.

By adding this parameter, you do not need to use clearAllSynonyms, it’s done for you. This parameter tells the engine to delete all existing synonyms before recreating a new list from the synonyms listed in the current call. This is the only way to avoid having no synonyms, ensuring that your index will always provide a full list of synonyms to your end users.

Response # A

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here. You can view the response in the logs (using the getLogs method).

JSON format#

Copy

          {
  "updatedAt":"2013-01-18T15:33:13.556Z",
  "taskID": 678
}

        

`updatedAt` #	string Date at which the indexing job has been created.
`taskID` #	integer The taskID used with the waitTask method.

Did you find this page helpful?

Save Synonyms

About this method # Found an issue? Edit this page A Edit this page

Examples # Found an issue? Edit this page A Edit this page

Save synonyms#

Parameters # Found an issue? Edit this page A Edit this page

Response # Found an issue? Edit this page A Edit this page

JSON format#

On this page

About this method # A

Examples # A

Parameters # A

Response # A