ixp
latest
false
- Introduction
- Setting up your account
- Balance
- Clusters
- Concept drift
- Coverage
- Datasets
- General fields
- Labels (predictions, confidence levels, label hierarchy, and label sentiment)
- Models
- Streams
- Model Rating
- Projects
- Precision
- Recall
- Annotated and unannotated messages
- Extraction Fields
- Sources
- Taxonomies
- Training
- True and false positive and negative predictions
- Validation
- Messages
- Access Control and Administration
- Manage sources and datasets
- Understanding the data structure and permissions
- Creating or deleting a data source in the GUI
- Uploading a CSV file into a source
- Preparing data for .CSV upload
- Creating a dataset
- Multilingual sources and datasets
- Enabling sentiment on a dataset
- Amending dataset settings
- Deleting a message
- Deleting a dataset
- Exporting a dataset
- Using Exchange integrations
- Model training and maintenance
- Understanding labels, general fields, and metadata
- Label hierarchy and best practices
- Comparing analytics and automation use cases
- Turning your objectives into labels
- Overview of the model training process
- Generative Annotation
- Dastaset status
- Model training and annotating best practice
- Training with label sentiment analysis enabled
- Training chat and calls data
- Understanding data requirements
- Train
- Introduction to Refine
- Precision and recall explained
- Precision and Recall
- How validation works
- Understanding and improving model performance
- Reasons for label low average precision
- Training using Check label and Missed label
- Training using Teach label (Refine)
- Training using Search (Refine)
- Understanding and increasing coverage
- Improving Balance and using Rebalance
- When to stop training your model
- Using general fields
- Generative extraction
- Using analytics and monitoring
- Automations and Communications Mining™
- Developer
- Exchange Integration with Azure service user
- Exchange Integration with Azure Application Authentication
- Exchange Integration with Azure Application Authentication and Graph
- Fetching data for Tableau with Python
- Elasticsearch integration
- Self-hosted Exchange integration
- UiPath® Automation Framework
- UiPath® Marketplace activities
- UiPath® official activities
- 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
- Licensing
- FAQs and more
Important :
Communications Mining is now part of UiPath IXP. Check the Introduction in the Overview Guide for more details.

Communications Mining user guide
Last updated Aug 1, 2025
Summary
All the available API routes are listed below.
METHOD | URL | DESCRIPTION |
---|---|---|
GET | /api/v1/sources | Retrieve metadata about all accessible sources |
GET | /api/v1/sources/<project> | Retrieve metadata about all sources in a project |
GET | /api/v1/sources/<project>/<source_name> | Retrieve metadata about a source by name |
GET | /api/v1/sources/id:<source_id> | Retrieve metadata about a source by id |
PUT | /api/v1/sources/<project>/<source_name> | Create a source |
POST | /api/v1/sources/<project>/<source_name> | Update a source |
DELETE | /api/v1/sources/id:<source_id> | Delete a source by id |
METHOD | URL | DESCRIPTION |
---|---|---|
GET | /api/v1/datasets | Retrieve metadata about all accessible datasets |
GET | /api/v1/datasets/<project> | Retrieve metadata about all datasets in a project |
GET | /api/v1/datasets/<project>/<dataset_name> | Retrieve metadata about a dataset by name |
PUT | /api/v1/datasets/<project>/<dataset_name> | Create a dataset |
POST | /api/v1/datasets/<project>/<dataset_name> | Update a dataset |
DELETE | /api/v1/datasets/<project>/<dataset_name> | Delete a dataset by name |
POST | /api/v1/datasets/<project>/<dataset_name>/export | Export a dataset by name |
METHOD | URL | DESCRIPTION |
---|---|---|
POST | /api/v1/sources/<project>/<source_name>/sync | Create or update comments |
POST | /api/v1/sources/<project>/<source_name>/sync-raw-emails | Create or update comments from raw emails |
METHOD | URL | DESCRIPTION |
---|---|---|
GET | /api/v1/sources/<project>/<source_name>/comments/<comment_id> | Retrieve comment by ID |
DELETE | /api/v1/sources/<project>/<source_name>/messages?id=<message_id0>[&id=<message_id1>...] | Delete comments by ID |
METHOD | URL | DESCRIPTION |
---|---|---|
GET | /api/v1/datasets/<project>/<dataset_name>/labellers/<version>/validation | Get model statistics |
POST | /api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict | Get predictions |
POST | /api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-comments | Get predictions by comment ID |
POST | /api/v1/datasets/<project>/<dataset_name>/labellers/<version>/predict-raw-emails | Get predictions for raw emails |
METHOD | URL | DESCRIPTION |
---|---|---|
GET | /api/v1/datasets/<project>/<dataset_name>/streams/<stream_name> | Get a stream by name |
GET | /api/v1/datasets/<project>/<dataset_name>/streams | Get all streams |
PUT | /api/v1/datasets/<project>/<dataset_name>/streams | Create a stream |
PUT | /api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/exceptions | Tag an exception |
POST | /api/v1/datasets/<project>/<dataset_name>/streams/<stream_name> | Update a stream |
POST | /api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/fetch | Fetch comments from a stream |
POST | /api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/advance | Advance a stream |
POST | /api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/reset | Reset a stream |
DELETE | /api/v1/datasets/<project>/<dataset_name>/streams/<stream_name> | Delete a stream |
DELETE | /api/v1/datasets/<project>/<dataset_name>/streams/<stream_name>/exceptions | Untag an exception |