Module: Google::Cloud::Language

Defined in:
lib/google/cloud/language.rb,
lib/google/cloud/language/v1.rb,
lib/google/cloud/language/v1beta2.rb,
lib/google/cloud/language/credentials.rb,
lib/google/cloud/language/v1/doc/overview.rb,
lib/google/cloud/language/v1beta2/doc/overview.rb,
lib/google/cloud/language/v1/language_service_client.rb,
lib/google/cloud/language/v1beta2/language_service_client.rb,
lib/google/cloud/language/v1/doc/google/cloud/language/v1/language_service.rb,
lib/google/cloud/language/v1beta2/doc/google/cloud/language/v1beta2/language_service.rb

Overview

Ruby Client for Google Cloud Natural Language API (Alpha)

Google Cloud Natural Language API: Google Cloud Natural Language API provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, and text annotations.

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.
  2. Enable the Google Cloud Natural Language API.
  3. Setup Authentication.

Installation

$ gem install google-cloud-language

Preview

LanguageServiceClient

require "google/cloud/language"

language_service_client = Google::Cloud::Language.new
content = "Hello, world!"
type = :PLAIN_TEXT
document = { content: content, type: type }
response = language_service_client.analyze_sentiment(document)

Next Steps

Defined Under Namespace

Modules: V1, V1beta2 Classes: Credentials

Constant Summary collapse

FILE_DIR =

rubocop:enable LineLength

File.realdirpath(Pathname.new(__FILE__).join("..").join("language"))
AVAILABLE_VERSIONS = 
Dir["#{FILE_DIR}/*"]
.select { |file| File.directory?(file) }
.select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
.select { |dir| File.exist?(dir + ".rb") }
.map { |dir| File.basename(dir) }

Class Method Summary collapse

Class Method Details

.new(version: , credentials: , scopes: , client_config: , timeout: ) ⇒ Object

Provides text analysis operations such as sentiment analysis and entity recognition.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.

Parameters:

  • version (Symbol, String) —

    The major version of the service to be used. By default :v1 is used.



107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/language.rb', line 107

def self.new(*args, version: :v1, **kwargs)
  unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
    raise "The version: #{version} is not available. The available versions " \
      "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
  end

  require "#{FILE_DIR}/#{version.to_s.downcase}"
  version_module = Google::Cloud::Language
    .constants
    .select {|sym| sym.to_s.downcase == version.to_s.downcase}
    .first
  Google::Cloud::Language.const_get(version_module).new(*args, **kwargs)
end