该 videointelligence1 命令行界面（CLI）允许您从终端舒适地使用 Google Cloud Video Intelligence 服务的多数功能。

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

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

有关 Cloud Video Intelligence API 的其他信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-videointelligence1-cli

在 github 上查找源代码。

用法

此文档是从 Cloud Video Intelligence API 的 20240118 版本生成的。CLI 的版本为 5.0.4。

videointelligence1 [options]
        operations
                projects-locations-operations-cancel <name> [-p <v>]... [-o <out>]
                projects-locations-operations-delete <name> [-p <v>]... [-o <out>]
                projects-locations-operations-get <name> [-p <v>]... [-o <out>]
        projects
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
        videos
                annotate (-r <kv>)... [-p <v>]... [-o <out>]
  videointelligence1 --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 目录中存储所有持久数据，该目录以 videointelligence1- 前缀的 JSON 文件开始。您可以使用 --config-dir 标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，会要求用户授权。根据CLI的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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