12个稳定版本 (3个主要版本)

5.0.4+20240222 2024年3月5日
3.1.0+20220221 2022年4月26日
3.0.0+20220221 2022年3月8日
2.0.4+20210325 2021年4月15日
1.0.7+20171205 2018年2月1日

#2487Web编程

Download history 25/week @ 2024-03-08 3/week @ 2024-03-15 60/week @ 2024-03-29 17/week @ 2024-04-05

每月下载量229

MIT 许可证

410KB
5K SLoC

使用speech1命令行界面(CLI),您可以在终端中轻松使用Google语音服务的大部分功能。

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

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

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

安装和源代码

使用cargo安装命令行界面:

cargo install google-speech1-cli

GitHub上找到源代码

用法

此文档是根据语音API修订版20240222生成的。CLI的版本为5.0.4

speech1 [options]
        operations
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        projects
                locations-custom-classes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-custom-classes-delete <name> [-p <v>]... [-o <out>]
                locations-custom-classes-get <name> [-p <v>]... [-o <out>]
                locations-custom-classes-list <parent> [-p <v>]... [-o <out>]
                locations-custom-classes-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-phrase-sets-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-phrase-sets-delete <name> [-p <v>]... [-o <out>]
                locations-phrase-sets-get <name> [-p <v>]... [-o <out>]
                locations-phrase-sets-list <parent> [-p <v>]... [-o <out>]
                locations-phrase-sets-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        speech
                longrunningrecognize (-r <kv>)... [-p <v>]... [-o <out>]
                recognize (-r <kv>)... [-p <v>]... [-o <out>]
  speech1 --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目录中存储所有持久数据,该目录以speech1-为前缀的JSON文件。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时,系统会要求用户授权。按照CLI给出的说明授权权限,或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~584K SLoC