Sha256: e0ac3fd5d56df1233dd4f7a7b38e37200bfa6180734bd9b37d2e9be941c1d970

Contents?: true

Size: 1.93 KB

Versions: 59

Compression:

Stored size: 1.93 KB

Contents

---
title: Annotation
---
## PureCloud::Annotation

## Properties

|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
| **name** | **String** |  | [optional] |
| **type** | **String** |  | [optional] |
| **location** | **Integer** | Offset of annotation in milliseconds. | [optional] |
| **duration_ms** | **Integer** | Duration of annotation in milliseconds. | [optional] |
| **user** | [**User**](User.html) | User that created this annotation (if any). | [optional] |
| **description** | **String** | Text of annotation. | [optional] |
| **keyword_name** | **String** | The word or phrase which is being looked for with speech recognition. | [optional] |
| **confidence** | **Float** | Actual confidence that this is an accurate match. | [optional] |
| **keyword_set_id** | **String** | A unique identifier for the keyword set to which this spotted keyword belongs. | [optional] |
| **keyword_set_name** | **String** | The keyword set to which this spotted keyword belongs. | [optional] |
| **utterance** | **String** | The phonetic spellings for the phrase and alternate spellings. | [optional] |
| **time_begin** | **String** | Beginning time offset of the keyword spot match. | [optional] |
| **time_end** | **String** | Ending time offset of the keyword spot match. | [optional] |
| **keyword_confidence_threshold** | **String** | Configured sensitivity threshold that can be increased to lower false positives or decreased to reduce false negatives. | [optional] |
| **agent_score_modifier** | **String** | A modifier to the evaluation score when the phrase is spotted in the agent channel. | |
| **customer_score_modifier** | **String** | A modifier to the evaluation score when the phrase is spotted in the customer channel. | |
| **self_uri** | **String** | The URI for this object | [optional] |
{: class="table table-striped"}


Version data entries

59 entries across 59 versions & 2 rubygems

Version Path
purecloudplatformclientv2-3.1.6 docs/Annotation.md
purecloudplatformclientv2-3.1.5 docs/Annotation.md
purecloudplatformclientv2-3.1.4 docs/Annotation.md
purecloudplatformclientv2-3.1.3 docs/Annotation.md
purecloudplatformclientv2-3.1.2 docs/Annotation.md
purecloudplatformclientv2-3.1.1 docs/Annotation.md
purecloudplatformclientv2-3.1.0 docs/Annotation.md
purecloudplatformclientv2-3.0.0 docs/Annotation.md
purecloudplatformclientv2-2.0.40 docs/Annotation.md
purecloudplatformclientv2-2.0.39 docs/Annotation.md
purecloudplatformclientv2-2.0.38 docs/Annotation.md
purecloudplatformclientv2-2.0.37 docs/Annotation.md
purecloudplatformclientv2-2.0.36 docs/Annotation.md
purecloudplatformclientv2-2.0.35 docs/Annotation.md
purecloudplatformclientv2-2.0.33 docs/Annotation.md
purecloudplatformclientv2-2.0.32 docs/Annotation.md
purecloudplatformclientv2-2.0.30 docs/Annotation.md
purecloudplatformclientv2-2.0.23 docs/Annotation.md
purecloudplatformclientv2-2.0.21 docs/Annotation.md
purecloudplatformclientv2-2.0.18 docs/Annotation.md