Class: Google::Cloud::Dialogflow::V2::SessionEntityTypesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dialogflow/v2/session_entity_types_client.rb

Overview

Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.

Session entity types are referred to as User entity types and are entities that are built for an individual user such as favorites, preferences, playlists, and so on. You can redefine a session entity type at the session level.

For more information about entity types, see the Dialogflow documentation.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"dialogflow.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"
].freeze

Instance Attribute Summary collapse

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: "") ⇒ SessionEntityTypesClient

Returns a new instance of SessionEntityTypesClient.

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.



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
 
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 144

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/dialogflow/v2/session_entity_type_services_pb"

  credentials ||= Google::Cloud::Dialogflow::V2::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Dialogflow::V2::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-dialogflow'].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(
    "session_entity_types_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.dialogflow.v2.SessionEntityTypes",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      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
  @session_entity_types_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::Dialogflow::V2::SessionEntityTypes::Stub.method(:new)
  )

  @list_session_entity_types = Google::Gax.create_api_call(
    @session_entity_types_stub.method(:list_session_entity_types),
    defaults["list_session_entity_types"],
    exception_transformer: exception_transformer
  )
  @get_session_entity_type = Google::Gax.create_api_call(
    @session_entity_types_stub.method(:get_session_entity_type),
    defaults["get_session_entity_type"],
    exception_transformer: exception_transformer
  )
  @create_session_entity_type = Google::Gax.create_api_call(
    @session_entity_types_stub.method(:create_session_entity_type),
    defaults["create_session_entity_type"],
    exception_transformer: exception_transformer
  )
  @update_session_entity_type = Google::Gax.create_api_call(
    @session_entity_types_stub.method(:update_session_entity_type),
    defaults["update_session_entity_type"],
    exception_transformer: exception_transformer
  )
  @delete_session_entity_type = Google::Gax.create_api_call(
    @session_entity_types_stub.method(:delete_session_entity_type),
    defaults["delete_session_entity_type"],
    exception_transformer: exception_transformer
  )
end

Instance Attribute Details

#session_entity_types_stub ⇒ Google::Cloud::Dialogflow::V2::SessionEntityTypes::Stub (readonly)

Returns:

  • (Google::Cloud::Dialogflow::V2::SessionEntityTypes::Stub) 


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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
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
439
440
441
442
443
444
445
446
447
 
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 49

class SessionEntityTypesClient
  attr_reader :session_entity_types_stub

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

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  # The default set of gRPC interceptors.
  GRPC_INTERCEPTORS = []

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_session_entity_types" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "session_entity_types")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # 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


  SESSION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/agent/sessions/{session}"
  )

  private_constant :SESSION_PATH_TEMPLATE

  SESSION_ENTITY_TYPE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/agent/sessions/{session}/entityTypes/{entity_type}"
  )

  private_constant :SESSION_ENTITY_TYPE_PATH_TEMPLATE

  # Returns a fully-qualified session resource name string.
  # @param project [String]
  # @param session [String]
  # @return [String]
  def self.session_path project, session
    SESSION_PATH_TEMPLATE.render(
      :"project" => project,
      :"session" => session
    )
  end

  # Returns a fully-qualified session_entity_type resource name string.
  # @param project [String]
  # @param session [String]
  # @param entity_type [String]
  # @return [String]
  def self.session_entity_type_path project, session, entity_type
    SESSION_ENTITY_TYPE_PATH_TEMPLATE.render(
      :"project" => project,
      :"session" => session,
      :"entity_type" => entity_type
    )
  end

  # @param credentials [Google::Auth::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::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.
  # @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.
  # @param metadata [Hash]
  #   Default metadata to be sent with each request. This can be overridden on a per call basis.
  # @param exception_transformer [Proc]
  #   An optional proc that intercepts any exceptions raised during an API call to inject
  #   custom error handling.
  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/dialogflow/v2/session_entity_type_services_pb"

    credentials ||= Google::Cloud::Dialogflow::V2::Credentials.default

    if credentials.is_a?(String) || credentials.is_a?(Hash)
      updater_proc = Google::Cloud::Dialogflow::V2::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-dialogflow'].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(
      "session_entity_types_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.cloud.dialogflow.v2.SessionEntityTypes",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        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
    @session_entity_types_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::Dialogflow::V2::SessionEntityTypes::Stub.method(:new)
    )

    @list_session_entity_types = Google::Gax.create_api_call(
      @session_entity_types_stub.method(:list_session_entity_types),
      defaults["list_session_entity_types"],
      exception_transformer: exception_transformer
    )
    @get_session_entity_type = Google::Gax.create_api_call(
      @session_entity_types_stub.method(:get_session_entity_type),
      defaults["get_session_entity_type"],
      exception_transformer: exception_transformer
    )
    @create_session_entity_type = Google::Gax.create_api_call(
      @session_entity_types_stub.method(:create_session_entity_type),
      defaults["create_session_entity_type"],
      exception_transformer: exception_transformer
    )
    @update_session_entity_type = Google::Gax.create_api_call(
      @session_entity_types_stub.method(:update_session_entity_type),
      defaults["update_session_entity_type"],
      exception_transformer: exception_transformer
    )
    @delete_session_entity_type = Google::Gax.create_api_call(
      @session_entity_types_stub.method(:delete_session_entity_type),
      defaults["delete_session_entity_type"],
      exception_transformer: exception_transformer
    )
  end

  # Service calls

  # Returns the list of all session entity types in the specified session.
  #
  # @param parent [String]
  #   Required. The session to list all session entity types from.
  #   Format: +projects/<Project ID>/agent/sessions/<Session ID>+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::SessionEntityType>]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::SessionEntityType>]
  #   An enumerable of Google::Cloud::Dialogflow::V2::SessionEntityType instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/dialogflow"
  #
  #   session_entity_types_client = Google::Cloud::Dialogflow::SessionEntityTypes.new(version: :v2)
  #   formatted_parent = Google::Cloud::Dialogflow::V2::SessionEntityTypesClient.session_path("[PROJECT]", "[SESSION]")
  #
  #   # Iterate over all results.
  #   session_entity_types_client.list_session_entity_types(formatted_parent).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   session_entity_types_client.list_session_entity_types(formatted_parent).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_session_entity_types \
      parent,
      page_size: nil,
      options: nil,
      &block
    req = {
      parent: parent,
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::ListSessionEntityTypesRequest)
    @list_session_entity_types.call(req, options, &block)
  end

  # Retrieves the specified session entity type.
  #
  # @param name [String]
  #   Required. The name of the session entity type. Format:
  #   +projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
  #   Display Name>+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Cloud::Dialogflow::V2::SessionEntityType]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Cloud::Dialogflow::V2::SessionEntityType]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/dialogflow"
  #
  #   session_entity_types_client = Google::Cloud::Dialogflow::SessionEntityTypes.new(version: :v2)
  #   formatted_name = Google::Cloud::Dialogflow::V2::SessionEntityTypesClient.session_entity_type_path("[PROJECT]", "[SESSION]", "[ENTITY_TYPE]")
  #   response = session_entity_types_client.get_session_entity_type(formatted_name)

  def get_session_entity_type \
      name,
      options: nil,
      &block
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::GetSessionEntityTypeRequest)
    @get_session_entity_type.call(req, options, &block)
  end

  # Creates a session entity type.
  #
  # @param parent [String]
  #   Required. The session to create a session entity type for.
  #   Format: +projects/<Project ID>/agent/sessions/<Session ID>+.
  # @param session_entity_type [Google::Cloud::Dialogflow::V2::SessionEntityType | Hash]
  #   Required. The session entity type to create.
  #   A hash of the same form as `Google::Cloud::Dialogflow::V2::SessionEntityType`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Cloud::Dialogflow::V2::SessionEntityType]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Cloud::Dialogflow::V2::SessionEntityType]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/dialogflow"
  #
  #   session_entity_types_client = Google::Cloud::Dialogflow::SessionEntityTypes.new(version: :v2)
  #   formatted_parent = Google::Cloud::Dialogflow::V2::SessionEntityTypesClient.session_path("[PROJECT]", "[SESSION]")
  #
  #   # TODO: Initialize +session_entity_type+:
  #   session_entity_type = {}
  #   response = session_entity_types_client.create_session_entity_type(formatted_parent, session_entity_type)

  def create_session_entity_type \
      parent,
      session_entity_type,
      options: nil,
      &block
    req = {
      parent: parent,
      session_entity_type: session_entity_type
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::CreateSessionEntityTypeRequest)
    @create_session_entity_type.call(req, options, &block)
  end

  # Updates the specified session entity type.
  #
  # @param session_entity_type [Google::Cloud::Dialogflow::V2::SessionEntityType | Hash]
  #   Required. The entity type to update. Format:
  #   +projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
  #   Display Name>+.
  #   A hash of the same form as `Google::Cloud::Dialogflow::V2::SessionEntityType`
  #   can also be provided.
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
  #   Optional. The mask to control which fields get updated.
  #   A hash of the same form as `Google::Protobuf::FieldMask`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Cloud::Dialogflow::V2::SessionEntityType]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Cloud::Dialogflow::V2::SessionEntityType]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/dialogflow"
  #
  #   session_entity_types_client = Google::Cloud::Dialogflow::SessionEntityTypes.new(version: :v2)
  #
  #   # TODO: Initialize +session_entity_type+:
  #   session_entity_type = {}
  #   response = session_entity_types_client.update_session_entity_type(session_entity_type)

  def update_session_entity_type \
      session_entity_type,
      update_mask: nil,
      options: nil,
      &block
    req = {
      session_entity_type: session_entity_type,
      update_mask: update_mask
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::UpdateSessionEntityTypeRequest)
    @update_session_entity_type.call(req, options, &block)
  end

  # Deletes the specified session entity type.
  #
  # @param name [String]
  #   Required. The name of the entity type to delete. Format:
  #   +projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
  #   Display Name>+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result []
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/dialogflow"
  #
  #   session_entity_types_client = Google::Cloud::Dialogflow::SessionEntityTypes.new(version: :v2)
  #   formatted_name = Google::Cloud::Dialogflow::V2::SessionEntityTypesClient.session_entity_type_path("[PROJECT]", "[SESSION]", "[ENTITY_TYPE]")
  #   session_entity_types_client.delete_session_entity_type(formatted_name)

  def delete_session_entity_type \
      name,
      options: nil,
      &block
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DeleteSessionEntityTypeRequest)
    @delete_session_entity_type.call(req, options, &block)
    nil
  end
end

Class Method Details

.session_entity_type_path(project, session, entity_type) ⇒ String

Returns a fully-qualified session_entity_type resource name string.

Parameters:

  • project (String)
  • session (String)
  • entity_type (String)

Returns:

  • (String) 


107
108
109
110
111
112
113
 
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 107

def self.session_entity_type_path project, session, entity_type
  SESSION_ENTITY_TYPE_PATH_TEMPLATE.render(
    :"project" => project,
    :"session" => session,
    :"entity_type" => entity_type
  )
end

.session_path(project, session) ⇒ String

Returns a fully-qualified session resource name string.

Parameters:

  • project (String)
  • session (String)

Returns:

  • (String) 


95
96
97
98
99
100
 
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 95

def self.session_path project, session
  SESSION_PATH_TEMPLATE.render(
    :"project" => project,
    :"session" => session
  )
end

Instance Method Details

#create_session_entity_type(parent, session_entity_type, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::SessionEntityType

Creates a session entity type.

Examples:

require "google/cloud/dialogflow"

session_entity_types_client = Google::Cloud::Dialogflow::SessionEntityTypes.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::SessionEntityTypesClient.session_path("[PROJECT]", "[SESSION]")

# TODO: Initialize +session_entity_type+:
session_entity_type = {}
response = session_entity_types_client.create_session_entity_type(formatted_parent, session_entity_type)

Parameters:

  • parent (String) —

    Required. The session to create a session entity type for. Format: +projects//agent/sessions/+.

  • session_entity_type (Google::Cloud::Dialogflow::V2::SessionEntityType | Hash) —

    Required. The session entity type to create. A hash of the same form as Google::Cloud::Dialogflow::V2::SessionEntityType 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.



361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 361

def create_session_entity_type \
    parent,
    session_entity_type,
    options: nil,
    &block
  req = {
    parent: parent,
    session_entity_type: session_entity_type
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::CreateSessionEntityTypeRequest)
  @create_session_entity_type.call(req, options, &block)
end

#delete_session_entity_type(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes the specified session entity type.

Examples:

require "google/cloud/dialogflow"

session_entity_types_client = Google::Cloud::Dialogflow::SessionEntityTypes.new(version: :v2)
formatted_name = Google::Cloud::Dialogflow::V2::SessionEntityTypesClient.session_entity_type_path("[PROJECT]", "[SESSION]", "[ENTITY_TYPE]")
session_entity_types_client.delete_session_entity_type(formatted_name)

Parameters:

  • name (String) —

    Required. The name of the entity type to delete. Format: +projects//agent/sessions//entityTypes/+.

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

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 436

def delete_session_entity_type \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::DeleteSessionEntityTypeRequest)
  @delete_session_entity_type.call(req, options, &block)
  nil
end

#get_session_entity_type(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::SessionEntityType

Retrieves the specified session entity type.

Examples:

require "google/cloud/dialogflow"

session_entity_types_client = Google::Cloud::Dialogflow::SessionEntityTypes.new(version: :v2)
formatted_name = Google::Cloud::Dialogflow::V2::SessionEntityTypesClient.session_entity_type_path("[PROJECT]", "[SESSION]", "[ENTITY_TYPE]")
response = session_entity_types_client.get_session_entity_type(formatted_name)

Parameters:

  • name (String) —

    Required. The name of the session entity type. Format: +projects//agent/sessions//entityTypes/+.

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



323
324
325
326
327
328
329
330
331
332
 
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 323

def get_session_entity_type \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::GetSessionEntityTypeRequest)
  @get_session_entity_type.call(req, options, &block)
end

#list_session_entity_types(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::SessionEntityType>

Returns the list of all session entity types in the specified session.

Examples:

require "google/cloud/dialogflow"

session_entity_types_client = Google::Cloud::Dialogflow::SessionEntityTypes.new(version: :v2)
formatted_parent = Google::Cloud::Dialogflow::V2::SessionEntityTypesClient.session_path("[PROJECT]", "[SESSION]")

# Iterate over all results.
session_entity_types_client.list_session_entity_types(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
session_entity_types_client.list_session_entity_types(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Required. The session to list all session entity types from. Format: +projects//agent/sessions/+.

  • page_size (Integer) (defaults to: nil) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

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

  • (Google::Gax::PagedEnumerable<Google::Cloud::Dialogflow::V2::SessionEntityType>) —

    An enumerable of Google::Cloud::Dialogflow::V2::SessionEntityType instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 289

def list_session_entity_types \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::ListSessionEntityTypesRequest)
  @list_session_entity_types.call(req, options, &block)
end

#update_session_entity_type(session_entity_type, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dialogflow::V2::SessionEntityType

Updates the specified session entity type.

Examples:

require "google/cloud/dialogflow"

session_entity_types_client = Google::Cloud::Dialogflow::SessionEntityTypes.new(version: :v2)

# TODO: Initialize +session_entity_type+:
session_entity_type = {}
response = session_entity_types_client.update_session_entity_type(session_entity_type)

Parameters:

  • session_entity_type (Google::Cloud::Dialogflow::V2::SessionEntityType | Hash) —

    Required. The entity type to update. Format: +projects//agent/sessions//entityTypes/+. A hash of the same form as Google::Cloud::Dialogflow::V2::SessionEntityType can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) (defaults to: nil) —

    Optional. The mask to control which fields get updated. A hash of the same form as Google::Protobuf::FieldMask 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.



403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/google/cloud/dialogflow/v2/session_entity_types_client.rb', line 403

def update_session_entity_type \
    session_entity_type,
    update_mask: nil,
    options: nil,
    &block
  req = {
    session_entity_type: session_entity_type,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dialogflow::V2::UpdateSessionEntityTypeRequest)
  @update_session_entity_type.call(req, options, &block)
end