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
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

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "") ⇒ LanguageServiceClient

Returns a new instance of LanguageServiceClient

Parameters:

  • service_path (String) —

    The domain name of the API remote host.

  • port (Integer) —

    The port on which to connect to the remote host.

  • channel (Channel) —

    A Channel object through which to make calls.

  • chan_creds (Grpc::ChannelCredentials) —

    A ChannelCredentials for the setting up the RPC client.

  • updater_proc (Proc) —

    A function that transforms the metadata for requests, e.g., 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.



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
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 79

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    updater_proc: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    app_name: nil,
    app_version: 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"


  if app_name || app_version
    warn "`app_name` and `app_version` are no longer being used in the request headers."
  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.v1.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::V1::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_syntax = Google::Gax.create_api_call(
    @language_service_stub.method(:analyze_syntax),
    defaults["analyze_syntax"]
  )
  @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::V1::LanguageService::Stub (readonly)

Returns:



41
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
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 41

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 service_path [String]
  #   The domain name of the API remote host.
  # @param port [Integer]
  #   The port on which to connect to the remote host.
  # @param channel [Channel]
  #   A Channel object through which to make calls.
  # @param chan_creds [Grpc::ChannelCredentials]
  #   A ChannelCredentials for the setting up the RPC client.
  # @param updater_proc [Proc]
  #   A function that transforms the metadata for requests, e.g., 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,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      app_name: nil,
      app_version: 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"


    if app_name || app_version
      warn "`app_name` and `app_version` are no longer being used in the request headers."
    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.v1.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::V1::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_syntax = Google::Gax.create_api_call(
      @language_service_stub.method(:analyze_syntax),
      defaults["analyze_syntax"]
    )
    @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::V1::Document]
  #   Input document. Currently, +analyzeSentiment+ only supports English text
  #   (Document#language="EN").
  # @param encoding_type [Google::Cloud::Language::V1::EncodingType]
  #   The encoding type used by the API to calculate sentence offsets.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Cloud::Language::V1::AnalyzeSentimentResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/language/v1"
  #
  #   Document = Google::Cloud::Language::V1::Document
  #   LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient
  #
  #   language_service_client = LanguageServiceClient.new
  #   document = Document.new
  #   response = language_service_client.analyze_sentiment(document)

  def analyze_sentiment \
      document,
      encoding_type: nil,
      options: nil
    req = Google::Cloud::Language::V1::AnalyzeSentimentRequest.new({
      document: document,
      encoding_type: encoding_type
    }.delete_if { |_, v| v.nil? })
    @analyze_sentiment.call(req, options)
  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::V1::Document]
  #   Input document.
  # @param encoding_type [Google::Cloud::Language::V1::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::V1::AnalyzeEntitiesResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/language/v1"
  #
  #   Document = Google::Cloud::Language::V1::Document
  #   EncodingType = Google::Cloud::Language::V1::EncodingType
  #   LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient
  #
  #   language_service_client = LanguageServiceClient.new
  #   document = Document.new
  #   encoding_type = EncodingType::NONE
  #   response = language_service_client.analyze_entities(document, encoding_type)

  def analyze_entities \
      document,
      encoding_type,
      options: nil
    req = Google::Cloud::Language::V1::AnalyzeEntitiesRequest.new({
      document: document,
      encoding_type: encoding_type
    }.delete_if { |_, v| v.nil? })
    @analyze_entities.call(req, options)
  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::V1::Document]
  #   Input document.
  # @param encoding_type [Google::Cloud::Language::V1::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::V1::AnalyzeSyntaxResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/language/v1"
  #
  #   Document = Google::Cloud::Language::V1::Document
  #   EncodingType = Google::Cloud::Language::V1::EncodingType
  #   LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient
  #
  #   language_service_client = LanguageServiceClient.new
  #   document = Document.new
  #   encoding_type = EncodingType::NONE
  #   response = language_service_client.analyze_syntax(document, encoding_type)

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

  # A convenience method that provides all the features that analyzeSentiment,
  # analyzeEntities, and analyzeSyntax provide in one call.
  #
  # @param document [Google::Cloud::Language::V1::Document]
  #   Input document.
  # @param features [Google::Cloud::Language::V1::AnnotateTextRequest::Features]
  #   The enabled features.
  # @param encoding_type [Google::Cloud::Language::V1::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::V1::AnnotateTextResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/language/v1"
  #
  #   Document = Google::Cloud::Language::V1::Document
  #   EncodingType = Google::Cloud::Language::V1::EncodingType
  #   Features = Google::Cloud::Language::V1::AnnotateTextRequest::Features
  #   LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient
  #
  #   language_service_client = LanguageServiceClient.new
  #   document = Document.new
  #   features = Features.new
  #   encoding_type = EncodingType::NONE
  #   response = language_service_client.annotate_text(document, features, encoding_type)

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

Instance Method Details

#analyze_entities(document, encoding_type, options: 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:

require "google/cloud/language/v1"

Document = Google::Cloud::Language::V1::Document
EncodingType = Google::Cloud::Language::V1::EncodingType
LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient

language_service_client = LanguageServiceClient.new
document = Document.new
encoding_type = EncodingType::NONE
response = language_service_client.analyze_entities(document, encoding_type)

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 212

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

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

Analyzes the sentiment of the provided text.

Examples:

require "google/cloud/language/v1"

Document = Google::Cloud::Language::V1::Document
LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient

language_service_client = LanguageServiceClient.new
document = Document.new
response = language_service_client.analyze_sentiment(document)

Parameters:

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

    Input document. Currently, +analyzeSentiment+ only supports English text (Document#language="EN").

  • 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.

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



176
177
178
179
180
181
182
183
184
185
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 176

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

#analyze_syntax(document, encoding_type, options: 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:

require "google/cloud/language/v1"

Document = Google::Cloud::Language::V1::Document
EncodingType = Google::Cloud::Language::V1::EncodingType
LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient

language_service_client = LanguageServiceClient.new
document = Document.new
encoding_type = EncodingType::NONE
response = language_service_client.analyze_syntax(document, encoding_type)

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 248

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

#annotate_text(document, features, encoding_type, options: nil) ⇒ 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/v1"

Document = Google::Cloud::Language::V1::Document
EncodingType = Google::Cloud::Language::V1::EncodingType
Features = Google::Cloud::Language::V1::AnnotateTextRequest::Features
LanguageServiceClient = Google::Cloud::Language::V1::LanguageServiceClient

language_service_client = LanguageServiceClient.new
document = Document.new
features = Features.new
encoding_type = EncodingType::NONE
response = language_service_client.annotate_text(document, features, encoding_type)

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/google/cloud/language/v1/language_service_client.rb', line 287

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