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

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接定向到文件，而不考虑shell的功能。错误将打印到标准错误，并将导致程序的退出代码非零。

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

有关Cloud Natural Language API的更多信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面

cargo install google-language1-cli

在github上找到源代码。

用法

此文档是从修订版20240303的Cloud Natural Language API生成的。CLI版本为5.0.4。

language1 [options]
        documents
                analyze-entities (-r <kv>)... [-p <v>]... [-o <out>]
                analyze-entity-sentiment (-r <kv>)... [-p <v>]... [-o <out>]
                analyze-sentiment (-r <kv>)... [-p <v>]... [-o <out>]
                analyze-syntax (-r <kv>)... [-p <v>]... [-o <out>]
                annotate-text (-r <kv>)... [-p <v>]... [-o <out>]
                classify-text (-r <kv>)... [-p <v>]... [-o <out>]
                moderate-text (-r <kv>)... [-p <v>]... [-o <out>]
  language1 --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文件中，这些文件以前缀language1-开头。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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