Class: Google::Cloud::Language::V2::LanguageService::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/language/v2/language_service/client.rb

Overview

Client for the LanguageService service.

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

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new LanguageService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Language::V2::LanguageService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Language::V2::LanguageService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the LanguageService client.

Yield Parameters:



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
 
# File 'lib/google/cloud/language/v2/language_service/client.rb', line 148

def initialize
  # 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 "gapic/grpc"
  require "google/cloud/language/v2/language_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @language_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Language::V2::LanguageService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the LanguageService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all LanguageService clients
::Google::Cloud::Language::V2::LanguageService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/google/cloud/language/v2/language_service/client.rb', line 61

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Language", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.analyze_sentiment.timeout = 600.0
    default_config.rpcs.analyze_sentiment.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.analyze_entities.timeout = 600.0
    default_config.rpcs.analyze_entities.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.classify_text.timeout = 600.0
    default_config.rpcs.classify_text.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.moderate_text.timeout = 600.0
    default_config.rpcs.moderate_text.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.annotate_text.timeout = 600.0
    default_config.rpcs.annotate_text.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#analyze_entities(request, options = nil) ⇒ ::Google::Cloud::Language::V2::AnalyzeEntitiesResponse #analyze_entities(document: nil, encoding_type: nil) ⇒ ::Google::Cloud::Language::V2::AnalyzeEntitiesResponse

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

Examples:

Basic example

require "google/cloud/language/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Language::V2::LanguageService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Language::V2::AnalyzeEntitiesRequest.new

# Call the analyze_entities method.
result = client.analyze_entities request

# The returned object is of type Google::Cloud::Language::V2::AnalyzeEntitiesResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/google/cloud/language/v2/language_service/client.rb', line 318

def analyze_entities request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V2::AnalyzeEntitiesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.analyze_entities.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Language::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.analyze_entities.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.analyze_entities.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @language_service_stub.call_rpc :analyze_entities, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#analyze_sentiment(request, options = nil) ⇒ ::Google::Cloud::Language::V2::AnalyzeSentimentResponse #analyze_sentiment(document: nil, encoding_type: nil) ⇒ ::Google::Cloud::Language::V2::AnalyzeSentimentResponse

Analyzes the sentiment of the provided text.

Examples:

Basic example

require "google/cloud/language/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Language::V2::LanguageService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Language::V2::AnalyzeSentimentRequest.new

# Call the analyze_sentiment method.
result = client.analyze_sentiment request

# The returned object is of type Google::Cloud::Language::V2::AnalyzeSentimentResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/google/cloud/language/v2/language_service/client.rb', line 236

def analyze_sentiment request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V2::AnalyzeSentimentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.analyze_sentiment.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Language::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.analyze_sentiment.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.analyze_sentiment.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @language_service_stub.call_rpc :analyze_sentiment, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#annotate_text(request, options = nil) ⇒ ::Google::Cloud::Language::V2::AnnotateTextResponse #annotate_text(document: nil, features: nil, encoding_type: nil) ⇒ ::Google::Cloud::Language::V2::AnnotateTextResponse

A convenience method that provides all features in one call.

Examples:

Basic example

require "google/cloud/language/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Language::V2::LanguageService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Language::V2::AnnotateTextRequest.new

# Call the annotate_text method.
result = client.annotate_text request

# The returned object is of type Google::Cloud::Language::V2::AnnotateTextResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/google/cloud/language/v2/language_service/client.rb', line 558

def annotate_text request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V2::AnnotateTextRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.annotate_text.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Language::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.annotate_text.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.annotate_text.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @language_service_stub.call_rpc :annotate_text, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#classify_text(request, options = nil) ⇒ ::Google::Cloud::Language::V2::ClassifyTextResponse #classify_text(document: nil) ⇒ ::Google::Cloud::Language::V2::ClassifyTextResponse

Classifies a document into categories.

Examples:

Basic example

require "google/cloud/language/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Language::V2::LanguageService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Language::V2::ClassifyTextRequest.new

# Call the classify_text method.
result = client.classify_text request

# The returned object is of type Google::Cloud::Language::V2::ClassifyTextResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/google/cloud/language/v2/language_service/client.rb', line 396

def classify_text request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V2::ClassifyTextRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.classify_text.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Language::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.classify_text.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.classify_text.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @language_service_stub.call_rpc :classify_text, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the LanguageService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



118
119
120
121
 
# File 'lib/google/cloud/language/v2/language_service/client.rb', line 118

def configure
  yield @config if block_given?
  @config
end

#moderate_text(request, options = nil) ⇒ ::Google::Cloud::Language::V2::ModerateTextResponse #moderate_text(document: nil, model_version: nil) ⇒ ::Google::Cloud::Language::V2::ModerateTextResponse

Moderates a document for harmful and sensitive categories.

Examples:

Basic example

require "google/cloud/language/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Language::V2::LanguageService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Language::V2::ModerateTextRequest.new

# Call the moderate_text method.
result = client.moderate_text request

# The returned object is of type Google::Cloud::Language::V2::ModerateTextResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/google/cloud/language/v2/language_service/client.rb', line 476

def moderate_text request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V2::ModerateTextRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.moderate_text.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Language::V2::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.moderate_text.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.moderate_text.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @language_service_stub.call_rpc :moderate_text, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


128
129
130
 
# File 'lib/google/cloud/language/v2/language_service/client.rb', line 128

def universe_domain
  @language_service_stub.universe_domain
end