使用 dialogflow3 命令行界面 (CLI) 可以在终端舒适地使用大多数Google Dialogflow服务的功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-dialogflow3-cli

在github上找到源代码。

用法

此文档是从修订版 20240227 的 Dialogflow API生成的。CLI版本为 5.0.4。

dialogflow3 [options]
        projects
                locations-agents-changelogs-get <name> [-p <v>]... [-o <out>]
                locations-agents-changelogs-list <parent> [-p <v>]... [-o <out>]
                locations-agents-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-delete <name> [-p <v>]... [-o <out>]
                locations-agents-entity-types-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-entity-types-delete <name> [-p <v>]... [-o <out>]
                locations-agents-entity-types-export <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-entity-types-get <name> [-p <v>]... [-o <out>]
                locations-agents-entity-types-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-entity-types-list <parent> [-p <v>]... [-o <out>]
                locations-agents-entity-types-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-continuous-test-results-list <parent> [-p <v>]... [-o <out>]
                locations-agents-environments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-delete <name> [-p <v>]... [-o <out>]
                locations-agents-environments-deploy-flow <environment> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-deployments-get <name> [-p <v>]... [-o <out>]
                locations-agents-environments-deployments-list <parent> [-p <v>]... [-o <out>]
                locations-agents-environments-experiments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-experiments-delete <name> [-p <v>]... [-o <out>]
                locations-agents-environments-experiments-get <name> [-p <v>]... [-o <out>]
                locations-agents-environments-experiments-list <parent> [-p <v>]... [-o <out>]
                locations-agents-environments-experiments-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-experiments-start <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-experiments-stop <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-get <name> [-p <v>]... [-o <out>]
                locations-agents-environments-list <parent> [-p <v>]... [-o <out>]
                locations-agents-environments-lookup-environment-history <name> [-p <v>]... [-o <out>]
                locations-agents-environments-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-run-continuous-test <environment> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-sessions-detect-intent <session> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-sessions-entity-types-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-sessions-entity-types-delete <name> [-p <v>]... [-o <out>]
                locations-agents-environments-sessions-entity-types-get <name> [-p <v>]... [-o <out>]
                locations-agents-environments-sessions-entity-types-list <parent> [-p <v>]... [-o <out>]
                locations-agents-environments-sessions-entity-types-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-sessions-fulfill-intent <session> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-sessions-match-intent <session> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-environments-sessions-server-streaming-detect-intent <session> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-export <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-delete <name> [-p <v>]... [-o <out>]
                locations-agents-flows-export <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-get <name> [-p <v>]... [-o <out>]
                locations-agents-flows-get-validation-result <name> [-p <v>]... [-o <out>]
                locations-agents-flows-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-list <parent> [-p <v>]... [-o <out>]
                locations-agents-flows-pages-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-pages-delete <name> [-p <v>]... [-o <out>]
                locations-agents-flows-pages-get <name> [-p <v>]... [-o <out>]
                locations-agents-flows-pages-list <parent> [-p <v>]... [-o <out>]
                locations-agents-flows-pages-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-train <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-transition-route-groups-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-transition-route-groups-delete <name> [-p <v>]... [-o <out>]
                locations-agents-flows-transition-route-groups-get <name> [-p <v>]... [-o <out>]
                locations-agents-flows-transition-route-groups-list <parent> [-p <v>]... [-o <out>]
                locations-agents-flows-transition-route-groups-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-validate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-versions-compare-versions <base-version> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-versions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-versions-delete <name> [-p <v>]... [-o <out>]
                locations-agents-flows-versions-get <name> [-p <v>]... [-o <out>]
                locations-agents-flows-versions-list <parent> [-p <v>]... [-o <out>]
                locations-agents-flows-versions-load <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-flows-versions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-generators-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-generators-delete <name> [-p <v>]... [-o <out>]
                locations-agents-generators-get <name> [-p <v>]... [-o <out>]
                locations-agents-generators-list <parent> [-p <v>]... [-o <out>]
                locations-agents-generators-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-get <name> [-p <v>]... [-o <out>]
                locations-agents-get-generative-settings <name> [-p <v>]... [-o <out>]
                locations-agents-get-validation-result <name> [-p <v>]... [-o <out>]
                locations-agents-intents-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-intents-delete <name> [-p <v>]... [-o <out>]
                locations-agents-intents-export <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-intents-get <name> [-p <v>]... [-o <out>]
                locations-agents-intents-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-intents-list <parent> [-p <v>]... [-o <out>]
                locations-agents-intents-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-list <parent> [-p <v>]... [-o <out>]
                locations-agents-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-restore <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-sessions-detect-intent <session> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-sessions-entity-types-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-sessions-entity-types-delete <name> [-p <v>]... [-o <out>]
                locations-agents-sessions-entity-types-get <name> [-p <v>]... [-o <out>]
                locations-agents-sessions-entity-types-list <parent> [-p <v>]... [-o <out>]
                locations-agents-sessions-entity-types-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-sessions-fulfill-intent <session> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-sessions-match-intent <session> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-sessions-server-streaming-detect-intent <session> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-sessions-submit-answer-feedback <session> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-test-cases-batch-delete <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-test-cases-batch-run <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-test-cases-calculate-coverage <agent> [-p <v>]... [-o <out>]
                locations-agents-test-cases-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-test-cases-export <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-test-cases-get <name> [-p <v>]... [-o <out>]
                locations-agents-test-cases-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-test-cases-list <parent> [-p <v>]... [-o <out>]
                locations-agents-test-cases-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-test-cases-results-get <name> [-p <v>]... [-o <out>]
                locations-agents-test-cases-results-list <parent> [-p <v>]... [-o <out>]
                locations-agents-test-cases-run <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-transition-route-groups-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-transition-route-groups-delete <name> [-p <v>]... [-o <out>]
                locations-agents-transition-route-groups-get <name> [-p <v>]... [-o <out>]
                locations-agents-transition-route-groups-list <parent> [-p <v>]... [-o <out>]
                locations-agents-transition-route-groups-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-update-generative-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-validate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-webhooks-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-agents-webhooks-delete <name> [-p <v>]... [-o <out>]
                locations-agents-webhooks-get <name> [-p <v>]... [-o <out>]
                locations-agents-webhooks-list <parent> [-p <v>]... [-o <out>]
                locations-agents-webhooks-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-security-settings-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-security-settings-delete <name> [-p <v>]... [-o <out>]
                locations-security-settings-get <name> [-p <v>]... [-o <out>]
                locations-security-settings-list <parent> [-p <v>]... [-o <out>]
                locations-security-settings-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-cancel <name> [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
                operations-list <name> [-p <v>]... [-o <out>]
  dialogflow3 --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 文件中，文件名以 dialogflow3- 开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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