Class: Google::Cloud::Translate::Detection

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/translate/detection.rb

Overview

Detection

Represents a detect language query result. Returned by Api#detect.

Examples:

require "google/cloud/translate"

translate = Google::Cloud::Translate.new

detections = translate.detect "chien", "chat"

detections.size #=> 2
detections[0].text #=> "chien"
detections[0].language #=> "fr"
detections[0].confidence #=> 0.7109375
detections[1].text #=> "chat"
detections[1].language #=> "en"
detections[1].confidence #=> 0.59922177

See Also:

Defined Under Namespace

Classes: Result

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#results ⇒ Array<Detection::Result> (readonly)

The list of detection results for the given text. The most likely language is listed first, and its attributes can be accessed through #language and #confidence.

Returns:



56
57
58
 
# File 'lib/google/cloud/translate/detection.rb', line 56

def results
  @results
end

#text ⇒ String (readonly)

The text upon which the language detection was performed.

Returns:

  • (String) 


48
49
50
 
# File 'lib/google/cloud/translate/detection.rb', line 48

def text
  @text
end

Instance Method Details

#confidence ⇒ Float

The confidence that the language detection result is correct. The closer this value is to 1, the higher the confidence in language detection.

Returns:

  • (Float) —

    a value between 0 and 1



71
72
73
74
 
# File 'lib/google/cloud/translate/detection.rb', line 71

def confidence
  return nil if results.empty?
  results.first.confidence
end

#language ⇒ String

The most likely language that was detected. This is an ISO 639-1 language code.

Returns:

  • (String) —

    the language code



82
83
84
85
 
# File 'lib/google/cloud/translate/detection.rb', line 82

def language
  return nil if results.empty?
  results.first.language
end