UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

Échanges conversationnels uip, messages, troncs, paramètres utilisateur

Syntaxe et options pour l'historique des conversations et les commentaires (échanges, messages), le routage des canaux directionnels et les paramètres de profil sous `uip conversational`.

Une partie de l'outil uip conversational . Cette page couvre quatre groupes de commandes: les échanges et les messages lisent l’historique d’une conversation et vous permettent d’évaluer les échanges; tronqués gère les numéros de téléphone SIP à partir desquels un agent conversationnel activé par la reconnaissance vocale; user-settings gère le profil conversationnel de l'utilisateur actuel. Aucun de ces éléments ne crée ni ne génère une conversation - voir la page parente pour chat, agents et conversations.

Concepts​

  • Exchange — un aller-retour de demande/réponse au sein d'une conversation: un message de l'utilisateur d'entrée, un message de l'assistant (avec des parties de contenu, des appels d'outils, des citations). chat (sur la page parente) entraîne les échanges en direct; les verbes exchanges/messages de cette page les sont lus par la suite.
  • Message → partie de contenu — un message est un conteneur pour une ou plusieurs parties de contenu (blocs texte/Markdown, enregistrements d'appel d'outil). messages get-content-part extrait directement une partie; si la recherche directe échoue, la CLI revient à récupérer le message parent et à rechercher son tableau contentParts avant d'abandonner.
  • Ligne de connexion — un numéro de téléphone SIP connecté dans la gestion des instances sous Numéros de téléphone. Les tronquages activés en sortie sont Appelés à partir de la file d'attente "Créer un appel sortant" d'un flux vocal activité; les troncs activés par l'entrée acheminent les appels entrants vers une version publiée du processus de flux via trunks assign.

Synthèse​

uip conversational exchanges list <conversation-id> [--limit <n>] [--exchange-sort <order>] [--message-sort <order>] [--cursor <token>]
uip conversational exchanges get <conversation-id> <exchange-id> [--message-sort <order>]
uip conversational exchanges feedback <conversation-id> <exchange-id> --rating positive|negative [--comment <text>]
uip conversational messages get <conversation-id> <exchange-id> <message-id>
uip conversational messages get-content-part <conversation-id> <exchange-id> <message-id> <content-part-id>
uip conversational trunks list [--direction inbound|outbound]
uip conversational trunks assign <trunk> [--process-key <key> --folder-key <key> [--entry-point <id>] | --clear] [-y]
uip conversational user-settings get
uip conversational user-settings update [--name <name>] [--email <email>] [--role <role>] [--department <department>] [--company <company>] [--country <country>] [--timezone <timezone>]
uip conversational exchanges list <conversation-id> [--limit <n>] [--exchange-sort <order>] [--message-sort <order>] [--cursor <token>]
uip conversational exchanges get <conversation-id> <exchange-id> [--message-sort <order>]
uip conversational exchanges feedback <conversation-id> <exchange-id> --rating positive|negative [--comment <text>]
uip conversational messages get <conversation-id> <exchange-id> <message-id>
uip conversational messages get-content-part <conversation-id> <exchange-id> <message-id> <content-part-id>
uip conversational trunks list [--direction inbound|outbound]
uip conversational trunks assign <trunk> [--process-key <key> --folder-key <key> [--entry-point <id>] | --clear] [-y]
uip conversational user-settings get
uip conversational user-settings update [--name <name>] [--email <email>] [--role <role>] [--department <department>] [--company <company>] [--country <country>] [--timezone <timezone>]

Échanges conversationnels uip​

Récupérer et donner des commentaires sur les échanges de conversation.

liste d’échanges conversationnels uip​

Arguments​
NomRequisObjectif
<conversation-id>ouiUUID de la conversation.
Options​
LongValeur (Value)Description
--limit <number>entier positifÉchanges par page.
--exchange-sort <order>ascending|descendingOrdre de tri pour les échanges.
--message-sort <order>ascending|descendingOrdre de tri pour les messages dans chaque échange.
--cursor <token>stringCurseur de pagination pour la page suivante.
Exemple​
uip conversational exchanges list b2c3d4e5-0000-0000-0000-000000000001 --limit 20
uip conversational exchanges list b2c3d4e5-0000-0000-0000-000000000001 --limit 20
Format des données (--sortie json)​
{
  "Result": "Success",
  "Code": "ExchangeList",
  "Data": {
    "items": [{ "id": "e1e2e3e4-0000-0000-0000-000000000001", "...": "raw exchange record" }],
    "nextCursor": null
  }
}
{
  "Result": "Success",
  "Code": "ExchangeList",
  "Data": {
    "items": [{ "id": "e1e2e3e4-0000-0000-0000-000000000001", "...": "raw exchange record" }],
    "nextCursor": null
  }
}

UiPath Exchanges conversationnels - Obtenir​

Arguments​
NomRequisObjectif
<conversation-id>ouiUUID de la conversation.
<exchange-id>ouiUUID Exchange.
Options​
LongValeur (Value)Description
--message-sort <order>ascending|descendingOrdre de tri pour les messages dans l'échange renvoyé.
Exemple​
uip conversational exchanges get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001
uip conversational exchanges get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001
Format des données (--sortie json)​
{ "Result": "Success", "Code": "Exchange", "Data": { "id": "e1e2e3e4-0000-0000-0000-000000000001", "messages": [] } }
{ "Result": "Success", "Code": "Exchange", "Data": { "id": "e1e2e3e4-0000-0000-0000-000000000001", "messages": [] } }

Commentaires sur les échanges de conversation UIP​

Arguments​
NomRequisObjectif
<conversation-id>ouiUUID de la conversation.
<exchange-id>ouiUUID Exchange.
Options​
LongValeur (Value)RequisDescription
--rating <rating>positive|negativeouiÉvaluation des commentaires. Toute autre valeur échoue côté client avant tout appel réseau.
--comment <comment>stringnonCommentaire facultatif.
Exemple​
uip conversational exchanges feedback b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 --rating positive --comment "Resolved quickly"
uip conversational exchanges feedback b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 --rating positive --comment "Resolved quickly"
Format des données (--sortie json)​
{ "Result": "Success", "Code": "FeedbackCreated", "Data": { "rating": "positive", "comment": "Resolved quickly" } }
{ "Result": "Success", "Code": "FeedbackCreated", "Data": { "rating": "positive", "comment": "Resolved quickly" } }

messages conversationnels uip​

Récupérez les messages de la conversation et leurs parties de contenu.

uip - Obtenir des messages conversationnels​

Arguments​
NomRequisObjectif
<conversation-id>ouiUUID de la conversation.
<exchange-id>ouiUUID Exchange.
<message-id>ouiUUID du message.
Exemple​
uip conversational messages get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001
uip conversational messages get b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001
Format des données (--sortie json)​
{ "Result": "Success", "Code": "Message", "Data": { "id": "f1f2f3f4-0000-0000-0000-000000000001", "contentParts": [] } }
{ "Result": "Success", "Code": "Message", "Data": { "id": "f1f2f3f4-0000-0000-0000-000000000001", "contentParts": [] } }

messages conversationnels uip get-content-part​

Arguments​
NomRequisObjectif
<conversation-id>ouiUUID de la conversation.
<exchange-id>ouiUUID Exchange.
<message-id>ouiUUID du message.
<content-part-id>ouiUUID de la partie de contenu.

Si la recherche directe de la partie de contenu échoue, la CLI réessaie automatiquement en récupérant le message parent et en recherchant son tableau contentParts une correspondance id ou contentPartId avant de signaler une erreur.

Exemple​
uip conversational messages get-content-part b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001 a1a2a3a4-0000-0000-0000-000000000001
uip conversational messages get-content-part b2c3d4e5-0000-0000-0000-000000000001 e1e2e3e4-0000-0000-0000-000000000001 f1f2f3f4-0000-0000-0000-000000000001 a1a2a3a4-0000-0000-0000-000000000001
Format des données (--sortie json)​
{ "Result": "Success", "Code": "ContentPart", "Data": { "id": "a1a2a3a4-0000-0000-0000-000000000001", "isText": true, "data": "..." } }
{ "Result": "Success", "Code": "ContentPart", "Data": { "id": "a1a2a3a4-0000-0000-0000-000000000001", "isText": true, "data": "..." } }

tronqués conversationnels uip​

Inspectez et acheminez les troncs SIP (numéros de téléphone) du locataire configurés pour la voix conversationnelle.

liste des troncs conversationnels uip​

Options​
LongValeur (Value)Description
--direction <direction>inbound|outboundUniquement les tronquages activés pour cette direction d'appel. Omettez pour répertorier chaque tronc. Toute autre valeur échoue côté client.
Exemple​
uip conversational trunks list --direction inbound
uip conversational trunks list --direction inbound
Format des données (--sortie json)​
{
  "Result": "Success",
  "Code": "SipTrunkList",
  "Data": [
    { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "+18334815468", "inboundEnabled": true, "outboundEnabled": false, "processKey": null }
  ]
}
{
  "Result": "Success",
  "Code": "SipTrunkList",
  "Data": [
    { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "+18334815468", "inboundEnabled": true, "outboundEnabled": false, "processKey": null }
  ]
}

affectation de troncs conversationnels uip​

Acheminez les appels entrants d'un coffre vers une version de processus de Flux publiée ou effacez le routage avec --clear. Le processus doit être une version de flux déployée dont le flux commence à partir d'un déclencheur d'appel entrant ; lorsque le flux a exactement un tel déclencheur, --entry-point peut être omis et est résolu automatiquement. Lorsqu'il en contient plus d'un, --entry-point est requis et la commande ne parvient pas à répertorier les ID valides.

Arguments​
NomRequisObjectif
<trunk>ouiID de coffre ou son numéro de téléphone au format E.164 (par exemple +18334815468).
Options​
LongValeur (Value)Description
--process-key <key>GUIDClé de version Orchestrator du processus de flux déployé (uip or processes list l'affiche comme Key). Obligatoire sauf --clear.
--folder-key <key>GUIDClé du dossier Orchestrator dans lequel se trouve la version. Obligatoire, sauf si --clear.
--entry-point <id>stringID du point d'entrée de l'appel entrant dans le package de flux. Résolu automatiquement lorsque le flux en contient exactement une; requis (et validés par rapport aux points d'entrée réels de la version); dans le cas contraire.
--clearDrapeauSupprimez le routage des processus entrants du coffre. mutuellement exclusif avec --process-key/--folder-key/--entry-point — leur combinaison échoue côté client.
-y, --yesDrapeauConfirmez le réacheminement ou la suppression d'un coffre disposant déjà d'un routage entrant. Obligatoire dans ce cas — la CLI ne s'affiche jamais.

Ordre de validation: --clear vs. la paire processus/dossiers est vérifiée en premier; alors le coffre doit être réellement inboundEnabled (une tentative de routage sur un coffre uniquement sortant échoue, pointant sur trunks list --direction inbound); ensuite, si le coffre a déjà une liaison, -y est requis; puis les points d'entrée d'appel entrant réels de la version sont répertoriés depuis la plate-forme et validés par rapport à --entry-point (ou résolus automatiquement) avant que la liaison ne soit écrite - l'écriture est tout ou rien.

Exemples​
# Auto-resolve the entry point (release has exactly one Incoming call trigger)
uip conversational trunks assign +18334815468 --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 --folder-key a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e

# Clear inbound routing on a bound trunk
uip conversational trunks assign +18334815468 --clear -y
# Auto-resolve the entry point (release has exactly one Incoming call trigger)
uip conversational trunks assign +18334815468 --process-key 9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09 --folder-key a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e

# Clear inbound routing on a bound trunk
uip conversational trunks assign +18334815468 --clear -y
Format des données (--sortie json)​
{
  "Result": "Success",
  "Code": "SipTrunkAssign",
  "Data": { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "+18334815468", "processKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09", "folderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e", "entryPoint": "..." }
}
{
  "Result": "Success",
  "Code": "SipTrunkAssign",
  "Data": { "id": "t1t2t3t4-0000-0000-0000-000000000001", "phoneNumber": "+18334815468", "processKey": "9e4b2f17-7c3a-4d81-b592-3f6e8a1d5c09", "folderKey": "a9f3b2c1-7d4e-4a8b-9c2f-5e1d3b6a8f7e", "entryPoint": "..." }
}

--clear écrit { processKey: null, folderKey: null, entryPoint: null }.

uipath-paramètres-utilisateurs conversationnels​

Gérez les paramètres du profil conversationnel de l’utilisateur actuel.

uip conversationnel user-settings obtenir​

Aucune option au-delà des variables globales.

Exemple​
uip conversational user-settings get
uip conversational user-settings get
Format des données (--sortie json)​
{
  "Result": "Success",
  "Code": "UserSettings",
  "Data": { "name": "Jane Doe", "email": "jane@example.com", "role": "Support Lead", "department": "Support", "company": "Acme", "country": "US", "timezone": "America/New_York" }
}
{
  "Result": "Success",
  "Code": "UserSettings",
  "Data": { "name": "Jane Doe", "email": "jane@example.com", "role": "Support Lead", "department": "Support", "company": "Acme", "country": "US", "timezone": "America/New_York" }
}

mise à jour des paramètres utilisateur des conversations uip​

Au moins une option est requise - en omettant les sept échecs côté client avant tout appel réseau.

Options​
LongValeur (Value)Description
--name <name>stringNom d’utilisateur.
--email <email>string« john.doe@example.com ».
--role <role>stringRôle de l'utilisateur.
--department <department>stringService.
--company <company>stringSociété.
--country <country>stringPays.
--timezone <timezone>stringFuseau horaire.
Exemple​
uip conversational user-settings update --timezone "America/Los_Angeles"
uip conversational user-settings update --timezone "America/Los_Angeles"
Format des données (--sortie json)​

Même forme que la réponse de get, Code: "UserSettingsUpdated".

Voir également​

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour