purecloudplatformclientv2 85.0.1 → 86.0.0

data/docs/MaxLength.md

@@ -0,0 +1,14 @@
+---
+title: MaxLength
+---
+## PureCloud::MaxLength
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **min** | **Integer** | A non-negative integer for a text-based schema field denoting the minimum largest length string the field can contain for a schema instance. | |
+| **max** | **Integer** | A non-negative integer for a text-based schema field denoting the maximum largest string the field can contain for a schema instance. | |
+{: class="table table-striped"}
+
+

data/docs/Message.md

@@ -28,6 +28,7 @@ title: Message
 | **to_address** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
 | **from_address** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
 | **messages** | [**Array<MessageDetails>**](MessageDetails.html) | The messages sent on this communication channel. | [optional] |
+| **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/MinLength.md

@@ -0,0 +1,14 @@
+---
+title: MinLength
+---
+## PureCloud::MinLength
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **min** | **Integer** | A non-negative integer for a text-based schema field denoting the minimum smallest length a string field can contain for a schema instance. | |
+| **max** | **Integer** | A non-negative integer for a text-based schema field denoting the maximum smallest length string the field can contain for a schema instance. | |
+{: class="table table-striped"}
+
+

data/docs/NamedEntityAnnotation.md

@@ -0,0 +1,13 @@
+---
+title: NamedEntityAnnotation
+---
+## PureCloud::NamedEntityAnnotation
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the annotated named entity. | |
+{: class="table table-striped"}
+
+

data/docs/NamedEntityTypeBinding.md

@@ -0,0 +1,14 @@
+---
+title: NamedEntityTypeBinding
+---
+## PureCloud::NamedEntityTypeBinding
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entity_type** | **String** | The named entity type of the binding. It can be a built-in one such as builtin:number or a custom entity type such as BeverageType. | |
+| **entity_name** | **String** | The name that this named entity type is bound to. | |
+{: class="table table-striped"}
+
+

data/docs/NamedEntityTypeDefinition.md

@@ -0,0 +1,15 @@
+---
+title: NamedEntityTypeDefinition
+---
+## PureCloud::NamedEntityTypeDefinition
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the entity type. | |
+| **description** | **String** | Description of the of the named entity type. | [optional] |
+| **mechanism** | [**NamedEntityTypeMechanism**](NamedEntityTypeMechanism.html) | The mechanism enabling detection of the named entity type. | |
+{: class="table table-striped"}
+
+

data/docs/NamedEntityTypeItem.md

@@ -0,0 +1,14 @@
+---
+title: NamedEntityTypeItem
+---
+## PureCloud::NamedEntityTypeItem
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **value** | **String** | A value for an named entity type definition. | |
+| **synonyms** | **Array<String>** | Synonyms for the given named entity value. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NamedEntityTypeMechanism.md

@@ -0,0 +1,15 @@
+---
+title: NamedEntityTypeMechanism
+---
+## PureCloud::NamedEntityTypeMechanism
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **items** | [**Array<NamedEntityTypeItem>**](NamedEntityTypeItem.html) | The items that define the named entity type. | |
+| **restricted** | **BOOLEAN** | Whether the named entity type is restricted to the items provided. Default: false | [optional] |
+| **type** | **String** | The type of the mechanism. | |
+{: class="table table-striped"}
+
+

data/docs/NluConfusionMatrixColumn.md

@@ -0,0 +1,14 @@
+---
+title: NluConfusionMatrixColumn
+---
+## PureCloud::NluConfusionMatrixColumn
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the intent for the column. | |
+| **value** | **Float** | The confusion value between the intents | |
+{: class="table table-striped"}
+
+

data/docs/NluConfusionMatrixRow.md

@@ -0,0 +1,14 @@
+---
+title: NluConfusionMatrixRow
+---
+## PureCloud::NluConfusionMatrixRow
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the intent for the row. | |
+| **columns** | [**Array<NluConfusionMatrixColumn>**](NluConfusionMatrixColumn.html) | The columns of confusion matrix for the intent | |
+{: class="table table-striped"}
+
+

data/docs/NluDetectionContext.md

@@ -0,0 +1,14 @@
+---
+title: NluDetectionContext
+---
+## PureCloud::NluDetectionContext
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **intent** | [**ContextIntent**](ContextIntent.html) | Restrict detection to this intent. | [optional] |
+| **entity** | [**ContextEntity**](ContextEntity.html) | Use this entity to restrict detection. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluDetectionInput.md

@@ -0,0 +1,13 @@
+---
+title: NluDetectionInput
+---
+## PureCloud::NluDetectionInput
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **text** | **String** | The text to perform NLU detection on. | |
+{: class="table table-striped"}
+
+

data/docs/NluDetectionOutput.md

@@ -0,0 +1,14 @@
+---
+title: NluDetectionOutput
+---
+## PureCloud::NluDetectionOutput
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **intents** | [**Array<DetectedIntent>**](DetectedIntent.html) | The detected intents. | [optional] |
+| **dialog_acts** | [**Array<DetectedDialogAct>**](DetectedDialogAct.html) | The detected dialog acts. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluDetectionRequest.md

@@ -0,0 +1,14 @@
+---
+title: NluDetectionRequest
+---
+## PureCloud::NluDetectionRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **input** | [**NluDetectionInput**](NluDetectionInput.html) | The input subject to NLU detection. | |
+| **context** | [**NluDetectionContext**](NluDetectionContext.html) | The context for the input to NLU detection. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluDetectionResponse.md

@@ -0,0 +1,15 @@
+---
+title: NluDetectionResponse
+---
+## PureCloud::NluDetectionResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **version** | [**NluDomainVersion**](NluDomainVersion.html) | The NLU domain version which performed the detection. | [optional] |
+| **output** | [**NluDetectionOutput**](NluDetectionOutput.html) |  | [optional] |
+| **input** | [**NluDetectionInput**](NluDetectionInput.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluDomain.md

@@ -0,0 +1,19 @@
+---
+title: NluDomain
+---
+## PureCloud::NluDomain
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** | The name of the NLU domain. | |
+| **draft_version** | [**NluDomainVersion**](NluDomainVersion.html) | The draft version of that NLU domain. | [optional] |
+| **last_published_version** | [**NluDomainVersion**](NluDomainVersion.html) | The last published version of that NLU domain. | [optional] |
+| **date_created** | **DateTime** | The date when the NLU domain was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | The date when the NLU domain was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluDomainListing.md

@@ -0,0 +1,22 @@
+---
+title: NluDomainListing
+---
+## PureCloud::NluDomainListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<NluDomain>**](NluDomain.html) |  | [optional] |
+| **page_size** | **Integer** |  | [optional] |
+| **page_number** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **page_count** | **Integer** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluDomainVersion.md

@@ -0,0 +1,24 @@
+---
+title: NluDomainVersion
+---
+## PureCloud::NluDomainVersion
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **domain** | [**NluDomain**](NluDomain.html) | The NLU domain of the version. | [optional] |
+| **description** | **String** | The description of the NLU domain version. | [optional] |
+| **language** | **String** | The language that the NLU domain version supports. | [optional] |
+| **date_created** | **DateTime** | The date when the NLU domain version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_modified** | **DateTime** | The date when the NLU domain version was updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_trained** | **DateTime** | The date when the NLU domain version was trained. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_published** | **DateTime** | The date when the NLU domain version was published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **training_status** | **String** | The training status of the NLU domain version. | [optional] |
+| **intents** | [**Array<IntentDefinition>**](IntentDefinition.html) | The intents defined for this NLU domain version. | [optional] |
+| **entity_types** | [**Array<NamedEntityTypeDefinition>**](NamedEntityTypeDefinition.html) | The entity types defined for this NLU domain version. | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluDomainVersionListing.md

@@ -0,0 +1,22 @@
+---
+title: NluDomainVersionListing
+---
+## PureCloud::NluDomainVersionListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<NluDomainVersion>**](NluDomainVersion.html) |  | [optional] |
+| **page_size** | **Integer** |  | [optional] |
+| **page_number** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **page_count** | **Integer** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluDomainVersionQualityReport.md

@@ -0,0 +1,15 @@
+---
+title: NluDomainVersionQualityReport
+---
+## PureCloud::NluDomainVersionQualityReport
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **version** | [**NluDomainVersion**](NluDomainVersion.html) | The domain and version details of the quality report | |
+| **confusion_matrix** | [**Array<NluConfusionMatrixRow>**](NluConfusionMatrixRow.html) | The confusion matrix for the Domain Version | |
+| **summary** | [**NluQualityReportSummary**](NluQualityReportSummary.html) | The quality report summary for the Domain Version | |
+{: class="table table-striped"}
+
+

data/docs/NluDomainVersionTrainingResponse.md

@@ -0,0 +1,14 @@
+---
+title: NluDomainVersionTrainingResponse
+---
+## PureCloud::NluDomainVersionTrainingResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **message** | **String** | A message indicating result of the action. | [optional] |
+| **version** | [**NluDomainVersion**](NluDomainVersion.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluFeedbackListing.md

@@ -0,0 +1,22 @@
+---
+title: NluFeedbackListing
+---
+## PureCloud::NluFeedbackListing
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<NluFeedbackResponse>**](NluFeedbackResponse.html) |  | [optional] |
+| **page_size** | **Integer** |  | [optional] |
+| **page_number** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
+| **self_uri** | **String** |  | [optional] |
+| **next_uri** | **String** |  | [optional] |
+| **last_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
+| **page_count** | **Integer** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluFeedbackRequest.md

@@ -0,0 +1,15 @@
+---
+title: NluFeedbackRequest
+---
+## PureCloud::NluFeedbackRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **text** | **String** | The feedback text. | |
+| **intents** | [**Array<IntentFeedback>**](IntentFeedback.html) | Detected intent of the utterance | |
+| **version_id** | **String** | The domain version ID of the feedback. | |
+{: class="table table-striped"}
+
+

data/docs/NluFeedbackResponse.md

@@ -0,0 +1,18 @@
+---
+title: NluFeedbackResponse
+---
+## PureCloud::NluFeedbackResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **text** | **String** | The feedback text. | [optional] |
+| **intents** | [**Array<IntentFeedback>**](IntentFeedback.html) | Detected intent of the utterance | [optional] |
+| **version** | [**NluDomainVersion**](NluDomainVersion.html) | The domain version of the feedback. | [optional] |
+| **date_created** | **DateTime** | The date when the feedback was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/NluQualityReportSummary.md

@@ -0,0 +1,13 @@
+---
+title: NluQualityReportSummary
+---
+## PureCloud::NluQualityReportSummary
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **metrics** | [**Array<NluQualityReportSummaryMetric>**](NluQualityReportSummaryMetric.html) | The list of metrics in the summary | |
+{: class="table table-striped"}
+
+

data/docs/NluQualityReportSummaryMetric.md

@@ -0,0 +1,14 @@
+---
+title: NluQualityReportSummaryMetric
+---
+## PureCloud::NluQualityReportSummaryMetric
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the metric. e.g. recall, f1_score | |
+| **value** | **Float** | The value of the metric | |
+{: class="table table-striped"}
+
+