Cloud Translation V2 API - Class Google::Cloud::Translate::V2::Api (v1.0.1)

Reference documentation and code samples for the Cloud Translation V2 API class Google::Cloud::Translate::V2::Api.

Api

Represents top-level access to the Google Cloud Translation API. Translation API supports more than one hundred different languages, from Afrikaans to Zulu. Used in combination, this enables translation between thousands of language pairs. Also, you can send in HTML and receive HTML with translated text back. You don't need to extract your source text or reassemble the translated content.

Inherits

  • Object

Example

require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new

translation = translate.translate "Hello world!", to: "la"

translation.to_s #=> "Salve mundi!"

translation.from #=> "en"
translation.origin #=> "Hello world!"
translation.to #=> "la"
translation.text #=> "Salve mundi!"

Methods

#detect

def detect(*text) -> Detection, Array<Detection>

Detect the most likely language or languages of a text or multiple texts.

Parameter
  • text (String) — The text or texts upon which language detection should be performed.
Returns
Examples 
require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new

detection = translate.detect "Hello world!"
detection.language #=> "en"
detection.confidence #=> 0.7100697

Detecting multiple texts.

require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new

detections = translate.detect "Hello world!",
                              "Bonjour le monde!"
detections.count #=> 2
detections.first.language #=> "en"
detections.first.confidence #=> 0.7100697
detections.last.language #=> "fr"
detections.last.confidence #=> 0.40440267

#languages

def languages(language = nil) -> Array<Language>

List the languages supported by the API. These are the languages to and from which text can be translated.

Parameter
  • language (String) — The language and collation in which the names of the languages are returned. If this is nil then no names are returned.
Returns
Examples 
require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new

languages = translate.languages
languages.count #=> 104

english = languages.detect { |l| l.code == "en" }
english.name #=> nil

Get all languages with their names in French.

require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new

languages = translate.languages "fr"
languages.count #=> 104

english = languages.detect { |l| l.code == "en" }
english.name #=> "Anglais"

#project

def project()
Alias Of: #project_id

The Cloud Translation API project connected to.

Example 
require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new(
  project_id: "my-todo-project",
  credentials: "/path/to/keyfile.json"
)

translate.project_id #=> "my-todo-project"

#project_id

def project_id()
Aliases

The Cloud Translation API project connected to.

Example 
require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new(
  project_id: "my-todo-project",
  credentials: "/path/to/keyfile.json"
)

translate.project_id #=> "my-todo-project"

#translate

def translate(*text, to: nil, from: nil, format: nil, model: nil, cid: nil) -> Translation, Array<Translation>

Returns text translations from one language to another.

Parameters
  • text (String) — The text or texts to translate.
  • to (String) (defaults to: nil) — The target language into which the text should be translated. This is required. The value must be an ISO 639-1 language code.
  • from (String) (defaults to: nil) — The source language of the text or texts. This is an ISO 639-1 language code. This is optional.
  • format (String) (defaults to: nil) — The format of the text. Possible values include :text and :html. This is optional. The Translation API default is :html.
  • model (String) (defaults to: nil) — The model used by the service to perform the translation. Can be either base to use the Phrase-Based Machine Translation (PBMT) model, or nmt to use the Neural Machine Translation (NMT) model. The default is nmt.

    If the model is nmt, and the requested language translation pair is not supported for the NMT model, then the request is translated using the PBMT model.

  • cid (String) (defaults to: nil) — The customization id for translate. This is optional.
Returns
Raises
  • (ArgumentError)
Examples 
require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new

translation = translate.translate "Hello world!", to: "la"

translation.to_s #=> "Salve mundi!"

translation.detected? #=> true
translation.from #=> "en"
translation.origin #=> "Hello world!"
translation.to #=> "la"
translation.text #=> "Salve mundi!"
translation.model #=> "base"

Using the neural machine translation model:

require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new

translation = translate.translate "Hello world!",
                                  to: "la", model: "nmt"

translation.to_s #=> "Salve mundi!"
translation.model #=> "nmt"

Setting the from language.

require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new

translation = translate.translate "Hello world!",
                                  from: :en, to: :la
translation.detected? #=> false
translation.text #=> "Salve mundi!"

Retrieving multiple translations.

require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new

translations = translate.translate "Hello my friend.",
                                   "See you soon.",
                                   from: "en", to: "la"
translations.count #=> 2
translations[0].text #=> "Salve amice."
translations[1].text #=> "Vide te mox."

Preserving HTML tags.

require "google/cloud/translate/v2"

translate = Google::Cloud::Translate::V2.new

translation = translate.translate "<strong>Hello</strong> world!",
                                  to: :la
translation.text #=> "<strong>Salve</strong> mundi!"