didimo-cli 2.6.0

迪迪莫 CLI

• 网站：https ://www.didimo.co
• 客户门户：https ://app.didimo.co
• 文档：https ://developer.didimo.co

Didimo CLI 是我们 API 的命令行界面。

$ didimo --help
Usage: didimo [OPTIONS] COMMAND [ARGS]...

  Create, list and download didimos

Options:
  -c, --config TEXT  Use this configuration instead of the default one.
  -h, --help         Show this message and exit.

Commands:
  account                           Get account information
  bulk                              Perform bulk requests related operations
  clear-cache                       Clears cache and exit
  config                            Get or set configuration
  delete                            Delete a didimo
  download                          Download a didimo
  execute                           Execute on-demand features on didimos
  generation-template               Perform didimo generation template management operations
  init                              Initializes configuration
  inspect                           Get details of didimos
  list                              List didimos
  list-demo-didimos                 List demo didimos
  metadata                          Perform metadata related operations on didimos
  new                               Create a didimo
  status                            Get status of didimos
  version                           Print CLI version and exit
  version-api                       Print API/DGP version and exit

这些是目前实现的功能：

• 创建didimos，支持不同的输入类型、包类型、版本和功能
• 列出迪迪莫斯
• 下载didimos，支持不同的包类型
• 在 didimos 上执行按需功能
• 支持多个配置文件作为在环境甚至帐户之间进行更改的简便方法

快速开始

1.安装

CLI 是用 Python 3 编写的，在 PyPI 上作为包分发，可以使用 pip 安装。

pip3 install didimo-cli

如果您已经安装了以前的版本，您应该执行：

pip3 install didimo-cli --upgrade

2. 使用您的 API 密钥进行配置

创建一个新配置并输入您的 API 密钥。如果您没有 API 密钥，请参阅获取 API 密钥部分。

didimo init <configuration name>

设置 CLI 后，您可以通过以下方式检查您的帐户：

didimo account

3.创建一个didimo

现在 CLI 已经配置好了，让我们根据照片创建一个 didimo。

didimo new <path to the photo> photo 

CLI 等待创建 didimo 并将结果下载到 zip 文件中。

生成一个 didimo 可能包括几个选项，如我们的开发人员门户中所述。

该工具允许选择化身结构（--avatar-structure），它目前接受全身或仅头部（默认）选项。对于全文请求，一些额外的参数可用：

• 身体姿势的定义（--body-pose）；
• 服装的定义（--服装）；
• 性别的定义（--gender）。

Didimo CLI 目前接受以下功能 (-f)：

• oculus_lipsync
• 简单姿势
• 方舟
• aws_polly

CLI 接受以下输出格式 (-p)：

• glTF
• FBX

除此之外，它还接受：

• 配置文件（--profile）的定义，它将驱动输出纹理文件的尺寸和格式；
• 默认头发或棒球帽的定义，来自我们的发型集合（--hair）。

输入类型接受：

• 照片
• rgbd（目前仅使用 Apple 深度图像进行测试）

请使用以下命令检查所有选项和接受的值。

didimo new --help

4.为新生成的didimo生成一个头发变形的包

现在我们有了一个 didimo 包，我们可以使用 Didimo 的默认毛发集生成一个包。

didimo execute hairsdeform <path to the didimo package>

5. 探索

您可以列出您的 didimos：

didimo list

要列出演示 didimos，请使用：

didimo list-demo-didimos

如需更多帮助，请使用该--help选项查看每个命令的文档。

4.批处理

Didimo CLI 支持自动批量处理照片输入。只需提供包含输入文件和所有要处理的文件的目录的路径。或者，您可以指向包含输入文件的 zip 文件。

didimo new /path_to_batch_input_files photo

目前，批处理仅支持照片输入。

此功能将导致生成 didimo 的标准请求，因此如果您打算一次生成大量 didimo，则应考虑批量处理（有关批量处理的更多信息，请阅读以下部分）。

5.批量处理

Didimo CLI 支持自动批量处理照片输入。只需提供包含输入文件的 ZIP 文件的路径，所有文件都将作为批量请求处理。

didimo bulk new didimos /path_to_batch_input_files photo

批处理和批量处理之间的一个重要区别是批处理由客户端应用程序控制，客户端应用程序发出标准请求以生成 didimos，而批量请求处理整个过程。可以更快地注册作业，但由于包裹在后台处理，优先级较低，因此可能会缩短周转时间 (TAT)。此功能旨在用于生成大量的 didimo，而不会阻塞用户界面。

您可以使用输出每个单独项目的相关进度信息的 get 命令执行查询以评估批量请求的处理状态。

didimo bulk get didimos bulk_uuid

您还可以使用 list 命令查询您帐户上所有现有的批量请求。

didimo bulk list didimos

目前，批量处理仅支持照片输入。

6. Didimo 生成模板

与 didimo 生成相关的命令支持使用模板，以方便使用并防止在生成 didimo 时出现意外错误。我们有在系统级别设置的预定义模板，您可以生成自己的模板。

使用以下命令列出可用的 didimo 生成模板。

didimo generation-templates list

您可以使用 create 命令根据您当前的 DGP 签名添加新的 DGT。使用以下命令获取有关如何使用它的说明并查看所有可用的功能和选项。

didimo generation-templates create -h

您将能够将这些模板用作命令的参数：

• “new”（生成新的 didimo）：例如 didimo new /path_to_batch_input_files --template templateUUID
• “bulk”（批量生成 didimo）：例如 didimo bulk new didimos /path_to_batch_input_files --template templateUUID

如果需要，您仍然可以通过像往常一样提供参数来覆盖任何模板值，其余属性将从提供的模板中获取。

注意：如果 DGP 签名发生重大更改，则需要为每个 DGP（didimo 生成管道）签名创建这些模板，但在兼容的 DGP 版本之间共享这些模板。

获取 API 密钥

转到客户门户并注册一个帐户。

确保勾选“开发者帐户”复选框以解锁侧边栏上的“开发者”部分。

之后，转到“开发人员”>“应用程序”并创建一个应用程序和一个 API 密钥。复制信息并粘贴到文本编辑器中，以查看您的凭据的每个细节