Class: OCI::Oda::ManagementClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/oda/management_client.rb

Overview

API to create and maintain Oracle Digital Assistant service instances.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ManagementClient

Creates a new ManagementClient. Notes:

If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified.  If an endpoint is specified, it will be used instead of the
  region. A region may be specified in the config or via or the region parameter. If specified in both, then the
  region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

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

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

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

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/oda/management_client.rb', line 53

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20190506'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "ManagementClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



13
14
15
 
# File 'lib/oci/oda/management_client.rb', line 13

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/oda/management_client.rb', line 17

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/oda/management_client.rb', line 27

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries

Returns:



23
24
25
 
# File 'lib/oci/oda/management_client.rb', line 23

def retry_config
  @retry_config
end

Instance Method Details

#configure_digital_assistant_parameters(oda_instance_id, configure_digital_assistant_parameters_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/configure_digital_assistant_parameters.rb.html) to see an example of how to use configure_digital_assistant_parameters API.

This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again.

    Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/oda/management_client.rb', line 118

def configure_digital_assistant_parameters(oda_instance_id, configure_digital_assistant_parameters_details, opts = {})
  logger.debug 'Calling operation ManagementClient#configure_digital_assistant_parameters.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling configure_digital_assistant_parameters." if oda_instance_id.nil?
  raise "Missing the required parameter 'configure_digital_assistant_parameters_details' when calling configure_digital_assistant_parameters." if configure_digital_assistant_parameters_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/actions/configureDigitalAssistantParameters'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(configure_digital_assistant_parameters_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#configure_digital_assistant_parameters') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_authentication_provider(oda_instance_id, create_authentication_provider_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/create_authentication_provider.rb.html) to see an example of how to use create_authentication_provider API.

Creates a new Authentication Provider

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • create_authentication_provider_details (OCI::Oda::Models::CreateAuthenticationProviderDetails) —

    Property values required to create the new Authentication Provider.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again.

    Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

Returns:



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
 
# File 'lib/oci/oda/management_client.rb', line 183

def create_authentication_provider(oda_instance_id, create_authentication_provider_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_authentication_provider.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_authentication_provider." if oda_instance_id.nil?
  raise "Missing the required parameter 'create_authentication_provider_details' when calling create_authentication_provider." if create_authentication_provider_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/authenticationProviders'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_authentication_provider_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_authentication_provider') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::AuthenticationProvider'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_channel(oda_instance_id, create_channel_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/create_channel.rb.html) to see an example of how to use create_channel API.

Creates a new Channel.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • create_channel_details (OCI::Oda::Models::CreateChannelDetails) —

    Property values for creating the new Channel.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again.

    Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

Returns:



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
 
# File 'lib/oci/oda/management_client.rb', line 249

def create_channel(oda_instance_id, create_channel_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_channel." if oda_instance_id.nil?
  raise "Missing the required parameter 'create_channel_details' when calling create_channel." if create_channel_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/channels'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_channel_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_channel') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::CreateChannelResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_digital_assistant(oda_instance_id, create_digital_assistant_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/create_digital_assistant.rb.html) to see an example of how to use create_digital_assistant API.

Creates a new Digital Assistant.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • create_digital_assistant_details (OCI::Oda::Models::CreateDigitalAssistantDetails) —

    Property values for creating the new Digital Assistant.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again.

    Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/oda/management_client.rb', line 315

def create_digital_assistant(oda_instance_id, create_digital_assistant_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'create_digital_assistant_details' when calling create_digital_assistant." if create_digital_assistant_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_digital_assistant_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_digital_assistant') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_skill(oda_instance_id, create_skill_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/create_skill.rb.html) to see an example of how to use create_skill API.

Creates a new Skill from scratch.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • create_skill_details (OCI::Oda::Models::CreateSkillDetails) —

    Property values for creating the Skill.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again.

    Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/oda/management_client.rb', line 380

def create_skill(oda_instance_id, create_skill_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'create_skill_details' when calling create_skill." if create_skill_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/skills'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_skill_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_skill') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_skill_parameter(oda_instance_id, skill_id, create_skill_parameter_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/create_skill_parameter.rb.html) to see an example of how to use create_skill_parameter API.

Creates a new Skill Parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • create_skill_parameter_details (OCI::Oda::Models::CreateSkillParameterDetails) —

    Property values for creating the new Skill Parameter.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again.

    Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

Returns:



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/oci/oda/management_client.rb', line 446

def create_skill_parameter(oda_instance_id, skill_id, create_skill_parameter_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_skill_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_skill_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling create_skill_parameter." if skill_id.nil?
  raise "Missing the required parameter 'create_skill_parameter_details' when calling create_skill_parameter." if create_skill_parameter_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/parameters'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_skill_parameter_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_skill_parameter') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::SkillParameter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_translator(oda_instance_id, create_translator_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/create_translator.rb.html) to see an example of how to use create_translator API.

Creates a new Translator

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • create_translator_details (OCI::Oda::Models::CreateTranslatorDetails) —

    Property values to create the new Translator.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again.

    Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

Returns:



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/oci/oda/management_client.rb', line 514

def create_translator(oda_instance_id, create_translator_details, opts = {})
  logger.debug 'Calling operation ManagementClient#create_translator.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling create_translator." if oda_instance_id.nil?
  raise "Missing the required parameter 'create_translator_details' when calling create_translator." if create_translator_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/translators'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_translator_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#create_translator') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::Translator'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_authentication_provider(oda_instance_id, authentication_provider_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/delete_authentication_provider.rb.html) to see an example of how to use delete_authentication_provider API.

Delete the specified Authentication Provider.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • authentication_provider_id (String) —

    Unique Authentication Provider identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/oci/oda/management_client.rb', line 579

def delete_authentication_provider(oda_instance_id, authentication_provider_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_authentication_provider.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_authentication_provider." if oda_instance_id.nil?
  raise "Missing the required parameter 'authentication_provider_id' when calling delete_authentication_provider." if authentication_provider_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'authentication_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(authentication_provider_id)

  path = '/odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{authenticationProviderId}', authentication_provider_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#delete_authentication_provider') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_channel(oda_instance_id, channel_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/delete_channel.rb.html) to see an example of how to use delete_channel API.

Delete the specified Channel.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
 
# File 'lib/oci/oda/management_client.rb', line 643

def delete_channel(oda_instance_id, channel_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_channel." if oda_instance_id.nil?
  raise "Missing the required parameter 'channel_id' when calling delete_channel." if channel_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{channelId}', channel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#delete_channel') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_digital_assistant(oda_instance_id, digital_assistant_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/delete_digital_assistant.rb.html) to see an example of how to use delete_digital_assistant API.

Delete the specified Digital Assistant.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/oci/oda/management_client.rb', line 708

def delete_digital_assistant(oda_instance_id, digital_assistant_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling delete_digital_assistant." if digital_assistant_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#delete_digital_assistant') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_skill(oda_instance_id, skill_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/delete_skill.rb.html) to see an example of how to use delete_skill API.

Delete the specified Skill.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
 
# File 'lib/oci/oda/management_client.rb', line 773

def delete_skill(oda_instance_id, skill_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling delete_skill." if skill_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#delete_skill') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_skill_parameter(oda_instance_id, skill_id, parameter_name, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/delete_skill_parameter.rb.html) to see an example of how to use delete_skill_parameter API.

Delete the specified Skill Parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • parameter_name (String) —

    The name of a Skill Parameter.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'lib/oci/oda/management_client.rb', line 839

def delete_skill_parameter(oda_instance_id, skill_id, parameter_name, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_skill_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_skill_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling delete_skill_parameter." if skill_id.nil?
  raise "Missing the required parameter 'parameter_name' when calling delete_skill_parameter." if parameter_name.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)
  raise "Parameter value for 'parameter_name' must not be blank" if OCI::Internal::Util.blank_string?(parameter_name)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s).sub('{parameterName}', parameter_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#delete_skill_parameter') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_translator(oda_instance_id, translator_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/delete_translator.rb.html) to see an example of how to use delete_translator API.

Delete the specified Translator.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • translator_id (String) —

    Unique Translator identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/oci/oda/management_client.rb', line 905

def delete_translator(oda_instance_id, translator_id, opts = {})
  logger.debug 'Calling operation ManagementClient#delete_translator.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling delete_translator." if oda_instance_id.nil?
  raise "Missing the required parameter 'translator_id' when calling delete_translator." if translator_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'translator_id' must not be blank" if OCI::Internal::Util.blank_string?(translator_id)

  path = '/odaInstances/{odaInstanceId}/translators/{translatorId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{translatorId}', translator_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#delete_translator') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#export_digital_assistant(oda_instance_id, digital_assistant_id, export_digital_assistant_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/export_digital_assistant.rb.html) to see an example of how to use export_digital_assistant API.

Exports the specified Digital Assistant as an archive to Object Storage.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • export_digital_assistant_details (OCI::Oda::Models::ExportDigitalAssistantDetails) —

    Where in Object Storage to export the Digital Assistant to.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'lib/oci/oda/management_client.rb', line 963

def export_digital_assistant(oda_instance_id, digital_assistant_id, export_digital_assistant_details, opts = {})
  logger.debug 'Calling operation ManagementClient#export_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling export_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling export_digital_assistant." if digital_assistant_id.nil?
  raise "Missing the required parameter 'export_digital_assistant_details' when calling export_digital_assistant." if export_digital_assistant_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/export'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(export_digital_assistant_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#export_digital_assistant') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#export_skill(oda_instance_id, skill_id, export_skill_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/export_skill.rb.html) to see an example of how to use export_skill API.

Exports the specified Skill as an archive to Object Storage.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • export_skill_details (OCI::Oda::Models::ExportSkillDetails) —

    Where in Object Storage to export the Skill to.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:

  • (Response) —

    A Response object with data of type nil



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
 
# File 'lib/oci/oda/management_client.rb', line 1021

def export_skill(oda_instance_id, skill_id, export_skill_details, opts = {})
  logger.debug 'Calling operation ManagementClient#export_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling export_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling export_skill." if skill_id.nil?
  raise "Missing the required parameter 'export_skill_details' when calling export_skill." if export_skill_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/actions/export'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(export_skill_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#export_skill') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_authentication_provider(oda_instance_id, authentication_provider_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/get_authentication_provider.rb.html) to see an example of how to use get_authentication_provider API.

Gets the specified Authentication Provider.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • authentication_provider_id (String) —

    Unique Authentication Provider identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/oci/oda/management_client.rb', line 1078

def get_authentication_provider(oda_instance_id, authentication_provider_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_authentication_provider.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_authentication_provider." if oda_instance_id.nil?
  raise "Missing the required parameter 'authentication_provider_id' when calling get_authentication_provider." if authentication_provider_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'authentication_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(authentication_provider_id)

  path = '/odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{authenticationProviderId}', authentication_provider_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#get_authentication_provider') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::AuthenticationProvider'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_channel(oda_instance_id, channel_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/get_channel.rb.html) to see an example of how to use get_channel API.

Gets the specified Channel.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'lib/oci/oda/management_client.rb', line 1135

def get_channel(oda_instance_id, channel_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_channel." if oda_instance_id.nil?
  raise "Missing the required parameter 'channel_id' when calling get_channel." if channel_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{channelId}', channel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#get_channel') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::Channel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_digital_assistant(oda_instance_id, digital_assistant_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/get_digital_assistant.rb.html) to see an example of how to use get_digital_assistant API.

Gets the specified Digital Assistant.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
 
# File 'lib/oci/oda/management_client.rb', line 1192

def get_digital_assistant(oda_instance_id, digital_assistant_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling get_digital_assistant." if digital_assistant_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#get_digital_assistant') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::DigitalAssistant'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_digital_assistant_parameter(oda_instance_id, digital_assistant_id, parameter_name, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/get_digital_assistant_parameter.rb.html) to see an example of how to use get_digital_assistant_parameter API.

Gets the specified Digital Assistant Parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • parameter_name (String) —

    The name of a Digital Assistant Parameter. This is unique with the Digital Assistant.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File 'lib/oci/oda/management_client.rb', line 1250

def get_digital_assistant_parameter(oda_instance_id, digital_assistant_id, parameter_name, opts = {})
  logger.debug 'Calling operation ManagementClient#get_digital_assistant_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_digital_assistant_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling get_digital_assistant_parameter." if digital_assistant_id.nil?
  raise "Missing the required parameter 'parameter_name' when calling get_digital_assistant_parameter." if parameter_name.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)
  raise "Parameter value for 'parameter_name' must not be blank" if OCI::Internal::Util.blank_string?(parameter_name)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters/{parameterName}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_id.to_s).sub('{parameterName}', parameter_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#get_digital_assistant_parameter') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::DigitalAssistantParameter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_skill(oda_instance_id, skill_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/get_skill.rb.html) to see an example of how to use get_skill API.

Gets the specified Skill.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
 
# File 'lib/oci/oda/management_client.rb', line 1309

def get_skill(oda_instance_id, skill_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling get_skill." if skill_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#get_skill') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::Skill'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_skill_parameter(oda_instance_id, skill_id, parameter_name, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/get_skill_parameter.rb.html) to see an example of how to use get_skill_parameter API.

Gets the specified Skill Parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • parameter_name (String) —

    The name of a Skill Parameter.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
 
# File 'lib/oci/oda/management_client.rb', line 1367

def get_skill_parameter(oda_instance_id, skill_id, parameter_name, opts = {})
  logger.debug 'Calling operation ManagementClient#get_skill_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_skill_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling get_skill_parameter." if skill_id.nil?
  raise "Missing the required parameter 'parameter_name' when calling get_skill_parameter." if parameter_name.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)
  raise "Parameter value for 'parameter_name' must not be blank" if OCI::Internal::Util.blank_string?(parameter_name)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s).sub('{parameterName}', parameter_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#get_skill_parameter') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::SkillParameter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_translator(oda_instance_id, translator_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/get_translator.rb.html) to see an example of how to use get_translator API.

Gets the specified Translator.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • translator_id (String) —

    Unique Translator identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
 
# File 'lib/oci/oda/management_client.rb', line 1426

def get_translator(oda_instance_id, translator_id, opts = {})
  logger.debug 'Calling operation ManagementClient#get_translator.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling get_translator." if oda_instance_id.nil?
  raise "Missing the required parameter 'translator_id' when calling get_translator." if translator_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'translator_id' must not be blank" if OCI::Internal::Util.blank_string?(translator_id)

  path = '/odaInstances/{odaInstanceId}/translators/{translatorId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{translatorId}', translator_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#get_translator') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::Translator'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#import_bot(oda_instance_id, import_bot_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/import_bot.rb.html) to see an example of how to use import_bot API.

Import a Bot archive from Object Storage.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • import_bot_details (OCI::Oda::Models::ImportBotDetails) —

    Properties for where in Object Storage to import the Bot archive from.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again.

    Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

Returns:

  • (Response) —

    A Response object with data of type nil



1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/oci/oda/management_client.rb', line 1490

def import_bot(oda_instance_id, import_bot_details, opts = {})
  logger.debug 'Calling operation ManagementClient#import_bot.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling import_bot." if oda_instance_id.nil?
  raise "Missing the required parameter 'import_bot_details' when calling import_bot." if import_bot_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/actions/importBot'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(import_bot_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#import_bot') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_authentication_providers(oda_instance_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/list_authentication_providers.rb.html) to see an example of how to use list_authentication_providers API.

Returns a page of Authentication Providers that belong to the specified Digital Assistant instance.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :id (String) —

    Unique Authentication Provider identifier.

  • :identity_provider (String) —

    List only Authentication Providers for this Identity Provider.

  • :name (String) —

    List only the information for Authentication Providers with this name. Authentication Provider names are unique and may not change.

    Example: `MyProvider`

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter.

    Example: `MToxMA==`

  • :sort_order (String) —

    Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.

    The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending.

    (default to timeCreated)

    Allowed values are: timeCreated, timeUpdated, name, identityProvider

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/oci/oda/management_client.rb', line 1574

def list_authentication_providers(oda_instance_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_authentication_providers.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_authentication_providers." if oda_instance_id.nil?

  if opts[:identity_provider] && !OCI::Oda::Models::AUTHENTICATION_IDENTITY_PROVIDER_ENUM.include?(opts[:identity_provider])
    raise 'Invalid value for "identity_provider", must be one of the values in OCI::Oda::Models::AUTHENTICATION_IDENTITY_PROVIDER_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated timeUpdated name identityProvider].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated, name, identityProvider.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/authenticationProviders'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:identityProvider] = opts[:identity_provider] if opts[:identity_provider]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#list_authentication_providers') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::AuthenticationProviderCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_channels(oda_instance_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/list_channels.rb.html) to see an example of how to use list_channels API.

Returns a page of Channels that belong to the specified Digital Assistant instance.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :id (String) —

    Unique Channel identifier.

  • :name (String) —

    List only the information for Channels with this name. Channels names are unique and may not change.

    Example: `MyChannel`

  • :category (String) —

    List only Channels with this category.

  • :type (String) —

    List only Channels of this type.

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter.

    Example: `MToxMA==`

  • :sort_order (String) —

    Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.

    The default sort order for `timeCreated` and `timeUpdated` is descending, and the default sort order for `name` is ascending.

    (default to timeCreated)

    Allowed values are: timeCreated, timeUpdated, name

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
 
# File 'lib/oci/oda/management_client.rb', line 1680

def list_channels(oda_instance_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_channels.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_channels." if oda_instance_id.nil?

  if opts[:category] && !OCI::Oda::Models::CHANNEL_CATEGORY_ENUM.include?(opts[:category])
    raise 'Invalid value for "category", must be one of the values in OCI::Oda::Models::CHANNEL_CATEGORY_ENUM.'
  end

  if opts[:type] && !OCI::Oda::Models::CHANNEL_TYPE_ENUM.include?(opts[:type])
    raise 'Invalid value for "type", must be one of the values in OCI::Oda::Models::CHANNEL_TYPE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated timeUpdated name].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated, name.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/channels'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#list_channels') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::ChannelCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_digital_assistant_parameters(oda_instance_id, digital_assistant_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/list_digital_assistant_parameters.rb.html) to see an example of how to use list_digital_assistant_parameters API.

Returns a page of Parameters that belong to the specified Digital Assistant.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :name (String) —

    List only Parameters with this name.

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter.

    Example: `MToxMA==`

  • :sort_order (String) —

    Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is `name`.

    The default sort order is ascending.

    (default to name)

    Allowed values are: name, displayName, type

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
 
# File 'lib/oci/oda/management_client.rb', line 1786

def list_digital_assistant_parameters(oda_instance_id, digital_assistant_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_digital_assistant_parameters.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_digital_assistant_parameters." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling list_digital_assistant_parameters." if digital_assistant_id.nil?

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[name displayName type].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, displayName, type.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#list_digital_assistant_parameters') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::DigitalAssistantParameterCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_digital_assistants(oda_instance_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/list_digital_assistants.rb.html) to see an example of how to use list_digital_assistants API.

Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • :category (String) —

    List only Bot resources with this category.

  • :name (String) —

    List only Bot resources with this name. Names are unique and may not change.

    Example: `MySkill`

  • :version (String) —

    List only Bot resources with this version. Versions are unique and may not change.

    Example: `1.0`

  • :namespace (String) —

    List only Bot resources with this namespace. Namespaces may not change.

    Example: `MyNamespace`

  • :platform_version (String) —

    List only Bot resources with this platform version.

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :lifecycle_details (String) —

    List only Bot resources with this lifecycle details.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter.

    Example: `MToxMA==`

  • :sort_order (String) —

    Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.

    The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending.

    (default to timeCreated)

    Allowed values are: timeCreated, timeUpdated, name

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/oci/oda/management_client.rb', line 1900

def list_digital_assistants(oda_instance_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_digital_assistants.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_digital_assistants." if oda_instance_id.nil?

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated timeUpdated name].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated, name.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:digitalAssistantId] = opts[:digital_assistant_id] if opts[:digital_assistant_id]
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:version] = opts[:version] if opts[:version]
  query_params[:namespace] = opts[:namespace] if opts[:namespace]
  query_params[:platformVersion] = opts[:platform_version] if opts[:platform_version]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:lifecycleDetails] = opts[:lifecycle_details] if opts[:lifecycle_details]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#list_digital_assistants') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::DigitalAssistantCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_skill_parameters(oda_instance_id, skill_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/list_skill_parameters.rb.html) to see an example of how to use list_skill_parameters API.

Returns a page of Skill Parameters that belong to the specified Skill.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :name (String) —

    List only Parameters with this name.

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter.

    Example: `MToxMA==`

  • :sort_order (String) —

    Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is `name`.

    The default sort order is ascending.

    (default to name)

    Allowed values are: name, displayName, type

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
 
# File 'lib/oci/oda/management_client.rb', line 2001

def list_skill_parameters(oda_instance_id, skill_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_skill_parameters.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_skill_parameters." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling list_skill_parameters." if skill_id.nil?

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[name displayName type].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of name, displayName, type.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/parameters'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#list_skill_parameters') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::SkillParameterCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_skills(oda_instance_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/list_skills.rb.html) to see an example of how to use list_skills API.

Returns a page of Skills that belong to the specified Digital Assistant instance.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :skill_id (String) —

    Unique Skill identifier.

  • :category (String) —

    List only Bot resources with this category.

  • :name (String) —

    List only Bot resources with this name. Names are unique and may not change.

    Example: `MySkill`

  • :version (String) —

    List only Bot resources with this version. Versions are unique and may not change.

    Example: `1.0`

  • :namespace (String) —

    List only Bot resources with this namespace. Namespaces may not change.

    Example: `MyNamespace`

  • :platform_version (String) —

    List only Bot resources with this platform version.

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :lifecycle_details (String) —

    List only Bot resources with this lifecycle details.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter.

    Example: `MToxMA==`

  • :sort_order (String) —

    Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.

    The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending.

    (default to timeCreated)

    Allowed values are: timeCreated, timeUpdated, name

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'lib/oci/oda/management_client.rb', line 2115

def list_skills(oda_instance_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_skills.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_skills." if oda_instance_id.nil?

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated timeUpdated name].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated, name.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/skills'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:skillId] = opts[:skill_id] if opts[:skill_id]
  query_params[:category] = opts[:category] if opts[:category]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:version] = opts[:version] if opts[:version]
  query_params[:namespace] = opts[:namespace] if opts[:namespace]
  query_params[:platformVersion] = opts[:platform_version] if opts[:platform_version]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:lifecycleDetails] = opts[:lifecycle_details] if opts[:lifecycle_details]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#list_skills') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::SkillCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_translators(oda_instance_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/list_translators.rb.html) to see an example of how to use list_translators API.

Returns a page of Translators that belong to the specified Digital Assistant instance.

If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :id (String) —

    Unique Translator identifier.

  • :type (String) —

    List only Translators of this type.

  • :name (String) —

    List only Translators with this name. Translator names are unique and may not change.

    Example: `MyTranslator`

  • :lifecycle_state (String) —

    List only the resources that are in this lifecycle state.

  • :limit (Integer) —

    The maximum number of items to return per page. (default to 100)

  • :page (String) —

    The page at which to start retrieving results.

    You get this value from the `opc-next-page` header in a previous list request. To retireve the first page, omit this query parameter.

    Example: `MToxMA==`

  • :sort_order (String) —

    Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

    Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.

    The default sort order for `timeCreated` and `timeUpdated` is descending. For all other sort fields the default sort order is ascending.

    (default to timeCreated)

    Allowed values are: timeCreated, timeUpdated, name, type

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
 
# File 'lib/oci/oda/management_client.rb', line 2221

def list_translators(oda_instance_id, opts = {})
  logger.debug 'Calling operation ManagementClient#list_translators.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling list_translators." if oda_instance_id.nil?

  if opts[:type] && !OCI::Oda::Models::TRANSLATION_SERVICE_ENUM.include?(opts[:type])
    raise 'Invalid value for "type", must be one of the values in OCI::Oda::Models::TRANSLATION_SERVICE_ENUM.'
  end

  if opts[:lifecycle_state] && !OCI::Oda::Models::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Oda::Models::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:sort_by] && !%w[timeCreated timeUpdated name type].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeUpdated, name, type.'
  end
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)

  path = '/odaInstances/{odaInstanceId}/translators'.sub('{odaInstanceId}', oda_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#list_translators') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::TranslatorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



92
93
94
 
# File 'lib/oci/oda/management_client.rb', line 92

def logger
  @api_client.config.logger
end

#publish_digital_assistant(oda_instance_id, digital_assistant_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/publish_digital_assistant.rb.html) to see an example of how to use publish_digital_assistant API.

Publish a draft Digital Assistant. Once published the Digital Assistant cannot be modified.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
 
# File 'lib/oci/oda/management_client.rb', line 2309

def publish_digital_assistant(oda_instance_id, digital_assistant_id, opts = {})
  logger.debug 'Calling operation ManagementClient#publish_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling publish_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling publish_digital_assistant." if digital_assistant_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/publish'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#publish_digital_assistant') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::DigitalAssistant'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#publish_skill(oda_instance_id, skill_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/publish_skill.rb.html) to see an example of how to use publish_skill API.

Publish a draft Skill. Once published it cannot be modified.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
 
# File 'lib/oci/oda/management_client.rb', line 2376

def publish_skill(oda_instance_id, skill_id, opts = {})
  logger.debug 'Calling operation ManagementClient#publish_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling publish_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling publish_skill." if skill_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/actions/publish'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#publish_skill') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::Skill'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#rotate_channel_keys(oda_instance_id, channel_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/rotate_channel_keys.rb.html) to see an example of how to use rotate_channel_keys API.

This will generate new keys for any generated keys in the Channel (eg. secretKey, verifyToken). If a Channel has no generated keys then no changes will be made. Ensure that you take note of the newly generated keys in the response as they will not be returned again.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again.

    Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

Returns:



2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
 
# File 'lib/oci/oda/management_client.rb', line 2451

def rotate_channel_keys(oda_instance_id, channel_id, opts = {})
  logger.debug 'Calling operation ManagementClient#rotate_channel_keys.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling rotate_channel_keys." if oda_instance_id.nil?
  raise "Missing the required parameter 'channel_id' when calling rotate_channel_keys." if channel_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}/actions/rotateKeys'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{channelId}', channel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#rotate_channel_keys') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::CreateChannelResult'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#start_channel(oda_instance_id, channel_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/start_channel.rb.html) to see an example of how to use start_channel API.

Starts a Channel so that it will begin accepting messages.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again.

    Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

Returns:



2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
 
# File 'lib/oci/oda/management_client.rb', line 2526

def start_channel(oda_instance_id, channel_id, opts = {})
  logger.debug 'Calling operation ManagementClient#start_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling start_channel." if oda_instance_id.nil?
  raise "Missing the required parameter 'channel_id' when calling start_channel." if channel_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}/actions/start'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{channelId}', channel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#start_channel') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::Channel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#stop_channel(oda_instance_id, channel_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/stop_channel.rb.html) to see an example of how to use stop_channel API.

Stops a Channel so that it will no longer accept messages.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so that you can retry the request if there's a timeout or server error without the risk of executing that same action again.

    Retry tokens expire after 24 hours, but they can become invalid before then if there are conflicting operations. For example, if an instance was deleted and purged from the system, then the service might reject a retry of the original creation request.

Returns:



2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
 
# File 'lib/oci/oda/management_client.rb', line 2601

def stop_channel(oda_instance_id, channel_id, opts = {})
  logger.debug 'Calling operation ManagementClient#stop_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling stop_channel." if oda_instance_id.nil?
  raise "Missing the required parameter 'channel_id' when calling stop_channel." if channel_id.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}/actions/stop'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{channelId}', channel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#stop_channel') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::Channel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_authentication_provider(oda_instance_id, authentication_provider_id, update_authentication_provider_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/update_authentication_provider.rb.html) to see an example of how to use update_authentication_provider API.

Updates the specified Authentication Provider with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • authentication_provider_id (String) —

    Unique Authentication Provider identifier.

  • update_authentication_provider_details (OCI::Oda::Models::UpdateAuthenticationProviderDetails) —

    Property values to update the Authentication Provider.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
 
# File 'lib/oci/oda/management_client.rb', line 2669

def update_authentication_provider(oda_instance_id, authentication_provider_id, update_authentication_provider_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_authentication_provider.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_authentication_provider." if oda_instance_id.nil?
  raise "Missing the required parameter 'authentication_provider_id' when calling update_authentication_provider." if authentication_provider_id.nil?
  raise "Missing the required parameter 'update_authentication_provider_details' when calling update_authentication_provider." if update_authentication_provider_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'authentication_provider_id' must not be blank" if OCI::Internal::Util.blank_string?(authentication_provider_id)

  path = '/odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{authenticationProviderId}', authentication_provider_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_authentication_provider_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_authentication_provider') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::AuthenticationProvider'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_channel(oda_instance_id, channel_id, update_channel_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/update_channel.rb.html) to see an example of how to use update_channel API.

Updates the specified Channel with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • channel_id (String) —

    Unique Channel identifier.

  • update_channel_details (OCI::Oda::Models::UpdateChannelDetails) —

    Property values to update the Channel.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
 
# File 'lib/oci/oda/management_client.rb', line 2736

def update_channel(oda_instance_id, channel_id, update_channel_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_channel.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_channel." if oda_instance_id.nil?
  raise "Missing the required parameter 'channel_id' when calling update_channel." if channel_id.nil?
  raise "Missing the required parameter 'update_channel_details' when calling update_channel." if update_channel_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'channel_id' must not be blank" if OCI::Internal::Util.blank_string?(channel_id)

  path = '/odaInstances/{odaInstanceId}/channels/{channelId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{channelId}', channel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_channel_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_channel') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::Channel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_digital_assistant(oda_instance_id, digital_assistant_id, update_digital_assistant_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/update_digital_assistant.rb.html) to see an example of how to use update_digital_assistant API.

Updates the specified Digital Assistant with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • update_digital_assistant_details (OCI::Oda::Models::UpdateDigitalAssistantDetails) —

    Property values to update the Digital Assistant.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
 
# File 'lib/oci/oda/management_client.rb', line 2803

def update_digital_assistant(oda_instance_id, digital_assistant_id, update_digital_assistant_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_digital_assistant.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_digital_assistant." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling update_digital_assistant." if digital_assistant_id.nil?
  raise "Missing the required parameter 'update_digital_assistant_details' when calling update_digital_assistant." if update_digital_assistant_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_digital_assistant_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_digital_assistant') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::DigitalAssistant'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_digital_assistant_parameter(oda_instance_id, digital_assistant_id, parameter_name, update_digital_assistant_parameter_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/update_digital_assistant_parameter.rb.html) to see an example of how to use update_digital_assistant_parameter API.

Updates the specified Digital Assistant Parameter with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • digital_assistant_id (String) —

    Unique Digital Assistant identifier.

  • parameter_name (String) —

    The name of a Digital Assistant Parameter. This is unique with the Digital Assistant.

  • update_digital_assistant_parameter_details (OCI::Oda::Models::UpdateDigitalAssistantParameterDetails) —

    Property values to update the Digital Assistant Parameter.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
 
# File 'lib/oci/oda/management_client.rb', line 2871

def update_digital_assistant_parameter(oda_instance_id, digital_assistant_id, parameter_name, update_digital_assistant_parameter_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_digital_assistant_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_digital_assistant_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'digital_assistant_id' when calling update_digital_assistant_parameter." if digital_assistant_id.nil?
  raise "Missing the required parameter 'parameter_name' when calling update_digital_assistant_parameter." if parameter_name.nil?
  raise "Missing the required parameter 'update_digital_assistant_parameter_details' when calling update_digital_assistant_parameter." if update_digital_assistant_parameter_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'digital_assistant_id' must not be blank" if OCI::Internal::Util.blank_string?(digital_assistant_id)
  raise "Parameter value for 'parameter_name' must not be blank" if OCI::Internal::Util.blank_string?(parameter_name)

  path = '/odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters/{parameterName}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{digitalAssistantId}', digital_assistant_id.to_s).sub('{parameterName}', parameter_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_digital_assistant_parameter_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_digital_assistant_parameter') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::DigitalAssistantParameter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_skill(oda_instance_id, skill_id, update_skill_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/update_skill.rb.html) to see an example of how to use update_skill API.

Updates the specified Skill with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • update_skill_details (OCI::Oda::Models::UpdateSkillDetails) —

    Property values to update the Skill.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
 
# File 'lib/oci/oda/management_client.rb', line 2940

def update_skill(oda_instance_id, skill_id, update_skill_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_skill.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_skill." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling update_skill." if skill_id.nil?
  raise "Missing the required parameter 'update_skill_details' when calling update_skill." if update_skill_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_skill_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_skill') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::Skill'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_skill_parameter(oda_instance_id, skill_id, parameter_name, update_skill_parameter_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/update_skill_parameter.rb.html) to see an example of how to use update_skill_parameter API.

Updates the specified Skill Parameter with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • skill_id (String) —

    Unique Skill identifier.

  • parameter_name (String) —

    The name of a Skill Parameter.

  • update_skill_parameter_details (OCI::Oda::Models::UpdateSkillParameterDetails) —

    Property values to update the Skill Parameter.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
 
# File 'lib/oci/oda/management_client.rb', line 3008

def update_skill_parameter(oda_instance_id, skill_id, parameter_name, update_skill_parameter_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_skill_parameter.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_skill_parameter." if oda_instance_id.nil?
  raise "Missing the required parameter 'skill_id' when calling update_skill_parameter." if skill_id.nil?
  raise "Missing the required parameter 'parameter_name' when calling update_skill_parameter." if parameter_name.nil?
  raise "Missing the required parameter 'update_skill_parameter_details' when calling update_skill_parameter." if update_skill_parameter_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'skill_id' must not be blank" if OCI::Internal::Util.blank_string?(skill_id)
  raise "Parameter value for 'parameter_name' must not be blank" if OCI::Internal::Util.blank_string?(parameter_name)

  path = '/odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{skillId}', skill_id.to_s).sub('{parameterName}', parameter_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_skill_parameter_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_skill_parameter') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::SkillParameter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_translator(oda_instance_id, translator_id, update_translator_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/oda/update_translator.rb.html) to see an example of how to use update_translator API.

Updates the specified Translator with the information in the request body.

Parameters:

  • oda_instance_id (String) —

    Unique Digital Assistant instance identifier.

  • translator_id (String) —

    Unique Translator identifier.

  • update_translator_details (OCI::Oda::Models::UpdateTranslatorDetails) —

    Property values to update the Translator.

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

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit `nil` value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control in a PUT or DELETE call for a Digital Assistant instance, set the `if-match` query parameter to the value of the `ETAG` header from a previous GET or POST response for that instance. The service updates or deletes the instance only if the etag that you provide matches the instance's current etag value.

  • :opc_request_id (String) —

    The client request ID for tracing. This value is included in the opc-request-id response header.

Returns:



3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
 
# File 'lib/oci/oda/management_client.rb', line 3077

def update_translator(oda_instance_id, translator_id, update_translator_details, opts = {})
  logger.debug 'Calling operation ManagementClient#update_translator.' if logger

  raise "Missing the required parameter 'oda_instance_id' when calling update_translator." if oda_instance_id.nil?
  raise "Missing the required parameter 'translator_id' when calling update_translator." if translator_id.nil?
  raise "Missing the required parameter 'update_translator_details' when calling update_translator." if update_translator_details.nil?
  raise "Parameter value for 'oda_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(oda_instance_id)
  raise "Parameter value for 'translator_id' must not be blank" if OCI::Internal::Util.blank_string?(translator_id)

  path = '/odaInstances/{odaInstanceId}/translators/{translatorId}'.sub('{odaInstanceId}', oda_instance_id.to_s).sub('{translatorId}', translator_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_translator_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ManagementClient#update_translator') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Oda::Models::Translator'
    )
  end
  # rubocop:enable Metrics/BlockLength
end