Class: Google::Cloud::Language::V1::LanguageService::Rest::Client

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

Overview

REST 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 REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the LanguageService client.

Yield Parameters:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/google/cloud/language/v1/language_service/rest/client.rb', line 140

def initialize
  # 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 == 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 = ::Google::Cloud::Language::V1::LanguageService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
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::V1::LanguageService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



57
58
59
60
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
102
 
# File 'lib/google/cloud/language/v1/language_service/rest/client.rb', line 57

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Language", "V1"]
    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.analyze_entity_sentiment.timeout = 600.0
    default_config.rpcs.analyze_entity_sentiment.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.analyze_syntax.timeout = 600.0
    default_config.rpcs.analyze_syntax.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.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::V1::AnalyzeEntitiesResponse #analyze_entities(document: nil, encoding_type: nil) ⇒ ::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:

Basic example

require "google/cloud/language/v1"

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

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

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

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

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/google/cloud/language/v1/language_service/rest/client.rb', line 294

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V1::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
  call_metadata = @config.rpcs.analyze_entities.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.analyze_entities.timeout,
                         metadata:     call_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.analyze_entities request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#analyze_entity_sentiment(request, options = nil) ⇒ ::Google::Cloud::Language::V1::AnalyzeEntitySentimentResponse #analyze_entity_sentiment(document: nil, encoding_type: nil) ⇒ ::Google::Cloud::Language::V1::AnalyzeEntitySentimentResponse

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

Examples:

Basic example

require "google/cloud/language/v1"

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

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

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

# The returned object is of type Google::Cloud::Language::V1::AnalyzeEntitySentimentResponse.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/google/cloud/language/v1/language_service/rest/client.rb', line 377

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V1::AnalyzeEntitySentimentRequest

  # 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
  call_metadata = @config.rpcs.analyze_entity_sentiment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.analyze_entity_sentiment.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.analyze_entity_sentiment.retry_policy

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

  @language_service_stub.analyze_entity_sentiment request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Analyzes the sentiment of the provided text.

Examples:

Basic example

require "google/cloud/language/v1"

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

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

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

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

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/google/cloud/language/v1/language_service/rest/client.rb', line 212

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V1::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
  call_metadata = @config.rpcs.analyze_sentiment.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.analyze_sentiment.timeout,
                         metadata:     call_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.analyze_sentiment request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#analyze_syntax(request, options = nil) ⇒ ::Google::Cloud::Language::V1::AnalyzeSyntaxResponse #analyze_syntax(document: nil, encoding_type: nil) ⇒ ::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:

Basic example

require "google/cloud/language/v1"

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

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

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

# The returned object is of type Google::Cloud::Language::V1::AnalyzeSyntaxResponse.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/google/cloud/language/v1/language_service/rest/client.rb', line 459

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V1::AnalyzeSyntaxRequest

  # 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
  call_metadata = @config.rpcs.analyze_syntax.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.analyze_syntax.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.analyze_syntax.retry_policy

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

  @language_service_stub.analyze_syntax request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

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

Examples:

Basic example

require "google/cloud/language/v1"

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

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

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

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

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
 
# File 'lib/google/cloud/language/v1/language_service/rest/client.rb', line 701

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V1::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
  call_metadata = @config.rpcs.annotate_text.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.annotate_text.timeout,
                         metadata:     call_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.annotate_text request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Classifies a document into categories.

Examples:

Basic example

require "google/cloud/language/v1"

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

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

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

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

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/google/cloud/language/v1/language_service/rest/client.rb', line 540

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V1::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
  call_metadata = @config.rpcs.classify_text.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.classify_text.timeout,
                         metadata:     call_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.classify_text request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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:



119
120
121
122
 
# File 'lib/google/cloud/language/v1/language_service/rest/client.rb', line 119

def configure
  yield @config if block_given?
  @config
end

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

Moderates a document for harmful and sensitive categories.

Examples:

Basic example

require "google/cloud/language/v1"

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

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

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

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

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/google/cloud/language/v1/language_service/rest/client.rb', line 618

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Language::V1::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
  call_metadata = @config.rpcs.moderate_text.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.moderate_text.timeout,
                         metadata:     call_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.moderate_text request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end