Class: Google::Cloud::Language::V1::LanguageServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/language/v1/language_service_client.rb

Overview

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

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"language.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ LanguageServiceClient

Returns a new instance of LanguageServiceClient

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.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 90

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/cloud/language/v1/language_service_services_pb"

  credentials ||= Google::Cloud::Language::V1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Language::V1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-language'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "language_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.language.v1.LanguageService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @language_service_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Language::V1::LanguageService::Stub.method(:new)
  )

  @analyze_sentiment = Google::Gax.create_api_call(
    @language_service_stub.method(:analyze_sentiment),
    defaults["analyze_sentiment"],
    exception_transformer: exception_transformer
  )
  @analyze_entities = Google::Gax.create_api_call(
    @language_service_stub.method(:analyze_entities),
    defaults["analyze_entities"],
    exception_transformer: exception_transformer
  )
  @analyze_entity_sentiment = Google::Gax.create_api_call(
    @language_service_stub.method(:analyze_entity_sentiment),
    defaults["analyze_entity_sentiment"],
    exception_transformer: exception_transformer
  )
  @analyze_syntax = Google::Gax.create_api_call(
    @language_service_stub.method(:analyze_syntax),
    defaults["analyze_syntax"],
    exception_transformer: exception_transformer
  )
  @classify_text = Google::Gax.create_api_call(
    @language_service_stub.method(:classify_text),
    defaults["classify_text"],
    exception_transformer: exception_transformer
  )
  @annotate_text = Google::Gax.create_api_call(
    @language_service_stub.method(:annotate_text),
    defaults["annotate_text"],
    exception_transformer: exception_transformer
  )
end

Instance Method Details

#analyze_entities(document, encoding_type: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Language::V1::AnalyzeEntitiesResponse

Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.

Examples:

require "google/cloud/language"

language_service_client = Google::Cloud::Language.new(version: :v1)

# TODO: Initialize +document+:
document = {}
response = language_service_client.analyze_entities(document)

Parameters:

  • document (Google::Cloud::Language::V1::Document | Hash) —

    Input document. A hash of the same form as Google::Cloud::Language::V1::Document can also be provided.

  • encoding_type (Google::Cloud::Language::V1::EncodingType) —

    The encoding type used by the API to calculate offsets.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 262

def analyze_entities \
    document,
    encoding_type: nil,
    options: nil,
    &block
  req = {
    document: document,
    encoding_type: encoding_type
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::AnalyzeEntitiesRequest)
  @analyze_entities.call(req, options, &block)
end

#analyze_entity_sentiment(document, encoding_type: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Language::V1::AnalyzeEntitySentimentResponse

Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.

Examples:

require "google/cloud/language"

language_service_client = Google::Cloud::Language.new(version: :v1)

# TODO: Initialize +document+:
document = {}
response = language_service_client.analyze_entity_sentiment(document)

Parameters:

  • document (Google::Cloud::Language::V1::Document | Hash) —

    Input document. A hash of the same form as Google::Cloud::Language::V1::Document can also be provided.

  • encoding_type (Google::Cloud::Language::V1::EncodingType) —

    The encoding type used by the API to calculate offsets.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 301

def analyze_entity_sentiment \
    document,
    encoding_type: nil,
    options: nil,
    &block
  req = {
    document: document,
    encoding_type: encoding_type
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::AnalyzeEntitySentimentRequest)
  @analyze_entity_sentiment.call(req, options, &block)
end

#analyze_sentiment(document, encoding_type: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Language::V1::AnalyzeSentimentResponse

Analyzes the sentiment of the provided text.

Examples:

require "google/cloud/language"

language_service_client = Google::Cloud::Language.new(version: :v1)

# TODO: Initialize +document+:
document = {}
response = language_service_client.analyze_sentiment(document)

Parameters:

  • document (Google::Cloud::Language::V1::Document | Hash) —

    Input document. A hash of the same form as Google::Cloud::Language::V1::Document can also be provided.

  • encoding_type (Google::Cloud::Language::V1::EncodingType) —

    The encoding type used by the API to calculate sentence offsets.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 222

def analyze_sentiment \
    document,
    encoding_type: nil,
    options: nil,
    &block
  req = {
    document: document,
    encoding_type: encoding_type
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::AnalyzeSentimentRequest)
  @analyze_sentiment.call(req, options, &block)
end

#analyze_syntax(document, encoding_type: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Language::V1::AnalyzeSyntaxResponse

Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.

Examples:

require "google/cloud/language"

language_service_client = Google::Cloud::Language.new(version: :v1)

# TODO: Initialize +document+:
document = {}
response = language_service_client.analyze_syntax(document)

Parameters:

  • document (Google::Cloud::Language::V1::Document | Hash) —

    Input document. A hash of the same form as Google::Cloud::Language::V1::Document can also be provided.

  • encoding_type (Google::Cloud::Language::V1::EncodingType) —

    The encoding type used by the API to calculate offsets.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 341

def analyze_syntax \
    document,
    encoding_type: nil,
    options: nil,
    &block
  req = {
    document: document,
    encoding_type: encoding_type
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::AnalyzeSyntaxRequest)
  @analyze_syntax.call(req, options, &block)
end

#annotate_text(document, features, encoding_type: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Language::V1::AnnotateTextResponse

A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.

Examples:

require "google/cloud/language"

language_service_client = Google::Cloud::Language.new(version: :v1)

# TODO: Initialize +document+:
document = {}

# TODO: Initialize +features+:
features = {}
response = language_service_client.annotate_text(document, features)

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 421

def annotate_text \
    document,
    features,
    encoding_type: nil,
    options: nil,
    &block
  req = {
    document: document,
    features: features,
    encoding_type: encoding_type
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::AnnotateTextRequest)
  @annotate_text.call(req, options, &block)
end

#classify_text(document, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Language::V1::ClassifyTextResponse

Classifies a document into categories.

Examples:

require "google/cloud/language"

language_service_client = Google::Cloud::Language.new(version: :v1)

# TODO: Initialize +document+:
document = {}
response = language_service_client.classify_text(document)

Parameters:

  • document (Google::Cloud::Language::V1::Document | Hash) —

    Input document. A hash of the same form as Google::Cloud::Language::V1::Document can also be provided.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



377
378
379
380
381
382
383
384
385
386
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 377

def classify_text \
    document,
    options: nil,
    &block
  req = {
    document: document
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Language::V1::ClassifyTextRequest)
  @classify_text.call(req, options, &block)
end