Class: Google::Cloud::Language::V1beta1::LanguageServiceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/language/v1beta1/language_service_api.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
CODE_GEN_NAME_VERSION = 
"gapic/0.1.0".freeze
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, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: "gax", app_version: Google::Gax::VERSION) ⇒ LanguageServiceApi

Returns a new instance of LanguageServiceApi

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.

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

  • app_name (String) —

    The codename of the calling service.

  • app_version (String) —

    The version of the calling service.



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
 
# File 'lib/google/cloud/language/v1beta1/language_service_api.rb', line 78

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    app_name: "gax",
    app_version: Google::Gax::VERSION
  google_api_client = "#{app_name}/#{app_version} " \
    "#{CODE_GEN_NAME_VERSION} ruby/#{RUBY_VERSION}".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.v1beta1.LanguageService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      errors: Google::Gax::Grpc::API_ERRORS,
      kwargs: headers
    )
  end
  @stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    scopes: scopes,
    &Google::Cloud::Language::V1beta1::LanguageService::Stub.method(:new)
  )

  @analyze_sentiment = Google::Gax.create_api_call(
    @stub.method(:analyze_sentiment),
    defaults["analyze_sentiment"]
  )
  @analyze_entities = Google::Gax.create_api_call(
    @stub.method(:analyze_entities),
    defaults["analyze_entities"]
  )
  @annotate_text = Google::Gax.create_api_call(
    @stub.method(:annotate_text),
    defaults["annotate_text"]
  )
end

Instance Attribute Details

#stub ⇒ Google::Cloud::Language::V1beta1::LanguageService::Stub (readonly)

Returns:



40
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
 
# File 'lib/google/cloud/language/v1beta1/language_service_api.rb', line 40

class LanguageServiceApi
  attr_reader :stub

  # The default address of the service.
  SERVICE_ADDRESS = "language.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  CODE_GEN_NAME_VERSION = "gapic/0.1.0".freeze

  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 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.
  # @param app_name [String]
  #   The codename of the calling service.
  # @param app_version [String]
  #   The version of the calling service.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      app_name: "gax",
      app_version: Google::Gax::VERSION
    google_api_client = "#{app_name}/#{app_version} " \
      "#{CODE_GEN_NAME_VERSION} ruby/#{RUBY_VERSION}".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.v1beta1.LanguageService",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      scopes: scopes,
      &Google::Cloud::Language::V1beta1::LanguageService::Stub.method(:new)
    )

    @analyze_sentiment = Google::Gax.create_api_call(
      @stub.method(:analyze_sentiment),
      defaults["analyze_sentiment"]
    )
    @analyze_entities = Google::Gax.create_api_call(
      @stub.method(:analyze_entities),
      defaults["analyze_entities"]
    )
    @annotate_text = Google::Gax.create_api_call(
      @stub.method(:annotate_text),
      defaults["annotate_text"]
    )
  end

  # Service calls

  # Analyzes the sentiment of the provided text.
  #
  # @param document [Google::Cloud::Language::V1beta1::Document]
  #   Input document. Currently, +analyzeSentiment+ only supports English text
  #   (Document#language="EN").
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Cloud::Language::V1beta1::AnalyzeSentimentResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  def analyze_sentiment \
      document,
      options: nil
    req = Google::Cloud::Language::V1beta1::AnalyzeSentimentRequest.new(
      document: document
    )
    @analyze_sentiment.call(req, options)
  end

  # Finds named entities (currently finds proper names) in the text,
  # entity types, salience, mentions for each entity, and other properties.
  #
  # @param document [Google::Cloud::Language::V1beta1::Document]
  #   Input document.
  # @param encoding_type [Google::Cloud::Language::V1beta1::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::V1beta1::AnalyzeEntitiesResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  def analyze_entities \
      document,
      encoding_type,
      options: nil
    req = Google::Cloud::Language::V1beta1::AnalyzeEntitiesRequest.new(
      document: document,
      encoding_type: encoding_type
    )
    @analyze_entities.call(req, options)
  end

  # Advanced API that analyzes the document and provides a full set of text
  # annotations, including semantic, syntactic, and sentiment information. This
  # API is intended for users who are familiar with machine learning and need
  # in-depth text features to build upon.
  #
  # @param document [Google::Cloud::Language::V1beta1::Document]
  #   Input document.
  # @param features [Google::Cloud::Language::V1beta1::AnnotateTextRequest::Features]
  #   The enabled features.
  # @param encoding_type [Google::Cloud::Language::V1beta1::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::V1beta1::AnnotateTextResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  def annotate_text \
      document,
      features,
      encoding_type,
      options: nil
    req = Google::Cloud::Language::V1beta1::AnnotateTextRequest.new(
      document: document,
      features: features,
      encoding_type: encoding_type
    )
    @annotate_text.call(req, options)
  end
end

Instance Method Details

#analyze_entities(document, encoding_type, options: nil) ⇒ Google::Cloud::Language::V1beta1::AnalyzeEntitiesResponse

Finds named entities (currently finds proper names) in the text, entity types, salience, mentions for each entity, and other properties.

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/google/cloud/language/v1beta1/language_service_api.rb', line 161

def analyze_entities \
    document,
    encoding_type,
    options: nil
  req = Google::Cloud::Language::V1beta1::AnalyzeEntitiesRequest.new(
    document: document,
    encoding_type: encoding_type
  )
  @analyze_entities.call(req, options)
end

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

Analyzes the sentiment of the provided text.

Parameters:

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

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

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



140
141
142
143
144
145
146
147
 
# File 'lib/google/cloud/language/v1beta1/language_service_api.rb', line 140

def analyze_sentiment \
    document,
    options: nil
  req = Google::Cloud::Language::V1beta1::AnalyzeSentimentRequest.new(
    document: document
  )
  @analyze_sentiment.call(req, options)
end

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

Advanced API that analyzes the document and provides a full set of text annotations, including semantic, syntactic, and sentiment information. This API is intended for users who are familiar with machine learning and need in-depth text features to build upon.

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/google/cloud/language/v1beta1/language_service_api.rb', line 188

def annotate_text \
    document,
    features,
    encoding_type,
    options: nil
  req = Google::Cloud::Language::V1beta1::AnnotateTextRequest.new(
    document: document,
    features: features,
    encoding_type: encoding_type
  )
  @annotate_text.call(req, options)
end