documentai1 命令行界面（CLI）允许您在终端中舒适地使用 Google Document 服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其定向到与您的 shell 能力无关的文件。错误将打印到标准错误，并导致程序退出码非零。

如果请求数据结构，这些将作为格式化好的 JSON 返回，作为其他工具的输入很有用。

有关 Document API 的其他所有信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-documentai1-cli

在 GitHub 上查找源代码。

用法

此文档是从修订版 20240223 的 Document API 生成的。CLI 版本为 5.0.4。

documentai1 [options]
        operations
                delete <name> [-p <v>]... [-o <out>]
        projects
                locations-fetch-processor-types <parent> [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-processor-types-get <name> [-p <v>]... [-o <out>]
                locations-processor-types-list <parent> [-p <v>]... [-o <out>]
                locations-processors-batch-process <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-delete <name> [-p <v>]... [-o <out>]
                locations-processors-disable <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-enable <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-get <name> [-p <v>]... [-o <out>]
                locations-processors-human-review-config-review-document <human-review-config> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-list <parent> [-p <v>]... [-o <out>]
                locations-processors-process <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-processor-versions-batch-process <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-processor-versions-delete <name> [-p <v>]... [-o <out>]
                locations-processors-processor-versions-deploy <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-processor-versions-evaluate-processor-version <processor-version> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-processor-versions-evaluations-get <name> [-p <v>]... [-o <out>]
                locations-processors-processor-versions-evaluations-list <parent> [-p <v>]... [-o <out>]
                locations-processors-processor-versions-get <name> [-p <v>]... [-o <out>]
                locations-processors-processor-versions-list <parent> [-p <v>]... [-o <out>]
                locations-processors-processor-versions-process <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-processor-versions-train <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-processor-versions-undeploy <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-processors-set-default-processor-version <processor> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
  documentai1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将在 ~/.google-service-cli 目录中存储所有持久数据，以 documentai1- 为前缀的 JSON 文件。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

以下段落中提供了有关各种持久数据的更多信息。

身份验证

大多数 API 需要用户对请求进行身份验证。如果是这样，范围 确定了授予的权限集。这些通常不超过 只读 或 完全访问。

如果没有设置，系统将自动选择最小的可行范围，例如，当调用只读方法时，它将只请求只读范围。您可以使用 --scope 标志直接指定范围。所有适用的范围在各自方法的 CLI 文档中有记录。

第一次使用范围时，用户会被要求授权。按照 CLI 提供的说明授予权限或拒绝。

如果用户已认证范围，相关的信息将被存储在配置目录中，例如，在 ~/.google-service-cli/documentai1-token-<scope-hash>.json 中。不需要手动管理这些令牌。

要撤销已授权的认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用Google服务，需要使用Google开发者控制台进行注册。应用程序可能使用的API将逐一启用。大多数API可以免费使用，并且有每日配额。

为了在不强迫任何人为自己的应用程序注册的情况下更方便地使用CLI，CLI附带了一个默认的应用程序密钥，相应地进行了配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放在此位置来解决这个问题：~/.google-service-cli/documentai1-secret.json，假设已为它启用了所需的documentai API。此类密钥文件可以在Google开发者控制台的APIs & auth -> Credentials -> Download JSON中下载并直接使用。

有关如何设置Google项目和启用API的更多信息，请参阅官方文档。

调试

尽管CLI尽可能提供可用的错误消息，但有时可能希望知道导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以原样输出到标准错误来完成的。

带有--debug标志将错误打印到标准错误，使用Debug表示形式。

您可以考虑将标准错误重定向到文件，以便于使用，例如documentai1 --debug <resource> <method> [options] 2>debug.txt。