该 datalabeling1-beta1 命令行界面 (CLI) 允许您从终端舒适地使用 Google 数据标注服务的几乎所有功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-datalabeling1_beta1-cli

在 GitHub 上找到源代码。

用法

此文档是从修订版 20240207 的 数据标注 API 生成的。CLI 版本为 5.0.4。

datalabeling1-beta1 [options]
        projects
                annotation-spec-sets-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                annotation-spec-sets-delete <name> [-p <v>]... [-o <out>]
                annotation-spec-sets-get <name> [-p <v>]... [-o <out>]
                annotation-spec-sets-list <parent> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-data-items-get <name> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-data-items-list <parent> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-delete <name> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-examples-get <name> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-examples-list <parent> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-feedback-threads-delete <name> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-feedback-threads-feedback-messages-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                datasets-annotated-datasets-feedback-threads-feedback-messages-delete <name> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-feedback-threads-feedback-messages-get <name> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-feedback-threads-feedback-messages-list <parent> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-feedback-threads-get <name> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-feedback-threads-list <parent> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-get <name> [-p <v>]... [-o <out>]
                datasets-annotated-datasets-list <parent> [-p <v>]... [-o <out>]
                datasets-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                datasets-data-items-get <name> [-p <v>]... [-o <out>]
                datasets-data-items-list <parent> [-p <v>]... [-o <out>]
                datasets-delete <name> [-p <v>]... [-o <out>]
                datasets-evaluations-example-comparisons-search <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                datasets-evaluations-get <name> [-p <v>]... [-o <out>]
                datasets-export-data <name> (-r <kv>)... [-p <v>]... [-o <out>]
                datasets-get <name> [-p <v>]... [-o <out>]
                datasets-image-label <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                datasets-import-data <name> (-r <kv>)... [-p <v>]... [-o <out>]
                datasets-list <parent> [-p <v>]... [-o <out>]
                datasets-text-label <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                datasets-video-label <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                evaluation-jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                evaluation-jobs-delete <name> [-p <v>]... [-o <out>]
                evaluation-jobs-get <name> [-p <v>]... [-o <out>]
                evaluation-jobs-list <parent> [-p <v>]... [-o <out>]
                evaluation-jobs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                evaluation-jobs-pause <name> (-r <kv>)... [-p <v>]... [-o <out>]
                evaluation-jobs-resume <name> (-r <kv>)... [-p <v>]... [-o <out>]
                evaluations-search <parent> [-p <v>]... [-o <out>]
                instructions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                instructions-delete <name> [-p <v>]... [-o <out>]
                instructions-get <name> [-p <v>]... [-o <out>]
                instructions-list <parent> [-p <v>]... [-o <out>]
                operations-cancel <name> [-p <v>]... [-o <out>]
                operations-delete <name> [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
                operations-list <name> [-p <v>]... [-o <out>]
  datalabeling1-beta1 --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 目录中的 JSON 文件中，文件名以 datalabeling1-beta1- 开头。您可以使用 --config-dir 标志在每个调用基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，会要求用户授权。根据CLI的指示授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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