uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
UIP 智能提取处理 (IXP)
用于使用“uip ixp”工具管理 IXP(智能文档处理)项目、分类、文档、标签和部署的命令。
uip ixp管理IXP项目 — UiPath 的智能文档处理产品,用于训练和部署文档提取模型。项目包含一个分类(表示要提取内容的架构 - 数据类型、字段组和字段)、一组训练文档以及用于改进已训练模型的人工审核标签(已确认/更正的预测)。训练后,模型版本将部署到 Orchestrator 文件夹,其中的活动和 Maestro Flow 可以在运行时调用该文件夹。ixp 是命令前缀;相关基础包为 @uipath/ixp-tool。
资源
每个资源都有其自己的参考页面。动词集与 uip ixp 注册的命令相匹配 — 运行 uip ixp --help 以确认安装的全部表面。
| 资源 | 用途 |
|---|---|
| 项目 | 创建、配置和管理智能提取处理 (IXP) 项目,包括模型发布、指标和分类导入/导出。 |
| taxonomy — Fields, Groups, Data-Types | 编辑项目的提取架构:数据类型(可重用的值定义)、字段组(文档类型容器)以及其中的字段。 |
| 文档和示例标签 | 上传/下载/删除训练文档,并确认、更正模型基于这些文档的预测或标记缺失项。 |
| 部署 | 将经过训练的模型版本部署到 Orchestrator 文件夹,将部署移动到其他版本,以及检查已部署版本的分类。 |
概念
- 分类— 项目的提取架构,由三个相关概念组成:数据类型(
entity_defs— 可重用的类型定义,例如“电子邮件地址”或“公民身份”选项列表,每个字段按名称引用一个)、字段组(label_defs— 文档类型容器,例如发票或可重复的“明细项目”组),字段— 组中单独的命名值(例如“发票编号” “发票”字段中组),每个提取指令都支持数据类型和每个字段的提取指令。uip ixp projects get-taxonomy/import-taxonomy将整个分类作为一个工件移动(有其自己的内部格式 — 将数据类型和字段分组);uip ixp taxonomy的fields/groups/data-types命令一次编辑一个片段。 - 训练循环— 创建项目(可以选择使用文档和自动建议的分类进行种子化)→ 优化分类(
data-types/groups/fields)→ 上传更多文档 → 审核模型的预测结果(labellings get-predictions)并确认或更正 (labellings confirm/unconfirm/mark-missing) → 检查projects get-metrics→projects publish模型版本 →deployments create将其复制到 Orchestrator 文件夹。 - 模型版本— 项目随着加标签和重新训练的进度累积经过训练的模型版本。
projects publish/unpublish/untag/list-models管理要发布和标记的版本 (live/staging);deployments create/upgrade控制 Orchestrator 文件夹在运行时实际提供服务的已发布版本 — 发布版本与部署是单独的步骤。 - 输出密钥大小写— 大多数
uip ixp响应都会原义转发基础 IXP API 有效负载,这意味着密钥采用驼峰式命名法或贪婪命名法,而不是此 CLI 的常用帕斯卡命名法 — 每个页面都会在适用的位置按动词调用此格式。这是有意为之的直通行为,并非错误。
大纲
uip ixp <resource> <verb> [options]
uip ixp <resource> <verb> [options]