Class: PureCloud::LanguageUnderstandingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/language_understanding_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LanguageUnderstandingApi

Returns a new instance of LanguageUnderstandingApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_languageunderstanding_domain(domain_id, opts = {}) ⇒ nil

Delete an NLU Domain.

Parameters:

  • domain_id —

    ID of the NLU domain.

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

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 32

def delete_languageunderstanding_domain(domain_id, opts = {})
  delete_languageunderstanding_domain_with_http_info(domain_id, opts)
  return nil
end

#delete_languageunderstanding_domain_feedback_feedback_id(domain_id, feedback_id, opts = {}) ⇒ nil

Delete the feedback on the NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • feedback_id —

    ID of the Feedback

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

    the optional parameters

Returns:

  • (nil) 


97
98
99
100
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 97

def delete_languageunderstanding_domain_feedback_feedback_id(domain_id, feedback_id, opts = {})
  delete_languageunderstanding_domain_feedback_feedback_id_with_http_info(domain_id, feedback_id, opts)
  return nil
end

#delete_languageunderstanding_domain_feedback_feedback_id_with_http_info(domain_id, feedback_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the feedback on the NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • feedback_id —

    ID of the Feedback

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 108

def delete_languageunderstanding_domain_feedback_feedback_id_with_http_info(domain_id, feedback_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.delete_languageunderstanding_domain_feedback_feedback_id ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.delete_languageunderstanding_domain_feedback_feedback_id" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'feedback_id' is set
  fail ArgumentError, "Missing the required parameter 'feedback_id' when calling LanguageUnderstandingApi.delete_languageunderstanding_domain_feedback_feedback_id" if feedback_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s).sub('{' + 'feedbackId' + '}', feedback_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#delete_languageunderstanding_domain_feedback_feedback_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_languageunderstanding_domain_version(domain_id, domain_version_id, opts = {}) ⇒ nil

Delete an NLU Domain Version

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

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

    the optional parameters

Returns:

  • (nil) 


171
172
173
174
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 171

def delete_languageunderstanding_domain_version(domain_id, domain_version_id, opts = {})
  delete_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, opts)
  return nil
end

#delete_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an NLU Domain Version

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 182

def delete_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.delete_languageunderstanding_domain_version ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.delete_languageunderstanding_domain_version" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'domain_version_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_version_id' when calling LanguageUnderstandingApi.delete_languageunderstanding_domain_version" if domain_version_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s).sub('{' + 'domainVersionId' + '}', domain_version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#delete_languageunderstanding_domain_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_languageunderstanding_domain_with_http_info(domain_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an NLU Domain.

Parameters:

  • domain_id —

    ID of the NLU domain.

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 42

def delete_languageunderstanding_domain_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.delete_languageunderstanding_domain ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.delete_languageunderstanding_domain" if domain_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#delete_languageunderstanding_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_languageunderstanding_domain(domain_id, opts = {}) ⇒ NluDomain

Find an NLU Domain.

Parameters:

  • domain_id —

    ID of the NLU domain.

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

    the optional parameters

Returns:



244
245
246
247
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 244

def get_languageunderstanding_domain(domain_id, opts = {})
  data, _status_code, _headers = get_languageunderstanding_domain_with_http_info(domain_id, opts)
  return data
end

#get_languageunderstanding_domain_feedback(domain_id, opts = {}) ⇒ NluFeedbackListing

Get all feedback in the given NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

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

    the optional parameters

Options Hash (opts):

  • :intent_name (String) —

    The top intent name to retrieve feedback for.

  • :assessment (String) —

    The top assessment to retrieve feedback for.

  • :date_start (Date) —

    Begin of time window as ISO-8601 date.

  • :date_end (Date) —

    End of time window as ISO-8601 date.

  • :include_deleted (BOOLEAN) —

    Whether to include soft-deleted items in the result.

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :fields (Array<String>) —

    Fields and properties to get, comma-separated

Returns:



317
318
319
320
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 317

def get_languageunderstanding_domain_feedback(domain_id, opts = {})
  data, _status_code, _headers = get_languageunderstanding_domain_feedback_with_http_info(domain_id, opts)
  return data
end

#get_languageunderstanding_domain_feedback_feedback_id(domain_id, feedback_id, opts = {}) ⇒ NluFeedbackResponse

Find a Feedback

Parameters:

  • domain_id —

    ID of the NLU domain.

  • feedback_id —

    ID of the Feedback

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    Fields and properties to get, comma-separated

Returns:



452
453
454
455
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 452

def get_languageunderstanding_domain_feedback_feedback_id(domain_id, feedback_id, opts = {})
  data, _status_code, _headers = get_languageunderstanding_domain_feedback_feedback_id_with_http_info(domain_id, feedback_id, opts)
  return data
end

#get_languageunderstanding_domain_feedback_feedback_id_with_http_info(domain_id, feedback_id, opts = {}) ⇒ Array<(NluFeedbackResponse, Fixnum, Hash)>

Find a Feedback

Parameters:

  • domain_id —

    ID of the NLU domain.

  • feedback_id —

    ID of the Feedback

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

    the optional parameters

Options Hash (opts):

  • :fields (Array<String>) —

    Fields and properties to get, comma-separated

Returns:

  • (Array<(NluFeedbackResponse, Fixnum, Hash)>) —

    NluFeedbackResponse data, response status code and response headers



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 464

def get_languageunderstanding_domain_feedback_feedback_id_with_http_info(domain_id, feedback_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.get_languageunderstanding_domain_feedback_feedback_id ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.get_languageunderstanding_domain_feedback_feedback_id" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'feedback_id' is set
  fail ArgumentError, "Missing the required parameter 'feedback_id' when calling LanguageUnderstandingApi.get_languageunderstanding_domain_feedback_feedback_id" if feedback_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s).sub('{' + 'feedbackId' + '}', feedback_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if opts[:'fields']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluFeedbackResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#get_languageunderstanding_domain_feedback_feedback_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_languageunderstanding_domain_feedback_with_http_info(domain_id, opts = {}) ⇒ Array<(NluFeedbackListing, Fixnum, Hash)>

Get all feedback in the given NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

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

    the optional parameters

Options Hash (opts):

  • :intent_name (String) —

    The top intent name to retrieve feedback for.

  • :assessment (String) —

    The top assessment to retrieve feedback for.

  • :date_start (Date) —

    Begin of time window as ISO-8601 date.

  • :date_end (Date) —

    End of time window as ISO-8601 date.

  • :include_deleted (BOOLEAN) —

    Whether to include soft-deleted items in the result.

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :fields (Array<String>) —

    Fields and properties to get, comma-separated

Returns:

  • (Array<(NluFeedbackListing, Fixnum, Hash)>) —

    NluFeedbackListing data, response status code and response headers



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 335

def get_languageunderstanding_domain_feedback_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.get_languageunderstanding_domain_feedback ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.get_languageunderstanding_domain_feedback" if domain_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'assessment'] && !['Incorrect', 'Correct', 'Unknown', 'Disabled'].include?(opts[:'assessment'])
    fail ArgumentError, 'invalid value for "assessment", must be one of Incorrect, Correct, Unknown, Disabled'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/feedback".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'intentName'] = opts[:'intent_name'] if opts[:'intent_name']
  query_params[:'assessment'] = opts[:'assessment'] if opts[:'assessment']
  query_params[:'dateStart'] = opts[:'date_start'] if opts[:'date_start']
  query_params[:'dateEnd'] = opts[:'date_end'] if opts[:'date_end']
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if opts[:'include_deleted']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if opts[:'fields']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluFeedbackListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#get_languageunderstanding_domain_feedback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_languageunderstanding_domain_version(domain_id, domain_version_id, opts = {}) ⇒ NluDomainVersion

Find an NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

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

    the optional parameters

Options Hash (opts):

  • :include_utterances (BOOLEAN) —

    Whether utterances for intent definition should be included when marshalling response.

Returns:



536
537
538
539
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 536

def get_languageunderstanding_domain_version(domain_id, domain_version_id, opts = {})
  data, _status_code, _headers = get_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, opts)
  return data
end

#get_languageunderstanding_domain_version_report(domain_id, domain_version_id, opts = {}) ⇒ NluDomainVersionQualityReport

Retrieved quality report for the specified NLU Domain Version

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

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

    the optional parameters

Returns:



619
620
621
622
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 619

def get_languageunderstanding_domain_version_report(domain_id, domain_version_id, opts = {})
  data, _status_code, _headers = get_languageunderstanding_domain_version_report_with_http_info(domain_id, domain_version_id, opts)
  return data
end

#get_languageunderstanding_domain_version_report_with_http_info(domain_id, domain_version_id, opts = {}) ⇒ Array<(NluDomainVersionQualityReport, Fixnum, Hash)>

Retrieved quality report for the specified NLU Domain Version

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

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

    the optional parameters

Returns:



630
631
632
633
634
635
636
637
638
639
640
641
642
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
682
683
684
685
686
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 630

def get_languageunderstanding_domain_version_report_with_http_info(domain_id, domain_version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.get_languageunderstanding_domain_version_report ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.get_languageunderstanding_domain_version_report" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'domain_version_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_version_id' when calling LanguageUnderstandingApi.get_languageunderstanding_domain_version_report" if domain_version_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s).sub('{' + 'domainVersionId' + '}', domain_version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDomainVersionQualityReport')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#get_languageunderstanding_domain_version_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, opts = {}) ⇒ Array<(NluDomainVersion, Fixnum, Hash)>

Find an NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

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

    the optional parameters

Options Hash (opts):

  • :include_utterances (BOOLEAN) —

    Whether utterances for intent definition should be included when marshalling response.

Returns:

  • (Array<(NluDomainVersion, Fixnum, Hash)>) —

    NluDomainVersion data, response status code and response headers



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
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
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 548

def get_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.get_languageunderstanding_domain_version ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.get_languageunderstanding_domain_version" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'domain_version_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_version_id' when calling LanguageUnderstandingApi.get_languageunderstanding_domain_version" if domain_version_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s).sub('{' + 'domainVersionId' + '}', domain_version_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeUtterances'] = opts[:'include_utterances'] if opts[:'include_utterances']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDomainVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#get_languageunderstanding_domain_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_languageunderstanding_domain_versions(domain_id, opts = {}) ⇒ NluDomainVersionListing

Get all NLU Domain Versions for a given Domain.

Parameters:

  • domain_id —

    ID of the NLU domain.

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

    the optional parameters

Options Hash (opts):

  • :include_utterances (BOOLEAN) —

    Whether utterances for intent definition should be included when marshalling response.

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

Returns:



696
697
698
699
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 696

def get_languageunderstanding_domain_versions(domain_id, opts = {})
  data, _status_code, _headers = get_languageunderstanding_domain_versions_with_http_info(domain_id, opts)
  return data
end

#get_languageunderstanding_domain_versions_with_http_info(domain_id, opts = {}) ⇒ Array<(NluDomainVersionListing, Fixnum, Hash)>

Get all NLU Domain Versions for a given Domain.

Parameters:

  • domain_id —

    ID of the NLU domain.

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

    the optional parameters

Options Hash (opts):

  • :include_utterances (BOOLEAN) —

    Whether utterances for intent definition should be included when marshalling response.

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:

  • (Array<(NluDomainVersionListing, Fixnum, Hash)>) —

    NluDomainVersionListing data, response status code and response headers



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
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 709

def get_languageunderstanding_domain_versions_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.get_languageunderstanding_domain_versions ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.get_languageunderstanding_domain_versions" if domain_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/versions".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeUtterances'] = opts[:'include_utterances'] if opts[:'include_utterances']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDomainVersionListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#get_languageunderstanding_domain_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_languageunderstanding_domain_with_http_info(domain_id, opts = {}) ⇒ Array<(NluDomain, Fixnum, Hash)>

Find an NLU Domain.

Parameters:

  • domain_id —

    ID of the NLU domain.

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

    the optional parameters

Returns:

  • (Array<(NluDomain, Fixnum, Hash)>) —

    NluDomain data, response status code and response headers



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 254

def get_languageunderstanding_domain_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.get_languageunderstanding_domain ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.get_languageunderstanding_domain" if domain_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDomain')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#get_languageunderstanding_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_languageunderstanding_domains(opts = {}) ⇒ NluDomainListing

Get all NLU Domains.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

Returns:



786
787
788
789
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 786

def get_languageunderstanding_domains(opts = {})
  data, _status_code, _headers = get_languageunderstanding_domains_with_http_info(opts)
  return data
end

#get_languageunderstanding_domains_with_http_info(opts = {}) ⇒ Array<(NluDomainListing, Fixnum, Hash)>

Get all NLU Domains.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:

  • (Array<(NluDomainListing, Fixnum, Hash)>) —

    NluDomainListing data, response status code and response headers



797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 797

def get_languageunderstanding_domains_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.get_languageunderstanding_domains ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDomainListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#get_languageunderstanding_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_languageunderstanding_domain(domain_id, body, opts = {}) ⇒ NluDomain

Update an NLU Domain.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • body —

    The updated NLU Domain.

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

    the optional parameters

Returns:



859
860
861
862
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 859

def patch_languageunderstanding_domain(domain_id, body, opts = {})
  data, _status_code, _headers = patch_languageunderstanding_domain_with_http_info(domain_id, body, opts)
  return data
end

#patch_languageunderstanding_domain_with_http_info(domain_id, body, opts = {}) ⇒ Array<(NluDomain, Fixnum, Hash)>

Update an NLU Domain.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • body —

    The updated NLU Domain.

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

    the optional parameters

Returns:

  • (Array<(NluDomain, Fixnum, Hash)>) —

    NluDomain data, response status code and response headers



870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 870

def patch_languageunderstanding_domain_with_http_info(domain_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.patch_languageunderstanding_domain ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.patch_languageunderstanding_domain" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.patch_languageunderstanding_domain" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDomain')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#patch_languageunderstanding_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_languageunderstanding_domain_feedback(domain_id, body, opts = {}) ⇒ NluFeedbackResponse

Create feedback for the NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • body —

    The Feedback to create.

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

    the optional parameters

Returns:



934
935
936
937
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 934

def post_languageunderstanding_domain_feedback(domain_id, body, opts = {})
  data, _status_code, _headers = post_languageunderstanding_domain_feedback_with_http_info(domain_id, body, opts)
  return data
end

#post_languageunderstanding_domain_feedback_with_http_info(domain_id, body, opts = {}) ⇒ Array<(NluFeedbackResponse, Fixnum, Hash)>

Create feedback for the NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • body —

    The Feedback to create.

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

    the optional parameters

Returns:

  • (Array<(NluFeedbackResponse, Fixnum, Hash)>) —

    NluFeedbackResponse data, response status code and response headers



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
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/purecloudplatformclientv2/api/language_understanding_api.rb', line 945

def post_languageunderstanding_domain_feedback_with_http_info(domain_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.post_languageunderstanding_domain_feedback ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_feedback" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_feedback" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/feedback".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluFeedbackResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#post_languageunderstanding_domain_feedback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, body, opts = {}) ⇒ NluDetectionResponse

Detect intent, entities, etc. in the submitted text using the specified NLU domain version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

  • body —

    The input data to perform detection on.

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

    the optional parameters

Returns:



1010
1011
1012
1013
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1010

def post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, body, opts = {})
  data, _status_code, _headers = post_languageunderstanding_domain_version_detect_with_http_info(domain_id, domain_version_id, body, opts)
  return data
end

#post_languageunderstanding_domain_version_detect_with_http_info(domain_id, domain_version_id, body, opts = {}) ⇒ Array<(NluDetectionResponse, Fixnum, Hash)>

Detect intent, entities, etc. in the submitted text using the specified NLU domain version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

  • body —

    The input data to perform detection on.

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

    the optional parameters

Returns:

  • (Array<(NluDetectionResponse, Fixnum, Hash)>) —

    NluDetectionResponse data, response status code and response headers



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
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1022

def post_languageunderstanding_domain_version_detect_with_http_info(domain_id, domain_version_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.post_languageunderstanding_domain_version_detect ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_version_detect" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'domain_version_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_version_id' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_version_detect" if domain_version_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_version_detect" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s).sub('{' + 'domainVersionId' + '}', domain_version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDetectionResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#post_languageunderstanding_domain_version_detect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_languageunderstanding_domain_version_publish(domain_id, domain_version_id, opts = {}) ⇒ NluDomainVersion

Publish the draft NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

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

    the optional parameters

Returns:



1094
1095
1096
1097
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1094

def post_languageunderstanding_domain_version_publish(domain_id, domain_version_id, opts = {})
  data, _status_code, _headers = post_languageunderstanding_domain_version_publish_with_http_info(domain_id, domain_version_id, opts)
  return data
end

#post_languageunderstanding_domain_version_publish_with_http_info(domain_id, domain_version_id, opts = {}) ⇒ Array<(NluDomainVersion, Fixnum, Hash)>

Publish the draft NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

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

    the optional parameters

Returns:

  • (Array<(NluDomainVersion, Fixnum, Hash)>) —

    NluDomainVersion data, response status code and response headers



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
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
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1105

def post_languageunderstanding_domain_version_publish_with_http_info(domain_id, domain_version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.post_languageunderstanding_domain_version_publish ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_version_publish" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'domain_version_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_version_id' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_version_publish" if domain_version_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s).sub('{' + 'domainVersionId' + '}', domain_version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDomainVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#post_languageunderstanding_domain_version_publish\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_languageunderstanding_domain_version_train(domain_id, domain_version_id, opts = {}) ⇒ NluDomainVersionTrainingResponse

Train the draft NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

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

    the optional parameters

Returns:



1169
1170
1171
1172
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1169

def post_languageunderstanding_domain_version_train(domain_id, domain_version_id, opts = {})
  data, _status_code, _headers = post_languageunderstanding_domain_version_train_with_http_info(domain_id, domain_version_id, opts)
  return data
end

#post_languageunderstanding_domain_version_train_with_http_info(domain_id, domain_version_id, opts = {}) ⇒ Array<(NluDomainVersionTrainingResponse, Fixnum, Hash)>

Train the draft NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

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

    the optional parameters

Returns:



1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
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
1231
1232
1233
1234
1235
1236
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1180

def post_languageunderstanding_domain_version_train_with_http_info(domain_id, domain_version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.post_languageunderstanding_domain_version_train ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_version_train" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'domain_version_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_version_id' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_version_train" if domain_version_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s).sub('{' + 'domainVersionId' + '}', domain_version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDomainVersionTrainingResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#post_languageunderstanding_domain_version_train\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_languageunderstanding_domain_versions(domain_id, body, opts = {}) ⇒ NluDomainVersion

Create an NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • body —

    The NLU Domain Version to create.

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

    the optional parameters

Returns:



1244
1245
1246
1247
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1244

def post_languageunderstanding_domain_versions(domain_id, body, opts = {})
  data, _status_code, _headers = post_languageunderstanding_domain_versions_with_http_info(domain_id, body, opts)
  return data
end

#post_languageunderstanding_domain_versions_with_http_info(domain_id, body, opts = {}) ⇒ Array<(NluDomainVersion, Fixnum, Hash)>

Create an NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • body —

    The NLU Domain Version to create.

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

    the optional parameters

Returns:

  • (Array<(NluDomainVersion, Fixnum, Hash)>) —

    NluDomainVersion data, response status code and response headers



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
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1255

def post_languageunderstanding_domain_versions_with_http_info(domain_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.post_languageunderstanding_domain_versions ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_versions" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.post_languageunderstanding_domain_versions" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/versions".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDomainVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#post_languageunderstanding_domain_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_languageunderstanding_domains(body, opts = {}) ⇒ NluDomain

Create an NLU Domain.

Parameters:

  • body —

    The NLU Domain to create.

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

    the optional parameters

Returns:



1318
1319
1320
1321
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1318

def post_languageunderstanding_domains(body, opts = {})
  data, _status_code, _headers = post_languageunderstanding_domains_with_http_info(body, opts)
  return data
end

#post_languageunderstanding_domains_with_http_info(body, opts = {}) ⇒ Array<(NluDomain, Fixnum, Hash)>

Create an NLU Domain.

Parameters:

  • body —

    The NLU Domain to create.

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

    the optional parameters

Returns:

  • (Array<(NluDomain, Fixnum, Hash)>) —

    NluDomain data, response status code and response headers



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1328

def post_languageunderstanding_domains_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.post_languageunderstanding_domains ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.post_languageunderstanding_domains" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDomain')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#post_languageunderstanding_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_languageunderstanding_domain_version(domain_id, domain_version_id, body, opts = {}) ⇒ NluDomainVersion

Update an NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

  • body —

    The updated NLU Domain Version.

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

    the optional parameters

Returns:



1385
1386
1387
1388
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1385

def put_languageunderstanding_domain_version(domain_id, domain_version_id, body, opts = {})
  data, _status_code, _headers = put_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, body, opts)
  return data
end

#put_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, body, opts = {}) ⇒ Array<(NluDomainVersion, Fixnum, Hash)>

Update an NLU Domain Version.

Parameters:

  • domain_id —

    ID of the NLU domain.

  • domain_version_id —

    ID of the NLU domain version.

  • body —

    The updated NLU Domain Version.

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

    the optional parameters

Returns:

  • (Array<(NluDomainVersion, Fixnum, Hash)>) —

    NluDomainVersion data, response status code and response headers



1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
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
 
# File 'lib/purecloudplatformclientv2/api/language_understanding_api.rb', line 1397

def put_languageunderstanding_domain_version_with_http_info(domain_id, domain_version_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LanguageUnderstandingApi.put_languageunderstanding_domain_version ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling LanguageUnderstandingApi.put_languageunderstanding_domain_version" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'domain_version_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_version_id' when calling LanguageUnderstandingApi.put_languageunderstanding_domain_version" if domain_version_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling LanguageUnderstandingApi.put_languageunderstanding_domain_version" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s).sub('{' + 'domainVersionId' + '}', domain_version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'NluDomainVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LanguageUnderstandingApi#put_languageunderstanding_domain_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end