UIP IXP 项目

“uip IXP project”的语法和选项，可创建并管理智能提取处理 (IXP) 训练项目，包括模型发布、指标和分类导入/导出。

uip ixp projects 创建和管理智能提取处理 (IXP) 训练项目：分类、训练文档和经过训练的模型版本的顶层容器。请参阅父页面上的“概念” ，以了解分类模型和训练循环概述。

大纲

uip ixp projects list [-l, --limit <n>] [--offset <n>]
uip ixp projects get <project-name>
uip ixp projects delete <project-name> -y
uip ixp projects update-title <project-name> <new-title>
uip ixp projects update-prompt <project-name> --prompt <text>
uip ixp projects get-taxonomy <project-name>
uip ixp projects import-taxonomy <project-name> <file>
uip ixp projects configure-model <project-name> [--model <version>] [--preprocessing <type>]
uip ixp projects get-metrics <project-name> [-m, --model-version <version>]
uip ixp projects publish <project-name> [-m, --model-version <version>] [--tag live|staging] [-d, --description <text>]
uip ixp projects unpublish <project-name> -m, --model-version <version>
uip ixp projects untag <project-name> --tag live|staging
uip ixp projects list-models <project-name>
uip ixp projects create <name> [folder-path] [-d, --description <text>] [--skip-taxonomy]

uip IXP 项目列表

列出租户中的所有 IXP 训练项目。

选项

短	长	值	默认	描述
-l	--limit <number>	1-10000	50	要返回的项目数。
—	--offset <number>	0-1000000	0	要跳过的项目数量。

示例

uip ixp projects list

数据形状（--输出 json）

{
  "Code": "IxpProjectsList",
  "Data": {
    "Projects": [
      {
        "Id": "3d8f1b67-2c5e-4a09-bf3d-9e1a4c7b820f",
        "Name": "my-invoices",
        "Title": "My Invoices",
        "CreatedAt": "2026-04-01T10:00:00Z",
        "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my-invoices/my-invoices"
      }
    ],
    "Total": 1,
    "Offset": 0,
    "Limit": 1
  }
}

包括 Data 在内的整个响应均从 IXP API 原义转发 — 按键在此保留其原生帕斯卡拼写法，但有关大小写，请参阅其他动词的注释，因为具体会因端点而异。

uip IXP 项目获取

按名称获取 IXP 训练项目。

参数

名称	必填	用途
<project-name>	是	项目名称。

示例

uip ixp projects get my-invoices

数据形状（--输出 json）

{
  "Code": "IxpProjectsGet",
  "Data": {
    "Id": "3d8f1b67-2c5e-4a09-bf3d-9e1a4c7b820f",
    "Name": "my-invoices",
    "Title": "My Invoices",
    "CreatedAt": "2026-04-01T10:00:00Z",
    "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my-invoices/my-invoices"
  }
}

UIP IXP 项目删除

永久删除项目 — 包含其文档、分类和经过训练的模型。不可撤销；需要 --yes。

参数

名称	必填	用途
<project-name>	是	项目名称。

选项

短	长	描述
-y	--yes	确认此不可逆操作。必需 — CLI 从不提示。

示例

uip ixp projects delete my-invoices --yes

数据形状（--输出 json）

{ "Code": "IxpProjectsDelete", "Data": { "Status": "ok" } }

uip IXP 项目更新标题

更新项目的显示标题。代理在服务器端保持数据集和项目标题同步。

参数

名称	必填	用途
<project-name>	是	项目名称。
<new-title>	是	新的显示标题。

示例

uip ixp projects update-title my-invoices "My Invoices"

数据形状（--输出 json）

{
  "Code": "IxpProjectsUpdateTitle",
  "Data": {
    "Id": "3d8f1b67-2c5e-4a09-bf3d-9e1a4c7b820f",
    "Name": "my-invoices",
    "Title": "My Invoices",
    "CreatedAt": "2026-04-01T10:00:00Z",
    "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my-invoices/my-invoices"
  }
}

uip IXP 项目更新提示词

更新项目的整体提取说明，即全分类提示词，提供与每个字段组相关的模型上下文。匹配 IXP 用户界面的“总体提取说明”管理分类页面上的字段。不同于字段组自身的提示词 ( taxonomy groups update-prompts ) 以及每个字段的提示词 ( taxonomy fields update-prompts )。

参数

名称	必填	用途
<project-name>	是	项目名称。

选项

长	值	必填	描述
--prompt <text>	字符串	是	新的整体提取说明。替换现有值。

示例

uip ixp projects update-prompt my-invoices --prompt "Extract key information from US vendor invoices, including header fields and line items."

数据形状（--输出 json）

{ "Code": "IxpProjectsUpdatePrompt", "Data": { "Status": "ok" } }

uip IXP 项目获取分类

导出项目的原始智能提取处理 (IXP) 分类工件（数据类型 + 字段组）。这是用于重新导入到另一个项目 (import-taxonomy) 的 IXP 内部格式，并非经过策划的人类可读视图。

参数

名称	必填	用途
<project-name>	是	项目名称。

示例

uip ixp projects get-taxonomy my-invoices --output json

数据形状（--输出 json）

{
  "Code": "IxpProjectsGetTaxonomy",
  "Data": {
    "status": "ok",
    "dataset": { "entity_defs": [], "label_groups": [] }
  }
}

Data 按照上游数据集自己的snack_case 命名法（而非帕斯卡命名法）原义转发。

uip IXP 项目导入分类

将分类从本地 JSON 文件导入到现有项目中。接受两种文件格式：{ field_types, label_group }（get-taxonomy/分类建议产生的形状）或 { entity_defs, label_groups }（分类端点本身返回的形状）— entity_defs/前 label_groups 条目按原样传递当给定第二种格式时，以保留 API 需要的 inherits_from 等属性。

参数

名称	必填	用途
<project-name>	是	项目名称。
<file>	是	分类 JSON 文件的路径。

示例

uip ixp projects import-taxonomy my-invoices ./taxonomy.json

数据形状（--输出 json）

{
  "Code": "IxpProjectsImportTaxonomy",
  "Data": {
    "ProjectName": "my-invoices",
    "FieldTypes": 4,
    "LabelDefs": 1,
    "Labels": ["Invoice"]
  }
}

如果文件没有可识别的形状（规范化后同时缺少 field_types 和 label_group），则失败并显示明确错误。

uip IXP 项目配置模型

为项目配置提取模型设置。代理读取当前配置，合并提供的模型/预处理，将其写回，并返回合并的配置。

参数

名称	必填	用途
<project-name>	是	项目名称。

选项

长	值	描述
--model <version>	字符串	提取模型名称，已验证的服务器端（例如gemini_2_5_flash、gemini_2_5_pro、gpt_4o_2024_05_13）。
--preprocessing <type>	none|table_mini|table	智能预处理模式。

至少需要 --model/--preprocessing 中的一个——在任何调用之前，传递这两个问题都不会使客户端失败（“无需配置”）。

示例

uip ixp projects configure-model my-invoices --model gemini_2_5_pro --preprocessing table

数据形状（--输出 json）

{
  "Code": "IxpProjectsConfigureModel",
  "Data": { "ProjectName": "my-invoices", "Config": {} }
}

uip IXP 项目获取指标

获取 IXP 项目的验证指标。

参数

名称	必填	用途
<project-name>	是	项目名称。

选项

短	长	值	默认	描述
-m	--model-version <version>	整数或 latest	latest	要为其获取指标的模型版本。

示例

uip ixp projects get-metrics my-invoices --output json

uip ixp projects get-metrics my-invoices --model-version 32 --output json

数据形状（--输出 json）

{
  "Code": "IxpProjectsGetMetrics",
  "Data": {
    "ModelVersion": 35,
    "ValidatedDocuments": 8,
    "ProjectScore": 0.8662574291229248,
    "ProjectScoreQuality": "excellent",
    "FieldGroups": [
      { "FieldGroup": "Invoice", "F1": 0.8939051628112793, "Precision": 0.824999988079071, "Recall": 0.9753694534301758, "ErrorRate": 0.1621621549129486, "Documents": 8 }
    ],
    "Fields": [
      { "FieldGroup": "Invoice", "FieldId": "1e8eadeac608df18", "Name": "Invoice Number", "F1": 0.875, "Precision": 0.875, "Recall": 0.875, "ErrorRate": 0.125, "Documents": 8, "Annotations": 8, "Quality": "good" }
    ]
  }
}

存在但尚未经过验证的模型将返回 { "Metrics": null }，而不是上面的平面形状。

uip IXP 项目发布

发布模型版本，可选择将其标记为 live 或 staging。

参数

名称	必填	用途
<project-name>	是	项目名称。

选项

短	长	值	描述
-m	--model-version <version>	整数	要发布的模型版本。默认为最新（最高）的训练版本。
—	--tag <live|staging>	live|staging	可以选择为已发布的版本添加标签。
-d	--description <text>	字符串	已发布版本的说明。空字符串会清除现有字符串。

示例

uip ixp projects publish my-invoices --model-version 4 --tag live --description "Q2 release"

uip ixp projects publish my-invoices --model-version 4

# --model-version defaults to the latest trained version
uip ixp projects publish my-invoices

数据形状（--输出 json）

{
  "Code": "IxpProjectsPublish",
  "Data": {
    "ProjectName": "my-invoices",
    "ModelVersion": 4,
    "Pinned": true,
    "Tag": { "Name": "live", "Version": 4, "UpdatedAt": "2026-04-29T00:00:00Z" },
    "Description": "Q2 release"
  }
}

当省略 Tag 时，null 为 --tag。

UIP IXP 项目取消发布

取消发布模型版本。该版本保持经过训练且可列出的状态；仅将其从已发布的集合中删除。

参数

名称	必填	用途
<project-name>	是	项目名称。

选项

短	长	值	必填	描述
-m	--model-version <version>	非负整数	是	要取消发布的模型版本。

示例

uip ixp projects unpublish my-invoices --model-version 4

数据形状（--输出 json）

{
  "Code": "IxpProjectsUnpublish",
  "Data": { "ProjectName": "my-invoices", "ModelVersion": 4, "Pinned": false }
}

uip IXP 项目取消标记

按名称从模型版本中删除标签。标签名称在项目中是唯一的，因此即使一个版本包含多个标签，标签名称也是明确的。版本保持训练和发布状态；则仅清除其标签指针。

参数

名称	必填	用途
<project-name>	是	项目名称。

选项

长	值	必填	描述
--tag <live|staging>	live|staging	是	要按名称删除的标签。

示例

uip ixp projects untag my-invoices --tag live

数据形状（--输出 json）

{
  "Code": "IxpProjectsUntag",
  "Data": { "ProjectName": "my-invoices", "ModelVersion": 4, "RemovedTags": ["live"] }
}

uip IXP 项目列表模型

列出项目的所有模型版本和标签。

参数

名称	必填	用途
<project-name>	是	项目名称。

示例

uip ixp projects list-models my-invoices

数据形状（--输出 json）

{
  "Code": "IxpProjectsListModels",
  "Data": { "Models": [], "Tags": [], "MaxPublished": 5 }
}

创建 UIP IXP 项目

创建 IXP 项目。给定一个文档文件夹，上传文档并根据最多 8 个均匀采样文档提出分类建议；若无文件夹，则创建一个空项目。

参数

名称	必填	用途
<name>	是	项目名称。
[folder-path]	否	文档文件夹的路径。省略创建空项目 — 没有文档，就无法上传、无法提供分类建议。

选项

短	长	描述
-d	--description <text>	对从文档中提取内容的描述 — 用作分类建议的上下文。
—	--skip-taxonomy	创建项目并上传文档，未提供分类建议。

单个文件上传失败（系统会收集每次失败信息，而非严重失败）——仅当文件夹中的每个上传都失败时，该命令才会完全失败。分类建议最多重试 3 次，会延迟 5 秒（当 OCR 尚未为 PDF 做好准备时，后端可以间歇性地重试）；如果 3 次尝试全部失败，仍会创建项目及其文档 — 错误会指出之后要运行的确切 import-taxonomy 命令。

示例

uip ixp projects create "My Invoices" ./training-set --description "extract invoice header fields"

uip ixp projects create "My Invoices" ./training-set --skip-taxonomy

uip ixp projects create "My Invoices"

数据形状（--输出 json）

{
  "Code": "IxpProjectsCreate",
  "Data": {
    "ProjectName": "my_invoices-a1b2c3d4-ixp",
    "ProjectUrl": "https://cloud.uipath.com/acme/DefaultTenant/reinfer_/ixp/my_invoices-a1b2c3d4-ixp/my_invoices-a1b2c3d4",
    "DocumentsUploaded": 12,
    "DocumentsFailed": 0
  }
}

FailedFiles（由 {file, error} 组成的数组）仅当至少有一次上传失败时才会显示。如果分类建议成功，则会为 SuggestedTaxonomy 添加 FieldTypes（名称/标题对）和 LabelGroup（名称加 LabelDefs）。如果传递 --skip-taxonomy，则系统会添加 TaxonomySkipped: true。<name> 以缩略名形式返回，并带有随机 ID 和 -ixp — 这不是您传递的文本字符串。

相关内容

• uip IXP — 概念和完整资源目录。
• uip IXP 分类— 一次一个编辑数据类型、组和字段（此页面的整个分类 get-taxonomy/import-taxonomy）。
• uip IXP 文档和标签— 上传文档并审核预测结果。
• uip IXP 部署— 将已发布的模型版本部署到 Orchestrator。

另请参阅

• IXP 工具概述
• 全局选项
• 退出代码