communications-mining
latest
false
- API docs
- CLI
- Integration guides
- Blog
- How machines learn to understand words: a guide to embeddings in NLP
- Prompt-based learning with Transformers
- Efficient Transformers II: knowledge distillation & fine-tuning
- Efficient Transformers I: attention mechanisms
- Deep hierarchical unsupervised intent modelling: getting value without training data
- Fixing annotating bias with Communications Mining
- Active learning: better ML models in less time
- It's all in the numbers - assessing model performance with metrics
- Why model validation is important
- Comparing Communications Mining and Google AutoML for conversational data intelligence
Communications Mining Developer Guide
Last updated Nov 19, 2024
UiPath Marketplace activities
Important:
These activities have limited support via internal labs and will soon be replaced by the Official Activities. It is recommended that you use the Official Activities for most use cases.
Create a Communications Mining Record which you can later upload into the platform
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Communication data type | Input | Type of communication data you would like to convert to a CM record |
| Record ID | Input | A unique hexadecimal number which identifies the record uniquely in the source |
| Message timestamp | Input | Day and time when the data was created. If timezone is not specified it’s assumed to be UTC |
| Message body | Input | String which is either email body content or other message content |
| Thread ID | Thread ID | A unique hexadecimal ID identifying a thread. Messages which has same threadID will be grouped together to form a conversation |
| Subject | Email content mapping | A string containing the message's subject |
| From | Email content mapping | The message sender email ID as string |
| To | Email content mapping | A string array of primary recipients |
| Cc | Email content mapping | A string array of carbon-copy recipients |
| Bcc | Email content mapping | A string array of blind carbon-copy recipients |
| User-defined string properties | User-defined properties | Any metadata of type string that applies to the record e.g. Domain Name, policy number, etc. |
| User-defined number properties | User-defined properties | Any metadata of type number that applies to the record e.g. star rating, score, etc. |
| Communication Mining Record | Output | The created record |
Get an existing communications mining record from within the platform
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Project name | Input | Project in Communications Mining from where you want to get the record |
| Source name | Input | Source in Communications Mining from where you want to get the record |
| Record ID | Input | A unique hexadecimal number which identifies the record uniquely in the source |
| Record | Output | The retrieved record |
Upload a batch of communications mining records to the given source
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Project name | Input | Project in Communications Mining from where you want to upload the record(s) |
| Source name | Input | Source in Communications Mining from where you want to upload the record(s) |
| Upload list of Communications Mining records | Input | Upload list of Communications Mining records |
| Record | Input | Create a record using Create Record activity |
| Records list | Input | Create a record using Create Record activity and append them to a list using Create List activity |
| Upload responses | Output | Upload responses |
Fetch a batch of communications from the given stream
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Project name | Input | Project in Communications Mining from where you want to fetch a batch |
| Dataset name | Input | Dataset in Communications Mining from where you want to fetch a batch |
| Stream name | Input | Stream in Communications Mining from where you want to fetch a batch |
| Stream feed | Output | Stream feed |
Advance a stream
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Select the stream to advance | Input | Select the stream that is an output of the Fetch Batch from Stream activity |
| Advance to the latest Sequence ID | Input | Advance the selected stream to the last fetched record’s ID |
| Advance to | Input | Sequence ID you received from the Fetch Batch from Stream activity |
| Advance stream response | Output | Advance stream response |
Reset a stream to the given date
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Select the stream to reset | Input | Select the stream that is an output of the Fetch Batch from Stream activity |
| Reset to a datetime | Input | The date time of record creation where you want to reset the stream to |
| Reset stream response | Output | Reset stream response |
Get predictions for a batch of communications mining records
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Project name | Input | Project in Communications Mining from where you want to predict record(s) |
| Dataset name | Input | Dataset in Communications Mining from where you want to predict record(s) |
| AI model version | Input | The version of the model to use, can be a version number or "Live" or "Staging". Available versions can be seen in Models page |
| Use auto-threshold | Input | Enabling auto-thresholds returns a list of pre-defined thresholds that the label prediction satisfies |
| Threshold | Input | A number in the range of 1-100 |
| Predict list of Communications Mining records | Input | Predict list of Communications Mining records |
| Record | Input | Create a record using Create Record activity |
| Records list | Input | Create a record using Create Record activity and append them to a list using Create List activity |
| Transform tag | Transform tag | The transform tag that you want to use to process the raw email |
| Prediction results | Output | Prediction results |
