该vision1命令行界面(CLI)允许您从终端舒适地使用Google Vision服务的多数功能。

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

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

关于Vision API的所有其他信息都可以在官方文档网站找到。

安装和源代码

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

cargo install google-vision1-cli

在github上查找源代码。

用法

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

vision1 [options]
        files
                annotate (-r <kv>)... [-p <v>]... [-o <out>]
                async-batch-annotate (-r <kv>)... [-p <v>]... [-o <out>]
        images
                annotate (-r <kv>)... [-p <v>]... [-o <out>]
                async-batch-annotate (-r <kv>)... [-p <v>]... [-o <out>]
        locations
                operations-get <name> [-p <v>]... [-o <out>]
        operations
                cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list <name> [-p <v>]... [-o <out>]
        projects
                files-annotate <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                files-async-batch-annotate <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                images-annotate <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                images-async-batch-annotate <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-files-annotate <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-files-async-batch-annotate <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-images-annotate <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-images-async-batch-annotate <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-product-sets-add-product <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-product-sets-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-product-sets-delete <name> [-p <v>]... [-o <out>]
                locations-product-sets-get <name> [-p <v>]... [-o <out>]
                locations-product-sets-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-product-sets-list <parent> [-p <v>]... [-o <out>]
                locations-product-sets-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-product-sets-products-list <name> [-p <v>]... [-o <out>]
                locations-product-sets-remove-product <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-products-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-products-delete <name> [-p <v>]... [-o <out>]
                locations-products-get <name> [-p <v>]... [-o <out>]
                locations-products-list <parent> [-p <v>]... [-o <out>]
                locations-products-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-products-purge <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-products-reference-images-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-products-reference-images-delete <name> [-p <v>]... [-o <out>]
                locations-products-reference-images-get <name> [-p <v>]... [-o <out>]
                locations-products-reference-images-list <parent> [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
  vision1 --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目录中存储所有持久数据，其中以vision1-为前缀的JSON文件。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，用户将被要求授权。遵循CLI给出的说明来授予权限或拒绝。

如果作用域已被用户验证，则相应的信息将被存储在配置目录中，例如 ~/.google-service-cli/vision1-token-<scope-hash>.json 作为 JSON 格式。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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