77 lines
3.9 KiB
Plaintext
77 lines
3.9 KiB
Plaintext
[[reference-synonyms-get_synonym]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.getSynonym]]
|
|
=== client.synonyms.getSynonym
|
|
|
|
Retrieves a synonym set
|
|
|
|
{ref}/get-synonyms-set.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(SynonymsGetSynonymRequest, options?): Promise<SynonymsGetSynonymResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== Request
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface SynonymsGetSynonymRequest extends <<RequestBase>> {
|
|
id: <<Id>>
|
|
from?: <<integer>>
|
|
size?: <<integer>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== Response
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface SynonymsGetSynonymResponse {
|
|
count: <<integer>>
|
|
synonyms_set: <<SynonymsSynonymRuleRead>>[]
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|