UIP-Konversation

Syntax und Optionen für „uip Conversational“, das mit bereitgestellten UiPath Conversational Agents chatt und die daraus resultierenden Konversationen verwaltet – Chat, Agents und Konversationen.

uip conversational interagiert mit bereitgestellten Conversational Agents – Von Orchestrator bereitgestellte Prozesse, die als Chatschnittstelle verfügbar gemacht werden und auf der Runtime von UiPath Conversational Agent basieren. Diese Seite behandelt das Erkennen von Agent-Releases (agents), das Starten/Verwalten der Konversationen, die Sie mit ihnen führen (conversations) und den Chat in Echtzeit (chat). Informationen zum Konversationsverlauf, Feedback, Sprachkanal-Routing und Profileinstellungen finden Sie unter Konversation: Austausch, Nachrichten, Funktion und Benutzereinstellungen.

Konzepte

• Agent-Release – ein bereitgestelltes Orchestrator-Prozess-Release mit aktivierter Konversationsfunktion, das durch eine Release-ID sowie den Ordner identifiziert wird. Entdecken Sie Versionen mit agents list.
• Konversation – eine persistente Sitzung gegen eine Agent-Version, erstellt mit conversations create und wird durch eine UUID identifiziert. Alle Chataktivitäten erfolgen innerhalb einer Konversation.
• Chat vs. Konversationen – conversations create/list/get verwalten den Konversationsdatensatz selbst (Metadaten, Beschriftung, Agent-Eingabe); chat ist die Live-Echtzeit-Interaktion mit einer vorhandenen Konversation – Sie erstellen zuerst eine Konversation und chat fügen sie dann ein.
• --agent-input in conversations create/update ist ein JSON-String, der die ursprüngliche Eingabe des Agents für die Konversation Seed oder Aktualisierung; Sie wird vor dem Senden als { inline: <parsed JSON> } verpackt.

Zusammenfassung

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>

UIP-Konversationschat

Interagieren Sie mit einer vorhandenen Konversation in Echtzeit – entweder mit einer Einzelnachricht (--message) oder einer interaktiven REPL-Nachricht (--message auslassen).

Argumente

Name	Erforderlich	Zweck
<conversation-id>	ja	Konversations-UUID (von conversations create/list).

Optionen

Long	Wert	Beschreibung
-m, --message <text>	string	Senden Sie eine einzelne Nachricht und beenden Sie sie nach Abschluss des Austauschs (nicht interaktiv). Lassen Sie stattdessen das Starten des interaktiven REPL.

Ohne --message erfordert chat ein Prompt-fähiges Terminal – es schlägt in einer nicht interaktiven Umgebung (CI, Pipelineausgabe) mit Anweisungen zur Verwendung von --message schnell fehl. Geben Sie im REPL /exit oder /quit ein, um die Sitzung zu beenden, oder drücken Sie Strg+C. Assistant antwortet Stream auf Standardausgabe Token für Token; Inline-Zitatmarker ([1], [2], …) werden als Antwortstreams gerendert, und ein --- Citations --- -Fußnotenblock mit Titel/URLs wird nach Abschluss jedes Austauschs ausgegeben und während der Sitzung dedupliziert.

Beispiele

# 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

Dieser Befehl überträgt lesbaren Text in das Standardformat, anstatt den üblichen --output json -Umschlag der CLI auszugeben – er ist für die interaktive Verwendung und nicht für die Skripterstellung konzipiert. Ein Start- oder Sitzungsfehler wird weiterhin über den Standardumschlag OutputFormatter.error gemeldet, bevor der Prozess bei einer Nicht-Null beendet wird.

UIP-Konversations-Agents

Überprüfen Sie die Versionen von Conversational Agents.

Liste der UIP-Konversationsagenten

Optionen

Long	Wert	Beschreibung
--folder-id <id>	positiver Integer	Filtern Sie Conversational Agents nach Ordner.

Beispiel

uip conversational agents list --folder-id 123456

Datenform (--output 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"
    }
  ]
}

Schlüssel werden im nativen BinnenMajuskel (preserveDataKeys: true) und nicht in PascalCase ausgeführt.

UIP-Konversationsagenten erhalten sie

Optionen

Long	Wert	Erforderlich	Beschreibung
--release-id <id>	positiver Integer	ja	Versions-ID des Agents.
--folder-id <id>	positiver Integer	ja	Ordner-ID, die den Agent enthält.

Beispiel

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

Datenform (--output 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 ist das einzige Feld, das get über das hinausgibt, was list bereits anzeigt.

UIP-Konversationskonversationen

Erstellen, Auflisten, Überprüfen, Aktualisieren und Löschen von Konversationen sowie Verwalten von Dateianhängen.

UIP-Konversationskonversationen erstellen

Optionen

Long	Wert	Erforderlich	Beschreibung
--release-id <id>	positiver Integer	ja	ID eines konversationaktivierten Releases.
--folder-id <id>	positiver Integer	ja	Ordner-ID, die den Release enthält.
--label <label>	string	nein	Konversationsbeschriftung.
--autogenerate-label	Markieren	nein	Aktivieren Sie die automatische Beschriftungsgenerierung, nachdem ein Austausch stattgefunden hat.
--no-autogenerate-label	Markieren	nein	Deaktivieren Sie die automatische Beschriftungsgenerierung.
--agent-input <json>	JSON-Zeichenfolge	nein	Ursprüngliche Eingabe für den Agent – geparst und verpackt als { inline: <value> }. Schlägt bei ungültiger JSON schnell fehl.

Beispiel

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

Datenform (--output 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 der UIP-Konversationskonversationen

Optionen

Long	Wert	Beschreibung
--limit <number>	positiver Integer	Konversationen pro Seite.
--sort-order <order>	ascending|descending	Sortierreihenfolge.
--cursor <token>	string	Paginierungscursor für die nächste Seite.
--agent-id <id>	positiver Integer	Filtern Sie nach Agent-Versions-ID.
--agent-key <guid>	string	Filtern Sie nach Agent-Versionsschlüssel.
--label <substring>	string	Filtern nach Beschriftungs-Teilzeichenfolge, Groß-/Kleinschreibung wird nicht berücksichtigt, 1–100 Zeichen.

Beispiel

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

Datenform (--output json)

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

Abrufen von UIP-Konversationskonversationen

Argumente

Name	Erforderlich	Zweck
<conversation-id>	ja	Konversations-UUID.

Beispiel

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

Datenform (--output json)

Die gleiche Form wie die Antwort von create, Code: "Conversation".

Aktualisierung der UIP-Konversationskonversationen

Mindestens eine Option ist erforderlich – das Auslassen aller vier Optionen schlägt auf der Clientseite vor einem Netzwerkaufruf fehl.

Argumente

Name	Erforderlich	Zweck
<conversation-id>	ja	Konversations-UUID.

Optionen

Long	Wert	Beschreibung
--label <label>	string	Neue Konversationsbeschriftung.
--autogenerate-label	Markieren	Aktivieren Sie die automatische Beschriftungsgenerierung.
--no-autogenerate-label	Markieren	Deaktivieren Sie die automatische Beschriftungsgenerierung.
--agent-input <json>	JSON-Zeichenfolge	Aktualisierte Agent-Eingabe – ersetzt den gesamten Wert, verpackt in { inline: <value> }.

Beispiel

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

Datenform (--output json)

Die gleiche Form wie die Antwort von create, Code: "ConversationUpdated".

UIP-Konversationskonversationen löschen

Destruktiv – erfordert -y/--yes; die CLI fordert nie auf.

Argumente

Name	Erforderlich	Zweck
<conversation-id>	ja	Konversations-UUID.

Optionen

Long	Beschreibung
-y, --yes	Bestätigen Sie diesen nicht rückgängig zu machenden Vorgang. Erforderlich – das Auslassen schlägt vor einem Netzwerkaufruf fehl.

Beispiel

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

Datenform (--output json)

Die gleiche Form wie die Antwort von create, Code: "ConversationDeleted" – der letzte bekannte Status der gelöschten Konversation.

UIP-Konversationsanhänge hochladen

Laden Sie eine lokale Datei als Konversationsanhang hoch.

Argumente

Name	Erforderlich	Zweck
<conversation-id>	ja	Konversations-UUID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--file <path>	Pfad	ja	Pfad zur hochzuladenden lokalen Datei.

Beispiel

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

Datenform (--output json)

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

UIP-Konversationskonversationsanhänge get-URI

Rufen Sie einen vorsignierten Upload-URI für einen Anhang ab, ohne eine lokale Datei hochzuladen (für Out-of-End-Uploads).

Argumente

Name	Erforderlich	Zweck
<conversation-id>	ja	Konversations-UUID.

Optionen

Long	Wert	Erforderlich	Beschreibung
--file-name <name>	string	ja	Name der Datei, die der URI akzeptiert.

Beispiel

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

Datenform (--output json)

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

Zugehörig

• Konversational: Austausch, Nachrichten, Instanzen und Benutzereinstellungen – Konversationsverlauf, Feedback, Sprachkanal-Routing und Profileinstellungen.

Siehe auch

• Globale Optionen
• Exitcodes