8 个版本 (稳定)

5.0.5+20240624	2024 年 6 月 27 日
5.0.4+20240226	2024 年 3 月 5 日
5.0.3+20230115	2023 年 8 月 23 日
5.0.2+20230115	2023 年 3 月 16 日
3.0.0+20220227	2022 年 3 月 8 日

#2933 在网络编程

在 google-contactcenterinsig… 中使用

MIT 许可证

1MB
10K SLoC

google-contactcenterinsights1 库允许访问 Google Contactcenterinsights 服务（协议 v1）的所有功能。

本文档是从 Contactcenterinsights 软件包版本 5.0.5+20240624 生成的，其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 contactcenterinsights:v1 模式的确切修订。

有关 Contactcenterinsights v1 API 的其他信息，请参阅官方文档网站。

特性

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

本库的结构

API 结构为以下主要项目

枢纽
- 一个中心对象，用于维护状态并允许访问所有活动
- 创建 方法构建器，它反过来允许访问单个 调用构建器
资源
- 可以将其应用于活动的主要类型
- 一组属性和部分
- 部分
  - 一组属性
  - 在活动中永远不会直接使用
活动
- 应用于资源的操作

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

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

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

或者具体地说...

let r = hub.projects().locations_conversations_analyses_create(...).doit().await
let r = hub.projects().locations_conversations_bulk_analyze(...).doit().await
let r = hub.projects().locations_conversations_bulk_delete(...).doit().await
let r = hub.projects().locations_conversations_ingest(...).doit().await
let r = hub.projects().locations_conversations_upload(...).doit().await
let r = hub.projects().locations_insightsdata_export(...).doit().await
let r = hub.projects().locations_issue_models_create(...).doit().await
let r = hub.projects().locations_issue_models_delete(...).doit().await
let r = hub.projects().locations_issue_models_deploy(...).doit().await
let r = hub.projects().locations_issue_models_export(...).doit().await
let r = hub.projects().locations_issue_models_import(...).doit().await
let r = hub.projects().locations_issue_models_undeploy(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await

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

用法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_contactcenterinsights1 as contactcenterinsights1;
use contactcenterinsights1::api::GoogleCloudContactcenterinsightsV1Analysis;
use contactcenterinsights1::{Result, Error};
use std::default::Default;
use contactcenterinsights1::{Contactcenterinsights, 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 = Contactcenterinsights::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 = GoogleCloudContactcenterinsightsV1Analysis::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_conversations_analyses_create(req, "parent")
             .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(...)。

自定义和回调

您可以通过向Method Builder提供一个代理来更改doit()方法的调用方式，在执行最后的doit()调用之前。相应的方程序将调用以提供进度信息，并确定系统是否应在失败时重试。

默认实现了委托特质，让您可以以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

使用方法构建器，您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数，以下陈述适用于该参数。

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–22MB
~342K SLoC