Class: Google::Cloud::Talent::V4beta1::ResumeServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/talent/v4beta1/resume_service_client.rb

Overview

A service that handles resume parsing.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"jobs.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
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",
  "https://www.googleapis.com/auth/jobs"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ ResumeServiceClient

Returns a new instance of ResumeServiceClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::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.

  • scopes (Array<String>) (defaults to: ALL_SCOPES) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {}) —

    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) (defaults to: DEFAULT_TIMEOUT) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) (defaults to: nil) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



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
 
# File 'lib/google/cloud/talent/v4beta1/resume_service_client.rb', line 106

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: 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/talent/v4beta1/resume_service_services_pb"

  credentials ||= Google::Cloud::Talent::V4beta1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Talent::V4beta1::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::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-talent'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "resume_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.talent.v4beta1.ResumeService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @resume_service_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Talent::V4beta1::ResumeService::Stub.method(:new)
  )

  @parse_resume = Google::Gax.create_api_call(
    @resume_service_stub.method(:parse_resume),
    defaults["parse_resume"],
    exception_transformer: exception_transformer
  )
end

Class Method Details

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


71
72
73
74
75
 
# File 'lib/google/cloud/talent/v4beta1/resume_service_client.rb', line 71

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

Instance Method Details

#parse_resume(parent, resume, region_code: nil, language_code: nil, options_: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Talent::V4beta1::ParseResumeResponse

Parses a resume into a Profile. The API attempts to fill out the following profile fields if present within the resume:

  • personNames
  • addresses
  • emailAddress
  • phoneNumbers
  • personalUris
  • employmentRecords
  • educationRecords
  • skills

Note that some attributes in these fields may not be populated if they're not present within the resume or unrecognizable by the resume parser.

This API does not save the resume or profile. To create a profile from this resume, clients need to call the CreateProfile method again with the profile returned.

The following list of formats are supported:

  • PDF
  • TXT
  • DOC
  • RTF
  • DOCX
  • PNG (only when ParseResumeRequest#enable_ocr is set to true, otherwise an error is thrown)

Examples:

require "google/cloud/talent"

resume_client = Google::Cloud::Talent::Resume.new(version: :v4beta1)
formatted_parent = Google::Cloud::Talent::V4beta1::ResumeServiceClient.project_path("[PROJECT]")

# TODO: Initialize `resume`:
resume = ''
response = resume_client.parse_resume(formatted_parent, resume)

Parameters:

  • parent (String) —

    Required.

    The resource name of the project.

    The format is "projects/project_id", for example, "projects/api-test-project".

  • resume (String) —

    Required.

    The bytes of the resume file in common format, for example, PDF, TXT. UTF-8 encoding is required if the resume is text-based, otherwise an error is thrown.

  • region_code (String) (defaults to: nil) —

    Optional.

    The region code indicating where the resume is from. Values are as per the ISO-3166-2 format. For example, US, FR, DE.

    This value is optional, but providing this value improves the resume parsing quality and performance.

    An error is thrown if the regionCode is invalid.

  • language_code (String) (defaults to: nil) —

    Optional.

    The language code of contents in the resume.

    Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages{: class="external" target="_blank" }.

  • options_ (Google::Cloud::Talent::V4beta1::ParseResumeOptions | Hash) (defaults to: nil) —

    Optional.

    Options that change how the resume parse is performed. A hash of the same form as Google::Cloud::Talent::V4beta1::ParseResumeOptions can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/google/cloud/talent/v4beta1/resume_service_client.rb', line 274

def parse_resume \
    parent,
    resume,
    region_code: nil,
    language_code: nil,
    options_: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    resume: resume,
    region_code: region_code,
    language_code: language_code,
    options: options_
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Talent::V4beta1::ParseResumeRequest)
  @parse_resume.call(req, options, &block)
end