uip 对话式

“uip Conversational”的语法和选项，可与部署的 UiPath 对话智能体聊天，并管理产生的对话 - 聊天、智能体和对话。

uip conversational与已部署的对话智能体交互 — Orchestrator 部署的流程公开为聊天界面，基于 UiPath 对话智能体运行时构建。此页面涵盖发现智能体版本 (agents)、发起/管理您与智能体的对话 (conversations)，以及实时聊天 (chat)。有关对话历史记录、反馈、语音通道路由和配置文件设置，请参阅对话：Exchange、消息、中继和用户设置。

概念

• 智能体版本— 已启用对话功能的已部署 Orchestrator 流程版本，由版本 ID 及其所在文件夹标识。发现包含agents list版本。
• 对话— 针对一个智能体版本的持久会话，使用conversations create创建，由 UUID 标识。所有聊天活动都发生在对话中。
• 聊天与对话— conversations create / list / get管理对话记录本身（元数据、标签、智能体输入）； chat是与现有对话的实时交互 — 您先创建一个对话，然后chat进入其中。
• --agent-input / conversations create上的update是 JSON 字符串，用于设定或更新智能体在对话中的初始输入；系统会在发送前将其封装为{ inline: <parsed JSON> } 。

大纲

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 对话聊天

与现有对话实时交互 — 可以是单次消息 (--message) 也可以是交互式 REPL（省略 --message）。

参数

名称	必填	用途
<conversation-id>	是	对话 UUID（来自 conversations create/list）。

选项

长	值	描述
-m, --message <text>	字符串	发送单条消息，并在交换完成后退出（非交互式）。省略启动交互式 REPL。

如果没有 --message，chat 需要具有提示功能的终端 — 在非交互式环境（CI、管道输出）中，它会快速失败，按照使用 --message 的说明即可。在 REPL 中，输入 /exit 或 /quit 以结束会话，或按 Ctrl+C。Assistant 响应逐个流式传输到标准输出；内联引文标记（[1]、[2] 等）作为响应流呈现，并在每次交换完成后打印包含标题/URL 的 --- Citations --- 脚注块，已在整个会话中进行重复数据删除。

示例

# 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

此命令将人类可读文本流式传输到标准输出，而不是发出 CLI 通常的 --output json 信封——它是为交互式使用而设计的，而不是为脚本使用而设计的。在流程以非零值退出之前，仍会通过标准 OutputFormatter.error 信封报告启动或会话中错误。

uip 对话智能体

检查对话智能体版本。

uip 对话智能体列表

选项

长	值	描述
--folder-id <id>	正整数	按文件夹筛选对话智能体。

示例

uip conversational agents list --folder-id 123456

数据形状（--输出 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"
    }
  ]
}

密钥采用原生驼峰式命名法 (preserveDataKeys: true)，而不是帕斯卡命名法。

uip 对话智能体获取

选项

长	值	必填	描述
--release-id <id>	正整数	是	智能体版本 ID。
--folder-id <id>	正整数	是	包含智能体的文件夹 ID。

示例

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

数据形状（--输出 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 是 get 已显示的字段之外，list 返回的唯一一个字段。

uip 对话

创建、列出、检查、更新和删除对话，并管理其文件附件。

uip 对话对话创建

选项

长	值	必填	描述
--release-id <id>	正整数	是	已启用对话的版本的 ID。
--folder-id <id>	正整数	是	包含版本的文件夹 ID。
--label <label>	字符串	否	对话标签。
--autogenerate-label	标记	否	交换发生后启用标签自动生成。
--no-autogenerate-label	标记	否	禁用标签自动生成。
--agent-input <json>	JSON 字符串	否	智能体的初始输入 — 已解析并包装为 { inline: <value> }。在无效 JSON 上快速失败。

示例

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

数据形状（--输出 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"
  }
}

uip 对话列表

选项

长	值	描述
--limit <number>	正整数	每页对话数
--sort-order <order>	ascending|descending	排序顺序。
--cursor <token>	字符串	下一页的分页光标。
--agent-id <id>	正整数	按智能体发布 ID 筛选。
--agent-key <guid>	字符串	按智能体发布密钥筛选。
--label <substring>	字符串	按标签筛选子字符串，不区分大小写，1-100 个字符。

示例

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

数据形状（--输出 json）

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

uip 对话对话获取

参数

名称	必填	用途
<conversation-id>	是	对话 UUID。

示例

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

数据形状（--输出 json）

形状与 create 的响应相同，Code: "Conversation"。

uip 对话对话更新

至少需要一个选项——在进行任何网络调用之前，忽略客户端的所有四个失败。

参数

名称	必填	用途
<conversation-id>	是	对话 UUID。

选项

长	值	描述
--label <label>	字符串	新的对话标签。
--autogenerate-label	标记	启用标签自动生成。
--no-autogenerate-label	标记	禁用标签自动生成。
--agent-input <json>	JSON 字符串	更新的智能体输入 — 替换完整值，并包含为 { inline: <value> }。

示例

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

数据形状（--输出 json）

形状与 create 的响应相同，Code: "ConversationUpdated"。

uip 对话对话删除

破坏性 — 需要 -y/--yes； CLI 从不提示。

参数

名称	必填	用途
<conversation-id>	是	对话 UUID。

选项

长	描述
-y, --yes	确认此不可逆操作。必需 — 省略此参数将在任何网络调用之前失败。

示例

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

数据形状（--输出 json）

与 create 的响应形状相同，Code: "ConversationDeleted" — 已删除对话的上次已知状态。

uip 对话附件上传

将本地文件作为对话附件上传。

参数

名称	必填	用途
<conversation-id>	是	对话 UUID。

选项

长	值	必填	描述
--file <path>	路径	是	要上传的本地文件的路径。

示例

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

数据形状（--输出 json）

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

uip 对话附件获取 URI

获取附件的预签名上传 URI，无需上传本地文件（用于带外上传）。

参数

名称	必填	用途
<conversation-id>	是	对话 UUID。

选项

长	值	必填	描述
--file-name <name>	字符串	是	URI 将接受的文件名称。

示例

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

数据形状（--输出 json）

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

相关内容

• 对话：Exchange、消息、中继和用户设置— 对话历史记录、反馈、语音通道路由和配置文件设置。

另请参阅

• 全局选项
• 退出代码