84 lines
4.3 KiB
Plaintext
84 lines
4.3 KiB
Plaintext
[[reference-indices-analyze]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| 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.indices.analyze]]
|
|
=== client.indices.analyze
|
|
|
|
Get tokens from text analysis. The analyze API performs [analysis](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis.html) on a text string and returns the resulting tokens.
|
|
|
|
{ref}/indices-analyze.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(IndicesAnalyzeRequest, options?): Promise<IndicesAnalyzeResponse>
|
|
----
|
|
|
|
[discrete]
|
|
==== Request
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface IndicesAnalyzeRequest extends <<RequestBase>> {
|
|
index?: <<IndexName>>
|
|
analyzer?: string
|
|
attributes?: string[]
|
|
char_filter?: <<AnalysisCharFilter>>[]
|
|
explain?: boolean
|
|
field?: <<Field>>
|
|
filter?: <<AnalysisTokenFilter>>[]
|
|
normalizer?: string
|
|
text?: IndicesAnalyzeTextToAnalyze
|
|
tokenizer?: <<AnalysisTokenizer>>
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|
|
[discrete]
|
|
==== Response
|
|
|
|
[pass]
|
|
++++
|
|
<pre>
|
|
++++
|
|
interface IndicesAnalyzeResponse {
|
|
detail?: IndicesAnalyzeAnalyzeDetail
|
|
tokens?: IndicesAnalyzeAnalyzeToken[]
|
|
}
|
|
|
|
[pass]
|
|
++++
|
|
</pre>
|
|
++++
|