Référence de commande

Référence pour toutes les commandes CLI de Communications Mining, y compris les sous-commandes pour la gestion des contextes, des sources et des ensembles de données nommés.

reconfigurer

Les opérations de gestion des contextes nommés sont limitées à la commande re config . Celles-ci incluent des sous-commandes pour créer, lire, mettre à jour, supprimer des contextes, ainsi que la configuration d'un contexte et d'utilitaires nommés par défaut.

Utilisation

re config [OPTIONS] <SUBCOMMAND>

Sous-commandes

Commande	DESCRIPTION
re config add	Créer ou modifier un contexte nommé dans le fichier de configuration
re config current	Afficher le contexte actuellement utilisé
re config delete	Supprimer le contexte spécifié du fichier de configuration de réinférence
re config get-token	Imprime le jeton pour un contexte donné ou le contexte actuel s'il n'est pas spécifié
re config ls	Répertorier tous les contextes disponibles dans le fichier de configuration
re config use	Définissez le contexte par défaut à utiliser lorsque aucun n'est spécifié pour une commande

Pour afficher les sous-commandes disponibles ou aider pour une sous-commande donnée

re config help

re config add

Créer ou modifier un contexte nommé dans le fichier de configuration

Utilisation

re config add [FLAGS] [OPTIONS]

Options

Nom	DESCRIPTION
-n, --name <name>	Le nom du contexte qui sera créé ou mis à jour
-e, --endpoint <endpoint>	Le point de terminaison du cluster Communications Mining™ qui sera utilisé pour ce contexte
-t, --token <token>	Le jeton d'API Communications Mining qui sera utilisé pour ce contexte
--proxy <proxy>	URL d'un proxy HTTP qui sera utilisée pour toutes les requêtes si spécifiée
-k, --accept-invalid-certificates	Indique s'il faut accepter les certificats TLS non valides. Vous ne devriez jamais avoir à l'utiliser, car vous exécutez localement un cluster Communications Mining pour le développement

Exemples

# 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

Imprime le contexte actuel utilisé sur la sortie standard

Utilisation

re config current

Exemples

# 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

Supprimer le contexte spécifié du fichier de configuration de réinférence

Utilisation

re config delete [names]...

Exemples

# Delete context acme
re config delete acme

# Delete multiple contexts
re config delete acme other-context

re config get-token

Imprime le jeton d'API pour un contexte donné ou le jeton actuel s'il n'est pas spécifié sur la sortie standard

Utilisation​

re config get-token [name]

Exemples

# 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

Répertorier tous les contextes disponibles dans le fichier de configuration

Utilisation

re config ls [OPTIONS]

Options

Option	DESCRIPTION
--tokens	Afficher les jetons API (par défaut, les jetons sont masqués)

re config use

Définir le contexte à utiliser par défaut lors de l'exécution d'une commande

Utilisation

re config use <name>

Options

Option	DESCRIPTION
<name>	Le nom du contexte pour effectuer la nouvelle valeur par défaut

re create

Sous-commandes pour la création de nouvelles ressources

Utilisation

re create [OPTIONS] <SUBCOMMAND>

Sous-commandes

Sous-Commande	DESCRIPTION
re create annotations	Créer ou mettre à jour des annotations
re create bucket	Créer un nouveau compartiment
re create comments	Créer ou mettre à jour des commentaires
re create dataset	Créer un nouveau jeu de données
re create emails	Créer ou mettre à jour des e-mails
re create project	Créer un nouveau projet
re create source	Créer une source
re create stream-exception	Créer une nouvelle exception de flux
re create user	Créer un nouvel utilisateur Remarque : aucun e-mail de bienvenue ne sera envoyé.

Options

Option	DESCRIPTION
-h, --help	Imprime les informations d'aide
-V, --version	Imprime les informations de version

Pour vérifier les sous-commandes disponibles ou pour aider avec une sous-commande donnée

re create help

re get

Imprime les ressources sur la sortie standard, y compris en exportant des commentaires en bloc vers le système de fichiers local.

re get [OPTIONS] <SUBCOMMAND>

Sous-commandes

Sous-Commande	DESCRIPTION
re get buckets	Lister les compartiments disponibles
re get comment	Obtenir un commentaire unique à partir d'une source
re get comments	Télécharger tous les commentaires d'une source
re get current-user	Obtenir l’utilisateur associé au jeton d’API utilisé
re get datasets	Lister les jeux de données disponibles
re get emails	Télécharger les e-mails depuis un compartiment
re get projects	Lister les projets disponibles
re get sources	Lister les sources disponibles
re get stream-comments	Récupérer les commentaires à partir d'un flux
re get streams	Répertorier les flux disponibles pour un jeu de données
re get users	Lister les utilisateurs disponibles

Pour vérifier les sous-commandes disponibles ou pour aider avec une sous-commande donnée

re get help

Options

Option	DESCRIPTION
-h, --help	Imprime les informations d'aide
-V, --version	Imprime les informations de version

re get buckets

Listez les compartiments disponibles.

Utilisation

re get buckets [bucket-name]

re get comment

Obtenir un commentaire unique à partir d'une source.

Utilisation

re get comment [OPTIONS] --source <source> <comment-id>

Option	DESCRIPTION
--source <source>	(Requis) Nom ou ID de la source
-f, --file <path>	Chemin d'accès où écrire les commentaires au format JSON. Si non spécifié, stdout sera utilisé
<comment-id>	Commentaire - ID

re get comments

Télécharger de nombreux commentaires à partir d'une source

re get comments [FLAGS] [OPTIONS] <source>

Options

Option	DESCRIPTION
<source>	(Requis) Nom ou ID de la source
-d, --dataset <dataset>	Nom ou ID du jeu de données
-f, --file <path>	Chemin d'accès où écrire les commentaires au format JSON. S'il n'est pas spécifié, stdout sera utilisé.
--no-progress	N’affiche pas de barre de progression (uniquement applicable lorsque --file est utilisé)
--from-timestamp <from-timestamp>	Heure de début pour les commentaires à récupérer (inclus)
--predictions <include-predictions>	Enregistrer les libellés et les champs généraux prévus pour chaque commentaire
--reviewed-only <reviewed-only>	Télécharger uniquement les commentaires révisés
--to-timestamp <to-timestamp>	Fin de l'horodatage pour les commentaires à récupérer (inclus)

re get current-user

Obtenir l’utilisateur associé au jeton d’API utilisé

Utilisation

re get current-user

re get datasets

Lister les jeux de données disponibles

Utilisation

re get datasets [dataset]

Options

Option	DESCRIPTION
<dataset>	Si spécifié, répertoriez uniquement cet ensemble de données (nom ou identifiant)

re get projects

Lister les projets disponibles

Utilisation

re get projects [dataset]

Options

Option	DESCRIPTION
<dataset>	Si spécifié, répertoriez uniquement cet ensemble de données (nom ou identifiant)

re get sources

Lister les sources disponibles

Utilisation

re get sources [source]

Options

Option	DESCRIPTION
<source>	Si spécifié, répertoriez uniquement cet ensemble de données (nom ou identifiant)

re get stream-comments

Récupérer les commentaires à partir d'un flux

Utilisation

re get stream-comments [FLAGS] [OPTIONS] --stream <stream>

Options

Option	DESCRIPTION
--stream <stream>	(Requis) Le nom complet du flux <owner>/<dataset>/<stream>
--individual-advance	Si cette option est définie, la commande reconnaîtra chaque commentaire à son tour, plutôt que les lots complets
--listen <listen>	Si cette option est définie, la commande s’exécutera indéfiniment toutes les N secondes et fera progresser le flux
--size <size>	Le nombre maximal de commentaires à renvoyer par lot [par défaut : 16]

re get streams

Répertorier les flux disponibles pour un jeu de données

Utilisation

re get streams --dataset <dataset>

Options

Option	DESCRIPTION
-d, --dataset <dataset>	(Requis) Le nom ou l’ID du jeu de données

re get users

Lister les utilisateurs disponibles

Utilisation

re get users [OPTIONS]

Options

Option	DESCRIPTION
-u, --user <user>	Utiliser pour récupérer un utilisateur unique avec l'ID fourni

re supprimer

Sous-commandes de suppression des ressources

Utilisation

re delete <SUBCOMMAND>

Sous-commandes

Sous-Commande	DESCRIPTION
re delete bucket	Supprimer un compartiment
re delete bulk	Supprimez des commentaires dans une source pour une plage de temps donnée. Sans plage de temps, couvre chaque commentaire dans la source, sous réserve de --include-annotated
re delete bulk-emails	Supprimez tous les e-mails d'un compartiment dans une plage de temps donnée. Sans plage de temps, supprime chaque e-mail du compartiment
re delete comments	Supprimer les commentaires par ID dans une source
re delete dataset	Supprimer un jeu de données
re delete emails	Supprimer les e-mails par ID dans un compartiment
re delete help	Imprime ce message ou l'aide de la ou des sous-commandes données
re delete keyed-sync-states	Supprimer les états de synchronisation par clé pour un compartiment et une boîte aux lettres
re delete project	Supprimer un projet
re delete source	Supprimer une source
re delete user	Supprimer un utilisateur

Indicateur

Indicateur	DESCRIPTION
-h, --help	Imprime les informations d'aide
-V, --version	Imprime les informations de version

Pour vérifier les sous-commandes disponibles ou pour aider avec une sous-commande donnée

re delete help

Réduire

Sauvegardez puis supprimez les données plus anciennes qu'une coupure sur des ensembles de données complets.

Pour obtenir un aperçu d'une exécution de suppression, de sa mise en page de sauvegarde et de la façon de la restaurer, consultez la section Suppression par lots.

Utilisation

re prune [FLAGS] [OPTIONS] --backup-dir <backup-dir> --datasets <datasets> --older-than-days <older-than-days>

Options

Option	DESCRIPTION
--datasets <datasets>	(Requis) Jeux de données dans l’étendue (noms complets <project>/<dataset> séparés par des virgules). Chaque source et chaque compartiment référencés par ces ensembles de données sont épurés
--older-than-days <older-than-days>	(Requis) Supprimer les données antérieures à ce nombre de jours (coupure = maintenant - N jours). 0 sélectionne tout jusqu'à présent
--backup-dir <backup-dir>	(Requis) Répertoire sous lequel un dossier de sauvegarde avec horodatage et écriture unique est créé
--mailbox <mailbox>	Limitez la suppression à une seule boîte aux lettres. Les e-mails sont filtrés par nom exact; les commentaires sont mis en correspondance de manière insensible à la casse. Ne restreint pas la sauvegarde de l’annotation

Indicateur

Indicateur	DESCRIPTION
--include-annotated	Supprimez également les commentaires annotés. Par défaut, un commentaire est conservé s'il est examiné dans l'un des ensembles de données que vous avez répertorié
--dry-run	Sauvegardez et signalez ce qui sera supprimé, sans vérifier la sauvegarde ni supprimer quoi que ce soit
-y, --yes	Ignorez l’invite de confirmation. Requis pour une utilisation non interactive, sauf si --dry-run est défini
--no-progress	Ne pas afficher les barres de progression
-h, --help	Imprime les informations d'aide
-V, --version	Imprime les informations de version

Exemples

# 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 [e-mail] --backup-dir /secure/cm-backups -y