UIP 文档

uip docsai针对 UiPath 文档提出自然语言问题，返回 AI 生成的答案，其中包含来源 URL 和建议的后续问题。在内部，该工具与托管的 MCP 服务器（ SearchDocumentation工具）而不是 REST 端点通信 — 这就是输出形状包含query_id字段的原因。

请参阅工具（插件） ，了解此工具如何与 CLI 集成。

大纲

uip docsai ask <query> [-t <tenant>] [--source <docs|technical_solution_articles>]

所有子命令都遵循全局选项和退出代码。

uip docsai 询问

搜索 UiPath 文档。返回综合答案及其支持来源。

参数

• <query> （必需） — 自然语言字符串形式的问题。如果包含空格，则使用引号换行。

选项

• -t, --tenant <name> — 租户；默认为uip login选择的租户。
• --source <source> — 要搜索的知识库。docs （默认）或technical_solution_articles之一。无效值将在解析时失败。

示例

# Ask a how-to question against the main docs
uip docsai ask "How do I create a process?"

# Search the technical solution articles instead
uip docsai ask "Selector failed with 404" --source technical_solution_articles

输出格式设置

uip docsai ask会调整其输出，以适应 CLI 的全局--output模式：

• --output table （默认）和--output plain打印可读、便于理解的响应：先打印答案文本，然后打印Sources:列表，然后打印Follow-up questions: （如果有）。
• --output json在标准信封中发出解析后的响应。

数据形状（--输出 json）

{
  "Code": "DocsAIAsk",
  "Data": {
    "query_id": "a1b2c3d4-0000-0000-0000-000000000001",
    "text": "To create a process, open UiPath Orchestrator, navigate to Processes, and click Add.",
    "sources": [
      "https://docs.uipath.com/zh-CN/orchestrator/standalone/2022.4/user-guide/managing-processes"
    ],
    "disclaimers": [],
    "followups": [
      "What permissions are required to create a process in Orchestrator?"
    ]
  }
}

• query_id — 此查询的唯一 ID。
• text — AI 生成的答案。
• sources — 答案中引用的文档页面的绝对 URL。
• disclaimers — 服务器希望客户端与答案一起显示的任何警示（通常为空）。
• followups — 建议的后续问题，已排名。

如果 CLI 无法将服务器返回的响应解析为上述结构化图形，则Data会回退到 MCP 工具调用中的原始内容数组，因此不会丢失任何内容。

错误行为

• MCP 客户端创建失败（通常是身份验证或连接问题）： Failure: "Error querying DocsAI" ， Instructions中存在根本错误，退出 1。
• MCP 工具调用错误：相同的Failure: "Error querying DocsAI"信封； CLI 会在退出之前完全关闭客户端。
• 服务器端错误（例如，速率限制）： Failure: "DocsAI returned an error"中Instructions原始内容有效负载。

相关内容

• 工具（插件） — 安装、更新、卸载docsai-tool包。
• uip mcp — 让客户端MCP 主机调用 CLI； docsai执行相反的操作，调用远程MCP 服务器。
• uip login — 用于对 DocsAI 调用进行身份验证的会话。