Configuration de la CLI

Cette section explique comment authentifier et configurer re. Il suppose que vous avez installé la CLI, consultez les instructions d' installation .

La section de configuration rapide est une courte référence étape par étape pour la façon de démarrer et de configurer la CLI. Le reste de la page contient des instructions détaillées et présente toutes les options disponibles.

Configuration rapide

Installez l'outil de ligne de commande de votre plate-forme (Linux, Mac et Windows sont pris en charge).

Créez un contexte nommé pour éviter d'avoir à saisir votre point de terminaison de locataire et votre jeton d'API à chaque fois. Indiquez votre point de terminaison locataire:

re config add --name main --endpoint https://<my_api_endpoint>/

Il vous sera demandé de coller votre jeton API:

I A new context `main` will be created.
  Enter API token [none]: MYSUPERSECRETTOKEN
I New context `main` was created.

Essayez d'exécuter une commande pour voir que tout fonctionne, par exemple

re get datasets

Vous pouvez utiliser l'indicateur global -c ou --context pour utiliser un contexte spécifique avec la commande, par exemple

re -c main get datasets

N'importe quel paramètre de contexte peut être remplacé par un seul à l'aide d'indicateurs globaux tels que --token, --endpoint , --proxy , etc. Les arguments de ligne de commande ont priorité sur les paramètres de contexte.

Fournir des informations d’identification à chaque fois

La méthode la plus simple pour authentifier l'interface en ligne de commande consiste à spécifier le point de terminaison et le jeton d'API pour chaque commande. Par défaut, re vous invitera à saisir le jeton de manière interactive.

Par exemple, pour répertorier les jeux de données disponibles

➜ re --endpoint https://acme.reinfer.io get datasets
input: Enter API token [none]: MYSUPERSECRETAPITOKEN
 Name                                ID                Updated (UTC)        Title
 InvestmentBank/collateral-streams  aa9dda7c059e5a8d  2019-04-30 17:25:03  IB Collateral Streams
 InvestmentBank/george-test          1aaeacd49dfce8a0  2019-05-10 15:32:34  Test Dataset
 InvestmentBank/margin-call          b9d50fb2b38c3af5  2019-05-08 07:51:09  IB Margin Call
 InvestmentBank/margin-call-large    6d00b9f69ab059f6  2019-05-11 09:23:43  IB Margin Call Large

Le jeton peut également être spécifié à l'aide de --token

➜ re --endpoint https://acme.reinfer.io --token MYSUPERSECRETAPITOKEN get datasets

Ce n'est généralement pas une bonne idée car le jeton d'API sera stocké dans votre historique du shell. Il serait préférable de stocker le jeton API dans une variable d'environnement.

➜ re --endpoint https://acme.reinfer.io --token $REINFER_TOKEN get datasets

Cependant, cela reste détaillé, répétitif et peu sécurisé.

Avertissement :

La configuration à l'aide d'indicateurs de ligne de commande peut être utile dans certains cas. Cependant, la méthode recommandée pour utiliser la CLI consiste à configurer un contexte nommé, voir ci-dessous.

Contextes nommés

Un contexte est une collection de paramètres et d'informations d'identification que vous pouvez appliquer à une commande re . Lorsque vous spécifiez un contexte pour exécuter une commande, les paramètres et les informations d'identification sont utilisés pour exécuter cette commande. Plusieurs contextes peuvent être stockés dans le fichier de configuration.

Les contextes aident à éviter d'avoir à spécifier manuellement un jeton, un point de terminaison et une autre configuration à chaque commande. Un contexte est composé des éléments suivants :

• Un nom mémorisé qui sert d'identificateur pour le contexte
• Un jeton API utilisé pour authentifier l'utilisateur effectuant des requêtes
• Point de terminaison vers lequel la CLI enverra les requêtes
• (Facultatif) Proxy HTTP à utiliser pour toutes les requêtes
• (Facultatif) Indique s'il faut accepter les certificats TLS non valides du point de terminaison (uniquement utile pour les clusters Communications Mining internes/dev)

Vous pouvez spécifier un contexte par défaut qui sera utilisé lorsque aucun n'est référencé explicitement.

L'indicateur global -c, --context peut être utilisé pour utiliser un contexte spécifique ayant des noms que vous pouvez spécifier en tant que paramètre sur la ligne de commande pour des commandes individuelles.

Création d'un contexte

Vous pouvez créer un nouveau contexte ou modifier un contexte existant avec

re config add

Si elle est exécutée sans option, la commande demandera de manière interactive le nom du contexte, le point de terminaison et le jeton.

➜ re config add
* Context name: acme-prod
I A new context `acme-prod` will be created
* Enter API token [none]: MYSUPERSECRETTOKEN
* Endpoint [https://reinfer.io/]: https://acme.reinfer.io
I Default context set to `acme-prod`
I New context `acme-prod` was created

Lors de la création du tout premier contexte, il sera défini comme étant actif

➜ re config add --name acme-dev --endpoint https://acme.reinfer.io/
I A new context `acme-dev` will be created.
* Enter API token [none]: MYSUPERSECRETTOKEN
I Default context set to `acme-dev`
I New context `acme-dev` was created.

L'ajout d'un contexte avec un nom qui existe déjà mettra à jour ce contexte.

# Edit the acme-dev context if it already exists
re config add acme-dev

Pour voir toutes les options, exécutez re config add -h, les plus importantes sont

Options

Nom	DESCRIPTION
--name <name>	Le nom du contexte qui sera créé ou mis à jour
--endpoint <endpoint>	Le point de terminaison du cluster Communications Mining qui sera utilisé pour ce contexte
--token <token>	Le jeton d’API de réinférence 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

Le contexte actuel sera utilisé pour toutes les commandes suivantes. Ce qui suit imprimera tous les ensembles de données pour le contexte actuel .

re get datasets

N'importe quel paramètre de contexte peut être remplacé par un paramètre unique à l'aide d'indicateurs globaux tels que --token, --endpoint et --proxy.

re --proxy http://proxy.example get datasets

Utiliser un contexte

Vous pouvez utiliser l'indicateur global -c ou --context pour utiliser un contexte spécifique avec la commande, par exemple

re -c my-context get datasets

re config

Toutes les opérations à réaliser avec la gestion des contextes nommés sont limitées sous la commande re config . Les sous-commandes permettent de créer, mettre à jour, définir la valeur par défaut et supprimer des contextes, etc.

Consultez la référence de commande pour toutes les options disponibles.

Où sont stockés les paramètres de configuration ?

L'emplacement de votre répertoire de configuration varie en fonction du système d'exploitation. L'outil de ligne de commande Communications Mining respecte ces valeurs par défaut du système d'exploitation. Le répertoire de configuration se trouve généralement dans

• ~/.config/reinfer sur Linux
• $HOME/.config/reinfer sur macOS
• %AppData%\reinfer sous Windows

Les paramètres de contexte sont stockés dans un fichier JSON contexts.json, par exemple ~/.config/reinfer/contexts.json sous Linux. Il ressemble à ceci

{
  "current_context": "prod",
  "contexts": [
    {
      "name": "prod",
      "endpoint": "https://acme.reinfer.io/",
      "token": "MYSUPERSECRETTOKEN",
      "accept_invalid_certificates": false,
      "proxy": null
    }
  ]
}