Class: Google::Cloud::Language::V1::LanguageService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Language::V1::LanguageService::Client
- Defined in:
- lib/google/cloud/language/v1/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
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the LanguageService Client class.
Instance Method Summary collapse
-
#analyze_entities(request, options = nil) {|response, 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.
-
#analyze_entity_sentiment(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Language::V1::AnalyzeEntitySentimentResponse
Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.
-
#analyze_sentiment(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Language::V1::AnalyzeSentimentResponse
Analyzes the sentiment of the provided text.
-
#analyze_syntax(request, options = nil) {|response, 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.
-
#annotate_text(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Language::V1::AnnotateTextResponse
A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.
-
#classify_text(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Language::V1::ClassifyTextResponse
Classifies a document into categories.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the LanguageService Client instance.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new LanguageService client object.
-
#moderate_text(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Language::V1::ModerateTextResponse
Moderates a document for harmful and sensitive categories.
-
#universe_domain ⇒ String
The effective universe domain.
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new LanguageService client object.
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 |
# File 'lib/google/cloud/language/v1/language_service/client.rb', line 153 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/v1/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::V1::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.
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 103 104 105 106 |
# File 'lib/google/cloud/language/v1/language_service/client.rb', line 61 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.
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 351 352 353 354 355 |
# File 'lib/google/cloud/language/v1/language_service/client.rb', line 323 def analyze_entities request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.analyze_entities..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.analyze_entities.timeout, metadata: , retry_policy: @config.rpcs.analyze_entities.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @language_service_stub.call_rpc :analyze_entities, request, 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_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.
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 |
# File 'lib/google/cloud/language/v1/language_service/client.rb', line 406 def analyze_entity_sentiment request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.analyze_entity_sentiment..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.analyze_entity_sentiment.timeout, metadata: , retry_policy: @config.rpcs.analyze_entity_sentiment.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @language_service_stub.call_rpc :analyze_entity_sentiment, request, 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::V1::AnalyzeSentimentResponse #analyze_sentiment(document: nil, encoding_type: nil) ⇒ ::Google::Cloud::Language::V1::AnalyzeSentimentResponse
Analyzes the sentiment of the provided text.
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 269 270 271 272 273 |
# File 'lib/google/cloud/language/v1/language_service/client.rb', line 241 def analyze_sentiment request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.analyze_sentiment..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.analyze_sentiment.timeout, metadata: , retry_policy: @config.rpcs.analyze_sentiment.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @language_service_stub.call_rpc :analyze_sentiment, request, 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_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.
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 |
# File 'lib/google/cloud/language/v1/language_service/client.rb', line 488 def analyze_syntax request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.analyze_syntax..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.analyze_syntax.timeout, metadata: , retry_policy: @config.rpcs.analyze_syntax.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @language_service_stub.call_rpc :analyze_syntax, request, 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::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.
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 |
# File 'lib/google/cloud/language/v1/language_service/client.rb', line 730 def annotate_text request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.annotate_text..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.annotate_text.timeout, metadata: , retry_policy: @config.rpcs.annotate_text.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @language_service_stub.call_rpc :annotate_text, request, 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::V1::ClassifyTextResponse #classify_text(document: nil, classification_model_options: nil) ⇒ ::Google::Cloud::Language::V1::ClassifyTextResponse
Classifies a document into categories.
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 |
# File 'lib/google/cloud/language/v1/language_service/client.rb', line 569 def classify_text request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.classify_text..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.classify_text.timeout, metadata: , retry_policy: @config.rpcs.classify_text.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @language_service_stub.call_rpc :classify_text, request, 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.
123 124 125 126 |
# File 'lib/google/cloud/language/v1/language_service/client.rb', line 123 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.
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 |
# File 'lib/google/cloud/language/v1/language_service/client.rb', line 647 def moderate_text request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.moderate_text..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"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 [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.moderate_text.timeout, metadata: , retry_policy: @config.rpcs.moderate_text.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @language_service_stub.call_rpc :moderate_text, request, 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
133 134 135 |
# File 'lib/google/cloud/language/v1/language_service/client.rb', line 133 def universe_domain @language_service_stub.universe_domain end |