@@ -4,7 +4,6 @@ Detect Language API Client
44[ ![ Gem Version] ( https://badge.fury.io/rb/detect_language.svg )] ( https://badge.fury.io/rb/detect_language )
55[ ![ Build Status] ( https://secure.travis-ci.org/detectlanguage/detectlanguage-ruby.svg )] ( http://travis-ci.org/detectlanguage/detectlanguage-ruby )
66
7-
87Detects language of given text. Returns detected language codes and scores.
98
109Before using Detect Language API client you have to setup your personal API key.
@@ -14,75 +13,98 @@ You can get it by signing up at https://detectlanguage.com
1413
1514Add this line to your application's Gemfile:
1615
17- gem 'detect_language'
16+ ```
17+ gem 'detect_language'
18+ ```
1819
1920Or install it yourself as:
2021
21- $ gem install detect_language
22+ ```
23+ gem install detect_language
24+ ```
2225
2326### Configuration
2427
2528If you are using Rails, create initializer ` config/initializers/detect_language.rb ` and add following code there.
2629Otherwise just integrate following code into your apps configuration.
2730
28- DetectLanguage.configure do |config|
29- config.api_key = "YOUR API KEY"
31+ ``` ruby
32+ DetectLanguage .configure do |config |
33+ config.api_key = " YOUR API KEY"
3034
31- # enable secure mode (SSL) if you are passing sensitive data
32- # config.secure = true
33- end
35+ # enable secure mode (SSL) if you are passing sensitive data
36+ # config.secure = true
37+ end
38+ ```
3439
3540## Usage
3641
3742### Language detection
3843
39- DetectLanguage.detect("Buenos dias señor")
44+ ``` ruby
45+ DetectLanguage .detect(" Buenos dias señor" )
46+ ```
4047
4148#### Result
4249
43- [ {"language"=>"es", "isReliable"=>false, "confidence"=>0.3271028037383178},
44- {"language"=>"pt", "isReliable"=>false, "confidence"=>0.08356545961002786} ]
50+ ``` ruby
51+ [ {" language" =>" es" , " isReliable" =>false , " confidence" =>0.3271028037383178 },
52+ {" language" =>" pt" , " isReliable" =>false , " confidence" =>0.08356545961002786 } ]
53+ ```
4554
4655### Simple language detection
4756
4857If you need just a language code you can use ` simple_detect ` . It returns just the language code.
4958
50- DetectLanguage.simple_detect("Buenos dias señor")
59+ ``` ruby
60+ DetectLanguage .simple_detect(" Buenos dias señor" )
61+ ```
5162
5263#### Result
5364
54- "es"
55-
65+ ``` ruby
66+ " es"
67+ ```
5668
5769### Batch detection
5870
5971It is possible to detect language of several texts with one request.
6072This method is significantly faster than doing one request per text.
6173To use batch detection just pass array of texts to ` detect ` method.
6274
63- DetectLanguage.detect(["Buenos dias señor", "Labas rytas"])
75+ ``` ruby
76+ DetectLanguage .detect([" Buenos dias señor" , " Labas rytas" ])
77+ ```
6478
6579#### Result
6680
6781Result is array of detections in the same order as the texts were passed.
6882
69- [ [ {"language"=>"es", "isReliable"=>false, "confidence"=>0.3271028037383178},
70- {"language"=>"pt", "isReliable"=>false, "confidence"=>0.08356545961002786} ],
71- [ {"language"=>"lt", "isReliable"=>false, "confidence"=>0.04918032786885246},
72- {"language"=>"lv", "isReliable"=>false, "confidence"=>0.03350083752093803} ] ]
83+ ``` ruby
84+ [ [ {" language" =>" es" , " isReliable" =>false , " confidence" =>0.3271028037383178 },
85+ {" language" =>" pt" , " isReliable" =>false , " confidence" =>0.08356545961002786 } ],
86+ [ {" language" =>" lt" , " isReliable" =>false , " confidence" =>0.04918032786885246 },
87+ {" language" =>" lv" , " isReliable" =>false , " confidence" =>0.03350083752093803 } ] ]
88+ ```
7389
7490### Getting your account status
7591
76- DetectLanguage.user_status
92+ ``` ruby
93+ DetectLanguage .user_status
94+ ```
7795
7896#### Result
7997
80- {"date"=>"2013-11-17", "requests"=>95, "bytes"=>2223, "plan"=>"FREE", "plan_expires"=>nil,
81- "daily_requests_limit"=>5000, "daily_bytes_limit"=>1048576, "status"=>"ACTIVE"}
98+ ``` ruby
99+ {" date" =>" 2013-11-17" , " requests" =>95 , " bytes" =>2223 , " plan" =>" FREE" , " plan_expires" =>nil ,
100+ " daily_requests_limit" =>5000 , " daily_bytes_limit" =>1048576 , " status" =>" ACTIVE" }
101+ ```
82102
83- ### Getting list detectable languages
103+ ### Getting list supported languages
84104
85- DetectLanguage.languages
105+ ``` ruby
106+ DetectLanguage .languages
107+ ```
86108
87109#### Result
88110
0 commit comments