From 67858f803534266345648405bab2e4d1502173d5 Mon Sep 17 00:00:00 2001 From: Kevin Kirsche Date: Tue, 17 Feb 2015 15:34:38 -0500 Subject: [PATCH] Correct and extend documentation on indices.analyze API MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Correct and extend documentation on indices.analyze API — equivalent to #109 --- .../lib/elasticsearch/api/actions/indices/analyze.rb | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb index 3cf75b2adc..bfa7890b2f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb @@ -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)