purecloudplatformclientv2 85.0.1 → 86.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (244) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AnalyticsEvaluation.md +1 -1
  4. data/docs/Call.md +1 -0
  5. data/docs/CallBasic.md +1 -0
  6. data/docs/Callback.md +1 -0
  7. data/docs/CallbackBasic.md +1 -0
  8. data/docs/Cobrowsesession.md +1 -0
  9. data/docs/{PartialUploadResponse.md → ContextEntity.md} +3 -3
  10. data/docs/ContextIntent.md +13 -0
  11. data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
  12. data/docs/ConversationChat.md +1 -0
  13. data/docs/ConversationEventTopicCallback.md +1 -0
  14. data/docs/Coretype.md +23 -0
  15. data/docs/CoretypeListing.md +15 -0
  16. data/docs/DataExtensionsApi.md +198 -0
  17. data/docs/DataSchemaListing.md +15 -0
  18. data/docs/DetectedDialogAct.md +14 -0
  19. data/docs/DetectedIntent.md +15 -0
  20. data/docs/DetectedNamedEntity.md +16 -0
  21. data/docs/DetectedNamedEntityValue.md +14 -0
  22. data/docs/DialogflowAgent.md +3 -2
  23. data/docs/Edge.md +1 -1
  24. data/docs/Email.md +1 -0
  25. data/docs/EntityListing.md +1 -5
  26. data/docs/ExternalContactsApi.md +1001 -144
  27. data/docs/FlowDivisionView.md +2 -0
  28. data/docs/IntentDefinition.md +15 -0
  29. data/docs/IntentFeedback.md +16 -0
  30. data/docs/ItemValidationLimits.md +14 -0
  31. data/docs/Items.md +14 -0
  32. data/docs/LanguageUnderstandingApi.md +1160 -0
  33. data/docs/MaxLength.md +14 -0
  34. data/docs/Message.md +1 -0
  35. data/docs/MinLength.md +14 -0
  36. data/docs/NamedEntityAnnotation.md +13 -0
  37. data/docs/NamedEntityTypeBinding.md +14 -0
  38. data/docs/NamedEntityTypeDefinition.md +15 -0
  39. data/docs/NamedEntityTypeItem.md +14 -0
  40. data/docs/NamedEntityTypeMechanism.md +15 -0
  41. data/docs/NluConfusionMatrixColumn.md +14 -0
  42. data/docs/NluConfusionMatrixRow.md +14 -0
  43. data/docs/NluDetectionContext.md +14 -0
  44. data/docs/NluDetectionInput.md +13 -0
  45. data/docs/NluDetectionOutput.md +14 -0
  46. data/docs/NluDetectionRequest.md +14 -0
  47. data/docs/NluDetectionResponse.md +15 -0
  48. data/docs/NluDomain.md +19 -0
  49. data/docs/NluDomainListing.md +22 -0
  50. data/docs/NluDomainVersion.md +24 -0
  51. data/docs/NluDomainVersionListing.md +22 -0
  52. data/docs/NluDomainVersionQualityReport.md +15 -0
  53. data/docs/NluDomainVersionTrainingResponse.md +14 -0
  54. data/docs/NluFeedbackListing.md +22 -0
  55. data/docs/NluFeedbackRequest.md +15 -0
  56. data/docs/NluFeedbackResponse.md +18 -0
  57. data/docs/NluQualityReportSummary.md +13 -0
  58. data/docs/NluQualityReportSummaryMetric.md +14 -0
  59. data/docs/NluUtterance.md +13 -0
  60. data/docs/NluUtteranceSegment.md +14 -0
  61. data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
  62. data/docs/QueueConversationEventTopicCallback.md +1 -0
  63. data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
  64. data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
  65. data/docs/ReportingExportJobRequest.md +1 -0
  66. data/docs/ReportingExportJobResponse.md +2 -0
  67. data/docs/RoutingApi.md +65 -0
  68. data/docs/SCIMApi.md +12 -12
  69. data/docs/Schema.md +17 -0
  70. data/docs/SchemaQuantityLimits.md +26 -0
  71. data/docs/ScimV2EnterpriseUser.md +1 -0
  72. data/docs/Screenshare.md +1 -0
  73. data/docs/SocialExpression.md +1 -0
  74. data/docs/{TimeOffRequestLookup.md → TimeOffRequest.md} +2 -2
  75. data/docs/TimeOffRequestListing.md +13 -0
  76. data/docs/UploadUrlRequest.md +15 -0
  77. data/docs/UploadUrlResponse.md +14 -0
  78. data/docs/UploadsApi.md +78 -0
  79. data/docs/ValidationLimits.md +18 -0
  80. data/docs/Video.md +1 -0
  81. data/docs/WorkforceManagementApi.md +297 -448
  82. data/lib/purecloudplatformclientv2.rb +50 -57
  83. data/lib/purecloudplatformclientv2/api/data_extensions_api.rb +207 -0
  84. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +868 -4
  85. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +1304 -0
  86. data/lib/purecloudplatformclientv2/api/routing_api.rb +64 -0
  87. data/lib/purecloudplatformclientv2/api/scim_api.rb +8 -8
  88. data/lib/purecloudplatformclientv2/api/uploads_api.rb +92 -0
  89. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +314 -571
  90. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  91. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  92. data/lib/purecloudplatformclientv2/models/bulk_update_shift_trade_state_result_item.rb +2 -2
  93. data/lib/purecloudplatformclientv2/models/call.rb +30 -4
  94. data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
  95. data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
  96. data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
  97. data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
  98. data/lib/purecloudplatformclientv2/models/{partial_upload_response.rb → context_entity.rb} +14 -9
  99. data/lib/purecloudplatformclientv2/models/{list_wrapper_wfm_forecast_modification.rb → context_intent.rb} +14 -10
  100. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb +26 -1
  101. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
  102. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
  103. data/lib/purecloudplatformclientv2/models/{rescheduling_options_response.rb → coretype.rb} +97 -102
  104. data/lib/purecloudplatformclientv2/models/{service_goal_group_list.rb → coretype_listing.rb} +34 -11
  105. data/lib/purecloudplatformclientv2/models/data_schema_listing.rb +253 -0
  106. data/lib/purecloudplatformclientv2/models/{forecast_result_response.rb → detected_dialog_act.rb} +16 -16
  107. data/lib/purecloudplatformclientv2/models/{intraday_queue.rb → detected_intent.rb} +23 -23
  108. data/lib/purecloudplatformclientv2/models/detected_named_entity.rb +280 -0
  109. data/lib/purecloudplatformclientv2/models/detected_named_entity_value.rb +228 -0
  110. data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +31 -3
  111. data/lib/purecloudplatformclientv2/models/edge.rb +1 -0
  112. data/lib/purecloudplatformclientv2/models/email.rb +30 -4
  113. data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
  114. data/lib/purecloudplatformclientv2/models/flow_division_view.rb +53 -1
  115. data/lib/purecloudplatformclientv2/models/{create_service_goal_group_request.rb → intent_definition.rb} +30 -19
  116. data/lib/purecloudplatformclientv2/models/{wfm_intraday_queue_listing.rb → intent_feedback.rb} +71 -18
  117. data/lib/purecloudplatformclientv2/models/{service_goal_group_goals.rb → item_validation_limits.rb} +18 -45
  118. data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_response.rb → items.rb} +33 -10
  119. data/lib/purecloudplatformclientv2/models/max_length.rb +238 -0
  120. data/lib/purecloudplatformclientv2/models/message.rb +30 -4
  121. data/lib/purecloudplatformclientv2/models/{forecast_generation_route_group_result.rb → min_length.rb} +26 -18
  122. data/lib/purecloudplatformclientv2/models/{list_wrapper_forecast_source_day_pointer.rb → named_entity_annotation.rb} +14 -10
  123. data/lib/purecloudplatformclientv2/models/{copy_short_term_forecast_request.rb → named_entity_type_binding.rb} +18 -19
  124. data/lib/purecloudplatformclientv2/models/{generate_week_schedule_request.rb → named_entity_type_definition.rb} +38 -13
  125. data/lib/purecloudplatformclientv2/models/{wfm_abandon_rate.rb → named_entity_type_item.rb} +19 -18
  126. data/lib/purecloudplatformclientv2/models/{short_term_forecast_response.rb → named_entity_type_mechanism.rb} +48 -36
  127. data/lib/purecloudplatformclientv2/models/{copy_week_schedule_request.rb → nlu_confusion_matrix_column.rb} +18 -18
  128. data/lib/purecloudplatformclientv2/models/{wfm_average_speed_of_answer.rb → nlu_confusion_matrix_row.rb} +24 -18
  129. data/lib/purecloudplatformclientv2/models/nlu_detection_context.rb +228 -0
  130. data/lib/purecloudplatformclientv2/models/{scheduling_run_list_response.rb → nlu_detection_input.rb} +14 -10
  131. data/lib/purecloudplatformclientv2/models/nlu_detection_output.rb +232 -0
  132. data/lib/purecloudplatformclientv2/models/nlu_detection_request.rb +233 -0
  133. data/lib/purecloudplatformclientv2/models/{route_group_list.rb → nlu_detection_response.rb} +39 -22
  134. data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_item_response.rb → nlu_domain.rb} +66 -60
  135. data/lib/purecloudplatformclientv2/models/{intraday_query_data_command.rb → nlu_domain_listing.rb} +156 -53
  136. data/lib/purecloudplatformclientv2/models/{short_term_forecast.rb → nlu_domain_version.rb} +132 -87
  137. data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +428 -0
  138. data/lib/purecloudplatformclientv2/models/{intraday_metric.rb → nlu_domain_version_quality_report.rb} +57 -28
  139. data/lib/purecloudplatformclientv2/models/{user_schedules_partial_upload_request.rb → nlu_domain_version_training_response.rb} +33 -16
  140. data/lib/purecloudplatformclientv2/models/{import_week_schedule_request.rb → nlu_feedback_listing.rb} +158 -46
  141. data/lib/purecloudplatformclientv2/models/{wfm_service_level.rb → nlu_feedback_request.rb} +36 -25
  142. data/lib/purecloudplatformclientv2/models/{service_goal_group.rb → nlu_feedback_response.rb} +32 -37
  143. data/lib/purecloudplatformclientv2/models/{generate_short_term_forecast_request.rb → nlu_quality_report_summary.rb} +12 -10
  144. data/lib/purecloudplatformclientv2/models/nlu_quality_report_summary_metric.rb +238 -0
  145. data/lib/purecloudplatformclientv2/models/nlu_utterance.rb +209 -0
  146. data/lib/purecloudplatformclientv2/models/nlu_utterance_segment.rb +233 -0
  147. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_media_participant.rb +26 -1
  148. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
  149. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
  150. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
  151. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +32 -4
  152. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +57 -1
  153. data/lib/purecloudplatformclientv2/models/{import_short_term_forecast_request.rb → schema.rb} +50 -35
  154. data/lib/purecloudplatformclientv2/models/schema_quantity_limits.rb +539 -0
  155. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +30 -4
  156. data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
  157. data/lib/purecloudplatformclientv2/models/shift_trade_match_violation.rb +2 -2
  158. data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
  159. data/lib/purecloudplatformclientv2/models/{time_off_request_lookup.rb → time_off_request.rb} +1 -1
  160. data/lib/purecloudplatformclientv2/models/{time_off_request_lookup_list.rb → time_off_request_listing.rb} +2 -2
  161. data/lib/purecloudplatformclientv2/models/{create_queue_media_association_request.rb → upload_url_request.rb} +23 -26
  162. data/lib/purecloudplatformclientv2/models/upload_url_response.rb +230 -0
  163. data/lib/purecloudplatformclientv2/models/{wfm_forecast_modification_attributes.rb → validation_limits.rb} +76 -38
  164. data/lib/purecloudplatformclientv2/models/video.rb +30 -4
  165. data/lib/purecloudplatformclientv2/version.rb +1 -1
  166. metadata +102 -116
  167. data/docs/AsyncWeekScheduleResponse.md +0 -16
  168. data/docs/CopyShortTermForecastRequest.md +0 -14
  169. data/docs/CopyWeekScheduleRequest.md +0 -14
  170. data/docs/CreateQueueMediaAssociationRequest.md +0 -15
  171. data/docs/CreateServiceGoalGroupRequest.md +0 -15
  172. data/docs/ForecastGenerationResult.md +0 -13
  173. data/docs/ForecastGenerationRouteGroupResult.md +0 -14
  174. data/docs/ForecastResultResponse.md +0 -14
  175. data/docs/ForecastTimeSeriesResult.md +0 -14
  176. data/docs/GenerateShortTermForecastRequest.md +0 -13
  177. data/docs/GenerateShortTermForecastResponse.md +0 -16
  178. data/docs/GenerateWeekScheduleRequest.md +0 -14
  179. data/docs/GenerateWeekScheduleResponse.md +0 -15
  180. data/docs/ImportShortTermForecastRequest.md +0 -16
  181. data/docs/ImportWeekScheduleRequest.md +0 -17
  182. data/docs/IntradayDataGroup.md +0 -19
  183. data/docs/IntradayForecastData.md +0 -15
  184. data/docs/IntradayHistoricalAgentData.md +0 -14
  185. data/docs/IntradayHistoricalQueueData.md +0 -20
  186. data/docs/IntradayMetric.md +0 -14
  187. data/docs/IntradayPerformancePredictionAgentData.md +0 -13
  188. data/docs/IntradayPerformancePredictionQueueData.md +0 -15
  189. data/docs/IntradayQueryDataCommand.md +0 -17
  190. data/docs/IntradayQueue.md +0 -15
  191. data/docs/IntradayResponse.md +0 -20
  192. data/docs/IntradayScheduleData.md +0 -14
  193. data/docs/ListWrapperForecastSourceDayPointer.md +0 -13
  194. data/docs/ListWrapperWfmForecastModification.md +0 -13
  195. data/docs/QueueMediaAssociation.md +0 -16
  196. data/docs/RescheduleRequest.md +0 -20
  197. data/docs/RescheduleResult.md +0 -13
  198. data/docs/ReschedulingOptionsResponse.md +0 -22
  199. data/docs/RouteGroup.md +0 -18
  200. data/docs/RouteGroupAttributes.md +0 -16
  201. data/docs/RouteGroupList.md +0 -14
  202. data/docs/SchedulingRunListResponse.md +0 -13
  203. data/docs/SchedulingRunResponse.md +0 -28
  204. data/docs/ServiceGoalGroup.md +0 -18
  205. data/docs/ServiceGoalGroupGoals.md +0 -15
  206. data/docs/ServiceGoalGroupList.md +0 -14
  207. data/docs/ShortTermForecast.md +0 -22
  208. data/docs/ShortTermForecastListItemResponse.md +0 -18
  209. data/docs/ShortTermForecastListResponse.md +0 -13
  210. data/docs/ShortTermForecastResponse.md +0 -15
  211. data/docs/TimeOffRequestEntityList.md +0 -13
  212. data/docs/TimeOffRequestLookupList.md +0 -13
  213. data/docs/UnscheduledAgentWarning.md +0 -14
  214. data/docs/UpdateWeekScheduleRequest.md +0 -21
  215. data/docs/UserSchedulesPartialUploadRequest.md +0 -13
  216. data/docs/WfmAbandonRate.md +0 -14
  217. data/docs/WfmAverageSpeedOfAnswer.md +0 -14
  218. data/docs/WfmForecastModification.md +0 -20
  219. data/docs/WfmForecastModificationAttributes.md +0 -16
  220. data/docs/WfmIntradayQueueListing.md +0 -14
  221. data/docs/WfmServiceLevel.md +0 -15
  222. data/lib/purecloudplatformclientv2/models/async_week_schedule_response.rb +0 -295
  223. data/lib/purecloudplatformclientv2/models/forecast_generation_result.rb +0 -204
  224. data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +0 -256
  225. data/lib/purecloudplatformclientv2/models/generate_short_term_forecast_response.rb +0 -294
  226. data/lib/purecloudplatformclientv2/models/generate_week_schedule_response.rb +0 -269
  227. data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +0 -384
  228. data/lib/purecloudplatformclientv2/models/intraday_forecast_data.rb +0 -254
  229. data/lib/purecloudplatformclientv2/models/intraday_historical_agent_data.rb +0 -228
  230. data/lib/purecloudplatformclientv2/models/intraday_historical_queue_data.rb +0 -384
  231. data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_agent_data.rb +0 -202
  232. data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_queue_data.rb +0 -254
  233. data/lib/purecloudplatformclientv2/models/intraday_response.rb +0 -404
  234. data/lib/purecloudplatformclientv2/models/intraday_schedule_data.rb +0 -228
  235. data/lib/purecloudplatformclientv2/models/queue_media_association.rb +0 -283
  236. data/lib/purecloudplatformclientv2/models/reschedule_request.rb +0 -418
  237. data/lib/purecloudplatformclientv2/models/reschedule_result.rb +0 -202
  238. data/lib/purecloudplatformclientv2/models/route_group.rb +0 -363
  239. data/lib/purecloudplatformclientv2/models/route_group_attributes.rb +0 -307
  240. data/lib/purecloudplatformclientv2/models/scheduling_run_response.rb +0 -609
  241. data/lib/purecloudplatformclientv2/models/time_off_request_entity_list.rb +0 -203
  242. data/lib/purecloudplatformclientv2/models/unscheduled_agent_warning.rb +0 -242
  243. data/lib/purecloudplatformclientv2/models/update_week_schedule_request.rb +0 -438
  244. data/lib/purecloudplatformclientv2/models/wfm_forecast_modification.rb +0 -435
@@ -13,6 +13,8 @@ title: FlowDivisionView
13
13
  | **type** | **String** | | [optional] |
14
14
  | **input_schema** | [**JsonSchemaDocument**](JsonSchemaDocument.html) | json schema describing the inputs for the flow | [optional] |
15
15
  | **output_schema** | [**JsonSchemaDocument**](JsonSchemaDocument.html) | json schema describing the outputs for the flow | [optional] |
16
+ | **published_version** | [**FlowVersion**](FlowVersion.html) | published version information if there is a published version | [optional] |
17
+ | **debug_version** | [**FlowVersion**](FlowVersion.html) | debug version information if there is a debug version | [optional] |
16
18
  | **self_uri** | **String** | The URI for this object | [optional] |
17
19
  {: class="table table-striped"}
18
20
 
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: IntentDefinition
3
+ ---
4
+ ## PureCloud::IntentDefinition
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **name** | **String** | The name of the intent. | |
11
+ | **entity_type_bindings** | [**Array<NamedEntityTypeBinding>**](NamedEntityTypeBinding.html) | The bindings for the named entity types used in this intent. | |
12
+ | **utterances** | [**Array<NluUtterance>**](NluUtterance.html) | The utterances that act as training phrases for the intent. | |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: IntentFeedback
3
+ ---
4
+ ## PureCloud::IntentFeedback
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **name** | **String** | The name of the detected intent. | [optional] |
11
+ | **probability** | **Float** | The probability of the detected intent. | [optional] |
12
+ | **entities** | [**Array<DetectedNamedEntity>**](DetectedNamedEntity.html) | The collection of named entities detected. | [optional] |
13
+ | **assessment** | **String** | The assessment on the detection for feedback text. | [optional] |
14
+ {: class="table table-striped"}
15
+
16
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: ItemValidationLimits
3
+ ---
4
+ ## PureCloud::ItemValidationLimits
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **min_length** | [**MinLength**](MinLength.html) | A structure denoting the system-imposed minimum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. | |
11
+ | **max_length** | [**MaxLength**](MaxLength.html) | A structure denoting the system-imposed minimum and maximum string length (for text-based core types) or numeric values (for number-based) core types. For example, the validationLimits for a text-based core type specify the min/max values for a minimum string length (minLength) constraint supplied by a schemaauthor on a text field. Similarly, the maxLength's min/max specifies maximum string length constraint supplied by a schema author for the same field. | |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: Items
3
+ ---
4
+ ## PureCloud::Items
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **type** | **String** | | [optional] |
11
+ | **pattern** | **String** | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,1160 @@
1
+ ---
2
+ title: LanguageUnderstandingApi
3
+ ---
4
+
5
+ ## PureCloud::LanguageUnderstandingApi
6
+
7
+ All URIs are relative to *https://api.mypurecloud.com*
8
+
9
+ Method | Description
10
+ ------------- | ------------- | -------------
11
+ [**delete_languageunderstanding_domain**](LanguageUnderstandingApi.html#delete_languageunderstanding_domain) | Delete an NLU Domain.
12
+ [**delete_languageunderstanding_domain_feedback_feedback_id**](LanguageUnderstandingApi.html#delete_languageunderstanding_domain_feedback_feedback_id) | Delete the feedback on the NLU Domain Version.
13
+ [**get_languageunderstanding_domain**](LanguageUnderstandingApi.html#get_languageunderstanding_domain) | Find an NLU Domain.
14
+ [**get_languageunderstanding_domain_feedback**](LanguageUnderstandingApi.html#get_languageunderstanding_domain_feedback) | Get all feedback in the given NLU Domain Version.
15
+ [**get_languageunderstanding_domain_feedback_feedback_id**](LanguageUnderstandingApi.html#get_languageunderstanding_domain_feedback_feedback_id) | Find a Feedback
16
+ [**get_languageunderstanding_domain_version**](LanguageUnderstandingApi.html#get_languageunderstanding_domain_version) | Find an NLU Domain Version.
17
+ [**get_languageunderstanding_domain_version_report**](LanguageUnderstandingApi.html#get_languageunderstanding_domain_version_report) | Retrieved quality report for the specified NLU Domain Version
18
+ [**get_languageunderstanding_domain_versions**](LanguageUnderstandingApi.html#get_languageunderstanding_domain_versions) | Get all NLU Domain Versions for a given Domain.
19
+ [**get_languageunderstanding_domains**](LanguageUnderstandingApi.html#get_languageunderstanding_domains) | Get all NLU Domains.
20
+ [**patch_languageunderstanding_domain**](LanguageUnderstandingApi.html#patch_languageunderstanding_domain) | Update an NLU Domain.
21
+ [**post_languageunderstanding_domain_feedback**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_feedback) | Create feedback for the NLU Domain Version.
22
+ [**post_languageunderstanding_domain_version_detect**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_detect) | Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
23
+ [**post_languageunderstanding_domain_version_publish**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_publish) | Publish the draft NLU Domain Version.
24
+ [**post_languageunderstanding_domain_version_train**](LanguageUnderstandingApi.html#post_languageunderstanding_domain_version_train) | Train the draft NLU Domain Version.
25
+ [**post_languageunderstanding_domains**](LanguageUnderstandingApi.html#post_languageunderstanding_domains) | Create an NLU Domain.
26
+ [**put_languageunderstanding_domain_version**](LanguageUnderstandingApi.html#put_languageunderstanding_domain_version) | Update an NLU Domain Version.
27
+ {: class="table table-striped"}
28
+
29
+ <a name="delete_languageunderstanding_domain"></a>
30
+
31
+ ## delete_languageunderstanding_domain(domain_id)
32
+
33
+
34
+
35
+ Delete an NLU Domain.
36
+
37
+
38
+
39
+ Wraps DELETE /api/v2/languageunderstanding/domains/{domainId}
40
+
41
+ Requires ANY permissions:
42
+
43
+ * languageUnderstanding:nluDomain:delete
44
+ * dialog:bot:delete
45
+
46
+
47
+ ### Example
48
+ ```{"language":"ruby"}
49
+ # load the gem
50
+ require 'purecloudplatformclientv2'
51
+ # setup authorization
52
+ @secret = ENV['PURECLOUD_SECRET']
53
+ @id = ENV['PURECLOUD_CLIENT_ID']
54
+ environment = "mypurecloud.com"
55
+
56
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
57
+
58
+ PureCloud.configure do |config|
59
+ config.access_token = @authToken
60
+ end
61
+
62
+ api_instance = PureCloud::LanguageUnderstandingApi.new
63
+
64
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
65
+
66
+
67
+ begin
68
+ #Delete an NLU Domain.
69
+ api_instance.delete_languageunderstanding_domain(domain_id)
70
+ rescue PureCloud::ApiError => e
71
+ puts "Exception when calling LanguageUnderstandingApi->delete_languageunderstanding_domain: #{e}"
72
+ end
73
+ ```
74
+
75
+ ### Parameters
76
+
77
+ Name | Type | Description | Notes
78
+ ------------- | ------------- | ------------- | -------------
79
+ **domain_id** | **String**| ID of the NLU domain. | |
80
+ {: class="table table-striped"}
81
+
82
+
83
+ ### Return type
84
+
85
+ nil (empty response body)
86
+
87
+ ### HTTP request headers
88
+
89
+ - **Content-Type**: application/json
90
+ - **Accept**: application/json
91
+
92
+
93
+
94
+ <a name="delete_languageunderstanding_domain_feedback_feedback_id"></a>
95
+
96
+ ## delete_languageunderstanding_domain_feedback_feedback_id(domain_id, feedback_id)
97
+
98
+
99
+
100
+ Delete the feedback on the NLU Domain Version.
101
+
102
+
103
+
104
+ Wraps DELETE /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}
105
+
106
+ Requires ANY permissions:
107
+
108
+ * languageUnderstanding:feedback:delete
109
+ * dialog:bot:delete
110
+
111
+
112
+ ### Example
113
+ ```{"language":"ruby"}
114
+ # load the gem
115
+ require 'purecloudplatformclientv2'
116
+ # setup authorization
117
+ @secret = ENV['PURECLOUD_SECRET']
118
+ @id = ENV['PURECLOUD_CLIENT_ID']
119
+ environment = "mypurecloud.com"
120
+
121
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
122
+
123
+ PureCloud.configure do |config|
124
+ config.access_token = @authToken
125
+ end
126
+
127
+ api_instance = PureCloud::LanguageUnderstandingApi.new
128
+
129
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
130
+
131
+ feedback_id = "feedback_id_example" # String | ID of the Feedback
132
+
133
+
134
+ begin
135
+ #Delete the feedback on the NLU Domain Version.
136
+ api_instance.delete_languageunderstanding_domain_feedback_feedback_id(domain_id, feedback_id)
137
+ rescue PureCloud::ApiError => e
138
+ puts "Exception when calling LanguageUnderstandingApi->delete_languageunderstanding_domain_feedback_feedback_id: #{e}"
139
+ end
140
+ ```
141
+
142
+ ### Parameters
143
+
144
+ Name | Type | Description | Notes
145
+ ------------- | ------------- | ------------- | -------------
146
+ **domain_id** | **String**| ID of the NLU domain. | |
147
+ **feedback_id** | **String**| ID of the Feedback | |
148
+ {: class="table table-striped"}
149
+
150
+
151
+ ### Return type
152
+
153
+ nil (empty response body)
154
+
155
+ ### HTTP request headers
156
+
157
+ - **Content-Type**: application/json
158
+ - **Accept**: application/json
159
+
160
+
161
+
162
+ <a name="get_languageunderstanding_domain"></a>
163
+
164
+ ## [**NluDomain**](NluDomain.html) get_languageunderstanding_domain(domain_id)
165
+
166
+
167
+
168
+ Find an NLU Domain.
169
+
170
+
171
+
172
+ Wraps GET /api/v2/languageunderstanding/domains/{domainId}
173
+
174
+ Requires ANY permissions:
175
+
176
+ * languageUnderstanding:nluDomain:view
177
+ * dialog:bot:view
178
+
179
+
180
+ ### Example
181
+ ```{"language":"ruby"}
182
+ # load the gem
183
+ require 'purecloudplatformclientv2'
184
+ # setup authorization
185
+ @secret = ENV['PURECLOUD_SECRET']
186
+ @id = ENV['PURECLOUD_CLIENT_ID']
187
+ environment = "mypurecloud.com"
188
+
189
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
190
+
191
+ PureCloud.configure do |config|
192
+ config.access_token = @authToken
193
+ end
194
+
195
+ api_instance = PureCloud::LanguageUnderstandingApi.new
196
+
197
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
198
+
199
+
200
+ begin
201
+ #Find an NLU Domain.
202
+ result = api_instance.get_languageunderstanding_domain(domain_id)
203
+ p result
204
+ rescue PureCloud::ApiError => e
205
+ puts "Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain: #{e}"
206
+ end
207
+ ```
208
+
209
+ ### Parameters
210
+
211
+ Name | Type | Description | Notes
212
+ ------------- | ------------- | ------------- | -------------
213
+ **domain_id** | **String**| ID of the NLU domain. | |
214
+ {: class="table table-striped"}
215
+
216
+
217
+ ### Return type
218
+
219
+ [**NluDomain**](NluDomain.html)
220
+
221
+ ### HTTP request headers
222
+
223
+ - **Content-Type**: application/json
224
+ - **Accept**: application/json
225
+
226
+
227
+
228
+ <a name="get_languageunderstanding_domain_feedback"></a>
229
+
230
+ ## [**NluFeedbackListing**](NluFeedbackListing.html) get_languageunderstanding_domain_feedback(domain_id, opts)
231
+
232
+
233
+
234
+ Get all feedback in the given NLU Domain Version.
235
+
236
+
237
+
238
+ Wraps GET /api/v2/languageunderstanding/domains/{domainId}/feedback
239
+
240
+ Requires ANY permissions:
241
+
242
+ * languageUnderstanding:feedback:view
243
+ * dialog:bot:view
244
+
245
+
246
+ ### Example
247
+ ```{"language":"ruby"}
248
+ # load the gem
249
+ require 'purecloudplatformclientv2'
250
+ # setup authorization
251
+ @secret = ENV['PURECLOUD_SECRET']
252
+ @id = ENV['PURECLOUD_CLIENT_ID']
253
+ environment = "mypurecloud.com"
254
+
255
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
256
+
257
+ PureCloud.configure do |config|
258
+ config.access_token = @authToken
259
+ end
260
+
261
+ api_instance = PureCloud::LanguageUnderstandingApi.new
262
+
263
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
264
+
265
+ opts = {
266
+ intent_name: "intent_name_example", # String | The top intent name to retrieve feedback for.
267
+ assessment: "assessment_example", # String | The top assessment to retrieve feedback for.
268
+ date_start: Date.parse("2013-10-20"), # Date | Begin of time window as ISO-8601 date.
269
+ date_end: Date.parse("2013-10-20"), # Date | End of time window as ISO-8601 date.
270
+ include_deleted: true, # BOOLEAN | Whether to include soft-deleted items in the result.
271
+ page_number: 1, # Integer | Page number
272
+ page_size: 25, # Integer | Page size
273
+ fields: ["fields_example"] # Array<String> | Fields and properties to get, comma-separated
274
+ }
275
+
276
+ begin
277
+ #Get all feedback in the given NLU Domain Version.
278
+ result = api_instance.get_languageunderstanding_domain_feedback(domain_id, opts)
279
+ p result
280
+ rescue PureCloud::ApiError => e
281
+ puts "Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain_feedback: #{e}"
282
+ end
283
+ ```
284
+
285
+ ### Parameters
286
+
287
+ Name | Type | Description | Notes
288
+ ------------- | ------------- | ------------- | -------------
289
+ **domain_id** | **String**| ID of the NLU domain. | |
290
+ **intent_name** | **String**| The top intent name to retrieve feedback for. | [optional] |
291
+ **assessment** | **String**| The top assessment to retrieve feedback for. | [optional] <br />**Values**: Incorrect, Correct, Unknown |
292
+ **date_start** | **Date**| Begin of time window as ISO-8601 date. | [optional] |
293
+ **date_end** | **Date**| End of time window as ISO-8601 date. | [optional] |
294
+ **include_deleted** | **BOOLEAN**| Whether to include soft-deleted items in the result. | [optional] |
295
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
296
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
297
+ **fields** | [**Array&lt;String&gt;**](String.html)| Fields and properties to get, comma-separated | [optional] <br />**Values**: version, dateCreated, text, intents |
298
+ {: class="table table-striped"}
299
+
300
+
301
+ ### Return type
302
+
303
+ [**NluFeedbackListing**](NluFeedbackListing.html)
304
+
305
+ ### HTTP request headers
306
+
307
+ - **Content-Type**: application/json
308
+ - **Accept**: application/json
309
+
310
+
311
+
312
+ <a name="get_languageunderstanding_domain_feedback_feedback_id"></a>
313
+
314
+ ## [**NluFeedbackResponse**](NluFeedbackResponse.html) get_languageunderstanding_domain_feedback_feedback_id(domain_id, feedback_id, opts)
315
+
316
+
317
+
318
+ Find a Feedback
319
+
320
+
321
+
322
+ Wraps GET /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}
323
+
324
+ Requires ANY permissions:
325
+
326
+ * languageUnderstanding:feedback:view
327
+ * dialog:bot:view
328
+
329
+
330
+ ### Example
331
+ ```{"language":"ruby"}
332
+ # load the gem
333
+ require 'purecloudplatformclientv2'
334
+ # setup authorization
335
+ @secret = ENV['PURECLOUD_SECRET']
336
+ @id = ENV['PURECLOUD_CLIENT_ID']
337
+ environment = "mypurecloud.com"
338
+
339
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
340
+
341
+ PureCloud.configure do |config|
342
+ config.access_token = @authToken
343
+ end
344
+
345
+ api_instance = PureCloud::LanguageUnderstandingApi.new
346
+
347
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
348
+
349
+ feedback_id = "feedback_id_example" # String | ID of the Feedback
350
+
351
+ opts = {
352
+ fields: ["fields_example"] # Array<String> | Fields and properties to get, comma-separated
353
+ }
354
+
355
+ begin
356
+ #Find a Feedback
357
+ result = api_instance.get_languageunderstanding_domain_feedback_feedback_id(domain_id, feedback_id, opts)
358
+ p result
359
+ rescue PureCloud::ApiError => e
360
+ puts "Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain_feedback_feedback_id: #{e}"
361
+ end
362
+ ```
363
+
364
+ ### Parameters
365
+
366
+ Name | Type | Description | Notes
367
+ ------------- | ------------- | ------------- | -------------
368
+ **domain_id** | **String**| ID of the NLU domain. | |
369
+ **feedback_id** | **String**| ID of the Feedback | |
370
+ **fields** | [**Array&lt;String&gt;**](String.html)| Fields and properties to get, comma-separated | [optional] <br />**Values**: version, dateCreated, text, intents |
371
+ {: class="table table-striped"}
372
+
373
+
374
+ ### Return type
375
+
376
+ [**NluFeedbackResponse**](NluFeedbackResponse.html)
377
+
378
+ ### HTTP request headers
379
+
380
+ - **Content-Type**: application/json
381
+ - **Accept**: application/json
382
+
383
+
384
+
385
+ <a name="get_languageunderstanding_domain_version"></a>
386
+
387
+ ## [**NluDomainVersion**](NluDomainVersion.html) get_languageunderstanding_domain_version(domain_id, domain_version_id, opts)
388
+
389
+
390
+
391
+ Find an NLU Domain Version.
392
+
393
+
394
+
395
+ Wraps GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}
396
+
397
+ Requires ANY permissions:
398
+
399
+ * languageUnderstanding:nluDomainVersion:view
400
+ * dialog:botVersion:view
401
+
402
+
403
+ ### Example
404
+ ```{"language":"ruby"}
405
+ # load the gem
406
+ require 'purecloudplatformclientv2'
407
+ # setup authorization
408
+ @secret = ENV['PURECLOUD_SECRET']
409
+ @id = ENV['PURECLOUD_CLIENT_ID']
410
+ environment = "mypurecloud.com"
411
+
412
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
413
+
414
+ PureCloud.configure do |config|
415
+ config.access_token = @authToken
416
+ end
417
+
418
+ api_instance = PureCloud::LanguageUnderstandingApi.new
419
+
420
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
421
+
422
+ domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
423
+
424
+ opts = {
425
+ include_utterances: true # BOOLEAN | Whether utterances for intent definition should be included when marshalling response.
426
+ }
427
+
428
+ begin
429
+ #Find an NLU Domain Version.
430
+ result = api_instance.get_languageunderstanding_domain_version(domain_id, domain_version_id, opts)
431
+ p result
432
+ rescue PureCloud::ApiError => e
433
+ puts "Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain_version: #{e}"
434
+ end
435
+ ```
436
+
437
+ ### Parameters
438
+
439
+ Name | Type | Description | Notes
440
+ ------------- | ------------- | ------------- | -------------
441
+ **domain_id** | **String**| ID of the NLU domain. | |
442
+ **domain_version_id** | **String**| ID of the NLU domain version. | |
443
+ **include_utterances** | **BOOLEAN**| Whether utterances for intent definition should be included when marshalling response. | [optional] |
444
+ {: class="table table-striped"}
445
+
446
+
447
+ ### Return type
448
+
449
+ [**NluDomainVersion**](NluDomainVersion.html)
450
+
451
+ ### HTTP request headers
452
+
453
+ - **Content-Type**: application/json
454
+ - **Accept**: application/json
455
+
456
+
457
+
458
+ <a name="get_languageunderstanding_domain_version_report"></a>
459
+
460
+ ## [**NluDomainVersionQualityReport**](NluDomainVersionQualityReport.html) get_languageunderstanding_domain_version_report(domain_id, domain_version_id)
461
+
462
+
463
+
464
+ Retrieved quality report for the specified NLU Domain Version
465
+
466
+
467
+
468
+ Wraps GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report
469
+
470
+ Requires ANY permissions:
471
+
472
+ * languageUnderstanding:nluDomainVersion:view
473
+ * dialog:botVersion:view
474
+
475
+
476
+ ### Example
477
+ ```{"language":"ruby"}
478
+ # load the gem
479
+ require 'purecloudplatformclientv2'
480
+ # setup authorization
481
+ @secret = ENV['PURECLOUD_SECRET']
482
+ @id = ENV['PURECLOUD_CLIENT_ID']
483
+ environment = "mypurecloud.com"
484
+
485
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
486
+
487
+ PureCloud.configure do |config|
488
+ config.access_token = @authToken
489
+ end
490
+
491
+ api_instance = PureCloud::LanguageUnderstandingApi.new
492
+
493
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
494
+
495
+ domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
496
+
497
+
498
+ begin
499
+ #Retrieved quality report for the specified NLU Domain Version
500
+ result = api_instance.get_languageunderstanding_domain_version_report(domain_id, domain_version_id)
501
+ p result
502
+ rescue PureCloud::ApiError => e
503
+ puts "Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain_version_report: #{e}"
504
+ end
505
+ ```
506
+
507
+ ### Parameters
508
+
509
+ Name | Type | Description | Notes
510
+ ------------- | ------------- | ------------- | -------------
511
+ **domain_id** | **String**| ID of the NLU domain. | |
512
+ **domain_version_id** | **String**| ID of the NLU domain version. | |
513
+ {: class="table table-striped"}
514
+
515
+
516
+ ### Return type
517
+
518
+ [**NluDomainVersionQualityReport**](NluDomainVersionQualityReport.html)
519
+
520
+ ### HTTP request headers
521
+
522
+ - **Content-Type**: application/json
523
+ - **Accept**: application/json
524
+
525
+
526
+
527
+ <a name="get_languageunderstanding_domain_versions"></a>
528
+
529
+ ## [**NluDomainVersionListing**](NluDomainVersionListing.html) get_languageunderstanding_domain_versions(domain_id, opts)
530
+
531
+
532
+
533
+ Get all NLU Domain Versions for a given Domain.
534
+
535
+
536
+
537
+ Wraps GET /api/v2/languageunderstanding/domains/{domainId}/versions
538
+
539
+ Requires ANY permissions:
540
+
541
+ * languageUnderstanding:nluDomainVersion:view
542
+ * dialog:botVersion:view
543
+
544
+
545
+ ### Example
546
+ ```{"language":"ruby"}
547
+ # load the gem
548
+ require 'purecloudplatformclientv2'
549
+ # setup authorization
550
+ @secret = ENV['PURECLOUD_SECRET']
551
+ @id = ENV['PURECLOUD_CLIENT_ID']
552
+ environment = "mypurecloud.com"
553
+
554
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
555
+
556
+ PureCloud.configure do |config|
557
+ config.access_token = @authToken
558
+ end
559
+
560
+ api_instance = PureCloud::LanguageUnderstandingApi.new
561
+
562
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
563
+
564
+ opts = {
565
+ include_utterances: true, # BOOLEAN | Whether utterances for intent definition should be included when marshalling response.
566
+ page_number: 1, # Integer | Page number
567
+ page_size: 25 # Integer | Page size
568
+ }
569
+
570
+ begin
571
+ #Get all NLU Domain Versions for a given Domain.
572
+ result = api_instance.get_languageunderstanding_domain_versions(domain_id, opts)
573
+ p result
574
+ rescue PureCloud::ApiError => e
575
+ puts "Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain_versions: #{e}"
576
+ end
577
+ ```
578
+
579
+ ### Parameters
580
+
581
+ Name | Type | Description | Notes
582
+ ------------- | ------------- | ------------- | -------------
583
+ **domain_id** | **String**| ID of the NLU domain. | |
584
+ **include_utterances** | **BOOLEAN**| Whether utterances for intent definition should be included when marshalling response. | [optional] |
585
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
586
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
587
+ {: class="table table-striped"}
588
+
589
+
590
+ ### Return type
591
+
592
+ [**NluDomainVersionListing**](NluDomainVersionListing.html)
593
+
594
+ ### HTTP request headers
595
+
596
+ - **Content-Type**: application/json
597
+ - **Accept**: application/json
598
+
599
+
600
+
601
+ <a name="get_languageunderstanding_domains"></a>
602
+
603
+ ## [**NluDomainListing**](NluDomainListing.html) get_languageunderstanding_domains(opts)
604
+
605
+
606
+
607
+ Get all NLU Domains.
608
+
609
+
610
+
611
+ Wraps GET /api/v2/languageunderstanding/domains
612
+
613
+ Requires ANY permissions:
614
+
615
+ * languageUnderstanding:nluDomain:view
616
+ * dialog:bot:view
617
+
618
+
619
+ ### Example
620
+ ```{"language":"ruby"}
621
+ # load the gem
622
+ require 'purecloudplatformclientv2'
623
+ # setup authorization
624
+ @secret = ENV['PURECLOUD_SECRET']
625
+ @id = ENV['PURECLOUD_CLIENT_ID']
626
+ environment = "mypurecloud.com"
627
+
628
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
629
+
630
+ PureCloud.configure do |config|
631
+ config.access_token = @authToken
632
+ end
633
+
634
+ api_instance = PureCloud::LanguageUnderstandingApi.new
635
+
636
+ opts = {
637
+ page_number: 1, # Integer | Page number
638
+ page_size: 25 # Integer | Page size
639
+ }
640
+
641
+ begin
642
+ #Get all NLU Domains.
643
+ result = api_instance.get_languageunderstanding_domains(opts)
644
+ p result
645
+ rescue PureCloud::ApiError => e
646
+ puts "Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domains: #{e}"
647
+ end
648
+ ```
649
+
650
+ ### Parameters
651
+
652
+ Name | Type | Description | Notes
653
+ ------------- | ------------- | ------------- | -------------
654
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
655
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
656
+ {: class="table table-striped"}
657
+
658
+
659
+ ### Return type
660
+
661
+ [**NluDomainListing**](NluDomainListing.html)
662
+
663
+ ### HTTP request headers
664
+
665
+ - **Content-Type**: application/json
666
+ - **Accept**: application/json
667
+
668
+
669
+
670
+ <a name="patch_languageunderstanding_domain"></a>
671
+
672
+ ## [**NluDomain**](NluDomain.html) patch_languageunderstanding_domain(domain_id, opts)
673
+
674
+
675
+
676
+ Update an NLU Domain.
677
+
678
+
679
+
680
+ Wraps PATCH /api/v2/languageunderstanding/domains/{domainId}
681
+
682
+ Requires ANY permissions:
683
+
684
+ * languageUnderstanding:nluDomain:edit
685
+ * dialog:bot:edit
686
+
687
+
688
+ ### Example
689
+ ```{"language":"ruby"}
690
+ # load the gem
691
+ require 'purecloudplatformclientv2'
692
+ # setup authorization
693
+ @secret = ENV['PURECLOUD_SECRET']
694
+ @id = ENV['PURECLOUD_CLIENT_ID']
695
+ environment = "mypurecloud.com"
696
+
697
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
698
+
699
+ PureCloud.configure do |config|
700
+ config.access_token = @authToken
701
+ end
702
+
703
+ api_instance = PureCloud::LanguageUnderstandingApi.new
704
+
705
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
706
+
707
+ opts = {
708
+ body: PureCloud::NluDomain.new # NluDomain |
709
+ }
710
+
711
+ begin
712
+ #Update an NLU Domain.
713
+ result = api_instance.patch_languageunderstanding_domain(domain_id, opts)
714
+ p result
715
+ rescue PureCloud::ApiError => e
716
+ puts "Exception when calling LanguageUnderstandingApi->patch_languageunderstanding_domain: #{e}"
717
+ end
718
+ ```
719
+
720
+ ### Parameters
721
+
722
+ Name | Type | Description | Notes
723
+ ------------- | ------------- | ------------- | -------------
724
+ **domain_id** | **String**| ID of the NLU domain. | |
725
+ **body** | [**NluDomain**](NluDomain.html)| | [optional] |
726
+ {: class="table table-striped"}
727
+
728
+
729
+ ### Return type
730
+
731
+ [**NluDomain**](NluDomain.html)
732
+
733
+ ### HTTP request headers
734
+
735
+ - **Content-Type**: application/json
736
+ - **Accept**: application/json
737
+
738
+
739
+
740
+ <a name="post_languageunderstanding_domain_feedback"></a>
741
+
742
+ ## [**NluFeedbackResponse**](NluFeedbackResponse.html) post_languageunderstanding_domain_feedback(domain_id, opts)
743
+
744
+
745
+
746
+ Create feedback for the NLU Domain Version.
747
+
748
+
749
+
750
+ Wraps POST /api/v2/languageunderstanding/domains/{domainId}/feedback
751
+
752
+ Requires ANY permissions:
753
+
754
+ * languageUnderstanding:feedback:add
755
+ * dialog:bot:add
756
+
757
+
758
+ ### Example
759
+ ```{"language":"ruby"}
760
+ # load the gem
761
+ require 'purecloudplatformclientv2'
762
+ # setup authorization
763
+ @secret = ENV['PURECLOUD_SECRET']
764
+ @id = ENV['PURECLOUD_CLIENT_ID']
765
+ environment = "mypurecloud.com"
766
+
767
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
768
+
769
+ PureCloud.configure do |config|
770
+ config.access_token = @authToken
771
+ end
772
+
773
+ api_instance = PureCloud::LanguageUnderstandingApi.new
774
+
775
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
776
+
777
+ opts = {
778
+ body: PureCloud::NluFeedbackRequest.new # NluFeedbackRequest |
779
+ }
780
+
781
+ begin
782
+ #Create feedback for the NLU Domain Version.
783
+ result = api_instance.post_languageunderstanding_domain_feedback(domain_id, opts)
784
+ p result
785
+ rescue PureCloud::ApiError => e
786
+ puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_feedback: #{e}"
787
+ end
788
+ ```
789
+
790
+ ### Parameters
791
+
792
+ Name | Type | Description | Notes
793
+ ------------- | ------------- | ------------- | -------------
794
+ **domain_id** | **String**| ID of the NLU domain. | |
795
+ **body** | [**NluFeedbackRequest**](NluFeedbackRequest.html)| | [optional] |
796
+ {: class="table table-striped"}
797
+
798
+
799
+ ### Return type
800
+
801
+ [**NluFeedbackResponse**](NluFeedbackResponse.html)
802
+
803
+ ### HTTP request headers
804
+
805
+ - **Content-Type**: application/json
806
+ - **Accept**: application/json
807
+
808
+
809
+
810
+ <a name="post_languageunderstanding_domain_version_detect"></a>
811
+
812
+ ## [**NluDetectionResponse**](NluDetectionResponse.html) post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, opts)
813
+
814
+
815
+
816
+ Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
817
+
818
+
819
+
820
+ Wraps POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect
821
+
822
+ Requires ANY permissions:
823
+
824
+ * languageUnderstanding:nluDomainVersion:view
825
+ * dialog:botVersion:view
826
+
827
+
828
+ ### Example
829
+ ```{"language":"ruby"}
830
+ # load the gem
831
+ require 'purecloudplatformclientv2'
832
+ # setup authorization
833
+ @secret = ENV['PURECLOUD_SECRET']
834
+ @id = ENV['PURECLOUD_CLIENT_ID']
835
+ environment = "mypurecloud.com"
836
+
837
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
838
+
839
+ PureCloud.configure do |config|
840
+ config.access_token = @authToken
841
+ end
842
+
843
+ api_instance = PureCloud::LanguageUnderstandingApi.new
844
+
845
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
846
+
847
+ domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
848
+
849
+ opts = {
850
+ body: PureCloud::NluDetectionRequest.new # NluDetectionRequest |
851
+ }
852
+
853
+ begin
854
+ #Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
855
+ result = api_instance.post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, opts)
856
+ p result
857
+ rescue PureCloud::ApiError => e
858
+ puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_version_detect: #{e}"
859
+ end
860
+ ```
861
+
862
+ ### Parameters
863
+
864
+ Name | Type | Description | Notes
865
+ ------------- | ------------- | ------------- | -------------
866
+ **domain_id** | **String**| ID of the NLU domain. | |
867
+ **domain_version_id** | **String**| ID of the NLU domain version. | |
868
+ **body** | [**NluDetectionRequest**](NluDetectionRequest.html)| | [optional] |
869
+ {: class="table table-striped"}
870
+
871
+
872
+ ### Return type
873
+
874
+ [**NluDetectionResponse**](NluDetectionResponse.html)
875
+
876
+ ### HTTP request headers
877
+
878
+ - **Content-Type**: application/json
879
+ - **Accept**: application/json
880
+
881
+
882
+
883
+ <a name="post_languageunderstanding_domain_version_publish"></a>
884
+
885
+ ## [**NluDomainVersion**](NluDomainVersion.html) post_languageunderstanding_domain_version_publish(domain_id, domain_version_id)
886
+
887
+
888
+
889
+ Publish the draft NLU Domain Version.
890
+
891
+
892
+
893
+ Wraps POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish
894
+
895
+ Requires ANY permissions:
896
+
897
+ * languageUnderstanding:nluDomainVersion:add
898
+ * dialog:botVersion:add
899
+
900
+
901
+ ### Example
902
+ ```{"language":"ruby"}
903
+ # load the gem
904
+ require 'purecloudplatformclientv2'
905
+ # setup authorization
906
+ @secret = ENV['PURECLOUD_SECRET']
907
+ @id = ENV['PURECLOUD_CLIENT_ID']
908
+ environment = "mypurecloud.com"
909
+
910
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
911
+
912
+ PureCloud.configure do |config|
913
+ config.access_token = @authToken
914
+ end
915
+
916
+ api_instance = PureCloud::LanguageUnderstandingApi.new
917
+
918
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
919
+
920
+ domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
921
+
922
+
923
+ begin
924
+ #Publish the draft NLU Domain Version.
925
+ result = api_instance.post_languageunderstanding_domain_version_publish(domain_id, domain_version_id)
926
+ p result
927
+ rescue PureCloud::ApiError => e
928
+ puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_version_publish: #{e}"
929
+ end
930
+ ```
931
+
932
+ ### Parameters
933
+
934
+ Name | Type | Description | Notes
935
+ ------------- | ------------- | ------------- | -------------
936
+ **domain_id** | **String**| ID of the NLU domain. | |
937
+ **domain_version_id** | **String**| ID of the NLU domain version. | |
938
+ {: class="table table-striped"}
939
+
940
+
941
+ ### Return type
942
+
943
+ [**NluDomainVersion**](NluDomainVersion.html)
944
+
945
+ ### HTTP request headers
946
+
947
+ - **Content-Type**: application/json
948
+ - **Accept**: application/json
949
+
950
+
951
+
952
+ <a name="post_languageunderstanding_domain_version_train"></a>
953
+
954
+ ## [**NluDomainVersionTrainingResponse**](NluDomainVersionTrainingResponse.html) post_languageunderstanding_domain_version_train(domain_id, domain_version_id)
955
+
956
+
957
+
958
+ Train the draft NLU Domain Version.
959
+
960
+
961
+
962
+ Wraps POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train
963
+
964
+ Requires ANY permissions:
965
+
966
+ * languageUnderstanding:nluDomainVersion:edit
967
+ * dialog:botVersion:edit
968
+
969
+
970
+ ### Example
971
+ ```{"language":"ruby"}
972
+ # load the gem
973
+ require 'purecloudplatformclientv2'
974
+ # setup authorization
975
+ @secret = ENV['PURECLOUD_SECRET']
976
+ @id = ENV['PURECLOUD_CLIENT_ID']
977
+ environment = "mypurecloud.com"
978
+
979
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
980
+
981
+ PureCloud.configure do |config|
982
+ config.access_token = @authToken
983
+ end
984
+
985
+ api_instance = PureCloud::LanguageUnderstandingApi.new
986
+
987
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
988
+
989
+ domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
990
+
991
+
992
+ begin
993
+ #Train the draft NLU Domain Version.
994
+ result = api_instance.post_languageunderstanding_domain_version_train(domain_id, domain_version_id)
995
+ p result
996
+ rescue PureCloud::ApiError => e
997
+ puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_version_train: #{e}"
998
+ end
999
+ ```
1000
+
1001
+ ### Parameters
1002
+
1003
+ Name | Type | Description | Notes
1004
+ ------------- | ------------- | ------------- | -------------
1005
+ **domain_id** | **String**| ID of the NLU domain. | |
1006
+ **domain_version_id** | **String**| ID of the NLU domain version. | |
1007
+ {: class="table table-striped"}
1008
+
1009
+
1010
+ ### Return type
1011
+
1012
+ [**NluDomainVersionTrainingResponse**](NluDomainVersionTrainingResponse.html)
1013
+
1014
+ ### HTTP request headers
1015
+
1016
+ - **Content-Type**: application/json
1017
+ - **Accept**: application/json
1018
+
1019
+
1020
+
1021
+ <a name="post_languageunderstanding_domains"></a>
1022
+
1023
+ ## [**NluDomain**](NluDomain.html) post_languageunderstanding_domains(opts)
1024
+
1025
+
1026
+
1027
+ Create an NLU Domain.
1028
+
1029
+
1030
+
1031
+ Wraps POST /api/v2/languageunderstanding/domains
1032
+
1033
+ Requires ANY permissions:
1034
+
1035
+ * languageUnderstanding:nluDomain:add
1036
+ * dialog:bot:add
1037
+
1038
+
1039
+ ### Example
1040
+ ```{"language":"ruby"}
1041
+ # load the gem
1042
+ require 'purecloudplatformclientv2'
1043
+ # setup authorization
1044
+ @secret = ENV['PURECLOUD_SECRET']
1045
+ @id = ENV['PURECLOUD_CLIENT_ID']
1046
+ environment = "mypurecloud.com"
1047
+
1048
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1049
+
1050
+ PureCloud.configure do |config|
1051
+ config.access_token = @authToken
1052
+ end
1053
+
1054
+ api_instance = PureCloud::LanguageUnderstandingApi.new
1055
+
1056
+ opts = {
1057
+ body: PureCloud::NluDomain.new # NluDomain |
1058
+ }
1059
+
1060
+ begin
1061
+ #Create an NLU Domain.
1062
+ result = api_instance.post_languageunderstanding_domains(opts)
1063
+ p result
1064
+ rescue PureCloud::ApiError => e
1065
+ puts "Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domains: #{e}"
1066
+ end
1067
+ ```
1068
+
1069
+ ### Parameters
1070
+
1071
+ Name | Type | Description | Notes
1072
+ ------------- | ------------- | ------------- | -------------
1073
+ **body** | [**NluDomain**](NluDomain.html)| | [optional] |
1074
+ {: class="table table-striped"}
1075
+
1076
+
1077
+ ### Return type
1078
+
1079
+ [**NluDomain**](NluDomain.html)
1080
+
1081
+ ### HTTP request headers
1082
+
1083
+ - **Content-Type**: application/json
1084
+ - **Accept**: application/json
1085
+
1086
+
1087
+
1088
+ <a name="put_languageunderstanding_domain_version"></a>
1089
+
1090
+ ## [**NluDomainVersion**](NluDomainVersion.html) put_languageunderstanding_domain_version(domain_id, domain_version_id, opts)
1091
+
1092
+
1093
+
1094
+ Update an NLU Domain Version.
1095
+
1096
+
1097
+
1098
+ Wraps PUT /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}
1099
+
1100
+ Requires ANY permissions:
1101
+
1102
+ * languageUnderstanding:nluDomainVersion:edit
1103
+ * dialog:botVersion:edit
1104
+
1105
+
1106
+ ### Example
1107
+ ```{"language":"ruby"}
1108
+ # load the gem
1109
+ require 'purecloudplatformclientv2'
1110
+ # setup authorization
1111
+ @secret = ENV['PURECLOUD_SECRET']
1112
+ @id = ENV['PURECLOUD_CLIENT_ID']
1113
+ environment = "mypurecloud.com"
1114
+
1115
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1116
+
1117
+ PureCloud.configure do |config|
1118
+ config.access_token = @authToken
1119
+ end
1120
+
1121
+ api_instance = PureCloud::LanguageUnderstandingApi.new
1122
+
1123
+ domain_id = "domain_id_example" # String | ID of the NLU domain.
1124
+
1125
+ domain_version_id = "domain_version_id_example" # String | ID of the NLU domain version.
1126
+
1127
+ opts = {
1128
+ body: PureCloud::NluDomainVersion.new # NluDomainVersion |
1129
+ }
1130
+
1131
+ begin
1132
+ #Update an NLU Domain Version.
1133
+ result = api_instance.put_languageunderstanding_domain_version(domain_id, domain_version_id, opts)
1134
+ p result
1135
+ rescue PureCloud::ApiError => e
1136
+ puts "Exception when calling LanguageUnderstandingApi->put_languageunderstanding_domain_version: #{e}"
1137
+ end
1138
+ ```
1139
+
1140
+ ### Parameters
1141
+
1142
+ Name | Type | Description | Notes
1143
+ ------------- | ------------- | ------------- | -------------
1144
+ **domain_id** | **String**| ID of the NLU domain. | |
1145
+ **domain_version_id** | **String**| ID of the NLU domain version. | |
1146
+ **body** | [**NluDomainVersion**](NluDomainVersion.html)| | [optional] |
1147
+ {: class="table table-striped"}
1148
+
1149
+
1150
+ ### Return type
1151
+
1152
+ [**NluDomainVersion**](NluDomainVersion.html)
1153
+
1154
+ ### HTTP request headers
1155
+
1156
+ - **Content-Type**: application/json
1157
+ - **Accept**: application/json
1158
+
1159
+
1160
+