Skip to content

Correct and extend documentation on indices.analyze API #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Correct and extend documentation on indices.analyze API #135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@ module Actions
#
# @example Analyze text "Quick Brown Jumping Fox" with a custom tokenizer and filter chain
#
# client.indices.analyze text: 'The Quick Brown Jumping Fox',
# client.indices.analyze body: 'The Quick Brown Jumping Fox',
# tokenizer: 'whitespace',
# filters: ['lowercase','stop']
#
# @note If your text for analysis is longer than 4096 bytes then you should use the :body argument, rather than :text, to avoid HTTP transport errors
#
# @option arguments [String] :index The name of the index to scope the operation
# @option arguments [Hash] :body The text on which the analysis should be performed
# @option arguments [String] :body The text on which the analysis should be performed
# @option arguments [String] :analyzer The name of the analyzer to use
# @option arguments [String] :field Use the analyzer configured for this field
# (instead of passing the analyzer name)
Expand Down