conversationnel UiP

Syntaxe et options de `uip conversationnel`, qui chat avec les Agents conversationnels UiPath déployés et gère les conversations qui en résultent — chat, Agents et conversations.

uip conversational interagit avec les agents conversationnels déployés - Processes déployés par Orchestrator exposés sous forme d'une interface de discussion, basée sur le runtime d'agent conversationnel UiPath. Cette page couvre la découverte des versions de l'agent (agents), le démarrage/la gestion des conversations que vous avez avec eux (conversations) et la discussion en temps réel (chat). Pour l’historique des conversations, les commentaires, le routage des canaux vocaux et les paramètres de profil, consultez la section Conversationnel: échanges, messages, troncs et paramètres utilisateur.

Concepts

• Version de l'agent — une version de processus Orchestrator déployée dont la capacité conversationnelle est activée, identifiée par un ID de version ainsi que du dossier dans lequel elle se trouve. Découvrez les versions avec agents list
• Conversation — une session persistante contre une version d'agent, créée avec conversations create, identifiée par un UUID. Toutes les activités de chat se produisent au sein d’une conversation.
• Chat vs. conversations - conversations create/list/get gèrent l’enregistrement de la conversation lui-même (métadonnées, libellé, entrée de l’agent); chat est l'interaction en direct et en temps réel avec une conversation existante — vous créez d'abord une conversation, puis chat dedans.
• --agent-input sur conversations create/update est une chaîne JSON qui génère ou met à jour l'entrée initiale de l'agent pour la conversation; il est encapsulé sous { inline: <parsed JSON> } avant d'être envoyé.

Synthèse

uip conversational chat <conversation-id> [-m, --message <text>]
uip conversational agents list [--folder-id <id>]
uip conversational agents get --release-id <id> --folder-id <id>
uip conversational conversations create --release-id <id> --folder-id <id> [--label <label>] [--autogenerate-label | --no-autogenerate-label] [--agent-input <json>]
uip conversational conversations list [--limit <n>] [--sort-order <order>] [--cursor <token>] [--agent-id <id>] [--agent-key <guid>] [--label <substring>]
uip conversational conversations get <conversation-id>
uip conversational conversations update <conversation-id> [--label <label>] [--autogenerate-label | --no-autogenerate-label] [--agent-input <json>]
uip conversational conversations delete <conversation-id> -y
uip conversational conversations attachments upload <conversation-id> --file <path>
uip conversational conversations attachments get-uri <conversation-id> --file-name <name>

chat conversationnel uip

Interagir avec une conversation existante en temps réel — soit un message unique ()--message soit une RéponseL --message

Arguments

Nom	Requis	Objectif
<conversation-id>	oui	UUID de la conversation (depuis conversations create/list).

Options

Long	Valeur (Value)	Description
-m, --message <text>	string	Envoyer un seul message et quitter une fois l’échange terminé (non interactif). Omettez de démarrer le RESPL interactif à la place.

Sans --message, chat nécessite un terminal compatible avec les invites - il échoue rapidement dans un environnement non interactif (CI, sortie de pipeline) avec des instructions pour utiliser --message à la place. Dans la VRP, saisissez /exit ou /quit pour mettre fin à la session, ou appuyez sur les touches Ctrl+C. Les réponses de l'Assistant sont transmises au jeton stdout par jeton; les marqueurs de citation en ligne ([1], [2], etc.) s'affichent sous forme de flux de réponse, et un bloc de note de bas --- Citations --- avec des titres/URL imprimés à la fin de chaque échange, dédupliqués sur l'ensemble de la session.

Exemples

# Single-shot message
uip conversational chat b2c3d4e5-0000-0000-0000-000000000001 --message "What's the status of order 4471?"

# Interactive REPL
uip conversational chat b2c3d4e5-0000-0000-0000-000000000001

Cette commande transmet le texte lisible par un humain vers stdout plutôt que d'émettre l'enveloppe --output json habituelle de la CLI — elle est conçue pour une utilisation interactive, et non pour des scripts. Une erreur de démarrage ou de mi-session est toujours signalée via l'enveloppe standard OutputFormatter.error avant que le processus ne se termine par un nombre non nul.

Agents conversationnels UITP

Inspectez les versions de l’agent conversationnel.

liste d’agents conversationnels uip

Options

Long	Valeur (Value)	Description
--folder-id <id>	entier positif	Filtrez les agents conversationnels par dossier.

Exemple

uip conversational agents list --folder-id 123456

Format des données (--sortie json)

{
  "Result": "Success",
  "Code": "ConversationalAgentList",
  "Data": [
    {
      "id": 42,
      "releaseKey": "b2c3d4e5-0000-0000-0000-000000000001",
      "name": "Support Assistant",
      "description": "Handles tier-1 support conversations",
      "processVersion": "1.0.0",
      "processKey": "SupportAssistant",
      "folderId": 123456,
      "feedId": "c3d4e5f6-0000-0000-0000-000000000001",
      "createdTime": "2026-08-01T10:00:00Z"
    }
  ]
}

Les clés sont conservées dans leur casse native (preserveDataKeys: true), et non PascalCase.

uip - Agents conversationnels - Obtenir

Options

Long	Valeur (Value)	Requis	Description
--release-id <id>	entier positif	oui	ID de version de l’agent.
--folder-id <id>	entier positif	oui	ID de dossier contenant l’agent.

Exemple

uip conversational agents get --release-id 42 --folder-id 123456

Format des données (--sortie json)

{
  "Result": "Success",
  "Code": "ConversationalAgent",
  "Data": {
    "id": 42,
    "releaseKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "name": "Support Assistant",
    "description": "Handles tier-1 support conversations",
    "processVersion": "1.0.0",
    "processKey": "SupportAssistant",
    "folderId": 123456,
    "feedId": "c3d4e5f6-0000-0000-0000-000000000001",
    "createdTime": "2026-08-01T10:00:00Z",
    "appearance": { "...": "agent chat-widget appearance config" }
  }
}

appearance est le champ que get renvoie au-delà de ce que list affiche déjà.

conversations conversationnelles uip

Créez, répertoriez, inspectez, mettez à jour et supprimez des conversations, et gérez leurs pièces jointes.

création de conversations conversationnelles uip

Options

Long	Valeur (Value)	Requis	Description
--release-id <id>	entier positif	oui	ID d’une version conversationnelle activée.
--folder-id <id>	entier positif	oui	ID de dossier contenant la version.
--label <label>	string	non	Libellé de la conversation.
--autogenerate-label	Drapeau	non	Activez la génération automatique de libellés après le début des échanges.
--no-autogenerate-label	Drapeau	non	Désactiver la génération automatique de libellés.
--agent-input <json>	Chaîne JSON	non	Entrée initiale pour l'agent — analysée et encapsulée en tant que { inline: <value> }. Échoue rapidement en cas d’élément JSON non valide.

Exemple

uip conversational conversations create --release-id 42 --folder-id 123456 --label "Order 4471"

Format des données (--sortie json)

{
  "Result": "Success",
  "Code": "ConversationCreated",
  "Data": {
    "id": "b2c3d4e5-0000-0000-0000-000000000001",
    "label": "Order 4471",
    "autogenerateLabel": false,
    "agentId": 42,
    "folderId": 123456,
    "agentInput": { "inline": {} },
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001",
    "spanId": "e5f6a7b8",
    "createdTime": "2026-08-01T10:00:00Z",
    "lastActivityTime": "2026-08-01T10:00:00Z"
  }
}

liste des conversations conversationnelles uip

Options

Long	Valeur (Value)	Description
--limit <number>	entier positif	Conversations par page.
--sort-order <order>	ascending|descending	sortOrder.
--cursor <token>	string	Curseur de pagination pour la page suivante.
--agent-id <id>	entier positif	Filtrez par ID de version d’agent.
--agent-key <guid>	string	Filtrer par clé de version d'agent.
--label <substring>	string	Filtrer par sous-chaîne de libellé, insensible à la casse, 1 à 100 caractères.

Exemple

uip conversational conversations list --agent-id 42 --limit 20

Format des données (--sortie json)

{
  "Result": "Success",
  "Code": "ConversationList",
  "Data": {
    "items": [{ "id": "b2c3d4e5-0000-0000-0000-000000000001", "label": "Order 4471" }],
    "nextCursor": null
  }
}

uip conversational conversations - obtenir

Arguments

Nom	Requis	Objectif
<conversation-id>	oui	UUID de la conversation.

Exemple

uip conversational conversations get b2c3d4e5-0000-0000-0000-000000000001

Format des données (--sortie json)

Même forme que la réponse de create, Code: "Conversation".

mise à jour des conversations conversationnelles uip

Au moins une option est requise - l'absence de quatre échoue côté client avant tout appel réseau.

Arguments

Nom	Requis	Objectif
<conversation-id>	oui	UUID de la conversation.

Options

Long	Valeur (Value)	Description
--label <label>	string	Nouveau libellé de la conversation.
--autogenerate-label	Drapeau	Activer la génération automatique de libellés.
--no-autogenerate-label	Drapeau	Désactiver la génération automatique de libellés.
--agent-input <json>	Chaîne JSON	Entrée de l'agent mise à jour — remplace la valeur entière, encapsulée sous la forme { inline: <value> }.

Exemple

uip conversational conversations update b2c3d4e5-0000-0000-0000-000000000001 --label "Order 4471 (resolved)"

Format des données (--sortie json)

Même forme que la réponse de create, Code: "ConversationUpdated".

suppression de conversations uip

Destructeur — nécessite -y/--yes; la CLI ne s'affiche jamais.

Arguments

Nom	Requis	Objectif
<conversation-id>	oui	UUID de la conversation.

Options

Long	Description
-y, --yes	Confirmez cette opération irréversible. Requis — l'omettre échoue avant tout appel réseau.

Exemple

uip conversational conversations delete b2c3d4e5-0000-0000-0000-000000000001 -y

Format des données (--sortie json)

Même forme que la réponse de create, Code: "ConversationDeleted" — le dernier état connu de la conversation supprimée.

Téléchargement des pièces jointes des conversations conversationnelles uip

Chargez un fichier local en tant que pièce jointe dans une conversation.

Arguments

Nom	Requis	Objectif
<conversation-id>	oui	UUID de la conversation.

Options

Long	Valeur (Value)	Requis	Description
--file <path>	Chemin d'accès	oui	Chemin d’accès au fichier local à charger.

Exemple

uip conversational conversations attachments upload b2c3d4e5-0000-0000-0000-000000000001 --file ./invoice.pdf

Format des données (--sortie json)

{ "Result": "Success", "Code": "AttachmentUploaded", "Data": { "...": "raw upload result from the conversational-agent SDK" } }

uip - Pièces jointes des conversations conversationnelles - URI

Obtenez un URI de téléchargement pré-signé pour une pièce jointe, sans télécharger de fichier local (pour les téléchargements hors ligne).

Arguments

Nom	Requis	Objectif
<conversation-id>	oui	UUID de la conversation.

Options

Long	Valeur (Value)	Requis	Description
--file-name <name>	string	oui	Nom du fichier que l'URI acceptera.

Exemple

uip conversational conversations attachments get-uri b2c3d4e5-0000-0000-0000-000000000001 --file-name invoice.pdf

Format des données (--sortie json)

{ "Result": "Success", "Code": "AttachmentUri", "Data": { "...": "pre-signed URI payload" } }

Associé

• Conversationnel: échanges, messages, troncs et paramètres utilisateur — historique des conversations, commentaires, routage des canaux directionnels et paramètres de profil.

Voir également

• Options globales
• Codes de sortie