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

75 lines
3.9 KiB
Plaintext

[[reference-synonyms-get_synonyms_sets]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.getSynonymsSets
Retrieves a summary of all defined synonym sets
{ref}/list-synonyms-sets.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SynonymsGetSynonymsSetsRequest, options?): Promise<SynonymsGetSynonymsSetsResponse>
----
[discrete]
==== SynonymsGetSynonymsSetsRequest
[pass]
++++
<pre>
++++
interface SynonymsGetSynonymsSetsRequest extends <<RequestBase>> {
from?: number
size?: number
}
[pass]
++++
</pre>
++++
[discrete]
==== SynonymsGetSynonymsSetsResponse
[pass]
++++
<pre>
++++
interface SynonymsGetSynonymsSetsResponse {
count: number
results: SynonymsGetSynonymsSetsSynonymsSetItem[]
}
[pass]
++++
</pre>
++++