ixp
latest
false
Communications Mining user guide
- 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
- Preparing data for .CSV upload
- Uploading a CSV file into a source
- Uploading a PST file
- 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
- Email transform tags
- 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
- 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
- Configuring the CLI
- Batch download
- Batch upload
- Batch delete
- Command reference
- Uploading data
- Downloading data
- Exchange Integration with Azure service user
- Exchange Integration with Azure Application Authentication
- Exchange Integration with Azure Application Authentication and Graph
- Migration Guide: Exchange Web Services (EWS) to Microsoft Graph API
- Fetching data for Tableau with Python
- Elasticsearch integration
- General field extraction
- Self-hosted Exchange integration
- UiPath® Automation Framework
- 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
Reference for all Communications Mining CLI commands, including subcommands for managing named contexts, sources, and datasets.
re config
Operations for managing named contexts are scoped under re config command. These include subcommands to create, read, update, delete contexts, as well as setting a default named context and utilities.
Usage
re config [OPTIONS] <SUBCOMMAND>
re config [OPTIONS] <SUBCOMMAND>
Subcommands
| COMMAND | DESCRIPTION |
|---|---|
re config add | Create or modify a named context in the configuration file |
re config current | Display the current context in use |
re config delete | Delete the specified context from the reinfer configuration file |
re config get-token | Print the token for a given context or the current one if unspecified |
re config ls | List all the available contexts in the configuration file |
re config use | Set the default context to use when none is specified for a command |
To view the available subcommands or help with a given subcommand
re config help
re config help
re config add
Create or modify a named context in the configuration file
Usage
re config add [FLAGS] [OPTIONS]
re config add [FLAGS] [OPTIONS]
Options
| NAME | DESCRIPTION |
|---|---|
-n, --name <name> | The name of the context that will be created or updated |
-e, --endpoint <endpoint> | The Communications Mining™ cluster endpoint that will be used for this context |
-t, --token <token> | The Communications Mining API token that will be used for this context |
--proxy <proxy> | URL for an HTTP proxy that will be used for all requests if specified |
-k, --accept-invalid-certificates | Whether to accept invalid TLS certificates. You should never have to use this, you running a Communications Mining cluster locally for development |
Examples
# Add a new context called `acme`. The cli will interactively ask to provide an API token.
re config add --name acme --endpoint https://cloud.uipath.com/<org>/<tenant>/reinfer_
# Using `--name` with a context that already exists will modify it instead.# For example, the next command changes the endpoint of the `acme` context.
re config add --name acme --endpoint https://cloud.uipath.com/<org>/<tenant>/reinfer_
# Create a context specifying all information as arguments.
re config add -n staging -e https://localhost:9443 -k -t MYTOKEN
# If options are not provided, the cli will interactively prompt user to enter them
re config add
# Standard output:
* Context name: my-context
I A new context `my-context` will be created
* Enter API token [none]: SECRETTOKEN
W Be careful, API tokens are stored in cleartext in /home/marius/.config/reinfer/contexts.json
* Endpoint [https://cloud.uipath.com/<org>/<tenant>/reinfer_/]: https://cloud.uipath.com/<org>/<tenant>/reinfer_
I New context `my-context` was created
# Add a new context called `acme`. The cli will interactively ask to provide an API token.
re config add --name acme --endpoint https://cloud.uipath.com/<org>/<tenant>/reinfer_
# Using `--name` with a context that already exists will modify it instead.# For example, the next command changes the endpoint of the `acme` context.
re config add --name acme --endpoint https://cloud.uipath.com/<org>/<tenant>/reinfer_
# Create a context specifying all information as arguments.
re config add -n staging -e https://localhost:9443 -k -t MYTOKEN
# If options are not provided, the cli will interactively prompt user to enter them
re config add
# Standard output:
* Context name: my-context
I A new context `my-context` will be created
* Enter API token [none]: SECRETTOKEN
W Be careful, API tokens are stored in cleartext in /home/marius/.config/reinfer/contexts.json
* Endpoint [https://cloud.uipath.com/<org>/<tenant>/reinfer_/]: https://cloud.uipath.com/<org>/<tenant>/reinfer_
I New context `my-context` was created
re config current
Print the current context in use to standard output
Usage
re config current
re config current
Examples
# Print the currently used context to stdout
re config current
# Save the current context to an environment variable
export REINFER_CONTEXT=`re config current`
# Print the currently used context to stdout
re config current
# Save the current context to an environment variable
export REINFER_CONTEXT=`re config current`
re config delete
Delete the specified context from the reinfer configuration file
Usage
re config delete [names]...
re config delete [names]...
Examples
# Delete context acme
re config delete acme
# Delete multiple contexts
re config delete acme other-context
# Delete context acme
re config delete acme
# Delete multiple contexts
re config delete acme other-context
re config get-token
Print the API token for a given context or the current one if unspecified to standard output
Usage
re config get-token [name]
re config get-token [name]
Examples
# Print the API token for the current context to stdout
re config get-token
# Save the API token for the current context in an environment variable
export REINFER_TOKEN=`re config get-token`
# Same, but get the API token for a specific context (acme)
export REINFER_TOKEN=`re config get-token`
# Print the API token for the current context to stdout
re config get-token
# Save the API token for the current context in an environment variable
export REINFER_TOKEN=`re config get-token`
# Same, but get the API token for a specific context (acme)
export REINFER_TOKEN=`re config get-token`
re config ls
List all the available contexts in the configuration file
Usage
re config ls [OPTIONS]
re config ls [OPTIONS]
Options
| OPTION | DESCRIPTION |
|---|---|
--tokens | Show API tokens (by default tokens are hidden) |
re config use
Set what context to use by default when running a command
Usage
re config use <name>
re config use <name>
Options
| OPTION | DESCRIPTION |
|---|---|
<name> | The name of the context to make the new default |
re create
Subcommands for creating new resources
Usage
re create [OPTIONS] <SUBCOMMAND>
re create [OPTIONS] <SUBCOMMAND>
Subcommands
| SUBCOMMAND | DESCRIPTION |
|---|---|
re create annotations | Create or update annotations |
re create bucket | Create a new bucket |
re create comments | Create or update comments |
re create dataset | Create a new dataset |
re create emails | Create or update emails |
re create project | Create a new project |
re create source | Create a new source |
re create stream-exception | Create a new stream exception |
re create user | Create a new user Note: No welcome email will be sent. |
Options
| OPTION | DESCRIPTION |
|---|---|
-h, --help | Prints help information |
-V, --version | Prints version information |
To check the available subcommands or help with a given subcommand
re create help
re create help
re get
Print resources to standard output, including exporting comments in bulk to the local filesystem.
re get [OPTIONS] <SUBCOMMAND>
re get [OPTIONS] <SUBCOMMAND>
Subcommands
| SUBCOMMAND | DESCRIPTION |
|---|---|
re get buckets | List the available buckets |
re get comment | Get a single comment from a source |
re get comments | Download all comments from a source |
re get current-user | Get the user associated with the API token in use |
re get datasets | List the available datasets |
re get emails | Download emails from a bucket |
re get projects | List the available projects |
re get sources | List the available sources |
re get stream-comments | Fetch comments from a stream |
re get streams | List the available streams for a dataset |
re get users | List the available users |
To check the available subcommands or help with a given subcommand
re get help
re get help
Options
| OPTION | DESCRIPTION |
|---|---|
-h, --help | Prints help information |
-V, --version | Prints version information |
re get buckets
List the available buckets.
Usage
re get buckets [bucket-name]
re get buckets [bucket-name]
re get comment
Get a single comment from a source.
Usage
re get comment [OPTIONS] --source <source> <comment-id>
re get comment [OPTIONS] --source <source> <comment-id>
| OPTION | DESCRIPTION |
|---|---|
--source <source> | (Required) Source name or id |
-f, --file <path> | Path where to write comments as JSON. If not specified, stdout will be used |
<comment-id> | Comment id |
re get comments
Download many comments from a source
re get comments [FLAGS] [OPTIONS] <source>
re get comments [FLAGS] [OPTIONS] <source>
Options
| OPTION | DESCRIPTION |
|---|---|
<source> | (Required) Source name or id |
-d, --dataset <dataset> | Dataset name or id |
-f, --file <path> | Path where to write comments as JSON. If not specified, stdout will be used. |
--no-progress | Don't display a progress bar (only applicable when --file is used) |
--from-timestamp <from-timestamp> | Starting timestamp for comments to retrieve (inclusive) |
--predictions <include-predictions> | Save predicted labels and general fields for each comment |
--reviewed-only <reviewed-only> | Only download reviewed comments |
--to-timestamp <to-timestamp> | Ending timestamp for comments to retrieve (inclusive) |
re get current-user
Get the user associated with the API token in use
Usage
re get current-user
re get current-user
re get datasets
List the available datasets
Usage
re get datasets [dataset]
re get datasets [dataset]
Options
| OPTION | DESCRIPTION |
|---|---|
<dataset> | If specified, only list this dataset (name or id) |
re get projects
List the available projects
Usage
re get projects [dataset]
re get projects [dataset]
Options
| OPTION | DESCRIPTION |
|---|---|
<dataset> | If specified, only list this dataset (name or id) |
re get sources
List the available sources
Usage
re get sources [source]
re get sources [source]
Options
| OPTION | DESCRIPTION |
|---|---|
<source> | If specified, only list this dataset (name or id) |
re get stream-comments
Fetch comments from a stream
Usage
re get stream-comments [FLAGS] [OPTIONS] --stream <stream>
re get stream-comments [FLAGS] [OPTIONS] --stream <stream>
Options
| OPTION | DESCRIPTION |
|---|---|
--stream <stream> | (Required) The full stream name <owner>/<dataset>/<stream> |
--individual-advance | If set, the command will acknowledge each comment in turn, rather than full batches |
--listen <listen> | If set, the command will run forever polling every N seconds and advancing the stream |
--size <size> | The max number of comments to return per batch [default: 16] |
re get streams
List the available streams for a dataset
Usage
re get streams --dataset <dataset>
re get streams --dataset <dataset>
Options
| OPTION | DESCRIPTION |
|---|---|
-d, --dataset <dataset> | (Required) The dataset name or id |
re get users
List the available users
Usage
re get users [OPTIONS]
re get users [OPTIONS]
Options
| OPTION | DESCRIPTION |
|---|---|
-u, --user <user> | Use to retrieve a single user with the provided id |
re delete
Subcommands for deleting resources
Usage
re delete <SUBCOMMAND>
re delete <SUBCOMMAND>
Subcommands
| SUBCOMMAND | DESCRIPTION |
|---|---|
re delete bucket | Delete a bucket |
re delete bulk | Delete comments in a source in a given time range. With no time range, covers every comment in the source, subject to --include-annotated |
re delete bulk-emails | Delete all emails in a bucket in a given time range. With no time range, deletes every email in the bucket |
re delete comments | Delete comments by id in a source |
re delete dataset | Delete a dataset |
re delete emails | Delete emails by id in a bucket |
re delete help | Prints this message or the help of the given subcommand(s) |
re delete keyed-sync-states | Delete the keyed sync states for a bucket and mailbox |
re delete project | Delete a project |
re delete source | Delete a source |
re delete user | Delete a user |
Flags
| FLAGS | DESCRIPTION |
|---|---|
-h, --help | Prints help information |
-V, --version | Prints version information |
To check the available subcommands or help with a given subcommand
re delete help
re delete help
re prune
Back up and then delete data older than a cutoff across whole datasets.
For a walkthrough of a prune run, its backup layout, and how to restore from it, see Batch delete.
Usage
re prune [FLAGS] [OPTIONS] --backup-dir <backup-dir> --datasets <datasets> --older-than-days <older-than-days>
re prune [FLAGS] [OPTIONS] --backup-dir <backup-dir> --datasets <datasets> --older-than-days <older-than-days>
Options
| OPTION | DESCRIPTION |
|---|---|
--datasets <datasets> | (Required) Datasets in scope (comma-separated full names <project>/<dataset>, or ids). Every source and bucket referenced by these datasets is pruned |
--older-than-days <older-than-days> | (Required) Delete data older than this many days (cutoff = now - N days). 0 selects everything up to now |
--backup-dir <backup-dir> | (Required) Directory under which a timestamped, write-once backup folder is created |
--mailbox <mailbox> | Restrict deletion to a single mailbox. Emails are filtered on the exact name; comments are matched case-insensitively. Does not narrow the annotation backup |
Flags
| FLAGS | DESCRIPTION |
|---|---|
--include-annotated | Also delete comments that are annotated. By default a comment is kept if it is reviewed in one of the datasets you listed |
--dry-run | Back up and report what would be deleted, without verifying the backup or deleting anything |
-y, --yes | Skip the confirmation prompt. Required for non-interactive use, unless --dry-run is set |
--no-progress | Don't display progress bars |
-h, --help | Prints help information |
-V, --version | Prints version information |
Examples
# Report what a two-year retention policy would delete, without deleting anything.
re prune --datasets my-project/my-dataset --older-than-days 730 --backup-dir /secure/cm-backups --dry-run
# Apply it across two datasets, keeping annotated comments.
re prune --datasets my-project/my-dataset,my-project/my-other-dataset --older-than-days 730 --backup-dir /secure/cm-backups
# Prune only the data synced from one mailbox, without a confirmation prompt.
re prune --datasets my-project/my-dataset --older-than-days 365 --mailbox team-inbox@example.com --backup-dir /secure/cm-backups -y
# Report what a two-year retention policy would delete, without deleting anything.
re prune --datasets my-project/my-dataset --older-than-days 730 --backup-dir /secure/cm-backups --dry-run
# Apply it across two datasets, keeping annotated comments.
re prune --datasets my-project/my-dataset,my-project/my-other-dataset --older-than-days 730 --backup-dir /secure/cm-backups
# Prune only the data synced from one mailbox, without a confirmation prompt.
re prune --datasets my-project/my-dataset --older-than-days 365 --mailbox [email protected] --backup-dir /secure/cm-backups -y
- re config
- Usage
re config add- Usage
- Examples
re config current- Usage
- Examples
re config delete- Usage
- Examples
re config get-token- Usage
- Examples
re config ls- Usage
re config use- Usage
- re create
- Usage
- re get
re get bucketsre get commentre get commentsre get current-userre get datasetsre get projectsre get sourcesre get stream-commentsre get streamsre get users- re delete
- Usage
- re prune
- Usage
- Examples