#dialogflow #google #google-api

google-dialogflow2_beta1

一个完整的库,用于与Dialogflow(协议v2beta1)交互

20个稳定版本 (4个主要版本)

5.0.5+20240614 2024年6月27日
5.0.4+20240227 2024年3月5日
5.0.3+20230110 2023年8月23日
5.0.2+20230110 2023年3月16日
1.0.7+20171211 2017年12月12日

#2134 in 网络编程

Download history 60/week @ 2024-04-25 25/week @ 2024-05-02 47/week @ 2024-05-09 34/week @ 2024-05-16 44/week @ 2024-05-23 132/week @ 2024-05-30 119/week @ 2024-06-06 63/week @ 2024-06-13 37/week @ 2024-06-20 192/week @ 2024-06-27 244/week @ 2024-07-04 61/week @ 2024-07-11 43/week @ 2024-07-18 10/week @ 2024-07-25 67/week @ 2024-08-01 27/week @ 2024-08-08

166每月下载量
用于 google-dialogflow2_beta1-…

MIT许可协议

4MB
45K SLoC

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

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

关于Dialogflow v2_beta1 API的其他所有内容,都可以在官方文档网站找到。

特性

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

本库的结构

API结构如下主要项目

  • 中心
  • 资源
    • 可以将活动应用于的主要类型
    • 一组属性和部分
    • 部分
      • 一组属性
      • 从未直接在活动中使用
  • 活动
    • 应用于资源的操作

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

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

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

或具体地...

let r = hub.projects().agent_entity_types_entities_batch_create(...).doit().await
let r = hub.projects().agent_entity_types_entities_batch_delete(...).doit().await
let r = hub.projects().agent_entity_types_entities_batch_update(...).doit().await
let r = hub.projects().agent_entity_types_batch_delete(...).doit().await
let r = hub.projects().agent_entity_types_batch_update(...).doit().await
let r = hub.projects().agent_intents_batch_delete(...).doit().await
let r = hub.projects().agent_intents_batch_update(...).doit().await
let r = hub.projects().agent_knowledge_bases_documents_create(...).doit().await
let r = hub.projects().agent_knowledge_bases_documents_delete(...).doit().await
let r = hub.projects().agent_knowledge_bases_documents_patch(...).doit().await
let r = hub.projects().agent_knowledge_bases_documents_reload(...).doit().await
let r = hub.projects().agent_export(...).doit().await
let r = hub.projects().agent_import(...).doit().await
let r = hub.projects().agent_restore(...).doit().await
let r = hub.projects().agent_train(...).doit().await
let r = hub.projects().conversation_profiles_clear_suggestion_feature_config(...).doit().await
let r = hub.projects().conversation_profiles_set_suggestion_feature_config(...).doit().await
let r = hub.projects().knowledge_bases_documents_create(...).doit().await
let r = hub.projects().knowledge_bases_documents_delete(...).doit().await
let r = hub.projects().knowledge_bases_documents_import(...).doit().await
let r = hub.projects().knowledge_bases_documents_patch(...).doit().await
let r = hub.projects().knowledge_bases_documents_reload(...).doit().await
let r = hub.projects().locations_agent_entity_types_entities_batch_create(...).doit().await
let r = hub.projects().locations_agent_entity_types_entities_batch_delete(...).doit().await
let r = hub.projects().locations_agent_entity_types_entities_batch_update(...).doit().await
let r = hub.projects().locations_agent_entity_types_batch_delete(...).doit().await
let r = hub.projects().locations_agent_entity_types_batch_update(...).doit().await
let r = hub.projects().locations_agent_intents_batch_delete(...).doit().await
let r = hub.projects().locations_agent_intents_batch_update(...).doit().await
let r = hub.projects().locations_agent_export(...).doit().await
let r = hub.projects().locations_agent_import(...).doit().await
let r = hub.projects().locations_agent_restore(...).doit().await
let r = hub.projects().locations_agent_train(...).doit().await
let r = hub.projects().locations_conversation_profiles_clear_suggestion_feature_config(...).doit().await
let r = hub.projects().locations_conversation_profiles_set_suggestion_feature_config(...).doit().await
let r = hub.projects().locations_knowledge_bases_documents_create(...).doit().await
let r = hub.projects().locations_knowledge_bases_documents_delete(...).doit().await
let r = hub.projects().locations_knowledge_bases_documents_import(...).doit().await
let r = hub.projects().locations_knowledge_bases_documents_patch(...).doit().await
let r = hub.projects().locations_knowledge_bases_documents_reload(...).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-dialogflow2_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dialogflow2_beta1 as dialogflow2_beta1;
use dialogflow2_beta1::api::GoogleCloudDialogflowV2beta1Document;
use dialogflow2_beta1::{Result, Error};
use std::default::Default;
use dialogflow2_beta1::{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 = GoogleCloudDialogflowV2beta1Document::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().agent_knowledge_bases_documents_create(req, "parent")
             .import_gcs_custom_metadata(true)
             .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 DelegateAuthenticator Delegate

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

上传和下载

如果某个方法支持下载,则应读取响应体以获取媒体,该响应体是 Result 的一部分。如果此类方法也支持 Response Result,则默认返回该结果。您可以将其视为实际媒体的数据。要触发媒体下载,您将需要通过以下调用设置构建器: .param("alt", "media")

支持上传的方法可以使用多达 2 种不同的协议:简单可恢复。每个的独特性通过定制的 doit(...) 方法来表示,分别命名为 upload(...)upload_resumable(...)

自定义和回调

您可以通过向 Method Builder 提供一个 delegate 来修改 doit() 方法的调用方式,在执行最终的 doit() 调用之前。相应的方 法将被调用以提供进度信息,以及确定系统是否应在失败时重试。

默认实现了 代理 trait,允许您以最少的努力对其进行自定义。

服务器请求中的可选部分

该库提供的所有结构都是为了可以通过 json 进行 编码解码 而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分被视为 部分,可以通过名称识别,这些部分将被发送到服务器,以指示请求的设置部分或响应中期望的部分。

构建器参数

通过使用 方法构建器,您可以通过重复调用其方法来准备一个动作调用。这些方法始终只接受一个参数,以下陈述对于该参数是正确的。

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

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

Cargo 功能

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

许可

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

依赖关系

~12–23MB
~342K SLoC