该documentai1-beta2命令行界面（CLI）允许您从终端轻松使用Google Document服务的多数功能。

默认情况下，所有输出都会打印到标准输出，但可以通过设置标志将其定向到文件，而不依赖于您的shell功能。错误将被打印到标准错误，并将导致程序退出代码不为零。

如果请求数据结构，则这些结构将作为格式化打印的JSON返回，以便作为其他工具的输入。

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

安装和源代码

使用cargo通过以下命令安装命令行界面：

cargo install google-documentai1_beta2-cli

在github上找到源代码。

用法

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

documentai1-beta2 [options]
        projects
                documents-batch-process <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                documents-process <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-documents-batch-process <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-documents-process <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
  documentai1-beta2 --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-beta2-为前缀的JSON文件开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

大多数API要求用户对任何请求进行身份验证。如果是这种情况，则作用域确定授予的权限集。这些权限的粒度通常不超过只读或完全访问。

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

第一次使用作用域时，会提示用户请求权限。按照CLI给出的说明授予权限或拒绝。

如果用户认证了作用域，相关信息将以JSON格式存储在配置目录中，例如：~/.google-service-cli/documentai1-beta2-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

--debug标志将使用Debug表示法将错误打印到标准错误。

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