该 google-dialogflow3 库允许访问Google Dialogflow服务的所有功能。

此文档是从Dialogflow crate版本5.0.5+20240614生成的，其中20240614是mako代码生成器v5.0.5构建的dialogflow:v3架构的确切修订。

有关Dialogflow v3 API的详细信息，请参阅官方文档网站。

功能

轻松从中央中心处理以下资源...

• 项目
• locations agents changelogs get, locations agents changelogs list, locations agents create, locations agents delete, locations agents entity types create, locations agents entity types delete, locations agents entity types export, locations agents entity types get, locations agents entity types import, locations agents entity types list, locations agents entity types patch, locations agents environments continuous test results list, locations agents environments create, locations agents environments delete, locations agents environments deploy flow, locations agents environments deployments get, locations agents environments deployments list, locations agents environments experiments create, locations agents environments experiments delete, locations agents environments experiments get, locations agents environments experiments list, locations agents environments experiments patch, locations agents environments experiments start, locations agents environments experiments stop, locations agents environments get, locations agents environments list, locations agents environments lookup environment history, locations agents environments patch, locations agents environments run continuous test, locations agents environments sessions detect intent, locations agents environments sessions entity types create, locations agents environments sessions entity types delete, locations agents environments sessions entity types get, locations agents environments sessions entity types list, locations agents environments sessions entity types patch, locations agents environments sessions fulfill intent, locations agents environments sessions match intent, locations agents environments sessions server streaming detect intent, locations agents export, locations agents flows create, locations agents flows delete, locations agents flows export, locations agents flows get, locations agents flows get validation result, locations agents flows import, locations agents flows list, locations agents flows pages create, locations agents flows pages delete, locations agents flows pages get, locations agents flows pages list, locations agents flows pages patch, locations agents flows patch, locations agents flows train, locations agents flows transition route groups create, locations agents flows transition route groups delete, locations agents flows transition route groups get, locations agents flows transition route groups list, locations agents flows transition route groups patch, locations agents flows validate, locations agents flows versions compare versions, locations agents flows versions create, locations agents flows versions delete, locations agents flows versions get, locations agents flows versions list, locations agents flows versions load, locations agents flows versions patch, locations agents generators create, locations agents generators delete, locations agents generators get, locations agents generators list, locations agents generators patch, locations agents get, locations agents get generative settings, locations agents get validation result, locations agents intents create, locations agents intents delete, locations agents intents export, locations agents intents get, locations agents intents import, locations agents intents list, locations agents intents patch, locations agents list, locations agents patch, locations agents restore, locations agents sessions detect intent, locations agents sessions entity types create, locations agents sessions entity types delete, locations agents sessions entity types get, locations agents sessions entity types list, locations agents sessions entity types patch, locations agents sessions fulfill intent, locations agents sessions match intent, locations agents sessions server streaming detect intent, locations agents sessions submit answer feedback, locations agents test cases batch delete, locations agents test cases batch run, locations agents test cases calculate coverage, locations agents test cases create, locations agents test cases export, locations agents test cases get, locations agents test cases import, locations agents test cases list, locations agents test cases patch, locations agents test cases results get, locations agents test cases results list, locations agents test cases run, locations agents transition route groups create, locations agents transition route groups delete, locations agents transition route groups get, locations agents transition route groups list, locations agents transition route groups patch, locations agents update generative settings, locations agents validate, locations agents webhooks create, locations agents webhooks delete, locations agents webhooks get, locations agents webhooks list, locations agents webhooks patch, locations get, locations list, locations operations cancel, locations operations get, locations operations list, locations security settings create, locations security settings delete, locations security settings get, locations security settings list, locations security settings patch, operations cancel, operations get and operations list

本库的结构

API结构如下主要项目

• 中心
  • 一个中心对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，后者又允许访问单个调用构建器
• 资源
  • 主要类型，您可以将活动应用于它们
  • 一组属性和部分
  • 部分
    • 一组属性
    • 不直接用于活动
• 活动
  • 应用于资源的操作

所有结构都带有适用的特质，以进一步分类它们并简化浏览。

一般来说，您可以像这样调用活动

let r = hub.resource().activity(...).doit().await

或具体地...

let r = hub.projects().locations_agents_entity_types_export(...).doit().await
let r = hub.projects().locations_agents_entity_types_import(...).doit().await
let r = hub.projects().locations_agents_environments_create(...).doit().await
let r = hub.projects().locations_agents_environments_deploy_flow(...).doit().await
let r = hub.projects().locations_agents_environments_patch(...).doit().await
let r = hub.projects().locations_agents_environments_run_continuous_test(...).doit().await
let r = hub.projects().locations_agents_flows_versions_create(...).doit().await
let r = hub.projects().locations_agents_flows_versions_load(...).doit().await
let r = hub.projects().locations_agents_flows_export(...).doit().await
let r = hub.projects().locations_agents_flows_import(...).doit().await
let r = hub.projects().locations_agents_flows_train(...).doit().await
let r = hub.projects().locations_agents_intents_export(...).doit().await
let r = hub.projects().locations_agents_intents_import(...).doit().await
let r = hub.projects().locations_agents_test_cases_batch_run(...).doit().await
let r = hub.projects().locations_agents_test_cases_export(...).doit().await
let r = hub.projects().locations_agents_test_cases_import(...).doit().await
let r = hub.projects().locations_agents_test_cases_run(...).doit().await
let r = hub.projects().locations_agents_export(...).doit().await
let r = hub.projects().locations_agents_restore(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().operations_get(...).doit().await

资源（resource）和活动（activity）调用创建了建造者。第二个调用处理Activities，支持配置即将进行的操作的各种方法（此处未展示）。它被设计成必须立即指定所有必需参数（即(...)），而所有可选参数都可以按需构建。doit()方法执行与服务器的实际通信并返回相应的结果。

用法

设置项目

要使用此库，您需要将以下行放入您的Cargo.toml文件中

[dependencies]
google-dialogflow3 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dialogflow3 as dialogflow3;
use dialogflow3::api::GoogleCloudDialogflowCxV3Environment;
use dialogflow3::{Result, Error};
use std::default::Default;
use dialogflow3::{Dialogflow, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = Dialogflow::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = GoogleCloudDialogflowCxV3Environment::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_agents_environments_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

错误处理

系统产生的所有错误都作为Result枚举提供，作为doit()方法的返回值，或者作为可能的中间结果传递给Hub Delegate，或Authenticator Delegate。

当代理处理错误或中间值时，它们有机会指示系统重试。这使得系统可能对所有类型的错误具有弹性。

上传和下载

如果某个方法支持下载，则响应体（是Result的一部分）应该由您读取以获取媒体。如果此方法还支持Response Result，则默认返回该值。您可以将它视为实际媒体的元数据。要触发媒体下载，您必须通过以下调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用最多2种不同的协议：简单和可重试。每种方法的独特性由定制的doit(...)方法表示，分别命名为upload(...)和upload_resumable(...)。

定制和回调

您可以通过在最终调用doit()之前向Method Builder提供代理来更改调用doit()方法的方式，相应的方法将被调用以提供进度信息，以及确定系统在失败时应否重试。

代理 trait具有默认实现，这使得您可以用最小的努力对其进行定制。

服务器请求中的可选部分

本库提供的所有结构都设计为可以通过 编码 和 解码 来使用 json 格式。可选参数用于表示部分请求和响应是有效的。大多数可选参数都是 Parts，可以通过名称识别，这些参数将被发送到服务器以指示请求或响应中的特定部分。

构建器参数

通过使用 方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受一个参数，以下语句对其适用。

• PODs 通过复制传递
• 字符串作为 &str 传递
• 请求值 被移动

参数将始终被复制或克隆到构建器中，以确保它们与其原始生命周期独立。

Cargo 功能

• utoipa - 添加对 utoipa 的支持，并在所有类型上派生 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入和注册所需的类型，否则生成的 openapi 规范将无效。

许可证

dialogflow3 库由 Sebastian Thiel 生成，并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。