communications-mining
latest
false
UiPath logo, featuring letters U and I in white
Communications Mining Developer Guide
Last updated Nov 26, 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 Communications Mining Record

Create a Communications Mining Record which you can later upload into the platform

NAMETYPEDESCRIPTION
Communication data typeInputType of communication data you would like to convert to a CM record
Record IDInputA unique hexadecimal number which identifies the record uniquely in the source
Message timestampInputDay and time when the data was created. If timezone is not specified it’s assumed to be UTC
Message bodyInputString which is either email body content or other message content
Thread IDThread IDA unique hexadecimal ID identifying a thread. Messages which has same threadID will be grouped together to form a conversation
SubjectEmail content mappingA string containing the message's subject
FromEmail content mappingThe message sender email ID as string
ToEmail content mappingA string array of primary recipients
CcEmail content mappingA string array of carbon-copy recipients
BccEmail content mappingA string array of blind carbon-copy recipients
User-defined string propertiesUser-defined propertiesAny metadata of type string that applies to the record e.g. Domain Name, policy number, etc.
User-defined number propertiesUser-defined propertiesAny metadata of type number that applies to the record e.g. star rating, score, etc.
Communication Mining RecordOutputThe created record

Get Record

Get an existing communications mining record from within the platform

NAMETYPEDESCRIPTION
Project nameInputProject in Communications Mining from where you want to get the record
Source nameInputSource in Communications Mining from where you want to get the record
Record IDInputA unique hexadecimal number which identifies the record uniquely in the source
RecordOutputThe retrieved record

Upload Record(s)

Upload a batch of communications mining records to the given source

NAMETYPEDESCRIPTION
Project nameInputProject in Communications Mining from where you want to upload the record(s)
Source nameInputSource in Communications Mining from where you want to upload the record(s)
Upload list of Communications Mining recordsInputUpload list of Communications Mining records
RecordInputCreate a record using Create Record activity
Records listInputCreate a record using Create Record activity and append them to a list using Create List activity
Upload responsesOutputUpload responses

Fetch Batch from Stream

Fetch a batch of communications from the given stream

NAMETYPEDESCRIPTION
Project nameInputProject in Communications Mining from where you want to fetch a batch
Dataset nameInputDataset in Communications Mining from where you want to fetch a batch
Stream nameInputStream in Communications Mining from where you want to fetch a batch
Stream feedOutputStream feed

Advance Stream

Advance a stream

NAMETYPEDESCRIPTION
Select the stream to advanceInputSelect the stream that is an output of the Fetch Batch from Stream activity
Advance to the latest Sequence IDInputAdvance the selected stream to the last fetched record’s ID
Advance toInputSequence ID you received from the Fetch Batch from Stream activity
Advance stream responseOutputAdvance stream response

Reset Stream

Reset a stream to the given date

NAMETYPEDESCRIPTION
Select the stream to resetInputSelect the stream that is an output of the Fetch Batch from Stream activity
Reset to a datetimeInputThe date time of record creation where you want to reset the stream to
Reset stream responseOutputReset stream response

Predict Record(s)

Get predictions for a batch of communications mining records

NAMETYPEDESCRIPTION
Project nameInputProject in Communications Mining from where you want to predict record(s)
Dataset nameInputDataset in Communications Mining from where you want to predict record(s)
AI model versionInputThe 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-thresholdInputEnabling auto-thresholds returns a list of pre-defined thresholds that the label prediction satisfies
ThresholdInputA number in the range of 1-100
Predict list of Communications Mining recordsInputPredict list of Communications Mining records
RecordInputCreate a record using Create Record activity
Records listInputCreate a record using Create Record activity and append them to a list using Create List activity
Transform tagTransform tagThe transform tag that you want to use to process the raw email
Prediction resultsOutputPrediction results

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.