Class: Google::Cloud::Language::V1beta2::LanguageServiceClient
- Inherits:
-
Object
- Object
- Google::Cloud::Language::V1beta2::LanguageServiceClient
- Defined in:
- lib/google/cloud/language/v1beta2/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
- 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 Attribute Summary collapse
Instance Method Summary collapse
-
#analyze_entities(document, encoding_type: nil, options: nil) ⇒ Google::Cloud::Language::V1beta2::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(document, encoding_type: nil, options: nil) ⇒ Google::Cloud::Language::V1beta2::AnalyzeEntitySentimentResponse
Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.
-
#analyze_sentiment(document, encoding_type: nil, options: nil) ⇒ Google::Cloud::Language::V1beta2::AnalyzeSentimentResponse
Analyzes the sentiment of the provided text.
-
#analyze_syntax(document, encoding_type: nil, options: nil) ⇒ Google::Cloud::Language::V1beta2::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(document, features, encoding_type: nil, options: nil) ⇒ Google::Cloud::Language::V1beta2::AnnotateTextResponse
A convenience method that provides all syntax, sentiment, entity, and classification features in one call.
-
#classify_text(document, options: nil) ⇒ Google::Cloud::Language::V1beta2::ClassifyTextResponse
Classifies a document into categories.
-
#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "") ⇒ LanguageServiceClient
constructor
A new instance of LanguageServiceClient.
Constructor Details
#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "") ⇒ LanguageServiceClient
Returns a new instance of LanguageServiceClient
84 85 86 87 88 89 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 |
# File 'lib/google/cloud/language/v1beta2/language_service_client.rb', line 84 def initialize \ service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, 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/v1beta2/language_service_services_pb" if channel || chan_creds || updater_proc warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \ "on 2017/09/08" credentials ||= channel credentials ||= chan_creds credentials ||= updater_proc end if service_path || port warn "`service_path` and `port` parameters are deprecated and will be removed" end credentials ||= Google::Cloud::Language::Credentials.default if credentials.is_a?(String) || credentials.is_a?(Hash) updater_proc = Google::Cloud::Language::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::Gax::Credentials) updater_proc = credentials.updater_proc end google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } 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.v1beta2.LanguageService", JSON.parse(f.read), client_config, Google::Gax::Grpc::STATUS_CODE_NAMES, timeout, errors: Google::Gax::Grpc::API_ERRORS, kwargs: headers ) end @language_service_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, updater_proc: updater_proc, scopes: scopes, &Google::Cloud::Language::V1beta2::LanguageService::Stub.method(:new) ) @analyze_sentiment = Google::Gax.create_api_call( @language_service_stub.method(:analyze_sentiment), defaults["analyze_sentiment"] ) @analyze_entities = Google::Gax.create_api_call( @language_service_stub.method(:analyze_entities), defaults["analyze_entities"] ) @analyze_entity_sentiment = Google::Gax.create_api_call( @language_service_stub.method(:analyze_entity_sentiment), defaults["analyze_entity_sentiment"] ) @analyze_syntax = Google::Gax.create_api_call( @language_service_stub.method(:analyze_syntax), defaults["analyze_syntax"] ) @classify_text = Google::Gax.create_api_call( @language_service_stub.method(:classify_text), defaults["classify_text"] ) @annotate_text = Google::Gax.create_api_call( @language_service_stub.method(:annotate_text), defaults["annotate_text"] ) end |
Instance Attribute Details
#language_service_stub ⇒ Google::Cloud::Language::V1beta2::LanguageService::Stub (readonly)
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 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 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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 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 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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 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 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 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 |
# File 'lib/google/cloud/language/v1beta2/language_service_client.rb', line 42 class LanguageServiceClient attr_reader :language_service_stub # The default address of the service. SERVICE_ADDRESS = "language.googleapis.com".freeze # The default port of the service. DEFAULT_SERVICE_PORT = 443 DEFAULT_TIMEOUT = 30 # The scopes needed to make gRPC calls to all of the methods defined in # this service. ALL_SCOPES = [ "https://www.googleapis.com/auth/cloud-platform" ].freeze # @param credentials # [Google::Gax::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::Gax::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. # @param scopes [Array<String>] # The OAuth scopes for this service. This parameter is ignored if # an updater_proc is supplied. # @param 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. # @param timeout [Numeric] # The default timeout, in seconds, for calls made through this client. def initialize \ service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, 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/v1beta2/language_service_services_pb" if channel || chan_creds || updater_proc warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \ "on 2017/09/08" credentials ||= channel credentials ||= chan_creds credentials ||= updater_proc end if service_path || port warn "`service_path` and `port` parameters are deprecated and will be removed" end credentials ||= Google::Cloud::Language::Credentials.default if credentials.is_a?(String) || credentials.is_a?(Hash) updater_proc = Google::Cloud::Language::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::Gax::Credentials) updater_proc = credentials.updater_proc end google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } 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.v1beta2.LanguageService", JSON.parse(f.read), client_config, Google::Gax::Grpc::STATUS_CODE_NAMES, timeout, errors: Google::Gax::Grpc::API_ERRORS, kwargs: headers ) end @language_service_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, updater_proc: updater_proc, scopes: scopes, &Google::Cloud::Language::V1beta2::LanguageService::Stub.method(:new) ) @analyze_sentiment = Google::Gax.create_api_call( @language_service_stub.method(:analyze_sentiment), defaults["analyze_sentiment"] ) @analyze_entities = Google::Gax.create_api_call( @language_service_stub.method(:analyze_entities), defaults["analyze_entities"] ) @analyze_entity_sentiment = Google::Gax.create_api_call( @language_service_stub.method(:analyze_entity_sentiment), defaults["analyze_entity_sentiment"] ) @analyze_syntax = Google::Gax.create_api_call( @language_service_stub.method(:analyze_syntax), defaults["analyze_syntax"] ) @classify_text = Google::Gax.create_api_call( @language_service_stub.method(:classify_text), defaults["classify_text"] ) @annotate_text = Google::Gax.create_api_call( @language_service_stub.method(:annotate_text), defaults["annotate_text"] ) end # Service calls # Analyzes the sentiment of the provided text. # # @param document [Google::Cloud::Language::V1beta2::Document | Hash] # Input document. # A hash of the same form as `Google::Cloud::Language::V1beta2::Document` # can also be provided. # @param encoding_type [Google::Cloud::Language::V1beta2::EncodingType] # The encoding type used by the API to calculate sentence offsets for the # sentence sentiment. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Cloud::Language::V1beta2::AnalyzeSentimentResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/language/v1beta2" # # language_service_client = Google::Cloud::Language::V1beta2.new # document = {} # response = language_service_client.analyze_sentiment(document) def analyze_sentiment \ document, encoding_type: nil, options: nil req = { document: document, encoding_type: encoding_type }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::AnalyzeSentimentRequest) @analyze_sentiment.call(req, ) end # Finds named entities (currently proper names and common nouns) in the text # along with entity types, salience, mentions for each entity, and # other properties. # # @param document [Google::Cloud::Language::V1beta2::Document | Hash] # Input document. # A hash of the same form as `Google::Cloud::Language::V1beta2::Document` # can also be provided. # @param encoding_type [Google::Cloud::Language::V1beta2::EncodingType] # The encoding type used by the API to calculate offsets. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Cloud::Language::V1beta2::AnalyzeEntitiesResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/language/v1beta2" # # language_service_client = Google::Cloud::Language::V1beta2.new # document = {} # response = language_service_client.analyze_entities(document) def analyze_entities \ document, encoding_type: nil, options: nil req = { document: document, encoding_type: encoding_type }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::AnalyzeEntitiesRequest) @analyze_entities.call(req, ) end # Finds entities, similar to {Google::Cloud::Language::V1beta2::LanguageService::AnalyzeEntities AnalyzeEntities} in the text and analyzes # sentiment associated with each entity and its mentions. # # @param document [Google::Cloud::Language::V1beta2::Document | Hash] # Input document. # A hash of the same form as `Google::Cloud::Language::V1beta2::Document` # can also be provided. # @param encoding_type [Google::Cloud::Language::V1beta2::EncodingType] # The encoding type used by the API to calculate offsets. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Cloud::Language::V1beta2::AnalyzeEntitySentimentResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/language/v1beta2" # # language_service_client = Google::Cloud::Language::V1beta2.new # document = {} # response = language_service_client.analyze_entity_sentiment(document) def analyze_entity_sentiment \ document, encoding_type: nil, options: nil req = { document: document, encoding_type: encoding_type }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::AnalyzeEntitySentimentRequest) @analyze_entity_sentiment.call(req, ) end # Analyzes the syntax of the text and provides sentence boundaries and # tokenization along with part of speech tags, dependency trees, and other # properties. # # @param document [Google::Cloud::Language::V1beta2::Document | Hash] # Input document. # A hash of the same form as `Google::Cloud::Language::V1beta2::Document` # can also be provided. # @param encoding_type [Google::Cloud::Language::V1beta2::EncodingType] # The encoding type used by the API to calculate offsets. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Cloud::Language::V1beta2::AnalyzeSyntaxResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/language/v1beta2" # # language_service_client = Google::Cloud::Language::V1beta2.new # document = {} # response = language_service_client.analyze_syntax(document) def analyze_syntax \ document, encoding_type: nil, options: nil req = { document: document, encoding_type: encoding_type }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::AnalyzeSyntaxRequest) @analyze_syntax.call(req, ) end # Classifies a document into categories. # # @param document [Google::Cloud::Language::V1beta2::Document | Hash] # Input document. # A hash of the same form as `Google::Cloud::Language::V1beta2::Document` # can also be provided. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Cloud::Language::V1beta2::ClassifyTextResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/language/v1beta2" # # language_service_client = Google::Cloud::Language::V1beta2.new # document = {} # response = language_service_client.classify_text(document) def classify_text \ document, options: nil req = { document: document }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::ClassifyTextRequest) @classify_text.call(req, ) end # A convenience method that provides all syntax, sentiment, entity, and # classification features in one call. # # @param document [Google::Cloud::Language::V1beta2::Document | Hash] # Input document. # A hash of the same form as `Google::Cloud::Language::V1beta2::Document` # can also be provided. # @param features [Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features | Hash] # The enabled features. # A hash of the same form as `Google::Cloud::Language::V1beta2::AnnotateTextRequest::Features` # can also be provided. # @param encoding_type [Google::Cloud::Language::V1beta2::EncodingType] # The encoding type used by the API to calculate offsets. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Cloud::Language::V1beta2::AnnotateTextResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/language/v1beta2" # # language_service_client = Google::Cloud::Language::V1beta2.new # document = {} # features = {} # response = language_service_client.annotate_text(document, features) def annotate_text \ document, features, encoding_type: nil, options: nil req = { document: document, features: features, encoding_type: encoding_type }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::AnnotateTextRequest) @annotate_text.call(req, ) end end |
Instance Method Details
#analyze_entities(document, encoding_type: nil, options: nil) ⇒ Google::Cloud::Language::V1beta2::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.
245 246 247 248 249 250 251 252 253 254 255 |
# File 'lib/google/cloud/language/v1beta2/language_service_client.rb', line 245 def analyze_entities \ document, encoding_type: nil, options: nil req = { document: document, encoding_type: encoding_type }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::AnalyzeEntitiesRequest) @analyze_entities.call(req, ) end |
#analyze_entity_sentiment(document, encoding_type: nil, options: nil) ⇒ Google::Cloud::Language::V1beta2::AnalyzeEntitySentimentResponse
Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.
278 279 280 281 282 283 284 285 286 287 288 |
# File 'lib/google/cloud/language/v1beta2/language_service_client.rb', line 278 def analyze_entity_sentiment \ document, encoding_type: nil, options: nil req = { document: document, encoding_type: encoding_type }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::AnalyzeEntitySentimentRequest) @analyze_entity_sentiment.call(req, ) end |
#analyze_sentiment(document, encoding_type: nil, options: nil) ⇒ Google::Cloud::Language::V1beta2::AnalyzeSentimentResponse
Analyzes the sentiment of the provided text.
211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/google/cloud/language/v1beta2/language_service_client.rb', line 211 def analyze_sentiment \ document, encoding_type: nil, options: nil req = { document: document, encoding_type: encoding_type }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::AnalyzeSentimentRequest) @analyze_sentiment.call(req, ) end |
#analyze_syntax(document, encoding_type: nil, options: nil) ⇒ Google::Cloud::Language::V1beta2::AnalyzeSyntaxResponse
Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.
312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/google/cloud/language/v1beta2/language_service_client.rb', line 312 def analyze_syntax \ document, encoding_type: nil, options: nil req = { document: document, encoding_type: encoding_type }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::AnalyzeSyntaxRequest) @analyze_syntax.call(req, ) end |
#annotate_text(document, features, encoding_type: nil, options: nil) ⇒ Google::Cloud::Language::V1beta2::AnnotateTextResponse
A convenience method that provides all syntax, sentiment, entity, and classification features in one call.
378 379 380 381 382 383 384 385 386 387 388 389 390 |
# File 'lib/google/cloud/language/v1beta2/language_service_client.rb', line 378 def annotate_text \ document, features, encoding_type: nil, options: nil req = { document: document, features: features, encoding_type: encoding_type }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::AnnotateTextRequest) @annotate_text.call(req, ) end |
#classify_text(document, options: nil) ⇒ Google::Cloud::Language::V1beta2::ClassifyTextResponse
Classifies a document into categories.
342 343 344 345 346 347 348 349 350 |
# File 'lib/google/cloud/language/v1beta2/language_service_client.rb', line 342 def classify_text \ document, options: nil req = { document: document }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Language::V1beta2::ClassifyTextRequest) @classify_text.call(req, ) end |