Files
elasticsearch-js/docs/reference-synonyms-put_synonym_rule.asciidoc
2024-12-05 14:46:51 -06:00

73 lines
3.9 KiB
Plaintext

[[reference-synonyms-put_synonym_rule]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.synonyms.putSynonymRule
Creates or updates a synonym rule in a synonym set
{ref}/put-synonym-rule.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SynonymsPutSynonymRuleRequest, options?): Promise<SynonymsPutSynonymRuleResponse>
----
[discrete]
==== SynonymsPutSynonymRuleRequest
[pass]
++++
<pre>
++++
interface SynonymsPutSynonymRuleRequest extends <<RequestBase>> {
set_id: <<Id>>
rule_id: <<Id>>
synonyms: SynonymsSynonymString
}
[pass]
++++
</pre>
++++
[discrete]
==== SynonymsPutSynonymRuleResponse
[pass]
++++
<pre>
++++
type SynonymsPutSynonymRuleResponse = SynonymsSynonymsUpdateResult
[pass]
++++
</pre>
++++